Interface GroundingChunk.RetrievedContextOrBuilder (1.43.0)

Version latest

• 1.43.0 (latest)
• 1.42.0
• 1.40.0
• 1.38.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.30.0
• 1.28.0
• 1.27.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.20.1
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.8.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static interface GroundingChunk.RetrievedContextOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getContextDetailsCase()

public abstract GroundingChunk.RetrievedContext.ContextDetailsCase getContextDetailsCase()

Returns
Type	Description
GroundingChunk.RetrievedContext.ContextDetailsCase

getDocumentName()

public abstract String getDocumentName()

Output only. The full document name for the referenced Vertex AI Search document.

optional string document_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The documentName.

getDocumentNameBytes()

public abstract ByteString getDocumentNameBytes()

Output only. The full document name for the referenced Vertex AI Search document.

optional string document_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for documentName.

getRagChunk()

public abstract RagChunk getRagChunk()

Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.

.google.cloud.vertexai.v1.RagChunk rag_chunk = 4;

Returns
Type	Description
RagChunk	The ragChunk.

getRagChunkOrBuilder()

public abstract RagChunkOrBuilder getRagChunkOrBuilder()

Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.

.google.cloud.vertexai.v1.RagChunk rag_chunk = 4;

Returns
Type	Description
RagChunkOrBuilder

getText()

public abstract String getText()

Text of the attribution.

optional string text = 3;

Returns
Type	Description
String	The text.

getTextBytes()

public abstract ByteString getTextBytes()

Text of the attribution.

optional string text = 3;

Returns
Type	Description
ByteString	The bytes for text.

getTitle()

public abstract String getTitle()

Title of the attribution.

optional string title = 2;

Returns
Type	Description
String	The title.

getTitleBytes()

public abstract ByteString getTitleBytes()

Title of the attribution.

optional string title = 2;

Returns
Type	Description
ByteString	The bytes for title.

getUri()

public abstract String getUri()

URI reference of the attribution.

optional string uri = 1;

Returns
Type	Description
String	The uri.

getUriBytes()

public abstract ByteString getUriBytes()

URI reference of the attribution.

optional string uri = 1;

Returns
Type	Description
ByteString	The bytes for uri.

hasDocumentName()

public abstract boolean hasDocumentName()

Output only. The full document name for the referenced Vertex AI Search document.

optional string document_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the documentName field is set.

hasRagChunk()

public abstract boolean hasRagChunk()

Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.

.google.cloud.vertexai.v1.RagChunk rag_chunk = 4;

Returns
Type	Description
boolean	Whether the ragChunk field is set.

hasText()

public abstract boolean hasText()

Text of the attribution.

optional string text = 3;

Returns
Type	Description
boolean	Whether the text field is set.

hasTitle()

public abstract boolean hasTitle()

Title of the attribution.

optional string title = 2;

Returns
Type	Description
boolean	Whether the title field is set.

hasUri()

public abstract boolean hasUri()

URI reference of the attribution.

optional string uri = 1;

Returns
Type	Description
boolean	Whether the uri field is set.