Interface GroundingChunkRetrievedContext

Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset.

interface GroundingChunkRetrievedContext {
    customMetadata?: GroundingChunkCustomMetadata[];
    documentName?: string;
    fileSearchStore?: string;
    ragChunk?: RagChunk;
    text?: string;
    title?: string;
    uri?: string;
}

Properties

customMetadata? documentName? fileSearchStore? ragChunk? text? title? uri?

Properties

OptionalcustomMetadata

customMetadata?: GroundingChunkCustomMetadata[]

Optional. User-provided metadata about the retrieved context. This field is not supported in Vertex AI.

OptionaldocumentName

documentName?: string

Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}. This field is not supported in Gemini API.

OptionalfileSearchStore

fileSearchStore?: string

Optional. Name of the FileSearchStore containing the document. Example: fileSearchStores/123. This field is not supported in Vertex AI.

OptionalragChunk

ragChunk?: RagChunk

Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. This field is not supported in Gemini API.

Optionaltext

text?: string

The content of the retrieved data source.

Optionaltitle

title?: string

The title of the retrieved data source.

Optionaluri

uri?: string

The URI of the retrieved data source.

Settings

On This Page

Properties