All Implemented Interfaces:


public final class ResponseFormatTextJsonSchemaConfig.Builder

A builder for ResponseFormatTextJsonSchemaConfig.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

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 ResponseFormatTextJsonSchemaConfig.Builder`	`schema(ResponseFormatTextJsonSchemaConfig.Schema schema)`	The schema for the response format, described as a JSON Schema object.
`final ResponseFormatTextJsonSchemaConfig.Builder`	`schema(JsonField<ResponseFormatTextJsonSchemaConfig.Schema> schema)`	The schema for the response format, described as a JSON Schema object.
`final ResponseFormatTextJsonSchemaConfig.Builder`	`type(JsonValue type)`	The type of response format being defined.
`final ResponseFormatTextJsonSchemaConfig.Builder`	`description(String description)`	A description of what the response format is for, used by the model to determine how to respond in the format.
`final ResponseFormatTextJsonSchemaConfig.Builder`	`description(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 ResponseFormatTextJsonSchemaConfig.Builder`	`name(String name)`	The name of the response format.
`final ResponseFormatTextJsonSchemaConfig.Builder`	`name(JsonField<String> name)`	The name of the response format.
`final ResponseFormatTextJsonSchemaConfig.Builder`	`strict(Boolean strict)`	Whether to enable strict schema adherence when generating the output.
`final ResponseFormatTextJsonSchemaConfig.Builder`	`strict(Boolean strict)`	Whether to enable strict schema adherence when generating the output.
`final ResponseFormatTextJsonSchemaConfig.Builder`	`strict(Optional<Boolean> strict)`	Whether to enable strict schema adherence when generating the output.
`final ResponseFormatTextJsonSchemaConfig.Builder`	`strict(JsonField<Boolean> strict)`	Whether to enable strict schema adherence when generating the output.
`final ResponseFormatTextJsonSchemaConfig.Builder`	`additionalProperties(Map<String, JsonValue> additionalProperties)`
`final ResponseFormatTextJsonSchemaConfig.Builder`	`putAdditionalProperty(String key, JsonValue value)`
`final ResponseFormatTextJsonSchemaConfig.Builder`	`putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)`
`final ResponseFormatTextJsonSchemaConfig.Builder`	`removeAdditionalProperty(String key)`
`final ResponseFormatTextJsonSchemaConfig.Builder`	`removeAllAdditionalProperties(Set<String> keys)`
`final ResponseFormatTextJsonSchemaConfig`	`build()`

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

- Constructor Detail
- Method Detail
  - schema
```
 final ResponseFormatTextJsonSchemaConfig.Builder schema(ResponseFormatTextJsonSchemaConfig.Schema schema)
```
    The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas here.
  - schema
```
 final ResponseFormatTextJsonSchemaConfig.Builder schema(JsonField<ResponseFormatTextJsonSchemaConfig.Schema> schema)
```
    The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas here.
  - type
```
 final ResponseFormatTextJsonSchemaConfig.Builder type(JsonValue type)
```
    The type of response format being defined. Always json_schema.
  - description
```
 final ResponseFormatTextJsonSchemaConfig.Builder description(String description)
```
    A description of what the response format is for, used by the model to determine how to respond in the format.
  - description
```
 final ResponseFormatTextJsonSchemaConfig.Builder description(JsonField<String> description)
```
    A description of what the response format is for, used by the model to determine how to respond in the format.
  - name
```
 final ResponseFormatTextJsonSchemaConfig.Builder name(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.
  - name
```
 final ResponseFormatTextJsonSchemaConfig.Builder name(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.
  - strict
```
 final ResponseFormatTextJsonSchemaConfig.Builder strict(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.
  - strict
```
 final ResponseFormatTextJsonSchemaConfig.Builder strict(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.
  - strict
```
 final ResponseFormatTextJsonSchemaConfig.Builder strict(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.
  - strict
```
 final ResponseFormatTextJsonSchemaConfig.Builder strict(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 ResponseFormatTextJsonSchemaConfig.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
```
  - putAdditionalProperty
```
 final ResponseFormatTextJsonSchemaConfig.Builder putAdditionalProperty(String key, JsonValue value)
```
  - putAllAdditionalProperties
```
 final ResponseFormatTextJsonSchemaConfig.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
```
  - removeAdditionalProperty
```
 final ResponseFormatTextJsonSchemaConfig.Builder removeAdditionalProperty(String key)
```
  - removeAllAdditionalProperties
```
 final ResponseFormatTextJsonSchemaConfig.Builder removeAllAdditionalProperties(Set<String> keys)
```
  - build
```
 final ResponseFormatTextJsonSchemaConfig build()
```

Class ResponseFormatTextJsonSchemaConfig.Builder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

schema

schema

type

description

description

name

name

strict

strict

strict

strict

additionalProperties

putAdditionalProperty

putAllAdditionalProperties

removeAdditionalProperty

removeAllAdditionalProperties

build