twilio.rest.autopilot.v1.assistant package

Submodules

twilio.rest.autopilot.v1.assistant.defaults module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/autopilot/v1/assistant/defaults.py:docstring of twilio.rest.autopilot.v1.assistant.defaults, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.autopilot.v1.assistant.defaults.DefaultsContext(version, assistant_sid)[source]

Bases: twilio.base.instance_context.InstanceContext

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 help@twilio.com.

fetch()[source]

Fetch the DefaultsInstance

Returns:The fetched DefaultsInstance
Return type:twilio.rest.autopilot.v1.assistant.defaults.DefaultsInstance
update(defaults=<object object>)[source]

Update the DefaultsInstance

Parameters:defaults (dict) – A JSON string that describes the default task links.
Returns:The updated DefaultsInstance
Return type:twilio.rest.autopilot.v1.assistant.defaults.DefaultsInstance
class twilio.rest.autopilot.v1.assistant.defaults.DefaultsInstance(version, payload, assistant_sid)[source]

Bases: twilio.base.instance_resource.InstanceResource

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 help@twilio.com.

account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
assistant_sid
Returns:The SID of the Assistant that is the parent of the resource
Return type:unicode
data
Returns:The JSON string that describes the default task links
Return type:dict
fetch()[source]

Fetch the DefaultsInstance

Returns:The fetched DefaultsInstance
Return type:twilio.rest.autopilot.v1.assistant.defaults.DefaultsInstance
update(defaults=<object object>)[source]

Update the DefaultsInstance

Parameters:defaults (dict) – A JSON string that describes the default task links.
Returns:The updated DefaultsInstance
Return type:twilio.rest.autopilot.v1.assistant.defaults.DefaultsInstance
url
Returns:The absolute URL of the Defaults resource
Return type:unicode
class twilio.rest.autopilot.v1.assistant.defaults.DefaultsList(version, assistant_sid)[source]

Bases: twilio.base.list_resource.ListResource

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 help@twilio.com.

get()[source]

Constructs a DefaultsContext

Returns:twilio.rest.autopilot.v1.assistant.defaults.DefaultsContext
Return type:twilio.rest.autopilot.v1.assistant.defaults.DefaultsContext
class twilio.rest.autopilot.v1.assistant.defaults.DefaultsPage(version, response, solution)[source]

Bases: twilio.base.page.Page

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 help@twilio.com.

get_instance(payload)[source]

Build an instance of DefaultsInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.autopilot.v1.assistant.defaults.DefaultsInstance
Return type:twilio.rest.autopilot.v1.assistant.defaults.DefaultsInstance

twilio.rest.autopilot.v1.assistant.dialogue module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/autopilot/v1/assistant/dialogue.py:docstring of twilio.rest.autopilot.v1.assistant.dialogue, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.autopilot.v1.assistant.dialogue.DialogueContext(version, assistant_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

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 help@twilio.com.

fetch()[source]

Fetch the DialogueInstance

Returns:The fetched DialogueInstance
Return type:twilio.rest.autopilot.v1.assistant.dialogue.DialogueInstance
class twilio.rest.autopilot.v1.assistant.dialogue.DialogueInstance(version, payload, assistant_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

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 help@twilio.com.

account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
assistant_sid
Returns:The SID of the Assistant that is the parent of the resource
Return type:unicode
data
Returns:The JSON string that describes the dialogue session object
Return type:dict
fetch()[source]

Fetch the DialogueInstance

Returns:The fetched DialogueInstance
Return type:twilio.rest.autopilot.v1.assistant.dialogue.DialogueInstance
sid
Returns:The unique string that identifies the resource
Return type:unicode
url
Returns:The absolute URL of the Dialogue resource
Return type:unicode
class twilio.rest.autopilot.v1.assistant.dialogue.DialogueList(version, assistant_sid)[source]

Bases: twilio.base.list_resource.ListResource

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 help@twilio.com.

get(sid)[source]

Constructs a DialogueContext

Parameters:sid – The unique string that identifies the resource
Returns:twilio.rest.autopilot.v1.assistant.dialogue.DialogueContext
Return type:twilio.rest.autopilot.v1.assistant.dialogue.DialogueContext
class twilio.rest.autopilot.v1.assistant.dialogue.DialoguePage(version, response, solution)[source]

Bases: twilio.base.page.Page

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 help@twilio.com.

get_instance(payload)[source]

Build an instance of DialogueInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.autopilot.v1.assistant.dialogue.DialogueInstance
Return type:twilio.rest.autopilot.v1.assistant.dialogue.DialogueInstance

twilio.rest.autopilot.v1.assistant.model_build module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/autopilot/v1/assistant/model_build.py:docstring of twilio.rest.autopilot.v1.assistant.model_build, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.autopilot.v1.assistant.model_build.ModelBuildContext(version, assistant_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

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 help@twilio.com.

delete()[source]

Deletes the ModelBuildInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the ModelBuildInstance

Returns:The fetched ModelBuildInstance
Return type:twilio.rest.autopilot.v1.assistant.model_build.ModelBuildInstance
update(unique_name=<object object>)[source]

Update the ModelBuildInstance

Parameters:unique_name (unicode) – An application-defined string that uniquely identifies the resource
Returns:The updated ModelBuildInstance
Return type:twilio.rest.autopilot.v1.assistant.model_build.ModelBuildInstance
class twilio.rest.autopilot.v1.assistant.model_build.ModelBuildInstance(version, payload, assistant_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

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 help@twilio.com.

class Status[source]

Bases: object

BUILDING = 'building'
CANCELED = 'canceled'
COMPLETED = 'completed'
ENQUEUED = 'enqueued'
FAILED = 'failed'
account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
assistant_sid
Returns:The SID of the Assistant that is the parent of the resource
Return type:unicode
build_duration
Returns:The time in seconds it took to build the model
Return type:unicode
date_created
Returns:The RFC 2822 date and time in GMT when the resource was created
Return type:datetime
date_updated
Returns:The RFC 2822 date and time in GMT when the resource was last updated
Return type:datetime
delete()[source]

Deletes the ModelBuildInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
error_code
Returns:More information about why the model build failed, if status is failed
Return type:unicode
fetch()[source]

Fetch the ModelBuildInstance

Returns:The fetched ModelBuildInstance
Return type:twilio.rest.autopilot.v1.assistant.model_build.ModelBuildInstance
sid
Returns:The unique string that identifies the resource
Return type:unicode
status
Returns:The status of the model build process
Return type:ModelBuildInstance.Status
unique_name
Returns:An application-defined string that uniquely identifies the resource
Return type:unicode
update(unique_name=<object object>)[source]

Update the ModelBuildInstance

Parameters:unique_name (unicode) – An application-defined string that uniquely identifies the resource
Returns:The updated ModelBuildInstance
Return type:twilio.rest.autopilot.v1.assistant.model_build.ModelBuildInstance
url
Returns:The absolute URL of the ModelBuild resource
Return type:unicode
class twilio.rest.autopilot.v1.assistant.model_build.ModelBuildList(version, assistant_sid)[source]

Bases: twilio.base.list_resource.ListResource

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 help@twilio.com.

create(status_callback=<object object>, unique_name=<object object>)[source]

Create the ModelBuildInstance

Parameters:
  • status_callback (unicode) – The URL we should call using a POST method to send status information to your application
  • unique_name (unicode) – An application-defined string that uniquely identifies the new resource
Returns:

The created ModelBuildInstance

Return type:

twilio.rest.autopilot.v1.assistant.model_build.ModelBuildInstance

get(sid)[source]

Constructs a ModelBuildContext

Parameters:sid – The unique string that identifies the resource
Returns:twilio.rest.autopilot.v1.assistant.model_build.ModelBuildContext
Return type:twilio.rest.autopilot.v1.assistant.model_build.ModelBuildContext
get_page(target_url)[source]

Retrieve a specific page of ModelBuildInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of ModelBuildInstance
Return type:twilio.rest.autopilot.v1.assistant.model_build.ModelBuildPage
list(limit=None, page_size=None)[source]

Lists ModelBuildInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
  • page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.autopilot.v1.assistant.model_build.ModelBuildInstance]

page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

Retrieve a single page of ModelBuildInstance records from the API. Request is executed immediately

Parameters:
  • page_token (str) – PageToken provided by the API
  • page_number (int) – Page Number, this value is simply for client state
  • page_size (int) – Number of records to return, defaults to 50
Returns:

Page of ModelBuildInstance

Return type:

twilio.rest.autopilot.v1.assistant.model_build.ModelBuildPage

stream(limit=None, page_size=None)[source]

Streams ModelBuildInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.

Parameters:
  • limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
  • page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.autopilot.v1.assistant.model_build.ModelBuildInstance]

class twilio.rest.autopilot.v1.assistant.model_build.ModelBuildPage(version, response, solution)[source]

Bases: twilio.base.page.Page

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 help@twilio.com.

get_instance(payload)[source]

Build an instance of ModelBuildInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.autopilot.v1.assistant.model_build.ModelBuildInstance
Return type:twilio.rest.autopilot.v1.assistant.model_build.ModelBuildInstance

twilio.rest.autopilot.v1.assistant.query module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/autopilot/v1/assistant/query.py:docstring of twilio.rest.autopilot.v1.assistant.query, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.autopilot.v1.assistant.query.QueryContext(version, assistant_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

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 help@twilio.com.

delete()[source]

Deletes the QueryInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the QueryInstance

Returns:The fetched QueryInstance
Return type:twilio.rest.autopilot.v1.assistant.query.QueryInstance
update(sample_sid=<object object>, status=<object object>)[source]

Update the QueryInstance

Parameters:
  • sample_sid (unicode) – The SID of an optional reference to the Sample created from the query
  • status (unicode) – The new status of the resource
Returns:

The updated QueryInstance

Return type:

twilio.rest.autopilot.v1.assistant.query.QueryInstance

class twilio.rest.autopilot.v1.assistant.query.QueryInstance(version, payload, assistant_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

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 help@twilio.com.

account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
assistant_sid
Returns:The SID of the Assistant that is the parent of the resource
Return type:unicode
date_created
Returns:The RFC 2822 date and time in GMT when the resource was created
Return type:datetime
date_updated
Returns:The RFC 2822 date and time in GMT when the resource was last updated
Return type:datetime
delete()[source]

Deletes the QueryInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
dialogue_sid
Returns:The SID of the Dialogue.
Return type:unicode
fetch()[source]

Fetch the QueryInstance

Returns:The fetched QueryInstance
Return type:twilio.rest.autopilot.v1.assistant.query.QueryInstance
language
Returns:The ISO language-country string that specifies the language used by the Query
Return type:unicode
model_build_sid
Returns:The SID of the Model Build queried
Return type:unicode
query
Returns:The end-user’s natural language input
Return type:unicode
results
Returns:The natural language analysis results that include the Task recognized and a list of identified Fields
Return type:dict
sample_sid
Returns:The SID of an optional reference to the Sample created from the query
Return type:unicode
sid
Returns:The unique string that identifies the resource
Return type:unicode
source_channel
Returns:The communication channel from where the end-user input came
Return type:unicode
status
Returns:The status of the Query
Return type:unicode
update(sample_sid=<object object>, status=<object object>)[source]

Update the QueryInstance

Parameters:
  • sample_sid (unicode) – The SID of an optional reference to the Sample created from the query
  • status (unicode) – The new status of the resource
Returns:

The updated QueryInstance

Return type:

twilio.rest.autopilot.v1.assistant.query.QueryInstance

url
Returns:The absolute URL of the Query resource
Return type:unicode
class twilio.rest.autopilot.v1.assistant.query.QueryList(version, assistant_sid)[source]

Bases: twilio.base.list_resource.ListResource

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 help@twilio.com.

create(language, query, tasks=<object object>, model_build=<object object>)[source]

Create the QueryInstance

Parameters:
  • language (unicode) – The ISO language-country string that specifies the language used for the new query
  • query (unicode) – The end-user’s natural language input
  • tasks (unicode) – The list of tasks to limit the new query to
  • model_build (unicode) – The SID or unique name of the Model Build to be queried
Returns:

The created QueryInstance

Return type:

twilio.rest.autopilot.v1.assistant.query.QueryInstance

get(sid)[source]

Constructs a QueryContext

Parameters:sid – The unique string that identifies the resource
Returns:twilio.rest.autopilot.v1.assistant.query.QueryContext
Return type:twilio.rest.autopilot.v1.assistant.query.QueryContext
get_page(target_url)[source]

Retrieve a specific page of QueryInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of QueryInstance
Return type:twilio.rest.autopilot.v1.assistant.query.QueryPage
list(language=<object object>, model_build=<object object>, status=<object object>, dialogue_sid=<object object>, limit=None, page_size=None)[source]

Lists QueryInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • language (unicode) – The ISO language-country string that specifies the language used by the Query resources to read
  • model_build (unicode) – The SID or unique name of the Model Build to be queried
  • status (unicode) – The status of the resources to read
  • dialogue_sid (unicode) –

    The SID of the Dialogue.

  • limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
  • page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.autopilot.v1.assistant.query.QueryInstance]

page(language=<object object>, model_build=<object object>, status=<object object>, dialogue_sid=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

Retrieve a single page of QueryInstance records from the API. Request is executed immediately

Parameters:
  • language (unicode) – The ISO language-country string that specifies the language used by the Query resources to read
  • model_build (unicode) – The SID or unique name of the Model Build to be queried
  • status (unicode) – The status of the resources to read
  • dialogue_sid (unicode) –

    The SID of the Dialogue.

  • page_token (str) – PageToken provided by the API
  • page_number (int) – Page Number, this value is simply for client state
  • page_size (int) – Number of records to return, defaults to 50
Returns:

Page of QueryInstance

Return type:

twilio.rest.autopilot.v1.assistant.query.QueryPage

stream(language=<object object>, model_build=<object object>, status=<object object>, dialogue_sid=<object object>, limit=None, page_size=None)[source]

Streams QueryInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.

Parameters:
  • language (unicode) – The ISO language-country string that specifies the language used by the Query resources to read
  • model_build (unicode) – The SID or unique name of the Model Build to be queried
  • status (unicode) – The status of the resources to read
  • dialogue_sid (unicode) –

    The SID of the Dialogue.

  • limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
  • page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.autopilot.v1.assistant.query.QueryInstance]

class twilio.rest.autopilot.v1.assistant.query.QueryPage(version, response, solution)[source]

Bases: twilio.base.page.Page

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 help@twilio.com.

get_instance(payload)[source]

Build an instance of QueryInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.autopilot.v1.assistant.query.QueryInstance
Return type:twilio.rest.autopilot.v1.assistant.query.QueryInstance

twilio.rest.autopilot.v1.assistant.style_sheet module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/autopilot/v1/assistant/style_sheet.py:docstring of twilio.rest.autopilot.v1.assistant.style_sheet, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.autopilot.v1.assistant.style_sheet.StyleSheetContext(version, assistant_sid)[source]

Bases: twilio.base.instance_context.InstanceContext

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 help@twilio.com.

fetch()[source]

Fetch the StyleSheetInstance

Returns:The fetched StyleSheetInstance
Return type:twilio.rest.autopilot.v1.assistant.style_sheet.StyleSheetInstance
update(style_sheet=<object object>)[source]

Update the StyleSheetInstance

Parameters:style_sheet (dict) – The JSON string that describes the style sheet object
Returns:The updated StyleSheetInstance
Return type:twilio.rest.autopilot.v1.assistant.style_sheet.StyleSheetInstance
class twilio.rest.autopilot.v1.assistant.style_sheet.StyleSheetInstance(version, payload, assistant_sid)[source]

Bases: twilio.base.instance_resource.InstanceResource

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 help@twilio.com.

account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
assistant_sid
Returns:The SID of the Assistant that is the parent of the resource
Return type:unicode
data
Returns:The JSON string that describes the style sheet object
Return type:dict
fetch()[source]

Fetch the StyleSheetInstance

Returns:The fetched StyleSheetInstance
Return type:twilio.rest.autopilot.v1.assistant.style_sheet.StyleSheetInstance
update(style_sheet=<object object>)[source]

Update the StyleSheetInstance

Parameters:style_sheet (dict) – The JSON string that describes the style sheet object
Returns:The updated StyleSheetInstance
Return type:twilio.rest.autopilot.v1.assistant.style_sheet.StyleSheetInstance
url
Returns:The absolute URL of the StyleSheet resource
Return type:unicode
class twilio.rest.autopilot.v1.assistant.style_sheet.StyleSheetList(version, assistant_sid)[source]

Bases: twilio.base.list_resource.ListResource

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 help@twilio.com.

get()[source]

Constructs a StyleSheetContext

Returns:twilio.rest.autopilot.v1.assistant.style_sheet.StyleSheetContext
Return type:twilio.rest.autopilot.v1.assistant.style_sheet.StyleSheetContext
class twilio.rest.autopilot.v1.assistant.style_sheet.StyleSheetPage(version, response, solution)[source]

Bases: twilio.base.page.Page

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 help@twilio.com.

get_instance(payload)[source]

Build an instance of StyleSheetInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.autopilot.v1.assistant.style_sheet.StyleSheetInstance
Return type:twilio.rest.autopilot.v1.assistant.style_sheet.StyleSheetInstance

twilio.rest.autopilot.v1.assistant.webhook module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/autopilot/v1/assistant/webhook.py:docstring of twilio.rest.autopilot.v1.assistant.webhook, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.autopilot.v1.assistant.webhook.WebhookContext(version, assistant_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

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 help@twilio.com.

delete()[source]

Deletes the WebhookInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the WebhookInstance

Returns:The fetched WebhookInstance
Return type:twilio.rest.autopilot.v1.assistant.webhook.WebhookInstance
update(unique_name=<object object>, events=<object object>, webhook_url=<object object>, webhook_method=<object object>)[source]

Update the WebhookInstance

Parameters:
  • unique_name (unicode) – An application-defined string that uniquely identifies the resource
  • events (unicode) – The list of space-separated events that this Webhook will subscribe to.
  • webhook_url (unicode) – The URL associated with this Webhook.
  • webhook_method (unicode) – The method to be used when calling the webhook’s URL.
Returns:

The updated WebhookInstance

Return type:

twilio.rest.autopilot.v1.assistant.webhook.WebhookInstance

class twilio.rest.autopilot.v1.assistant.webhook.WebhookInstance(version, payload, assistant_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

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 help@twilio.com.

account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
assistant_sid
Returns:The SID of the Assistant that is the parent of the resource
Return type:unicode
date_created
Returns:The RFC 2822 date and time in GMT when the resource was created
Return type:datetime
date_updated
Returns:The RFC 2822 date and time in GMT when the resource was last updated
Return type:datetime
delete()[source]

Deletes the WebhookInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
events
Returns:The list of space-separated events that this Webhook is subscribed to.
Return type:unicode
fetch()[source]

Fetch the WebhookInstance

Returns:The fetched WebhookInstance
Return type:twilio.rest.autopilot.v1.assistant.webhook.WebhookInstance
sid
Returns:The unique string that identifies the resource
Return type:unicode
unique_name
Returns:An application-defined string that uniquely identifies the resource
Return type:unicode
update(unique_name=<object object>, events=<object object>, webhook_url=<object object>, webhook_method=<object object>)[source]

Update the WebhookInstance

Parameters:
  • unique_name (unicode) – An application-defined string that uniquely identifies the resource
  • events (unicode) – The list of space-separated events that this Webhook will subscribe to.
  • webhook_url (unicode) – The URL associated with this Webhook.
  • webhook_method (unicode) – The method to be used when calling the webhook’s URL.
Returns:

The updated WebhookInstance

Return type:

twilio.rest.autopilot.v1.assistant.webhook.WebhookInstance

url
Returns:The absolute URL of the Webhook resource
Return type:unicode
webhook_method
Returns:The method used when calling the webhook’s URL.
Return type:unicode
webhook_url
Returns:The URL associated with this Webhook.
Return type:unicode
class twilio.rest.autopilot.v1.assistant.webhook.WebhookList(version, assistant_sid)[source]

Bases: twilio.base.list_resource.ListResource

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 help@twilio.com.

create(unique_name, events, webhook_url, webhook_method=<object object>)[source]

Create the WebhookInstance

Parameters:
  • unique_name (unicode) – An application-defined string that uniquely identifies the resource
  • events (unicode) – The list of space-separated events that this Webhook will subscribe to.
  • webhook_url (unicode) – The URL associated with this Webhook.
  • webhook_method (unicode) – The method to be used when calling the webhook’s URL.
Returns:

The created WebhookInstance

Return type:

twilio.rest.autopilot.v1.assistant.webhook.WebhookInstance

get(sid)[source]

Constructs a WebhookContext

Parameters:sid – The unique string that identifies the resource to fetch
Returns:twilio.rest.autopilot.v1.assistant.webhook.WebhookContext
Return type:twilio.rest.autopilot.v1.assistant.webhook.WebhookContext
get_page(target_url)[source]

Retrieve a specific page of WebhookInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of WebhookInstance
Return type:twilio.rest.autopilot.v1.assistant.webhook.WebhookPage
list(limit=None, page_size=None)[source]

Lists WebhookInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
  • page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.autopilot.v1.assistant.webhook.WebhookInstance]

page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

Retrieve a single page of WebhookInstance records from the API. Request is executed immediately

Parameters:
  • page_token (str) – PageToken provided by the API
  • page_number (int) – Page Number, this value is simply for client state
  • page_size (int) – Number of records to return, defaults to 50
Returns:

Page of WebhookInstance

Return type:

twilio.rest.autopilot.v1.assistant.webhook.WebhookPage

stream(limit=None, page_size=None)[source]

Streams WebhookInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.

Parameters:
  • limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
  • page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.autopilot.v1.assistant.webhook.WebhookInstance]

class twilio.rest.autopilot.v1.assistant.webhook.WebhookPage(version, response, solution)[source]

Bases: twilio.base.page.Page

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 help@twilio.com.

get_instance(payload)[source]

Build an instance of WebhookInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.autopilot.v1.assistant.webhook.WebhookInstance
Return type:twilio.rest.autopilot.v1.assistant.webhook.WebhookInstance

Module contents

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/autopilot/v1/assistant/__init__.py:docstring of twilio.rest.autopilot.v1.assistant, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.autopilot.v1.assistant.AssistantContext(version, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

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 help@twilio.com.

defaults

Access the defaults

Returns:twilio.rest.autopilot.v1.assistant.defaults.DefaultsList
Return type:twilio.rest.autopilot.v1.assistant.defaults.DefaultsList
delete()[source]

Deletes the AssistantInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
dialogues

Access the dialogues

Returns:twilio.rest.autopilot.v1.assistant.dialogue.DialogueList
Return type:twilio.rest.autopilot.v1.assistant.dialogue.DialogueList
fetch()[source]

Fetch the AssistantInstance

Returns:The fetched AssistantInstance
Return type:twilio.rest.autopilot.v1.assistant.AssistantInstance
field_types

Access the field_types

Returns:twilio.rest.autopilot.v1.assistant.field_type.FieldTypeList
Return type:twilio.rest.autopilot.v1.assistant.field_type.FieldTypeList
model_builds

Access the model_builds

Returns:twilio.rest.autopilot.v1.assistant.model_build.ModelBuildList
Return type:twilio.rest.autopilot.v1.assistant.model_build.ModelBuildList
queries

Access the queries

Returns:twilio.rest.autopilot.v1.assistant.query.QueryList
Return type:twilio.rest.autopilot.v1.assistant.query.QueryList
style_sheet

Access the style_sheet

Returns:twilio.rest.autopilot.v1.assistant.style_sheet.StyleSheetList
Return type:twilio.rest.autopilot.v1.assistant.style_sheet.StyleSheetList
tasks

Access the tasks

Returns:twilio.rest.autopilot.v1.assistant.task.TaskList
Return type:twilio.rest.autopilot.v1.assistant.task.TaskList
update(friendly_name=<object object>, log_queries=<object object>, unique_name=<object object>, callback_url=<object object>, callback_events=<object object>, style_sheet=<object object>, defaults=<object object>, development_stage=<object object>)[source]

Update the AssistantInstance

Parameters:
  • friendly_name (unicode) – A string to describe the resource
  • log_queries (bool) – Whether queries should be logged and kept after training
  • unique_name (unicode) – An application-defined string that uniquely identifies the resource
  • callback_url (unicode) – Reserved
  • callback_events (unicode) – Reserved
  • style_sheet (dict) – A JSON string that defines the Assistant’s style sheet
  • defaults (dict) – A JSON object that defines the Assistant’s default tasks for various scenarios
  • development_stage (unicode) – A string describing the state of the assistant.
Returns:

The updated AssistantInstance

Return type:

twilio.rest.autopilot.v1.assistant.AssistantInstance

webhooks

Access the webhooks

Returns:twilio.rest.autopilot.v1.assistant.webhook.WebhookList
Return type:twilio.rest.autopilot.v1.assistant.webhook.WebhookList
class twilio.rest.autopilot.v1.assistant.AssistantInstance(version, payload, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

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 help@twilio.com.

account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
callback_events
Returns:Reserved
Return type:unicode
callback_url
Returns:Reserved
Return type:unicode
date_created
Returns:The RFC 2822 date and time in GMT when the resource was created
Return type:datetime
date_updated
Returns:The RFC 2822 date and time in GMT when the resource was last updated
Return type:datetime
defaults

Access the defaults

Returns:twilio.rest.autopilot.v1.assistant.defaults.DefaultsList
Return type:twilio.rest.autopilot.v1.assistant.defaults.DefaultsList
delete()[source]

Deletes the AssistantInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
development_stage
Returns:A string describing the state of the assistant.
Return type:unicode
dialogues

Access the dialogues

Returns:twilio.rest.autopilot.v1.assistant.dialogue.DialogueList
Return type:twilio.rest.autopilot.v1.assistant.dialogue.DialogueList
fetch()[source]

Fetch the AssistantInstance

Returns:The fetched AssistantInstance
Return type:twilio.rest.autopilot.v1.assistant.AssistantInstance
field_types

Access the field_types

Returns:twilio.rest.autopilot.v1.assistant.field_type.FieldTypeList
Return type:twilio.rest.autopilot.v1.assistant.field_type.FieldTypeList
friendly_name
Returns:The string that you assigned to describe the resource
Return type:unicode
latest_model_build_sid
Returns:Reserved
Return type:unicode
Returns:A list of the URLs of the Assistant’s related resources
Return type:unicode
log_queries
Returns:Whether queries should be logged and kept after training
Return type:bool
model_builds

Access the model_builds

Returns:twilio.rest.autopilot.v1.assistant.model_build.ModelBuildList
Return type:twilio.rest.autopilot.v1.assistant.model_build.ModelBuildList
needs_model_build
Returns:Whether model needs to be rebuilt
Return type:bool
queries

Access the queries

Returns:twilio.rest.autopilot.v1.assistant.query.QueryList
Return type:twilio.rest.autopilot.v1.assistant.query.QueryList
sid
Returns:The unique string that identifies the resource
Return type:unicode
style_sheet

Access the style_sheet

Returns:twilio.rest.autopilot.v1.assistant.style_sheet.StyleSheetList
Return type:twilio.rest.autopilot.v1.assistant.style_sheet.StyleSheetList
tasks

Access the tasks

Returns:twilio.rest.autopilot.v1.assistant.task.TaskList
Return type:twilio.rest.autopilot.v1.assistant.task.TaskList
unique_name
Returns:An application-defined string that uniquely identifies the resource
Return type:unicode
update(friendly_name=<object object>, log_queries=<object object>, unique_name=<object object>, callback_url=<object object>, callback_events=<object object>, style_sheet=<object object>, defaults=<object object>, development_stage=<object object>)[source]

Update the AssistantInstance

Parameters:
  • friendly_name (unicode) – A string to describe the resource
  • log_queries (bool) – Whether queries should be logged and kept after training
  • unique_name (unicode) – An application-defined string that uniquely identifies the resource
  • callback_url (unicode) – Reserved
  • callback_events (unicode) – Reserved
  • style_sheet (dict) – A JSON string that defines the Assistant’s style sheet
  • defaults (dict) –

    A JSON object that defines the Assistant’s default tasks for various scenarios

  • development_stage (unicode) – A string describing the state of the assistant.
Returns:

The updated AssistantInstance

Return type:

twilio.rest.autopilot.v1.assistant.AssistantInstance

url
Returns:The absolute URL of the Assistant resource
Return type:unicode
webhooks

Access the webhooks

Returns:twilio.rest.autopilot.v1.assistant.webhook.WebhookList
Return type:twilio.rest.autopilot.v1.assistant.webhook.WebhookList
class twilio.rest.autopilot.v1.assistant.AssistantList(version)[source]

Bases: twilio.base.list_resource.ListResource

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 help@twilio.com.

create(friendly_name=<object object>, log_queries=<object object>, unique_name=<object object>, callback_url=<object object>, callback_events=<object object>, style_sheet=<object object>, defaults=<object object>)[source]

Create the AssistantInstance

Parameters:
  • friendly_name (unicode) – A string to describe the new resource
  • log_queries (bool) – Whether queries should be logged and kept after training
  • unique_name (unicode) – An application-defined string that uniquely identifies the new resource
  • callback_url (unicode) – Reserved
  • callback_events (unicode) – Reserved
  • style_sheet (dict) – A JSON string that defines the Assistant’s style sheet
  • defaults (dict) – A JSON object that defines the Assistant’s default tasks for various scenarios
Returns:

The created AssistantInstance

Return type:

twilio.rest.autopilot.v1.assistant.AssistantInstance

get(sid)[source]

Constructs a AssistantContext

Parameters:sid – The unique string that identifies the resource
Returns:twilio.rest.autopilot.v1.assistant.AssistantContext
Return type:twilio.rest.autopilot.v1.assistant.AssistantContext
get_page(target_url)[source]

Retrieve a specific page of AssistantInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of AssistantInstance
Return type:twilio.rest.autopilot.v1.assistant.AssistantPage
list(limit=None, page_size=None)[source]

Lists AssistantInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
  • page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.autopilot.v1.assistant.AssistantInstance]

page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

Retrieve a single page of AssistantInstance records from the API. Request is executed immediately

Parameters:
  • page_token (str) – PageToken provided by the API
  • page_number (int) – Page Number, this value is simply for client state
  • page_size (int) – Number of records to return, defaults to 50
Returns:

Page of AssistantInstance

Return type:

twilio.rest.autopilot.v1.assistant.AssistantPage

stream(limit=None, page_size=None)[source]

Streams AssistantInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.

Parameters:
  • limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
  • page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.autopilot.v1.assistant.AssistantInstance]

class twilio.rest.autopilot.v1.assistant.AssistantPage(version, response, solution)[source]

Bases: twilio.base.page.Page

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 help@twilio.com.

get_instance(payload)[source]

Build an instance of AssistantInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.autopilot.v1.assistant.AssistantInstance
Return type:twilio.rest.autopilot.v1.assistant.AssistantInstance