JsonSchemaResponseFormat (Semantic Kernel API 1.4.2 API)

java.lang.Object
- com.microsoft.semantickernel.orchestration.responseformat.ResponseFormat
- - com.microsoft.semantickernel.orchestration.responseformat.JsonSchemaResponseFormat

public class JsonSchemaResponseFormat
extends ResponseFormat

A response represented in a JSON schema format.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class JsonSchemaResponseFormat.Builder
A builder for the JsonSchemaResponseFormat class.
- Nested classes/interfaces inherited from class com.microsoft.semantickernel.orchestration.responseformat.ResponseFormat
  ResponseFormat.Type

Constructor Summary

Constructors
Constructor	Description
`JsonSchemaResponseFormat(JsonResponseSchema jsonSchema)`	Used by Jackson deserialization to create a new instance of the `JsonSchemaResponseFormat` class.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static JsonSchemaResponseFormat.Builder`	`builder()`	Creates a new instance of the `JsonSchemaResponseFormat` class.
`JsonResponseSchema`	`getJsonSchema()`	Gets the JSON schema.

Methods inherited from class com.microsoft.semantickernel.orchestration.responseformat.ResponseFormat
getType

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JsonSchemaResponseFormat
```
public JsonSchemaResponseFormat(JsonResponseSchema jsonSchema)
```
    Used by Jackson deserialization to create a new instance of the JsonSchemaResponseFormat class.
    
    Parameters:
    
    jsonSchema - The JSON schema.
- Method Detail
  - getJsonSchema
```
public JsonResponseSchema getJsonSchema()
```
    Gets the JSON schema.
    
    Returns:
    
    The JSON schema.
  - builder
```
public static JsonSchemaResponseFormat.Builder builder()
```
    Creates a new instance of the JsonSchemaResponseFormat class.
    
    Returns:
    
    The new instance.