Class ContextsClient (0.7.2)

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

A context represents additional information included with user input or with an intent returned by the Dialogflow API. Contexts are helpful for differentiating user input which may be vague or have a different meaning depending on additional details from your application such as user setting and preferences, previous user input, where the user is in your application, geographic location, and so on.

You can include contexts as input parameters of a DetectIntent (or StreamingDetectIntent) request, or as output contexts included in the returned intent. Contexts expire when an intent is matched, after the number of DetectIntent requests specified by the lifespan_count parameter, or after 20 minutes if no intents are matched for a DetectIntent request.

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

Methods

ContextsClient

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

Constructor.

Parameters
NameDescription
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.

context_path

context_path(project, session, context)

Return a fully-qualified context string.

create_context

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

Creates a context.

If the specified context already exists, overrides the context.

.. rubric:: Example

import dialogflow_v2beta1

client = dialogflow_v2beta1.ContextsClient()

parent = client.session_path('[PROJECT]', '[SESSION]')

TODO: Initialize context:

context = {}

response = client.create_context(parent, context)

Parameters
NameDescription
parent str

Required. The session to create a context for. Format: projects/ or projects/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

context Union[dict, Context]

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

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
TypeDescription
google.api_core.exceptions.GoogleAPICallErrorIf the request failed for any reason.
google.api_core.exceptions.RetryErrorIf the request failed due to a retryable error and retry attempts failed.
ValueErrorIf the parameters are invalid.

delete_all_contexts

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

Deletes all active contexts in the specified session.

.. rubric:: Example

import dialogflow_v2beta1

client = dialogflow_v2beta1.ContextsClient()

parent = client.session_path('[PROJECT]', '[SESSION]')

client.delete_all_contexts(parent)

Parameters
NameDescription
parent str

Required. The name of the session to delete all contexts from. Format: projects/ or projects/. If Environment ID is not specified we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

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
TypeDescription
google.api_core.exceptions.GoogleAPICallErrorIf the request failed for any reason.
google.api_core.exceptions.RetryErrorIf the request failed due to a retryable error and retry attempts failed.
ValueErrorIf the parameters are invalid.

delete_context

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

Deletes the specified context.

.. rubric:: Example

import dialogflow_v2beta1

client = dialogflow_v2beta1.ContextsClient()

name = client.context_path('[PROJECT]', '[SESSION]', '[CONTEXT]')

client.delete_context(name)

Parameters
NameDescription
name str

Required. The name of the context to delete. Format: projects/ or projects/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

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
TypeDescription
google.api_core.exceptions.GoogleAPICallErrorIf the request failed for any reason.
google.api_core.exceptions.RetryErrorIf the request failed due to a retryable error and retry attempts failed.
ValueErrorIf the parameters are invalid.

environment_context_path

environment_context_path(project, environment, user, session, context)

Return a fully-qualified environment_context string.

environment_session_path

environment_session_path(project, environment, user, session)

Return a fully-qualified environment_session string.

from_service_account_file

from_service_account_file(filename, *args, **kwargs)

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

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
dialogflow_v2beta1.ContextsClientThe constructed client.

from_service_account_json

from_service_account_json(filename, *args, **kwargs)

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

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
dialogflow_v2beta1.ContextsClientThe constructed client.

get_context

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

Retrieves the specified context.

.. rubric:: Example

import dialogflow_v2beta1

client = dialogflow_v2beta1.ContextsClient()

name = client.context_path('[PROJECT]', '[SESSION]', '[CONTEXT]')

response = client.get_context(name)

Parameters
NameDescription
name str

Required. The name of the context. Format: projects/ or projects/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

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
TypeDescription
google.api_core.exceptions.GoogleAPICallErrorIf the request failed for any reason.
google.api_core.exceptions.RetryErrorIf the request failed due to a retryable error and retry attempts failed.
ValueErrorIf the parameters are invalid.

list_contexts

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

Returns the list of all contexts in the specified session.

.. rubric:: Example

import dialogflow_v2beta1

client = dialogflow_v2beta1.ContextsClient()

parent = client.session_path('[PROJECT]', '[SESSION]')

Iterate over all results

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

Alternatively:

Iterate over results one page at a time

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

Parameters
NameDescription
parent str

Required. The session to list all contexts from. Format: projects/ or projects/. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user.

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
TypeDescription
google.api_core.exceptions.GoogleAPICallErrorIf the request failed for any reason.
google.api_core.exceptions.RetryErrorIf the request failed due to a retryable error and retry attempts failed.
ValueErrorIf the parameters are invalid.

session_path

session_path(project, session)

Return a fully-qualified session string.

update_context

update_context(context, update_mask=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Updates the specified context.

.. rubric:: Example

import dialogflow_v2beta1

client = dialogflow_v2beta1.ContextsClient()

TODO: Initialize context:

context = {}

response = client.update_context(context)

Parameters
NameDescription
context Union[dict, Context]

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

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

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
TypeDescription
google.api_core.exceptions.GoogleAPICallErrorIf the request failed for any reason.
google.api_core.exceptions.RetryErrorIf the request failed due to a retryable error and retry attempts failed.
ValueErrorIf the parameters are invalid.