Constructor Detail

• GroundingChunkRetrievedContext.Builder

  GroundingChunkRetrievedContext.Builder()

Method Detail

• documentName

   abstract GroundingChunkRetrievedContext.Builder documentName(String documentName)

  Setter for documentName.

  documentName: 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.

• clearDocumentName

  @CanIgnoreReturnValue() GroundingChunkRetrievedContext.Builder clearDocumentName()

  Clears the value of documentName field.

• ragChunk

   abstract GroundingChunkRetrievedContext.Builder ragChunk(RagChunk ragChunk)

  Setter for 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.

• ragChunk

  @CanIgnoreReturnValue() GroundingChunkRetrievedContext.Builder ragChunk(RagChunk.Builder ragChunkBuilder)

  Setter for ragChunk builder.

  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.

• clearRagChunk

  @CanIgnoreReturnValue() GroundingChunkRetrievedContext.Builder clearRagChunk()

  Clears the value of ragChunk field.

• text

   abstract GroundingChunkRetrievedContext.Builder text(String text)

  Setter for text.

  text: The content of the retrieved data source.

• clearText

  @CanIgnoreReturnValue() GroundingChunkRetrievedContext.Builder clearText()

  Clears the value of text field.

• title

   abstract GroundingChunkRetrievedContext.Builder title(String title)

  Setter for title.

  title: The title of the retrieved data source.

• clearTitle

  @CanIgnoreReturnValue() GroundingChunkRetrievedContext.Builder clearTitle()

  Clears the value of title field.

• uri

   abstract GroundingChunkRetrievedContext.Builder uri(String uri)

  Setter for uri.

  uri: The URI of the retrieved data source.

• clearUri

  @CanIgnoreReturnValue() GroundingChunkRetrievedContext.Builder clearUri()

  Clears the value of uri field.

• customMetadata

   abstract GroundingChunkRetrievedContext.Builder customMetadata(List<GroundingChunkCustomMetadata> customMetadata)

  Setter for customMetadata.

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

• customMetadata

  @CanIgnoreReturnValue() GroundingChunkRetrievedContext.Builder customMetadata(Array<GroundingChunkCustomMetadata> customMetadata)

  Setter for customMetadata.

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

• customMetadata

  @CanIgnoreReturnValue() GroundingChunkRetrievedContext.Builder customMetadata(Array<GroundingChunkCustomMetadata.Builder> customMetadataBuilders)

  Setter for customMetadata builder.

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

• clearCustomMetadata

  @CanIgnoreReturnValue() GroundingChunkRetrievedContext.Builder clearCustomMetadata()

  Clears the value of customMetadata field.

• fileSearchStore

   abstract GroundingChunkRetrievedContext.Builder fileSearchStore(String fileSearchStore)

  Setter for fileSearchStore.

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

• clearFileSearchStore

  @CanIgnoreReturnValue() GroundingChunkRetrievedContext.Builder clearFileSearchStore()

  Clears the value of fileSearchStore field.

• build

   abstract GroundingChunkRetrievedContext build()