Retrieves relevant contexts for a query.
Endpoint
post
https://{service-endpoint}/v1beta1/{parent}:retrieveContexts
Where {service-endpoint}
is one of the supported service endpoints.
Path parameters
parent
string
Required. The resource name of the Location from which to retrieve RagContexts. 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:
Required. Single RAG retrieve query.
data_source
. Data Source to retrieve contexts. data_source
can be only one of the following:The data source for Vertex RagStore.
Response body
Response message for VertexRagService.RetrieveContexts
.
If successful, the response body contains data with the following structure:
The contexts of the query.
JSON representation |
---|
{
"contexts": {
object ( |
VertexRagStore
The data source for Vertex RagStore.
ragCorpora[]
(deprecated)
string
Optional. Deprecated. Please use ragResources to specify the data source.
Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
vectorDistanceThreshold
number
Optional. Only return contexts with vector distance smaller than the threshold.
JSON representation |
---|
{
"ragCorpora": [
string
],
"ragResources": [
{
object ( |
RagResource
The definition of the Rag resource.
ragCorpus
string
Optional. RagCorpora resource name. Format: projects/{project}/locations/{location}/ragCorpora/{ragCorpus}
ragFileIds[]
string
Optional. ragFileId. The files should be in the same ragCorpus set in ragCorpus field.
JSON representation |
---|
{ "ragCorpus": string, "ragFileIds": [ string ] } |
RagQuery
A query to retrieve relevant contexts.
similarityTopK
integer
Optional. The number of contexts to retrieve.
query
. The query to retrieve contexts. Currently only text query is supported. query
can be only one of the following:text
string
Optional. The query in text format to get relevant contexts.
JSON representation |
---|
{ "similarityTopK": integer, // Union field |
RagContexts
Context
A context of the query.
sourceUri
string
For vertex RagStore, if the file is imported from Cloud Storage or Google Drive, sourceUri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, sourceUri will be file display name.
text
string
The text chunk.
JSON representation |
---|
{ "sourceUri": string, "text": string } |