Share via

GeminiPromptExecutionSettings.ResponseSchema Property

Definition

Namespace:
Microsoft.SemanticKernel.Connectors.Google
Assembly:
Microsoft.SemanticKernel.Connectors.Google.dll
Package:
Microsoft.SemanticKernel.Connectors.Google v1.45.0-alpha

Optional. Output schema of the generated candidate text. Schemas must be a subset of the OpenAPI schema and can be objects, primitives or arrays. If set, a compatible responseMimeType must also be set. Compatible MIME types: application/json: Schema for JSON response. Refer to the https://ai.google.dev/gemini-api/docs/json-mode for more information.

[System.Text.Json.Serialization.JsonIgnore(Condition=System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull)]
[System.Text.Json.Serialization.JsonPropertyName("response_schema")]
public object? ResponseSchema { get; set; }
[<System.Text.Json.Serialization.JsonIgnore(Condition=System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull)>]
[<System.Text.Json.Serialization.JsonPropertyName("response_schema")>]
member this.ResponseSchema : obj with get, set
Public Property ResponseSchema As Object

Property Value

Object
Attributes
JsonIgnoreAttribute JsonPropertyNameAttribute

Remarks

Possible values are:

- Type which will be used to automatically generate a JSON schema.

- JsonElement schema definition, which will be used as is.

- JsonNode schema definition, which will be used as is.

- JsonDocument schema definition, which will be used as is.

- Object object, where none of the above matches which the type will be used to automatically generate a JSON schema.

Applies to