Package com.google.genai.types

Class GroundingChunkRetrievedContext.Builder

java.lang.Object

com.google.genai.types.GroundingChunkRetrievedContext.Builder

Enclosing class:

GroundingChunkRetrievedContext

public abstract static class GroundingChunkRetrievedContext.Builder
extends Object

Builder for GroundingChunkRetrievedContext.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
abstract GroundingChunkRetrievedContext	build()
GroundingChunkRetrievedContext.Builder	clearCustomMetadata()	Clears the value of customMetadata field.
GroundingChunkRetrievedContext.Builder	clearDocumentName()	Clears the value of documentName field.
GroundingChunkRetrievedContext.Builder	clearFileSearchStore()	Clears the value of fileSearchStore field.
GroundingChunkRetrievedContext.Builder	clearRagChunk()	Clears the value of ragChunk field.
GroundingChunkRetrievedContext.Builder	clearText()	Clears the value of text field.
GroundingChunkRetrievedContext.Builder	clearTitle()	Clears the value of title field.
GroundingChunkRetrievedContext.Builder	clearUri()	Clears the value of uri field.
GroundingChunkRetrievedContext.Builder	customMetadata(GroundingChunkCustomMetadata... customMetadata)	Setter for customMetadata.
GroundingChunkRetrievedContext.Builder	customMetadata(GroundingChunkCustomMetadata.Builder... customMetadataBuilders)	Setter for customMetadata builder.
abstract GroundingChunkRetrievedContext.Builder	customMetadata(List<GroundingChunkCustomMetadata> customMetadata)	Setter for customMetadata.
abstract GroundingChunkRetrievedContext.Builder	documentName(String documentName)	Setter for documentName.
abstract GroundingChunkRetrievedContext.Builder	fileSearchStore(String fileSearchStore)	Setter for fileSearchStore.
abstract GroundingChunkRetrievedContext.Builder	ragChunk(RagChunk ragChunk)	Setter for ragChunk.
GroundingChunkRetrievedContext.Builder	ragChunk(RagChunk.Builder ragChunkBuilder)	Setter for ragChunk builder.
abstract GroundingChunkRetrievedContext.Builder	text(String text)	Setter for text.
abstract GroundingChunkRetrievedContext.Builder	title(String title)	Setter for title.
abstract GroundingChunkRetrievedContext.Builder	uri(String uri)	Setter for uri.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

documentName

public 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
public GroundingChunkRetrievedContext.Builder clearDocumentName()

Clears the value of documentName field.

ragChunk

public 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
public 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
public GroundingChunkRetrievedContext.Builder clearRagChunk()

Clears the value of ragChunk field.

text

public abstract GroundingChunkRetrievedContext.Builder text(String text)

Setter for text.

text: The content of the retrieved data source.

clearText

@CanIgnoreReturnValue
public GroundingChunkRetrievedContext.Builder clearText()

Clears the value of text field.

title

public abstract GroundingChunkRetrievedContext.Builder title(String title)

Setter for title.

title: The title of the retrieved data source.

clearTitle

@CanIgnoreReturnValue
public GroundingChunkRetrievedContext.Builder clearTitle()

Clears the value of title field.

uri

public abstract GroundingChunkRetrievedContext.Builder uri(String uri)

Setter for uri.

uri: The URI of the retrieved data source.

clearUri

@CanIgnoreReturnValue
public GroundingChunkRetrievedContext.Builder clearUri()

Clears the value of uri field.

customMetadata

public 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
public GroundingChunkRetrievedContext.Builder customMetadata(GroundingChunkCustomMetadata... customMetadata)

Setter for customMetadata.

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

customMetadata

@CanIgnoreReturnValue
public GroundingChunkRetrievedContext.Builder customMetadata(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
public GroundingChunkRetrievedContext.Builder clearCustomMetadata()

Clears the value of customMetadata field.

fileSearchStore

public 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
public GroundingChunkRetrievedContext.Builder clearFileSearchStore()

Clears the value of fileSearchStore field.

build

public abstract GroundingChunkRetrievedContext build()