Send feedback
Method: projects.locations.augmentPrompt
Stay organized with collections
Save and categorize content based on your preferences.
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:
Fields
Optional. Input content to augment, only text format is supported for now.
Optional. metadata of the backend deployed model.
Union field data_source
. The data source for retrieving contexts. data_source
can be only one of the following:
Optional. Retrieves contexts from the Vertex RagStore.
Response body
Response message for locations.augmentPrompt.
If successful, the response body contains data with the following structure:
Fields
Augmented prompt, only text format is supported for now.
Retrieved facts from RAG data sources.
JSON representation
{
"augmentedPrompt" : [
{
object (Content
)
}
] ,
"facts" : [
{
object (Fact
)
}
]
}
Model
metadata of the backend deployed model.
Fields
model
string
Optional. The model that the user will send the augmented prompt for content generation.
modelVersion
string
Optional. The model version of the backend deployed model.
JSON representation
{
"model" : string ,
"modelVersion" : string
}
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-03 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
Need to tell us more?
{"lastModified": "Last updated 2024-10-03 UTC."}
[[["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 2024-10-03 UTC."]]