Class: Anthropic::Models::JSONOutputFormat

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Anthropic::Models::JSONOutputFormat

Defined in:

lib/anthropic/models/json_output_format.rb,
sig/anthropic/models/json_output_format.rbs

Instance Attribute Summary

• #schema ⇒ Hash{Symbol=>Object}

  The JSON schema of the format.

• #type ⇒ Symbol, :json_schema

Instance Method Summary

• #initialize(schema:, type: :json_schema) ⇒ JSONOutputFormat constructor

  A new instance of JSONOutputFormat.

• #to_hash ⇒ { schema: ::Hash[Symbol, top], type: :json_schema }

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(schema:, type: :json_schema) ⇒ JSONOutputFormat

Returns a new instance of JSONOutputFormat.

Parameters:

• schema (Hash{Symbol=>Object}) —

  The JSON schema of the format

• type (Symbol, :json_schema) (defaults to: :json_schema)
• schema: (::Hash[Symbol, top])
• type: (:json_schema) (defaults to: :json_schema)

# File 'lib/anthropic/models/json_output_format.rb', line 17

Instance Attribute Details

#schema ⇒ Hash{Symbol=>Object}

The JSON schema of the format

Parameters:

• value (::Hash[Symbol, top])

Returns:

• (Hash{Symbol=>Object})

# File 'lib/anthropic/models/json_output_format.rb', line 10

required :schema, Anthropic::Internal::Type::HashOf[Anthropic::Internal::Type::Unknown]

#type ⇒ Symbol, :json_schema

Parameters:

• value (:json_schema)

Returns:

• (Symbol, :json_schema)

# File 'lib/anthropic/models/json_output_format.rb', line 15

required :type, const: :json_schema

Instance Method Details

#to_hash ⇒ { schema: ::Hash[Symbol, top], type: :json_schema }

Returns:

• ({ schema: ::Hash[Symbol, top], type: :json_schema })

# File 'sig/anthropic/models/json_output_format.rbs', line 13

def to_hash: -> { schema: ::Hash[Symbol, top], type: :json_schema }