Starting April 29, 2025, Gemini 1.5 Pro and Gemini 1.5 Flash models are not available in projects that have no prior usage of these models, including new projects. For details, see Model versions and lifecycle.
Stay organized with collections
Save and categorize content based on your preferences.
Full name: projects.locations.augmentPrompt
Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.
Endpoint
post
https://aiplatform.googleapis.com/v1beta1/{parent}:augmentPrompt
Path parameters
parent
string
Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: projects/{project}/locations/{location}.
Request body
The request body contains data with the following structure:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[],[],null,["# Method: locations.augmentPrompt\n\n**Full name**: projects.locations.augmentPrompt\n\nGiven an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses. \n\n### Endpoint\n\npost `https:``/``/aiplatform.googleapis.com``/v1beta1``/{parent}:augmentPrompt` \n\n### Path parameters\n\n`parent` `string` \nRequired. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.\n\n### Request body\n\nThe request body contains data with the following structure:\nFields `contents[]` `object (`[Content](/vertex-ai/generative-ai/docs/reference/rest/v1beta1/Content)`)` \nOptional. Input content to augment, only text format is supported for now.\n`model` `object (`[Model](/vertex-ai/generative-ai/docs/reference/rest/v1beta1/projects.locations/augmentPrompt#Model)`)` \nOptional. metadata of the backend deployed model. \n`data_source` `Union type` \nThe data source for retrieving contexts. `data_source` can be only one of the following:\n`vertexRagStore` `object (`[VertexRagStore](/vertex-ai/generative-ai/docs/reference/rest/v1beta1/projects.locations.cachedContents#VertexRagStore)`)` \nOptional. Retrieves contexts from the Vertex RagStore. \n\n### Response body\n\nResponse message for locations.augmentPrompt.\n\nIf successful, the response body contains data with the following structure:\nFields `augmentedPrompt[]` `object (`[Content](/vertex-ai/generative-ai/docs/reference/rest/v1beta1/Content)`)` \nAugmented prompt, only text format is supported for now.\n`facts[]` `object (`[Fact](/vertex-ai/generative-ai/docs/reference/rest/v1beta1/Fact)`)` \nRetrieved facts from RAG data sources. \n\nModel\n-----\n\nmetadata of the backend deployed model.\nFields `model` `string` \nOptional. The model that the user will send the augmented prompt for content generation.\n`modelVersion` `string` \nOptional. The model version of the backend deployed model."]]