Record Class JsonSchemaResponseFormat

java.lang.Object
java.lang.Record
com.github.copilot.generated.rpc.JsonSchemaResponseFormat
@Generated("copilot-sdk-codegen") public record JsonSchemaResponseFormat(String name, Object schema, String description, Boolean strict) extends Record
A JSON Schema output contract. OpenAI receives the name, description, schema and strict setting; Anthropic receives the schema in output_config.format and always uses its native strict enforcement.
Since:
1.0.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    JsonSchemaResponseFormat(String name, Object schema, String description, Boolean strict)
    Creates an instance of a JsonSchemaResponseFormat record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    description()
    Returns the value of the description record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    name()
    Returns the value of the name record component.
    Object
    schema()
    Returns the value of the schema record component.
    Boolean
    strict()
    Returns the value of the strict record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • JsonSchemaResponseFormat

      public JsonSchemaResponseFormat(String name, Object schema, String description, Boolean strict)
      Creates an instance of a JsonSchemaResponseFormat record class.
      Parameters:
      name - the value for the name record component
      schema - the value for the schema record component
      description - the value for the description record component
      strict - the value for the strict record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • schema

      public Object schema()
      Returns the value of the schema record component.
      Returns:
      the value of the schema record component

    • description

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • strict

      public Boolean strict()
      Returns the value of the strict record component.
      Returns:
      the value of the strict record component