Class RetrievalMetadata

Namespace

Google.GenAI.Types

Assembly

Google.GenAI.dll

Metadata returned to client when grounding is enabled.

public record RetrievalMetadata : IEquatable<RetrievalMetadata>

Inheritance

object

RetrievalMetadata

Implements

IEquatable<RetrievalMetadata>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

GoogleSearchDynamicRetrievalScore

Optional. Score indicating how likely information from google search could help answer the prompt. The score is in the range [0, 1], where 0 is the least likely and 1 is the most likely. This score is only populated when google search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google search.

[JsonPropertyName("googleSearchDynamicRetrievalScore")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public double? GoogleSearchDynamicRetrievalScore { get; set; }

Property Value

double?

Methods

FromJson(string, JsonSerializerOptions?)

Deserializes a JSON string to a RetrievalMetadata object.

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

Parameters

jsonString string

The JSON string to deserialize.

options JsonSerializerOptions

Optional JsonSerializerOptions.

Returns

RetrievalMetadata

The deserialized RetrievalMetadata object, or null if deserialization fails.