All Implemented Interfaces:


public final class ResponseFormatJsonSchema.JsonSchema

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`ResponseFormatJsonSchema.JsonSchema.Builder`
`public final class`	`ResponseFormatJsonSchema.JsonSchema.Schema`	The schema for the response format, described as a JSON Schema object.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`name()`	The name of the response format.
`final Optional<String>`	`description()`	A description of what the response format is for, used by the model to determine how to respond in the format.
`final Optional<ResponseFormatJsonSchema.JsonSchema.Schema>`	`schema()`	The schema for the response format, described as a JSON Schema object.
`final Optional<Boolean>`	`strict()`	Whether to enable strict schema adherence when generating the output.
`final JsonField<String>`	`_name()`	The name of the response format.
`final JsonField<String>`	`_description()`	A description of what the response format is for, used by the model to determine how to respond in the format.
`final JsonField<ResponseFormatJsonSchema.JsonSchema.Schema>`	`_schema()`	The schema for the response format, described as a JSON Schema object.
`final JsonField<Boolean>`	`_strict()`	Whether to enable strict schema adherence when generating the output.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final ResponseFormatJsonSchema.JsonSchema`	`validate()`
`final ResponseFormatJsonSchema.JsonSchema.Builder`	`toBuilder()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static ResponseFormatJsonSchema.JsonSchema.Builder`	`builder()`

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

- Constructor Detail
- Method Detail
  - name
```
 final String name()
```
    The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
  - description
```
 final Optional<String> description()
```
    A description of what the response format is for, used by the model to determine how to respond in the format.
  - schema
```
 final Optional<ResponseFormatJsonSchema.JsonSchema.Schema> schema()
```
    The schema for the response format, described as a JSON Schema object.
  - strict
```
 final Optional<Boolean> strict()
```
    Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true. To learn more, read the Structured Outputs guide.
  - _name
```
 final JsonField<String> _name()
```
    The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
  - _description
```
 final JsonField<String> _description()
```
    A description of what the response format is for, used by the model to determine how to respond in the format.
  - _schema
```
 final JsonField<ResponseFormatJsonSchema.JsonSchema.Schema> _schema()
```
    The schema for the response format, described as a JSON Schema object.
  - _strict
```
 final JsonField<Boolean> _strict()
```
    Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true. To learn more, read the Structured Outputs guide.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - validate
```
 final ResponseFormatJsonSchema.JsonSchema validate()
```
  - toBuilder
```
 final ResponseFormatJsonSchema.JsonSchema.Builder toBuilder()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static ResponseFormatJsonSchema.JsonSchema.Builder builder()
```

Class ResponseFormatJsonSchema.JsonSchema

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

name

description

schema

strict

_name

_description

_schema

_strict

_additionalProperties

validate

toBuilder

equals

hashCode

toString

builder