Constructor Detail

Method Detail

• name

   final ResponseFormatJsonSchema.JsonSchema.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 ResponseFormatJsonSchema.JsonSchema.Builder name(JsonField<String> name)

  Sets Builder.name to an arbitrary JSON value.

  You should usually call Builder.name with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• description

   final ResponseFormatJsonSchema.JsonSchema.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 ResponseFormatJsonSchema.JsonSchema.Builder description(JsonField<String> description)

  Sets Builder.description to an arbitrary JSON value.

  You should usually call Builder.description with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• schema

   final ResponseFormatJsonSchema.JsonSchema.Builder schema(ResponseFormatJsonSchema.JsonSchema.Schema schema)

  The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas here.

• schema

   final ResponseFormatJsonSchema.JsonSchema.Builder schema(JsonField<ResponseFormatJsonSchema.JsonSchema.Schema> schema)

  Sets Builder.schema to an arbitrary JSON value.

  You should usually call Builder.schema with a well-typed Schema value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• strict

   final ResponseFormatJsonSchema.JsonSchema.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 ResponseFormatJsonSchema.JsonSchema.Builder strict(Boolean strict)

  Alias for Builder.strict.

  This unboxed primitive overload exists for backwards compatibility.

• strict

   final ResponseFormatJsonSchema.JsonSchema.Builder strict(Optional<Boolean> strict)

  Alias for calling Builder.strict with strict.orElse(null).

• strict

   final ResponseFormatJsonSchema.JsonSchema.Builder strict(JsonField<Boolean> strict)

  Sets Builder.strict to an arbitrary JSON value.

  You should usually call Builder.strict with a well-typed Boolean value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalProperties

   final ResponseFormatJsonSchema.JsonSchema.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final ResponseFormatJsonSchema.JsonSchema.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final ResponseFormatJsonSchema.JsonSchema.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final ResponseFormatJsonSchema.JsonSchema.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final ResponseFormatJsonSchema.JsonSchema.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final ResponseFormatJsonSchema.JsonSchema build()

  Returns an immutable instance of JsonSchema.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .name()