Console
    Contact Us Start free

    Class IntentsClient (1.0.0) 

      IntentsClient 
 ( 
 transport 
 = 
 None 
 , 
 channel 
 = 
 None 
 , 
 credentials 
 = 
 None 
 , 
 client_config 
 = 
 None 
 , 
 client_info 
 = 
 None 
 , 
 client_options 
 = 
 None 
 , 
 )

    An intent represents a mapping between input from a user and an action to be taken by your application. When you pass user input to the DetectIntent (or StreamingDetectIntent ) method, the Dialogflow API analyzes the input and searches for a matching intent. If no match is found, the Dialogflow API returns a fallback intent ( is_fallback = true).

    You can provide additional information for the Dialogflow API to use to match user input to an intent by adding the following to your intent.

    • Contexts- provide additional context for intent analysis. For example, if an intent is related to an object in your application that plays music, you can provide a context to determine when to match the intent if the user input is "turn it off". You can include a context that matches the intent when there is previous user input of "play music", and not when there is previous user input of "turn on the light".

    • Events- allow for matching an intent by using an event name instead of user input. Your application can provide an event name and related parameters to the Dialogflow API to match an intent. For example, when your application starts, you can send a welcome event with a user name parameter to the Dialogflow API to match an intent with a personalized welcome message for the user.

    • Training phrases- provide examples of user input to train the Dialogflow API agent to better match intents.

    For more information about intents, see the Dialogflow documentation <https://cloud.google.com/dialogflow/docs/intents-overview> __.

    Methods

    IntentsClient

      IntentsClient 
 ( 
 transport 
 = 
 None 
 , 
 channel 
 = 
 None 
 , 
 credentials 
 = 
 None 
 , 
 client_config 
 = 
 None 
 , 
 client_info 
 = 
 None 
 , 
 client_options 
 = 
 None 
 , 
 )

    Constructor.

    Parameters
    Name
    Description
    channel
    grpc.Channel

    DEPRECATED. A Channel instance through which to make calls. This argument is mutually exclusive with credentials ; providing both will raise an exception.

    credentials
    google.auth.credentials.Credentials

    The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to transport ; doing so will raise an exception.

    client_config
    dict

    DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is used.

    client_info
    google.api_core.gapic_v1.client_info.ClientInfo

    The client info used to send a user-agent string along with API requests. If None , then default info will be used. Generally, you only need to set this if you're developing your own client library.

    client_options
    Union[dict, google.api_core.client_options.ClientOptions]

    Client options used to set user options on the client. API Endpoint should be set through client_options.

    agent_path

      agent_path 
 ( 
 project 
 , 
 agent 
 )

    Return a fully-qualified agent string.

    batch_delete_intents

      batch_delete_intents 
 ( 
 parent 
 , 
 intents 
 , 
 retry 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 timeout 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 metadata 
 = 
 None 
 )

    Deletes intents in the specified agent.

    Operation <response: google.protobuf.Empty >

    .. rubric:: Example

    import dialogflow_v2

    client = dialogflow_v2.IntentsClient()

    parent = client.project_agent_path('[PROJECT]')

    TODO: Initialize intents :

    intents = []

    response = client.batch_delete_intents(parent, intents)

    def callback(operation_future): ... # Handle result. ... result = operation_future.result()

    response.add_done_callback(callback)

    Handle metadata.

    metadata = response.metadata()

    Parameters
    Name
    Description
    parent
    str

    Required. The name of the agent to delete all entities types for. Format: projects/ .

    intents
    list[Union[dict, Intent ]]

    Required. The collection of intents to delete. Only intent name must be filled in. If a dict is provided, it must be of the same form as the protobuf message Intent

    retry
    Optional[google.api_core.retry.Retry]

    A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

    timeout
    Optional[float]

    The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

    metadata
    Optional[Sequence[Tuple[str, str]]]

    Additional metadata that is provided to the method.

    Exceptions
    Type
    Description
    google.api_core.exceptions.GoogleAPICallError
    If the request failed for any reason.
    google.api_core.exceptions.RetryError
    If the request failed due to a retryable error and retry attempts failed.
    ValueError
    If the parameters are invalid.

    batch_update_intents

      batch_update_intents 
 ( 
 parent 
 , 
 intent_batch_uri 
 = 
 None 
 , 
 intent_batch_inline 
 = 
 None 
 , 
 language_code 
 = 
 None 
 , 
 update_mask 
 = 
 None 
 , 
 intent_view 
 = 
 None 
 , 
 retry 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 timeout 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 metadata 
 = 
 None 
 )

    Updates/Creates multiple intents in the specified agent.

    Operation <response: BatchUpdateIntentsResponse >

    .. rubric:: Example

    import dialogflow_v2

    client = dialogflow_v2.IntentsClient()

    parent = client.project_agent_path('[PROJECT]')

    response = client.batch_update_intents(parent)

    def callback(operation_future): ... # Handle result. ... result = operation_future.result()

    response.add_done_callback(callback)

    Handle metadata.

    metadata = response.metadata()

    Parameters
    Name
    Description
    parent
    str

    Required. The name of the agent to update or create intents in. Format: projects/ .

    intent_batch_uri
    str

    The URI to a Google Cloud Storage file containing intents to update or create. The file format can either be a serialized proto (of IntentBatch type) or JSON object. Note: The URI must start with "gs://".

    intent_batch_inline
    Union[dict, IntentBatch ]

    The collection of intents to update or create. If a dict is provided, it must be of the same form as the protobuf message IntentBatch

    language_code
    str

    Optional. The language of training phrases, parameters and rich messages defined in intents . If not specified, the agent's default language is used. Many languages https://cloud.google.com/dialogflow/docs/reference/language __ are supported. Note: languages must be enabled in the agent before they can be used.

    update_mask
    Union[dict, FieldMask ]

    Optional. The mask to control which fields get updated. If a dict is provided, it must be of the same form as the protobuf message FieldMask

    intent_view
    IntentView

    Optional. The resource view to apply to the returned intent.

    retry
    Optional[google.api_core.retry.Retry]

    A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

    timeout
    Optional[float]

    The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

    metadata
    Optional[Sequence[Tuple[str, str]]]

    Additional metadata that is provided to the method.

    Exceptions
    Type
    Description
    google.api_core.exceptions.GoogleAPICallError
    If the request failed for any reason.
    google.api_core.exceptions.RetryError
    If the request failed due to a retryable error and retry attempts failed.
    ValueError
    If the parameters are invalid.

    create_intent

      create_intent 
 ( 
 parent 
 , 
 intent 
 , 
 language_code 
 = 
 None 
 , 
 intent_view 
 = 
 None 
 , 
 retry 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 timeout 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 metadata 
 = 
 None 
 )

    Creates an intent in the specified agent.

    .. rubric:: Example

    import dialogflow_v2

    client = dialogflow_v2.IntentsClient()

    parent = client.project_agent_path('[PROJECT]')

    TODO: Initialize intent :

    intent = {}

    response = client.create_intent(parent, intent)

    Parameters
    Name
    Description
    parent
    str

    Required. The agent to create a intent for. Format: projects/ .

    intent
    Union[dict, Intent ]

    Required. The intent to create. If a dict is provided, it must be of the same form as the protobuf message Intent

    language_code
    str

    Optional. The language of training phrases, parameters and rich messages defined in intent . If not specified, the agent's default language is used. Many languages https://cloud.google.com/dialogflow/docs/reference/language __ are supported. Note: languages must be enabled in the agent before they can be used.

    intent_view
    Intent View

    Optional. The resource view to apply to the returned intent.

    retry
    Optional[google.api_core.retry.Retry]

    A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

    timeout
    Optional[float]

    The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

    metadata
    Optional[Sequence[Tuple[str, str]]]

    Additional metadata that is provided to the method.

    Exceptions
    Type
    Description
    google.api_core.exceptions.GoogleAPICallError
    If the request failed for any reason.
    google.api_core.exceptions.RetryError
    If the request failed due to a retryable error and retry attempts failed.
    ValueError
    If the parameters are invalid.

    delete_intent

      delete_intent 
 ( 
 name 
 , 
 retry 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 timeout 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 metadata 
 = 
 None 
 )

    Deletes the specified intent and its direct or indirect followup intents.

    .. rubric:: Example

    import dialogflow_v2

    client = dialogflow_v2.IntentsClient()

    name = client.intent_path('[PROJECT]', '[INTENT]')

    client.delete_intent(name)

    Parameters
    Name
    Description
    name
    str

    Required. The name of the intent to delete. If this intent has direct or indirect followup intents, we also delete them. Format: projects/ .

    retry
    Optional[google.api_core.retry.Retry]

    A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

    timeout
    Optional[float]

    The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

    metadata
    Optional[Sequence[Tuple[str, str]]]

    Additional metadata that is provided to the method.

    Exceptions
    Type
    Description
    google.api_core.exceptions.GoogleAPICallError
    If the request failed for any reason.
    google.api_core.exceptions.RetryError
    If the request failed due to a retryable error and retry attempts failed.
    ValueError
    If the parameters are invalid.
      from_service_account_file 
 ( 
 filename 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 )

    Creates an instance of this client using the provided credentials file.

    Parameter
    Name
    Description
    filename
    str

    The path to the service account private key json file.

    Returns
    Type
    Description
    dialogflow_v2.IntentsClient
    The constructed client.
      from_service_account_json 
 ( 
 filename 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 )

    Creates an instance of this client using the provided credentials file.

    Parameter
    Name
    Description
    filename
    str

    The path to the service account private key json file.

    Returns
    Type
    Description
    dialogflow_v2.IntentsClient
    The constructed client.

    get_intent

      get_intent 
 ( 
 name 
 , 
 language_code 
 = 
 None 
 , 
 intent_view 
 = 
 None 
 , 
 retry 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 timeout 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 metadata 
 = 
 None 
 )

    Retrieves the specified intent.

    .. rubric:: Example

    import dialogflow_v2

    client = dialogflow_v2.IntentsClient()

    name = client.intent_path('[PROJECT]', '[INTENT]')

    response = client.get_intent(name)

    Parameters
    Name
    Description
    name
    str

    Required. The name of the intent. Format: projects/ .

    language_code
    str

    Optional. The language to retrieve training phrases, parameters and rich messages for. If not specified, the agent's default language is used. Many languages https://cloud.google.com/dialogflow/docs/reference/language __ are supported. Note: languages must be enabled in the agent before they can be used.

    intent_view
    IntentView

    Optional. The resource view to apply to the returned intent.

    retry
    Optional[google.api_core.retry.Retry]

    A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

    timeout
    Optional[float]

    The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

    metadata
    Optional[Sequence[Tuple[str, str]]]

    Additional metadata that is provided to the method.

    Exceptions
    Type
    Description
    google.api_core.exceptions.GoogleAPICallError
    If the request failed for any reason.
    google.api_core.exceptions.RetryError
    If the request failed due to a retryable error and retry attempts failed.
    ValueError
    If the parameters are invalid.

    intent_path

      intent_path 
 ( 
 project 
 , 
 intent 
 )

    Return a fully-qualified intent string.

    list_intents

      list_intents 
 ( 
 parent 
 , 
 language_code 
 = 
 None 
 , 
 intent_view 
 = 
 None 
 , 
 page_size 
 = 
 None 
 , 
 retry 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 timeout 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 metadata 
 = 
 None 
 )

    Returns the list of all intents in the specified agent.

    .. rubric:: Example

    import dialogflow_v2

    client = dialogflow_v2.IntentsClient()

    parent = client.project_agent_path('[PROJECT]')

    Iterate over all results

    for element in client.list_intents(parent): ... # process element ... pass

    Alternatively:

    Iterate over results one page at a time

    for page in client.list_intents(parent).pages: ... for element in page: ... # process element ... pass

    Parameters
    Name
    Description
    parent
    str

    Required. The agent to list all intents from. Format: projects/ .

    language_code
    str

    Optional. The language to list training phrases, parameters and rich messages for. If not specified, the agent's default language is used. Many languages https://cloud.google.com/dialogflow/docs/reference/language __ are supported. Note: languages must be enabled in the agent before they can be used.

    intent_view
    IntentView

    Optional. The resource view to apply to the returned intent.

    page_size
    int

    The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

    retry
    Optional[google.api_core.retry.Retry]

    A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

    timeout
    Optional[float]

    The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

    metadata
    Optional[Sequence[Tuple[str, str]]]

    Additional metadata that is provided to the method.

    Exceptions
    Type
    Description
    google.api_core.exceptions.GoogleAPICallError
    If the request failed for any reason.
    google.api_core.exceptions.RetryError
    If the request failed due to a retryable error and retry attempts failed.
    ValueError
    If the parameters are invalid.

    project_agent_path

      project_agent_path 
 ( 
 project 
 )

    Return a fully-qualified project_agent string.

    update_intent

      update_intent 
 ( 
 intent 
 , 
 language_code 
 = 
 None 
 , 
 update_mask 
 = 
 None 
 , 
 intent_view 
 = 
 None 
 , 
 retry 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 timeout 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 metadata 
 = 
 None 
 )

    Updates the specified intent.

    .. rubric:: Example

    import dialogflow_v2

    client = dialogflow_v2.IntentsClient()

    TODO: Initialize intent :

    intent = {}

    response = client.update_intent(intent)

    Parameters
    Name
    Description
    intent
    Union[dict, Intent ]

    Required. The intent to update. If a dict is provided, it must be of the same form as the protobuf message Intent

    language_code
    str

    Optional. The language of training phrases, parameters and rich messages defined in intent . If not specified, the agent's default language is used. Many languages https://cloud.google.com/dialogflow/docs/reference/language __ are supported. Note: languages must be enabled in the agent before they can be used.

    update_mask
    Union[dict, FieldMask ]

    Optional. The mask to control which fields get updated. If a dict is provided, it must be of the same form as the protobuf message FieldMask

    intent_view
    Intent View

    Optional. The resource view to apply to the returned intent.

    retry
    Optional[google.api_core.retry.Retry]

    A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

    timeout
    Optional[float]

    The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

    metadata
    Optional[Sequence[Tuple[str, str]]]

    Additional metadata that is provided to the method.

    Exceptions
    Type
    Description
    google.api_core.exceptions.GoogleAPICallError
    If the request failed for any reason.
    google.api_core.exceptions.RetryError
    If the request failed due to a retryable error and retry attempts failed.
    ValueError
    If the parameters are invalid.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: