As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Playbooks

class google.cloud.dialogflowcx_v3beta1.services.playbooks.PlaybooksAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.dialogflowcx_v3beta1.services.playbooks.transports.base.PlaybooksTransport, typing.Callable[[...], google.cloud.dialogflowcx_v3beta1.services.playbooks.transports.base.PlaybooksTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

Service for managing [Playbooks][google.cloud.dialogflow.cx.v3beta1.Playbook].

Instantiates the playbooks async client.

Parameters

  • credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

  • transport (Optional[Union[str,PlaybooksTransport,Callable[..., PlaybooksTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the PlaybooksTransport constructor. If set to None, a transport is chosen automatically.

  • client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –

    Custom options for the client.

    1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

    2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

    3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

  • 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.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

property api_endpoint

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

async cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters

  • request (CancelOperationRequest) – The request object. Request message for CancelOperation method.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

None

static common_billing_account_path(billing_account: str) → str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str

Returns a fully-qualified location string.

static common_organization_path(organization: str) → str

Returns a fully-qualified organization string.

static common_project_path(project: str) → str

Returns a fully-qualified project string.

async create_playbook(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.playbook.CreatePlaybookRequest, dict]] = None, *, parent: Optional[str] = None, playbook: Optional[google.cloud.dialogflowcx_v3beta1.types.playbook.Playbook] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3beta1.types.playbook.Playbook[source]

Creates a playbook in a specified agent.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

async def sample_create_playbook():
    # Create a client
    client = dialogflowcx_v3beta1.PlaybooksAsyncClient()

    # Initialize request argument(s)
    playbook = dialogflowcx_v3beta1.Playbook()
    playbook.display_name = "display_name_value"
    playbook.goal = "goal_value"

    request = dialogflowcx_v3beta1.CreatePlaybookRequest(
        parent="parent_value",
        playbook=playbook,
    )

    # Make the request
    response = await client.create_playbook(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.dialogflowcx_v3beta1.types.CreatePlaybookRequest, dict]]) – The request object. The request message for [Playbooks.CreatePlaybook][google.cloud.dialogflow.cx.v3beta1.Playbooks.CreatePlaybook].

  • parent (str) –

    Required. The agent to create a playbook for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • playbook (google.cloud.dialogflowcx_v3beta1.types.Playbook) – Required. The playbook to create. This corresponds to the playbook field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Playbook is the basic building block to instruct the LLM how to execute a certain task.

A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.

Return type

google.cloud.dialogflowcx_v3beta1.types.Playbook

async create_playbook_version(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.playbook.CreatePlaybookVersionRequest, dict]] = None, *, parent: Optional[str] = None, playbook_version: Optional[google.cloud.dialogflowcx_v3beta1.types.playbook.PlaybookVersion] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3beta1.types.playbook.PlaybookVersion[source]

Creates a version for the specified Playbook.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

async def sample_create_playbook_version():
    # Create a client
    client = dialogflowcx_v3beta1.PlaybooksAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.CreatePlaybookVersionRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.create_playbook_version(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.dialogflowcx_v3beta1.types.CreatePlaybookVersionRequest, dict]]) – The request object. The request message for [Playbooks.CreatePlaybookVersion][google.cloud.dialogflow.cx.v3beta1.Playbooks.CreatePlaybookVersion].

  • parent (str) –

    Required. The playbook to create a version for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • playbook_version (google.cloud.dialogflowcx_v3beta1.types.PlaybookVersion) –

    Required. The playbook version to create.

    This corresponds to the playbook_version field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Playbook version is a snapshot of the playbook at certain timestamp.

Return type

google.cloud.dialogflowcx_v3beta1.types.PlaybookVersion

async delete_playbook(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.playbook.DeletePlaybookRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]

Deletes a specified playbook.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

async def sample_delete_playbook():
    # Create a client
    client = dialogflowcx_v3beta1.PlaybooksAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.DeletePlaybookRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_playbook(request=request)
Parameters

  • request (Optional[Union[google.cloud.dialogflowcx_v3beta1.types.DeletePlaybookRequest, dict]]) – The request object. The request message for [Playbooks.DeletePlaybook][google.cloud.dialogflow.cx.v3beta1.Playbooks.DeletePlaybook].

  • name (str) –

    Required. The name of the playbook to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

async delete_playbook_version(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.playbook.DeletePlaybookVersionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]

Deletes the specified version of the Playbook.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

async def sample_delete_playbook_version():
    # Create a client
    client = dialogflowcx_v3beta1.PlaybooksAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.DeletePlaybookVersionRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_playbook_version(request=request)
Parameters

  • request (Optional[Union[google.cloud.dialogflowcx_v3beta1.types.DeletePlaybookVersionRequest, dict]]) – The request object. The request message for [Playbooks.DeletePlaybookVersion][google.cloud.dialogflow.cx.v3beta1.Playbooks.DeletePlaybookVersion].

  • name (str) –

    Required. The name of the playbook version to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>.

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

static example_path(project: str, location: str, agent: str, playbook: str, example: str) → str

Returns a fully-qualified example string.

static flow_path(project: str, location: str, agent: str, flow: str) → str

Returns a fully-qualified flow string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters

  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

PlaybooksAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters

  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

PlaybooksAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters

  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

PlaybooksAsyncClient

async get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.Location[source]

Gets information about a location.

Parameters

  • request (GetLocationRequest) – The request object. Request message for GetLocation method.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Location object.

Return type

Location

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]

Gets the latest state of a long-running operation.

Parameters

  • request (GetOperationRequest) – The request object. Request message for GetOperation method.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An Operation object.

Return type

Operation

async get_playbook(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.playbook.GetPlaybookRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3beta1.types.playbook.Playbook[source]

Retrieves the specified Playbook.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

async def sample_get_playbook():
    # Create a client
    client = dialogflowcx_v3beta1.PlaybooksAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.GetPlaybookRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_playbook(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.dialogflowcx_v3beta1.types.GetPlaybookRequest, dict]]) – The request object. The request message for [Playbooks.GetPlaybook][google.cloud.dialogflow.cx.v3beta1.Playbooks.GetPlaybook].

  • name (str) –

    Required. The name of the playbook. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Playbook is the basic building block to instruct the LLM how to execute a certain task.

A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.

Return type

google.cloud.dialogflowcx_v3beta1.types.Playbook

async get_playbook_version(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.playbook.GetPlaybookVersionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3beta1.types.playbook.PlaybookVersion[source]

Retrieves the specified version of the Playbook.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

async def sample_get_playbook_version():
    # Create a client
    client = dialogflowcx_v3beta1.PlaybooksAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.GetPlaybookVersionRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_playbook_version(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.dialogflowcx_v3beta1.types.GetPlaybookVersionRequest, dict]]) – The request object. The request message for [Playbooks.GetPlaybookVersion][google.cloud.dialogflow.cx.v3beta1.Playbooks.GetPlaybookVersion].

  • name (str) –

    Required. The name of the playbook version. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>.

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Playbook version is a snapshot of the playbook at certain timestamp.

Return type

google.cloud.dialogflowcx_v3beta1.types.PlaybookVersion

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.dialogflowcx_v3beta1.services.playbooks.transports.base.PlaybooksTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

async list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.ListLocationsResponse[source]

Lists information about the supported locations for this service.

Parameters

  • request (ListLocationsRequest) – The request object. Request message for ListLocations method.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListLocations method.

Return type

ListLocationsResponse

async list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse[source]

Lists operations that match the specified filter in the request.

Parameters

  • request (ListOperationsRequest) – The request object. Request message for ListOperations method.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListOperations method.

Return type

ListOperationsResponse

async list_playbook_versions(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.playbook.ListPlaybookVersionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3beta1.services.playbooks.pagers.ListPlaybookVersionsAsyncPager[source]

Lists versions for the specified Playbook.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

async def sample_list_playbook_versions():
    # Create a client
    client = dialogflowcx_v3beta1.PlaybooksAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.ListPlaybookVersionsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_playbook_versions(request=request)

    # Handle the response
    async for response in page_result:
        print(response)
Parameters

  • request (Optional[Union[google.cloud.dialogflowcx_v3beta1.types.ListPlaybookVersionsRequest, dict]]) – The request object. The request message for [Playbooks.ListPlaybookVersions][google.cloud.dialogflow.cx.v3beta1.Playbooks.ListPlaybookVersions].

  • parent (str) –

    Required. The playbook to list versions for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response message for

[Playbooks.ListPlaybookVersions][google.cloud.dialogflow.cx.v3beta1.Playbooks.ListPlaybookVersions].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.dialogflowcx_v3beta1.services.playbooks.pagers.ListPlaybookVersionsAsyncPager

async list_playbooks(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.playbook.ListPlaybooksRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3beta1.services.playbooks.pagers.ListPlaybooksAsyncPager[source]

Returns a list of playbooks in the specified agent.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

async def sample_list_playbooks():
    # Create a client
    client = dialogflowcx_v3beta1.PlaybooksAsyncClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.ListPlaybooksRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_playbooks(request=request)

    # Handle the response
    async for response in page_result:
        print(response)
Parameters

  • request (Optional[Union[google.cloud.dialogflowcx_v3beta1.types.ListPlaybooksRequest, dict]]) – The request object. The request message for [Playbooks.ListPlaybooks][google.cloud.dialogflow.cx.v3beta1.Playbooks.ListPlaybooks].

  • parent (str) –

    Required. The agent to list playbooks from. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response message for

[Playbooks.ListPlaybooks][google.cloud.dialogflow.cx.v3beta1.Playbooks.ListPlaybooks].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.dialogflowcx_v3beta1.services.playbooks.pagers.ListPlaybooksAsyncPager

static parse_common_billing_account_path(path: str) → Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]

Parse a project path into its component segments.

static parse_example_path(path: str) → Dict[str, str]

Parses a example path into its component segments.

static parse_flow_path(path: str) → Dict[str, str]

Parses a flow path into its component segments.

static parse_playbook_path(path: str) → Dict[str, str]

Parses a playbook path into its component segments.

static parse_playbook_version_path(path: str) → Dict[str, str]

Parses a playbook_version path into its component segments.

static parse_tool_path(path: str) → Dict[str, str]

Parses a tool path into its component segments.

static playbook_path(project: str, location: str, agent: str, playbook: str) → str

Returns a fully-qualified playbook string.

static playbook_version_path(project: str, location: str, agent: str, playbook: str, version: str) → str

Returns a fully-qualified playbook_version string.

static tool_path(project: str, location: str, agent: str, tool: str) → str

Returns a fully-qualified tool string.

property transport: google.cloud.dialogflowcx_v3beta1.services.playbooks.transports.base.PlaybooksTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

PlaybooksTransport

property universe_domain: str

Return the universe domain used by the client instance.

Returns

The universe domain used

by the client instance.

Return type

str

async update_playbook(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.playbook.UpdatePlaybookRequest, dict]] = None, *, playbook: Optional[google.cloud.dialogflowcx_v3beta1.types.playbook.Playbook] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3beta1.types.playbook.Playbook[source]

Updates the specified Playbook.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

async def sample_update_playbook():
    # Create a client
    client = dialogflowcx_v3beta1.PlaybooksAsyncClient()

    # Initialize request argument(s)
    playbook = dialogflowcx_v3beta1.Playbook()
    playbook.display_name = "display_name_value"
    playbook.goal = "goal_value"

    request = dialogflowcx_v3beta1.UpdatePlaybookRequest(
        playbook=playbook,
    )

    # Make the request
    response = await client.update_playbook(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.dialogflowcx_v3beta1.types.UpdatePlaybookRequest, dict]]) – The request object. The request message for [Playbooks.UpdatePlaybook][google.cloud.dialogflow.cx.v3beta1.Playbooks.UpdatePlaybook].

  • playbook (google.cloud.dialogflowcx_v3beta1.types.Playbook) – Required. The playbook to update. This corresponds to the playbook field on the request instance; if request is provided, this should not be set.

  • update_mask (google.protobuf.field_mask_pb2.FieldMask) –

    The mask to control which fields get updated. If the mask is not present, all fields will be updated.

    This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Playbook is the basic building block to instruct the LLM how to execute a certain task.

A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.

Return type

google.cloud.dialogflowcx_v3beta1.types.Playbook

class google.cloud.dialogflowcx_v3beta1.services.playbooks.PlaybooksClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.dialogflowcx_v3beta1.services.playbooks.transports.base.PlaybooksTransport, typing.Callable[[...], google.cloud.dialogflowcx_v3beta1.services.playbooks.transports.base.PlaybooksTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

Service for managing [Playbooks][google.cloud.dialogflow.cx.v3beta1.Playbook].

Instantiates the playbooks client.

Parameters

  • credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

  • transport (Optional[Union[str,PlaybooksTransport,Callable[..., PlaybooksTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the PlaybooksTransport constructor. If set to None, a transport is chosen automatically.

  • client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –

    Custom options for the client.

    1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

    2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

    3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

  • 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.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]

Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

property api_endpoint

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters

  • request (CancelOperationRequest) – The request object. Request message for CancelOperation method.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

None

static common_billing_account_path(billing_account: str) → str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]

Returns a fully-qualified project string.

create_playbook(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.playbook.CreatePlaybookRequest, dict]] = None, *, parent: Optional[str] = None, playbook: Optional[google.cloud.dialogflowcx_v3beta1.types.playbook.Playbook] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3beta1.types.playbook.Playbook[source]

Creates a playbook in a specified agent.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

def sample_create_playbook():
    # Create a client
    client = dialogflowcx_v3beta1.PlaybooksClient()

    # Initialize request argument(s)
    playbook = dialogflowcx_v3beta1.Playbook()
    playbook.display_name = "display_name_value"
    playbook.goal = "goal_value"

    request = dialogflowcx_v3beta1.CreatePlaybookRequest(
        parent="parent_value",
        playbook=playbook,
    )

    # Make the request
    response = client.create_playbook(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.dialogflowcx_v3beta1.types.CreatePlaybookRequest, dict]) – The request object. The request message for [Playbooks.CreatePlaybook][google.cloud.dialogflow.cx.v3beta1.Playbooks.CreatePlaybook].

  • parent (str) –

    Required. The agent to create a playbook for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • playbook (google.cloud.dialogflowcx_v3beta1.types.Playbook) – Required. The playbook to create. This corresponds to the playbook field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Playbook is the basic building block to instruct the LLM how to execute a certain task.

A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.

Return type

google.cloud.dialogflowcx_v3beta1.types.Playbook

create_playbook_version(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.playbook.CreatePlaybookVersionRequest, dict]] = None, *, parent: Optional[str] = None, playbook_version: Optional[google.cloud.dialogflowcx_v3beta1.types.playbook.PlaybookVersion] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3beta1.types.playbook.PlaybookVersion[source]

Creates a version for the specified Playbook.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

def sample_create_playbook_version():
    # Create a client
    client = dialogflowcx_v3beta1.PlaybooksClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.CreatePlaybookVersionRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_playbook_version(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.dialogflowcx_v3beta1.types.CreatePlaybookVersionRequest, dict]) – The request object. The request message for [Playbooks.CreatePlaybookVersion][google.cloud.dialogflow.cx.v3beta1.Playbooks.CreatePlaybookVersion].

  • parent (str) –

    Required. The playbook to create a version for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • playbook_version (google.cloud.dialogflowcx_v3beta1.types.PlaybookVersion) –

    Required. The playbook version to create.

    This corresponds to the playbook_version field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Playbook version is a snapshot of the playbook at certain timestamp.

Return type

google.cloud.dialogflowcx_v3beta1.types.PlaybookVersion

delete_playbook(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.playbook.DeletePlaybookRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]

Deletes a specified playbook.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

def sample_delete_playbook():
    # Create a client
    client = dialogflowcx_v3beta1.PlaybooksClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.DeletePlaybookRequest(
        name="name_value",
    )

    # Make the request
    client.delete_playbook(request=request)
Parameters

  • request (Union[google.cloud.dialogflowcx_v3beta1.types.DeletePlaybookRequest, dict]) – The request object. The request message for [Playbooks.DeletePlaybook][google.cloud.dialogflow.cx.v3beta1.Playbooks.DeletePlaybook].

  • name (str) –

    Required. The name of the playbook to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

delete_playbook_version(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.playbook.DeletePlaybookVersionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]

Deletes the specified version of the Playbook.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

def sample_delete_playbook_version():
    # Create a client
    client = dialogflowcx_v3beta1.PlaybooksClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.DeletePlaybookVersionRequest(
        name="name_value",
    )

    # Make the request
    client.delete_playbook_version(request=request)
Parameters

  • request (Union[google.cloud.dialogflowcx_v3beta1.types.DeletePlaybookVersionRequest, dict]) – The request object. The request message for [Playbooks.DeletePlaybookVersion][google.cloud.dialogflow.cx.v3beta1.Playbooks.DeletePlaybookVersion].

  • name (str) –

    Required. The name of the playbook version to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>.

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

static example_path(project: str, location: str, agent: str, playbook: str, example: str) → str[source]

Returns a fully-qualified example string.

static flow_path(project: str, location: str, agent: str, flow: str) → str[source]

Returns a fully-qualified flow string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters

  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

PlaybooksClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters

  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

PlaybooksClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters

  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

PlaybooksClient

get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.Location[source]

Gets information about a location.

Parameters

  • request (GetLocationRequest) – The request object. Request message for GetLocation method.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Location object.

Return type

Location

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]

Gets the latest state of a long-running operation.

Parameters

  • request (GetOperationRequest) – The request object. Request message for GetOperation method.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An Operation object.

Return type

Operation

get_playbook(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.playbook.GetPlaybookRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3beta1.types.playbook.Playbook[source]

Retrieves the specified Playbook.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

def sample_get_playbook():
    # Create a client
    client = dialogflowcx_v3beta1.PlaybooksClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.GetPlaybookRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_playbook(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.dialogflowcx_v3beta1.types.GetPlaybookRequest, dict]) – The request object. The request message for [Playbooks.GetPlaybook][google.cloud.dialogflow.cx.v3beta1.Playbooks.GetPlaybook].

  • name (str) –

    Required. The name of the playbook. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Playbook is the basic building block to instruct the LLM how to execute a certain task.

A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.

Return type

google.cloud.dialogflowcx_v3beta1.types.Playbook

get_playbook_version(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.playbook.GetPlaybookVersionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3beta1.types.playbook.PlaybookVersion[source]

Retrieves the specified version of the Playbook.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

def sample_get_playbook_version():
    # Create a client
    client = dialogflowcx_v3beta1.PlaybooksClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.GetPlaybookVersionRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_playbook_version(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.dialogflowcx_v3beta1.types.GetPlaybookVersionRequest, dict]) – The request object. The request message for [Playbooks.GetPlaybookVersion][google.cloud.dialogflow.cx.v3beta1.Playbooks.GetPlaybookVersion].

  • name (str) –

    Required. The name of the playbook version. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/versions/<VersionID>.

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Playbook version is a snapshot of the playbook at certain timestamp.

Return type

google.cloud.dialogflowcx_v3beta1.types.PlaybookVersion

list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.ListLocationsResponse[source]

Lists information about the supported locations for this service.

Parameters

  • request (ListLocationsRequest) – The request object. Request message for ListLocations method.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListLocations method.

Return type

ListLocationsResponse

list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse[source]

Lists operations that match the specified filter in the request.

Parameters

  • request (ListOperationsRequest) – The request object. Request message for ListOperations method.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListOperations method.

Return type

ListOperationsResponse

list_playbook_versions(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.playbook.ListPlaybookVersionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3beta1.services.playbooks.pagers.ListPlaybookVersionsPager[source]

Lists versions for the specified Playbook.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

def sample_list_playbook_versions():
    # Create a client
    client = dialogflowcx_v3beta1.PlaybooksClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.ListPlaybookVersionsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_playbook_versions(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters

  • request (Union[google.cloud.dialogflowcx_v3beta1.types.ListPlaybookVersionsRequest, dict]) – The request object. The request message for [Playbooks.ListPlaybookVersions][google.cloud.dialogflow.cx.v3beta1.Playbooks.ListPlaybookVersions].

  • parent (str) –

    Required. The playbook to list versions for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response message for

[Playbooks.ListPlaybookVersions][google.cloud.dialogflow.cx.v3beta1.Playbooks.ListPlaybookVersions].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.dialogflowcx_v3beta1.services.playbooks.pagers.ListPlaybookVersionsPager

list_playbooks(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.playbook.ListPlaybooksRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3beta1.services.playbooks.pagers.ListPlaybooksPager[source]

Returns a list of playbooks in the specified agent.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

def sample_list_playbooks():
    # Create a client
    client = dialogflowcx_v3beta1.PlaybooksClient()

    # Initialize request argument(s)
    request = dialogflowcx_v3beta1.ListPlaybooksRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_playbooks(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters

  • request (Union[google.cloud.dialogflowcx_v3beta1.types.ListPlaybooksRequest, dict]) – The request object. The request message for [Playbooks.ListPlaybooks][google.cloud.dialogflow.cx.v3beta1.Playbooks.ListPlaybooks].

  • parent (str) –

    Required. The agent to list playbooks from. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response message for

[Playbooks.ListPlaybooks][google.cloud.dialogflow.cx.v3beta1.Playbooks.ListPlaybooks].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.dialogflowcx_v3beta1.services.playbooks.pagers.ListPlaybooksPager

static parse_common_billing_account_path(path: str) → Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]

Parse a project path into its component segments.

static parse_example_path(path: str) → Dict[str, str][source]

Parses a example path into its component segments.

static parse_flow_path(path: str) → Dict[str, str][source]

Parses a flow path into its component segments.

static parse_playbook_path(path: str) → Dict[str, str][source]

Parses a playbook path into its component segments.

static parse_playbook_version_path(path: str) → Dict[str, str][source]

Parses a playbook_version path into its component segments.

static parse_tool_path(path: str) → Dict[str, str][source]

Parses a tool path into its component segments.

static playbook_path(project: str, location: str, agent: str, playbook: str) → str[source]

Returns a fully-qualified playbook string.

static playbook_version_path(project: str, location: str, agent: str, playbook: str, version: str) → str[source]

Returns a fully-qualified playbook_version string.

static tool_path(project: str, location: str, agent: str, tool: str) → str[source]

Returns a fully-qualified tool string.

property transport: google.cloud.dialogflowcx_v3beta1.services.playbooks.transports.base.PlaybooksTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

PlaybooksTransport

property universe_domain: str

Return the universe domain used by the client instance.

Returns

The universe domain used by the client instance.

Return type

str

update_playbook(request: Optional[Union[google.cloud.dialogflowcx_v3beta1.types.playbook.UpdatePlaybookRequest, dict]] = None, *, playbook: Optional[google.cloud.dialogflowcx_v3beta1.types.playbook.Playbook] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.dialogflowcx_v3beta1.types.playbook.Playbook[source]

Updates the specified Playbook.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dialogflowcx_v3beta1

def sample_update_playbook():
    # Create a client
    client = dialogflowcx_v3beta1.PlaybooksClient()

    # Initialize request argument(s)
    playbook = dialogflowcx_v3beta1.Playbook()
    playbook.display_name = "display_name_value"
    playbook.goal = "goal_value"

    request = dialogflowcx_v3beta1.UpdatePlaybookRequest(
        playbook=playbook,
    )

    # Make the request
    response = client.update_playbook(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Union[google.cloud.dialogflowcx_v3beta1.types.UpdatePlaybookRequest, dict]) – The request object. The request message for [Playbooks.UpdatePlaybook][google.cloud.dialogflow.cx.v3beta1.Playbooks.UpdatePlaybook].

  • playbook (google.cloud.dialogflowcx_v3beta1.types.Playbook) – Required. The playbook to update. This corresponds to the playbook field on the request instance; if request is provided, this should not be set.

  • update_mask (google.protobuf.field_mask_pb2.FieldMask) –

    The mask to control which fields get updated. If the mask is not present, all fields will be updated.

    This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Playbook is the basic building block to instruct the LLM how to execute a certain task.

A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.

Return type

google.cloud.dialogflowcx_v3beta1.types.Playbook

class google.cloud.dialogflowcx_v3beta1.services.playbooks.pagers.ListPlaybookVersionsAsyncPager(method: Callable[[...], Awaitable[google.cloud.dialogflowcx_v3beta1.types.playbook.ListPlaybookVersionsResponse]], request: google.cloud.dialogflowcx_v3beta1.types.playbook.ListPlaybookVersionsRequest, response: google.cloud.dialogflowcx_v3beta1.types.playbook.ListPlaybookVersionsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_playbook_versions requests.

This class thinly wraps an initial google.cloud.dialogflowcx_v3beta1.types.ListPlaybookVersionsResponse object, and provides an __aiter__ method to iterate through its playbook_versions field.

If there are more pages, the __aiter__ method will make additional ListPlaybookVersions requests and continue to iterate through the playbook_versions field on the corresponding responses.

All the usual google.cloud.dialogflowcx_v3beta1.types.ListPlaybookVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.dialogflowcx_v3beta1.services.playbooks.pagers.ListPlaybookVersionsPager(method: Callable[[...], google.cloud.dialogflowcx_v3beta1.types.playbook.ListPlaybookVersionsResponse], request: google.cloud.dialogflowcx_v3beta1.types.playbook.ListPlaybookVersionsRequest, response: google.cloud.dialogflowcx_v3beta1.types.playbook.ListPlaybookVersionsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_playbook_versions requests.

This class thinly wraps an initial google.cloud.dialogflowcx_v3beta1.types.ListPlaybookVersionsResponse object, and provides an __iter__ method to iterate through its playbook_versions field.

If there are more pages, the __iter__ method will make additional ListPlaybookVersions requests and continue to iterate through the playbook_versions field on the corresponding responses.

All the usual google.cloud.dialogflowcx_v3beta1.types.ListPlaybookVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.cloud.dialogflowcx_v3beta1.services.playbooks.pagers.ListPlaybooksAsyncPager(method: Callable[[...], Awaitable[google.cloud.dialogflowcx_v3beta1.types.playbook.ListPlaybooksResponse]], request: google.cloud.dialogflowcx_v3beta1.types.playbook.ListPlaybooksRequest, response: google.cloud.dialogflowcx_v3beta1.types.playbook.ListPlaybooksResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_playbooks requests.

This class thinly wraps an initial google.cloud.dialogflowcx_v3beta1.types.ListPlaybooksResponse object, and provides an __aiter__ method to iterate through its playbooks field.

If there are more pages, the __aiter__ method will make additional ListPlaybooks requests and continue to iterate through the playbooks field on the corresponding responses.

All the usual google.cloud.dialogflowcx_v3beta1.types.ListPlaybooksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.dialogflowcx_v3beta1.services.playbooks.pagers.ListPlaybooksPager(method: Callable[[...], google.cloud.dialogflowcx_v3beta1.types.playbook.ListPlaybooksResponse], request: google.cloud.dialogflowcx_v3beta1.types.playbook.ListPlaybooksRequest, response: google.cloud.dialogflowcx_v3beta1.types.playbook.ListPlaybooksResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_playbooks requests.

This class thinly wraps an initial google.cloud.dialogflowcx_v3beta1.types.ListPlaybooksResponse object, and provides an __iter__ method to iterate through its playbooks field.

If there are more pages, the __iter__ method will make additional ListPlaybooks requests and continue to iterate through the playbooks field on the corresponding responses.

All the usual google.cloud.dialogflowcx_v3beta1.types.ListPlaybooksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters