This information is developers working directly with the backend APIs. See the root README for information on deploying the solution (including the backend).
We developed a comprehensive set of APIs, utilizing Python and FastAPI, which encapsulate all features available in the GenAI for Marketing repository. This implementation paves the way for streamlined data interactions and enhanced functionality, enabling you to deploy the solution in your environment.
You are empowered to extend these APIs, intertwining them with your specific policies pertaining to security, access, and authentication to bolster a secure, seamless, and individualized interaction with the data and services available. Our offering merges practicality with customization, ensuring that your specific requirements are catered to with precision and reliability.
Campaign Creation and Generating the Brief Assets (POST) (path="/campaigns")
- Create Campaign and Generate text with Gemini.
List All Campaigns Created by User (GET) (path="/campaigns")
- List of Campaigns and there details.
Update Campaign (PUT) (path="/campaigns/{campaign_id}")
- List of Campaigns and there details.
Delete Campaign (DELETE) (path="/campaigns/{campaign_id}")
- List of Campaigns and there details.
Image Generation with Vertex Imagen API (path="/generate-image")
- Generate images with the Vertex Imagen API.
Image Editing with Vertex Imagen API (path="/edit-image")
- Edit images with a prompt and a mask.
Get Top Search Terms from Google Trends (path="/get-top-search-terms")
- Retrieve top search terms from Google trends.
Summarize News Articles Related to Keywords (path="/post-summarize-news")
- Retrieve N news articles with keyword(s) using the GDELT API and summarize them.
From Natural Language to SQL (path="/post-audiences")
- Transform a question using natural language to SQL and query BigQuery.
Query Sample Data (path="/get-dataset-sample")
- Query BigQuery and return 3 lines of a given table
Query Vertex AI Search (path="/post-consumer-insights")
- Query Vertex AI Search with using input and return to 10 results.
Upload File to Google Drive (path="/post-upload-file-drive")
- Given an uploaded file using a form, upload it to Google Drive.
Create Brief Document and Upload to Drive (path="/creative-brief-create-upload")
- Create a folder in Drive with correct permissions, copy the Creative Brief to Drive and update its contents with the generated text.
Create Slides and Populate with Charts (path="/creative-slides-upload")
- Create a Google Slides from a template and populate with information from Google Sheets.
Translate Text Using Google Translation API (path="/translate")
- Translate Text using Google Translation API.
Content-Generation API for Email/Webpost/SocialMedia/AssetGroup(path="/generate-content")
- Generate Text and Image content for Email or Webpost or SocialMedia using Generative AI
Connect your app to your Firebase project, do so from the Firebase console.
- Enable Email/Password sign-in:
- In the Firebase console, open the Auth section.
- On the Sign in method tab, enable the Email/password sign-in method and click Save
- Add a Web App to project by going to Project Setting, it will generate the credentials.
- Store credentialds in Secret Manager and add secret_name in config.toml
Follow the steps below to setup the Workspace integration with this demonstration.
- Create a Service Account (SA) in the same project you are deploying the demo and download the JSON API Key. This SA doesn't need any roles / permissions.
- Follow this documentation to create the service account. Take note of the service account address; it will look like this:
[email protected]. - Follow this documentation to download the key JSON file with the service account credentials.
- Rename the JSON file to
credentials.jsonand copy it under /app folder. - [Optional] If your file has a different name and/or you copied it to a different location, change line 27 in app_config.toml to reflect these changes.
- Follow this documentation to create the service account. Take note of the service account address; it will look like this:
- When you deploy the app to AppEngine, the JSON file will be copied inside the docker image.
- IMPORTANT: For security reasons, DON'T push this credentials to a public Github repository.
- Navigate to Google Drive and create a folder.
- This folder will be used to host the templates and assets created in the demo.
- Share this folder with the service account address you created in the previous step. Give "Editor" rights to the service account. The share will look like this:
- Take note of the folder ID. Go into the folder you created and you will be able to find the ID in the URL. The URL will look like this:
- Open the configuration file app_config.toml - line 558 and change to your folder ID.
- IMPORTANT: Also share this folder with people who will be using the code.
Using the same Vertex AI managed notebook you created in this README file, follow the steps below:
- Open the JupyterLab environment
- Create a new terminal
- Navigate to the
backend_apisfolder
cd ./genai-for-marketing/backend_apis
- Open the file config.toml, change the variables below and save it:
- project_id
- location
- vertexai_search_datastore
- drive_folder_id
- slides_template_id
- doc_template_id
- sheet_template_id
- slide_page_id_list
You will find detailed intructions in this README file, specially for the workspace integration.
-
Copy the Service Account to interact with Workspace inside the folder backend_apis/app and rename it to
credentials.json. -
Build the docker image:
gcloud builds submit --region=us-central1 --tag gcr.io/"YOUR PROJECT ID"/genai-marketing-apis
- Deploy the container to Cloud Run:
gcloud run deploy genai-marketing-apis --image gcr.io/"YOUR PROJECT ID"/genai-marketing-apis --allow-unauthenticated --region us-central1
Replace "YOUR PROJECT ID" with the id of your project.
This is just one example on how to deploy this container to Cloud Run on an endpoint that accepts unauthenticated requests. Change to your requirements.