Class: Twilio::REST::Preview::Understand::AssistantContext::TaskContext::SampleContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

#initialize(version, assistant_sid, task_sid, sid) ⇒ SampleContext

Initialize the SampleContext



174
175
176
177
178
179
180
181
182
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 174

def initialize(version, assistant_sid, task_sid, sid)
    super(version)

    # Path Solution
    @solution = { assistant_sid: assistant_sid, task_sid: task_sid, sid: sid,  }
    @uri = "/Assistants/#{@solution[:assistant_sid]}/Tasks/#{@solution[:task_sid]}/Samples/#{@solution[:sid]}"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the SampleInstance



186
187
188
189
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 186

def delete

    @version.delete('DELETE', @uri)
end

#fetch ⇒ SampleInstance

Fetch the SampleInstance



194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 194

def fetch

    payload = @version.fetch('GET', @uri)
    SampleInstance.new(
        @version,
        payload,
        assistant_sid: @solution[:assistant_sid],
        task_sid: @solution[:task_sid],
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



244
245
246
247
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 244

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Preview.Understand.SampleContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



237
238
239
240
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 237

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Preview.Understand.SampleContext #{context}>"
end

#update(language: :unset, tagged_text: :unset, source_channel: :unset) ⇒ SampleInstance

Update the SampleInstance



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/sample.rb', line 212

def update(
    language: :unset, 
    tagged_text: :unset, 
    source_channel: :unset
)

    data = Twilio::Values.of({
        'Language' => language,
        'TaggedText' => tagged_text,
        'SourceChannel' => source_channel,
    })

    payload = @version.update('POST', @uri, data: data)
    SampleInstance.new(
        @version,
        payload,
        assistant_sid: @solution[:assistant_sid],
        task_sid: @solution[:task_sid],
        sid: @solution[:sid],
    )
end