Class PartialArg

Namespace

Google.GenAI.Types

Assembly

Google.GenAI.dll

Partial argument value of the function call. This data type is not supported in Gemini API.

public record PartialArg : IEquatable<PartialArg>

Inheritance

object

PartialArg

Implements

IEquatable<PartialArg>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

BoolValue

Optional. Represents a boolean value.

[JsonPropertyName("boolValue")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public bool? BoolValue { get; set; }

Property Value

bool?

JsonPath

A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data".

[JsonPropertyName("jsonPath")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? JsonPath { get; set; }

Property Value

string

NullValue

Optional. Represents a null value.

[JsonPropertyName("nullValue")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? NullValue { get; set; }

Property Value

string

NumberValue

Optional. Represents a double value.

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

Property Value

double?

StringValue

Optional. Represents a string value.

[JsonPropertyName("stringValue")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? StringValue { get; set; }

Property Value

string

WillContinue

Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow.

[JsonPropertyName("willContinue")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public bool? WillContinue { get; set; }

Property Value

bool?

Methods

FromJson(string, JsonSerializerOptions?)

Deserializes a JSON string to a PartialArg object.

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

Parameters

jsonString string

The JSON string to deserialize.

options JsonSerializerOptions

Optional JsonSerializerOptions.

Returns

PartialArg

The deserialized PartialArg object, or null if deserialization fails.