JsonSchemaResponseFormat Class

Package:
com.microsoft.semantickernel.orchestration.responseformat
Maven Artifact:
com.microsoft.semantic-kernel:semantickernel-api:1.4.0

public class JsonSchemaResponseFormat
extends ResponseFormat

A response represented in a JSON schema format.

Constructor Summary

Constructor Description
JsonSchemaResponseFormat(JsonResponseSchema jsonSchema)

Used by Jackson deserialization to create a new instance of the JsonSchemaResponseFormat class.

Method Summary

Modifier and Type Method and Description
static Builder builder()

Creates a new instance of the JsonSchemaResponseFormat class.
JsonResponseSchema getJsonSchema()

Gets the JSON schema.

Methods inherited from ResponseFormat

getType

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

JsonSchemaResponseFormat

public JsonSchemaResponseFormat(JsonResponseSchema jsonSchema)

Used by Jackson deserialization to create a new instance of the JsonSchemaResponseFormat class.

Parameters:

jsonSchema - The JSON schema.

Method Details

builder

public static JsonSchemaResponseFormat.Builder builder()

Creates a new instance of the JsonSchemaResponseFormat class.

Returns:

The new instance.

getJsonSchema

public JsonResponseSchema getJsonSchema()

Gets the JSON schema.

Returns:

The JSON schema.

Applies to