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.

Pages

class google.cloud.dialogflowcx_v3.services.pages.PagesAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dialogflowcx_v3.services.pages.transports.base.PagesTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

Service for managing [Pages][google.cloud.dialogflow.cx.v3.Page].

Instantiates the pages 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 (Union[str, PagesTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “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). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS 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.

Raises

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

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_page(request: Optional[google.cloud.dialogflowcx_v3.types.page.CreatePageRequest] = None, *, parent: Optional[str] = None, page: Optional[google.cloud.dialogflowcx_v3.types.page.Page] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.types.page.Page[source]

Creates a page in the specified flow.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.CreatePageRequest) – The request object. The request message for [Pages.CreatePage][google.cloud.dialogflow.cx.v3.Pages.CreatePage].

  • parent (str) –

    Required. The flow to create a page for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

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

  • page (google.cloud.dialogflowcx_v3.types.Page) – Required. The page to create. This corresponds to the page 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

A Dialogflow CX conversation (session) can be described and visualized as a

state machine. The states of a CX session are represented by pages.

For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page.

You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page.

For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page).

Return type

google.cloud.dialogflowcx_v3.types.Page

async delete_page(request: Optional[google.cloud.dialogflowcx_v3.types.page.DeletePageRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Deletes the specified page.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.DeletePageRequest) – The request object. The request message for [Pages.DeletePage][google.cloud.dialogflow.cx.v3.Pages.DeletePage].

  • name (str) –

    Required. The name of the page to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/Flows/<flow ID>/pages/<Page ID>.

    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 entity_type_path(project: str, location: str, agent: str, entity_type: str)str

Returns a fully-qualified entity_type 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

PagesAsyncClient

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

PagesAsyncClient

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

PagesAsyncClient

async get_page(request: Optional[google.cloud.dialogflowcx_v3.types.page.GetPageRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.types.page.Page[source]

Retrieves the specified page.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.GetPageRequest) – The request object. The request message for [Pages.GetPage][google.cloud.dialogflow.cx.v3.Pages.GetPage].

  • name (str) –

    Required. The name of the page. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

    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

A Dialogflow CX conversation (session) can be described and visualized as a

state machine. The states of a CX session are represented by pages.

For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page.

You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page.

For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page).

Return type

google.cloud.dialogflowcx_v3.types.Page

get_transport_class()Type[google.cloud.dialogflowcx_v3.services.pages.transports.base.PagesTransport]

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.

static intent_path(project: str, location: str, agent: str, intent: str)str

Returns a fully-qualified intent string.

async list_pages(request: Optional[google.cloud.dialogflowcx_v3.types.page.ListPagesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.services.pages.pagers.ListPagesAsyncPager[source]

Returns the list of all pages in the specified flow.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.ListPagesRequest) – The request object. The request message for [Pages.ListPages][google.cloud.dialogflow.cx.v3.Pages.ListPages].

  • parent (str) –

    Required. The flow to list all pages for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

    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 [Pages.ListPages][google.cloud.dialogflow.cx.v3.Pages.ListPages].

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

Return type

google.cloud.dialogflowcx_v3.services.pages.pagers.ListPagesAsyncPager

static page_path(project: str, location: str, agent: str, flow: str, page: str)str

Returns a fully-qualified page string.

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_entity_type_path(path: str)Dict[str, str]

Parses a entity_type path into its component segments.

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

Parses a flow path into its component segments.

static parse_intent_path(path: str)Dict[str, str]

Parses a intent path into its component segments.

static parse_page_path(path: str)Dict[str, str]

Parses a page path into its component segments.

static parse_transition_route_group_path(path: str)Dict[str, str]

Parses a transition_route_group path into its component segments.

static parse_webhook_path(path: str)Dict[str, str]

Parses a webhook path into its component segments.

static transition_route_group_path(project: str, location: str, agent: str, flow: str, transition_route_group: str)str

Returns a fully-qualified transition_route_group string.

property transport: google.cloud.dialogflowcx_v3.services.pages.transports.base.PagesTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

PagesTransport

async update_page(request: Optional[google.cloud.dialogflowcx_v3.types.page.UpdatePageRequest] = None, *, page: Optional[google.cloud.dialogflowcx_v3.types.page.Page] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.types.page.Page[source]

Updates the specified page.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.UpdatePageRequest) – The request object. The request message for [Pages.UpdatePage][google.cloud.dialogflow.cx.v3.Pages.UpdatePage].

  • page (google.cloud.dialogflowcx_v3.types.Page) – Required. The page to update. This corresponds to the page 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

A Dialogflow CX conversation (session) can be described and visualized as a

state machine. The states of a CX session are represented by pages.

For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page.

You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page.

For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page).

Return type

google.cloud.dialogflowcx_v3.types.Page

static webhook_path(project: str, location: str, agent: str, webhook: str)str

Returns a fully-qualified webhook string.

class google.cloud.dialogflowcx_v3.services.pages.PagesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dialogflowcx_v3.services.pages.transports.base.PagesTransport]] = None, client_options: 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 [Pages][google.cloud.dialogflow.cx.v3.Page].

Instantiates the pages 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 (Union[str, PagesTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “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). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS 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.

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

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_page(request: Optional[google.cloud.dialogflowcx_v3.types.page.CreatePageRequest] = None, *, parent: Optional[str] = None, page: Optional[google.cloud.dialogflowcx_v3.types.page.Page] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.types.page.Page[source]

Creates a page in the specified flow.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.CreatePageRequest) – The request object. The request message for [Pages.CreatePage][google.cloud.dialogflow.cx.v3.Pages.CreatePage].

  • parent (str) –

    Required. The flow to create a page for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

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

  • page (google.cloud.dialogflowcx_v3.types.Page) – Required. The page to create. This corresponds to the page 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

A Dialogflow CX conversation (session) can be described and visualized as a

state machine. The states of a CX session are represented by pages.

For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page.

You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page.

For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page).

Return type

google.cloud.dialogflowcx_v3.types.Page

delete_page(request: Optional[google.cloud.dialogflowcx_v3.types.page.DeletePageRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Deletes the specified page.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.DeletePageRequest) – The request object. The request message for [Pages.DeletePage][google.cloud.dialogflow.cx.v3.Pages.DeletePage].

  • name (str) –

    Required. The name of the page to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/Flows/<flow ID>/pages/<Page ID>.

    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 entity_type_path(project: str, location: str, agent: str, entity_type: str)str[source]

Returns a fully-qualified entity_type 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

PagesClient

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

PagesClient

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

PagesClient

get_page(request: Optional[google.cloud.dialogflowcx_v3.types.page.GetPageRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.types.page.Page[source]

Retrieves the specified page.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.GetPageRequest) – The request object. The request message for [Pages.GetPage][google.cloud.dialogflow.cx.v3.Pages.GetPage].

  • name (str) –

    Required. The name of the page. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

    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

A Dialogflow CX conversation (session) can be described and visualized as a

state machine. The states of a CX session are represented by pages.

For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page.

You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page.

For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page).

Return type

google.cloud.dialogflowcx_v3.types.Page

static intent_path(project: str, location: str, agent: str, intent: str)str[source]

Returns a fully-qualified intent string.

list_pages(request: Optional[google.cloud.dialogflowcx_v3.types.page.ListPagesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.services.pages.pagers.ListPagesPager[source]

Returns the list of all pages in the specified flow.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.ListPagesRequest) – The request object. The request message for [Pages.ListPages][google.cloud.dialogflow.cx.v3.Pages.ListPages].

  • parent (str) –

    Required. The flow to list all pages for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

    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 [Pages.ListPages][google.cloud.dialogflow.cx.v3.Pages.ListPages].

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

Return type

google.cloud.dialogflowcx_v3.services.pages.pagers.ListPagesPager

static page_path(project: str, location: str, agent: str, flow: str, page: str)str[source]

Returns a fully-qualified page string.

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_entity_type_path(path: str)Dict[str, str][source]

Parses a entity_type 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_intent_path(path: str)Dict[str, str][source]

Parses a intent path into its component segments.

static parse_page_path(path: str)Dict[str, str][source]

Parses a page path into its component segments.

static parse_transition_route_group_path(path: str)Dict[str, str][source]

Parses a transition_route_group path into its component segments.

static parse_webhook_path(path: str)Dict[str, str][source]

Parses a webhook path into its component segments.

static transition_route_group_path(project: str, location: str, agent: str, flow: str, transition_route_group: str)str[source]

Returns a fully-qualified transition_route_group string.

property transport: google.cloud.dialogflowcx_v3.services.pages.transports.base.PagesTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

PagesTransport

update_page(request: Optional[google.cloud.dialogflowcx_v3.types.page.UpdatePageRequest] = None, *, page: Optional[google.cloud.dialogflowcx_v3.types.page.Page] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dialogflowcx_v3.types.page.Page[source]

Updates the specified page.

Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
  • request (google.cloud.dialogflowcx_v3.types.UpdatePageRequest) – The request object. The request message for [Pages.UpdatePage][google.cloud.dialogflow.cx.v3.Pages.UpdatePage].

  • page (google.cloud.dialogflowcx_v3.types.Page) – Required. The page to update. This corresponds to the page 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

A Dialogflow CX conversation (session) can be described and visualized as a

state machine. The states of a CX session are represented by pages.

For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page.

You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page.

For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page).

Return type

google.cloud.dialogflowcx_v3.types.Page

static webhook_path(project: str, location: str, agent: str, webhook: str)str[source]

Returns a fully-qualified webhook string.

class google.cloud.dialogflowcx_v3.services.pages.pagers.ListPagesAsyncPager(method: Callable[[...], Awaitable[google.cloud.dialogflowcx_v3.types.page.ListPagesResponse]], request: google.cloud.dialogflowcx_v3.types.page.ListPagesRequest, response: google.cloud.dialogflowcx_v3.types.page.ListPagesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_pages requests.

This class thinly wraps an initial google.cloud.dialogflowcx_v3.types.ListPagesResponse object, and provides an __aiter__ method to iterate through its pages field.

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

All the usual google.cloud.dialogflowcx_v3.types.ListPagesResponse 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_v3.services.pages.pagers.ListPagesPager(method: Callable[[...], google.cloud.dialogflowcx_v3.types.page.ListPagesResponse], request: google.cloud.dialogflowcx_v3.types.page.ListPagesRequest, response: google.cloud.dialogflowcx_v3.types.page.ListPagesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_pages requests.

This class thinly wraps an initial google.cloud.dialogflowcx_v3.types.ListPagesResponse object, and provides an __iter__ method to iterate through its pages field.

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

All the usual google.cloud.dialogflowcx_v3.types.ListPagesResponse 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