Class: ContextDev::Models::WebExtractResponse::Metadata::ActionsApplied

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

Defined Under Namespace

Modules: Status

Instance Attribute 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(instruction:, status:, completion_evidence: nil, duration_ms: nil, error: nil, method_: nil, target_description: nil) ⇒ Object

Some parameter documentations has been truncated, see ContextDev::Models::WebExtractResponse::Metadata::ActionsApplied for more details.

Parameters:

  • instruction (String)
  • status (Symbol, ContextDev::Models::WebExtractResponse::Metadata::ActionsApplied::Status) —

    Applied means the requested page state was visibly verified. Failed means it was

  • completion_evidence (String) (defaults to: nil) —

    Visible page evidence used to verify an applied action.

  • duration_ms (Float) (defaults to: nil)
  • error (String) (defaults to: nil)
  • method_ (String) (defaults to: nil)
  • target_description (String) (defaults to: nil) 


119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/context_dev/models/web_extract_response.rb', line 119

class ActionsApplied < ContextDev::Internal::Type::BaseModel
  # @!attribute instruction
  #
  #   @return [String]
  required :instruction, String

  # @!attribute status
  #   Applied means the requested page state was visibly verified. Failed means it was
  #   not verified. Skipped means it was not attempted.
  #
  #   @return [Symbol, ContextDev::Models::WebExtractResponse::Metadata::ActionsApplied::Status]
  required :status, enum: -> { ContextDev::Models::WebExtractResponse::Metadata::ActionsApplied::Status }

  # @!attribute completion_evidence
  #   Visible page evidence used to verify an applied action.
  #
  #   @return [String, nil]
  optional :completion_evidence, String, api_name: :completionEvidence

  # @!attribute duration_ms
  #
  #   @return [Float, nil]
  optional :duration_ms, Float, api_name: :durationMs

  # @!attribute error
  #
  #   @return [String, nil]
  optional :error, String

  # @!attribute method_
  #
  #   @return [String, nil]
  optional :method_, String, api_name: :method

  # @!attribute target_description
  #
  #   @return [String, nil]
  optional :target_description, String, api_name: :targetDescription

  # @!method initialize(instruction:, status:, completion_evidence: nil, duration_ms: nil, error: nil, method_: nil, target_description: nil)
  #   Some parameter documentations has been truncated, see
  #   {ContextDev::Models::WebExtractResponse::Metadata::ActionsApplied} for more
  #   details.
  #
  #   @param instruction [String]
  #
  #   @param status [Symbol, ContextDev::Models::WebExtractResponse::Metadata::ActionsApplied::Status] Applied means the requested page state was visibly verified. Failed means it was
  #
  #   @param completion_evidence [String] Visible page evidence used to verify an applied action.
  #
  #   @param duration_ms [Float]
  #
  #   @param error [String]
  #
  #   @param method_ [String]
  #
  #   @param target_description [String]

  # Applied means the requested page state was visibly verified. Failed means it was
  # not verified. Skipped means it was not attempted.
  #
  # @see ContextDev::Models::WebExtractResponse::Metadata::ActionsApplied#status
  module Status
    extend ContextDev::Internal::Type::Enum

    APPLIED = :applied
    FAILED = :failed
    SKIPPED = :skipped

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#completion_evidence ⇒ String?

Visible page evidence used to verify an applied action.

Parameters:

  • (String)

Returns:

  • (String, nil) 


136
 
# File 'lib/context_dev/models/web_extract_response.rb', line 136

optional :completion_evidence, String, api_name: :completionEvidence

#duration_ms ⇒ Float?

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


141
 
# File 'lib/context_dev/models/web_extract_response.rb', line 141

optional :duration_ms, Float, api_name: :durationMs

#error ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


146
 
# File 'lib/context_dev/models/web_extract_response.rb', line 146

optional :error, String

#instruction ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


123
 
# File 'lib/context_dev/models/web_extract_response.rb', line 123

required :instruction, String

#method_ ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


151
 
# File 'lib/context_dev/models/web_extract_response.rb', line 151

optional :method_, String, api_name: :method

#status ⇒ Symbol, ContextDev::Models::WebExtractResponse::Metadata::ActionsApplied::Status

Applied means the requested page state was visibly verified. Failed means it was not verified. Skipped means it was not attempted.

Parameters:

  • value (ContextDev::Models::WebExtractResponse::Metadata::ActionsApplied::status)

Returns:



130
 
# File 'lib/context_dev/models/web_extract_response.rb', line 130

required :status, enum: -> { ContextDev::Models::WebExtractResponse::Metadata::ActionsApplied::Status }

#target_description ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


156
 
# File 'lib/context_dev/models/web_extract_response.rb', line 156

optional :target_description, String, api_name: :targetDescription

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


144
 
# File 'sig/context_dev/models/web_extract_response.rbs', line 144

def to_hash: -> {