Table of Contents

Class SemanticRetrieverConfig

Namespace
GenerativeAI.Types
Assembly
GenerativeAI.dll

Configuration for retrieving grounding content from a Corpus or Document created using the Semantic Retriever API.

public class SemanticRetrieverConfig
Inheritance
SemanticRetrieverConfig
Inherited Members
Extension Methods

Constructors

SemanticRetrieverConfig()

Initializes a new instance of the SemanticRetrieverConfig class for JSON deserialization.

public SemanticRetrieverConfig()

SemanticRetrieverConfig(Content)

Initializes a new instance of the SemanticRetrieverConfig class with the specified query.

public SemanticRetrieverConfig(Content query)

Parameters

query Content

Query to use for matching chunks by similarity.

Properties

MaxChunksCount

Optional. Maximum number of relevant Chunks to retrieve.

[JsonPropertyName("maxChunksCount")]
public int? MaxChunksCount { get; set; }

Property Value

int?

MetadataFilters

Optional. Filters for selecting Documents and/or Chunks from the resource.

[JsonPropertyName("metadataFilters")]
public List<MetadataFilter>? MetadataFilters { get; set; }

Property Value

List<MetadataFilter>

MinimumRelevanceScore

Optional. Minimum relevance score for retrieved relevant Chunks.

[JsonPropertyName("minimumRelevanceScore")]
public double? MinimumRelevanceScore { get; set; }

Property Value

double?

Query

Required. Query to use for matching Chunks in the given resource by similarity.

[JsonPropertyName("query")]
public Content Query { get; set; }

Property Value

Content

Source

Required. Name of the resource for retrieval. Example: corpora/123 or corpora/123/documents/abc.

[JsonPropertyName("source")]
public string Source { get; set; }

Property Value

string

See Also