Table of Contents

Class GroundingChunkRetrievedContext

Namespace
GenerativeAI.Types
Assembly
GenerativeAI.dll

Chunk from context retrieved by the retrieval tools.

public class GroundingChunkRetrievedContext
Inheritance
GroundingChunkRetrievedContext
Inherited Members
Extension Methods

Properties

CustomMetadata

Custom metadata of the source document.

[JsonPropertyName("customMetadata")]
public List<GroundingChunkCustomMetadata>? CustomMetadata { get; set; }

Property Value

List<GroundingChunkCustomMetadata>

DocumentName

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

[JsonPropertyName("documentName")]
public string? DocumentName { get; set; }

Property Value

string

FileSearchStore

Name of the File Search store the chunk came from.

[JsonPropertyName("fileSearchStore")]
public string? FileSearchStore { get; set; }

Property Value

string

MediaId

Identifier of the media the chunk came from.

[JsonPropertyName("mediaId")]
public string? MediaId { get; set; }

Property Value

string

PageNumber

Page number of the chunk in the source document.

[JsonPropertyName("pageNumber")]
public int? PageNumber { get; set; }

Property Value

int?

RagChunk

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

[JsonPropertyName("ragChunk")]
public RagChunk? RagChunk { get; set; }

Property Value

RagChunk

Text

Text of the attribution.

[JsonPropertyName("text")]
public string? Text { get; set; }

Property Value

string

Title

Title of the attribution.

[JsonPropertyName("title")]
public string? Title { get; set; }

Property Value

string

Uri

URI reference of the attribution.

[JsonPropertyName("uri")]
public string? Uri { get; set; }

Property Value

string