Class: ContextDev::Models::ParseHandleResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/context_dev/models/parse_handle_response.rb,
sig/context_dev/models/parse_handle_response.rbs

Overview

See Also:

  • ContextDev::Resources::Parse#handle

Defined Under Namespace

Modules: Success, Type Classes: KeyMetadata

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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(markdown:, success:, type:, key_metadata: nil) ⇒ Object

Some parameter documentations has been truncated, see ContextDev::Models::ParseHandleResponse for more details.

Parameters:




# File 'lib/context_dev/models/parse_handle_response.rb', line 32

Instance Attribute Details

#key_metadata ⇒ ContextDev::Models::ParseHandleResponse::KeyMetadata?

Metadata about the API key used for the request. Included in every response whenever a valid API key is provided, even when the response status is not 200.

Returns:



30
 
# File 'lib/context_dev/models/parse_handle_response.rb', line 30

optional :key_metadata, -> { ContextDev::Models::ParseHandleResponse::KeyMetadata }

#markdown ⇒ String

Input bytes converted to GitHub Flavored Markdown

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/context_dev/models/parse_handle_response.rb', line 11

required :markdown, String

#success ⇒ Boolean, ContextDev::Models::ParseHandleResponse::Success

Indicates success

Parameters:

  • value (ContextDev::Models::ParseHandleResponse::success)

Returns:



17
 
# File 'lib/context_dev/models/parse_handle_response.rb', line 17

required :success, enum: -> { ContextDev::Models::ParseHandleResponse::Success }

#type ⇒ Symbol, ContextDev::Models::ParseHandleResponse::Type

Detected content type used for parsing

Parameters:

  • value (ContextDev::Models::ParseHandleResponse::type_)

Returns:



23
 
# File 'lib/context_dev/models/parse_handle_response.rb', line 23

required :type, enum: -> { ContextDev::Models::ParseHandleResponse::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/context_dev/models/parse_handle_response.rb', line 52

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


31
 
# File 'sig/context_dev/models/parse_handle_response.rbs', line 31

def to_hash: -> {