Class RagRetrievalConfig

Namespace

Google.GenAI.Types

Assembly

Google.GenAI.dll

Specifies the context retrieval config. This data type is not supported in Gemini API.

public record RagRetrievalConfig : IEquatable<RagRetrievalConfig>

Inheritance

object

RagRetrievalConfig

Implements

IEquatable<RagRetrievalConfig>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Filter

Optional. Config for filters.

[JsonPropertyName("filter")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public RagRetrievalConfigFilter? Filter { get; set; }

Property Value

RagRetrievalConfigFilter

HybridSearch

Optional. Config for Hybrid Search.

[JsonPropertyName("hybridSearch")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public RagRetrievalConfigHybridSearch? HybridSearch { get; set; }

Property Value

RagRetrievalConfigHybridSearch

Ranking

Optional. Config for ranking and reranking.

[JsonPropertyName("ranking")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public RagRetrievalConfigRanking? Ranking { get; set; }

Property Value

RagRetrievalConfigRanking

TopK

Optional. The number of contexts to retrieve.

[JsonPropertyName("topK")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public int? TopK { get; set; }

Property Value

int?

Methods

FromJson(string, JsonSerializerOptions?)

Deserializes a JSON string to a RagRetrievalConfig object.

public static RagRetrievalConfig? FromJson(string jsonString, JsonSerializerOptions? options = null)

Parameters

jsonString string

The JSON string to deserialize.

options JsonSerializerOptions

Optional JsonSerializerOptions.

Returns

RagRetrievalConfig

The deserialized RagRetrievalConfig object, or null if deserialization fails.