Package types (0.8.0)

Classes

Agent

Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way.

After you create an agent, you can add [Intents][google.cloud.dialogflow.cx.v3.Intent], [Entity Types][google.cloud.dialogflow.cx.v3.EntityType], [Flows][google.cloud.dialogflow.cx.v3.Flow], [Fulfillments][google.cloud.dialogflow.cx.v3.Fulfillment], [Webhooks][google.cloud.dialogflow.cx.v3.Webhook], and so on to manage the conversation flows..

Attributes: name (str): The unique identifier of the agent. Required for the [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent] method. [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent] populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. display_name (str): Required. The human-readable name of the agent, unique within the location. default_language_code (str): Required. Immutable. The default language of the agent as a language tag. See Language Support <https://cloud.google.com/dialogflow/cx/docs/reference/language> for a list of the currently supported language codes. This field cannot be set by the [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent] method. supported_language_codes (Sequence[str]): The list of all languages supported by the agent (except for the default_language_code). time_zone (str): Required. The time zone of the agent from the time zone database <https://www.iana.org/time-zones>, e.g., America/New_York, Europe/Paris. description (str): The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected. avatar_uri (str): The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo <https://cloud.google.com/dialogflow/docs/integrations/web-demo>__ integration. speech_to_text_settings (google.cloud.dialogflowcx_v3.types.SpeechToTextSettings): Speech recognition related settings. start_flow (str): Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>. security_settings (str): Name of the [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] reference for the agent. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>. enable_stackdriver_logging (bool): Indicates if stackdriver logging is enabled for the agent. enable_spell_correction (bool): Indicates if automatic spell correction is enabled in detect intent requests.

AgentValidationResult

The response message for [Agents.GetAgentValidationResult][google.cloud.dialogflow.cx.v3.Agents.GetAgentValidationResult].

Attributes: name (str): The unique identifier of the agent validation result. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/validationResult. flow_validation_results (Sequence[google.cloud.dialogflowcx_v3.types.FlowValidationResult]): Contains all flow validation results.

AudioEncoding

Audio encoding of the audio content sent in the conversational query request. Refer to the Cloud Speech API documentation <https://cloud.google.com/speech-to-text/docs/basics>__ for more details.

AudioInput

Represents the natural speech audio to be processed. Attributes: config (google.cloud.dialogflowcx_v3.types.InputAudioConfig): Required. Instructs the speech recognizer how to process the speech audio. audio (bytes): The natural language speech audio to be processed. A single request can contain up to 1 minute of speech audio data. The [transcribed text][google.cloud.dialogflow.cx.v3.QueryResult.transcript] cannot contain more than 256 bytes.

    For non-streaming audio detect intent, both ``config`` and
    ``audio`` must be provided. For streaming audio detect
    intent, ``config`` must be provided in the first request and
    ``audio`` must be provided in all following requests.

BatchDeleteTestCasesRequest

The request message for [TestCases.BatchDeleteTestCases][google.cloud.dialogflow.cx.v3.TestCases.BatchDeleteTestCases].

Attributes: parent (str): Required. The agent to delete test cases from. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. names (Sequence[str]): Required. Format of test case names: projects/<Project ID>/locations/ <Location ID>/agents/<AgentID>/testCases/<TestCase ID>.

BatchRunTestCasesMetadata

Metadata returned for the [TestCases.BatchRunTestCases][google.cloud.dialogflow.cx.v3.TestCases.BatchRunTestCases] long running operation.

Attributes: errors (Sequence[google.cloud.dialogflowcx_v3.types.TestError]): The test errors.

BatchRunTestCasesRequest

The request message for [TestCases.BatchRunTestCases][google.cloud.dialogflow.cx.v3.TestCases.BatchRunTestCases].

Attributes: parent (str): Required. Agent name. Format: projects/<Project ID>/locations/<Location ID>/agents/ <AgentID>. environment (str): Optional. If not set, draft environment is assumed. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>. test_cases (Sequence[str]): Required. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/testCases/<TestCase ID>.

BatchRunTestCasesResponse

The response message for [TestCases.BatchRunTestCases][google.cloud.dialogflow.cx.v3.TestCases.BatchRunTestCases].

Attributes: results (Sequence[google.cloud.dialogflowcx_v3.types.TestCaseResult]): The test case results. The detailed [conversation turns][google.cloud.dialogflow.cx.v3.TestCaseResult.conversation_turns] are empty in this response.

CalculateCoverageRequest

The request message for [TestCases.CalculateCoverage][google.cloud.dialogflow.cx.v3.TestCases.CalculateCoverage].

Attributes: agent (str): Required. The agent to calculate coverage for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. type_ (google.cloud.dialogflowcx_v3.types.CalculateCoverageRequest.CoverageType): Required. The type of coverage requested.

CalculateCoverageResponse

The response message for [TestCases.CalculateCoverage][google.cloud.dialogflow.cx.v3.TestCases.CalculateCoverage].

Attributes: agent (str): The agent to calculate coverage for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. intent_coverage (google.cloud.dialogflowcx_v3.types.IntentCoverage): Intent coverage. transition_coverage (google.cloud.dialogflowcx_v3.types.TransitionCoverage): Transition (excluding transition route groups) coverage. route_group_coverage (google.cloud.dialogflowcx_v3.types.TransitionRouteGroupCoverage): Transition route group coverage.

ContinuousTestResult

Represents a result from running a test case in an agent environment.

Attributes: name (str): The resource name for the continuous test result. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/continuousTestResults/<ContinuousTestResult ID>. result (google.cloud.dialogflowcx_v3.types.ContinuousTestResult.AggregatedTestResult): The result of this continuous test run, i.e. whether all the tests in this continuous test run pass or not. test_case_results (Sequence[str]): A list of individual test case results names in this continuous test run. run_time (google.protobuf.timestamp_pb2.Timestamp): Time when the continuous testing run starts.

ConversationTurn

One interaction between a human and virtual agent. The human provides some input and the virtual agent provides a response.

Attributes: user_input (google.cloud.dialogflowcx_v3.types.ConversationTurn.UserInput): The user input. virtual_agent_output (google.cloud.dialogflowcx_v3.types.ConversationTurn.VirtualAgentOutput): The virtual agent output.

CreateAgentRequest

The request message for [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent].

Attributes: parent (str): Required. The location to create a agent for. Format: projects/<Project ID>/locations/<Location ID>. agent (google.cloud.dialogflowcx_v3.types.Agent): Required. The agent to create.

CreateEntityTypeRequest

The request message for [EntityTypes.CreateEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.CreateEntityType].

Attributes: parent (str): Required. The agent to create a entity type for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. entity_type (google.cloud.dialogflowcx_v3.types.EntityType): Required. The entity type to create. language_code (str): The language of the following fields in entity_type:

    -  ``EntityType.entities.value``
    -  ``EntityType.entities.synonyms``
    -  ``EntityType.excluded_phrases.value``


    If not specified, the agent's default language is used.
    `Many
    languages <https://cloud.google.com/dialogflow/cx/docs/reference/language>`__
    are supported. Note: languages must be enabled in the agent
    before they can be used.

CreateEnvironmentRequest

The request message for [Environments.CreateEnvironment][google.cloud.dialogflow.cx.v3.Environments.CreateEnvironment].

Attributes: parent (str): Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. environment (google.cloud.dialogflowcx_v3.types.Environment): Required. The environment to create.

CreateExperimentRequest

The request message for [Experiments.CreateExperiment][google.cloud.dialogflow.cx.v3.Experiments.CreateExperiment].

Attributes: parent (str): Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to create an [Environment][google.cloud.dialogflow.cx.v3.Environment] for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>. experiment (google.cloud.dialogflowcx_v3.types.Experiment): Required. The experiment to create.

CreateFlowRequest

The request message for [Flows.CreateFlow][google.cloud.dialogflow.cx.v3.Flows.CreateFlow].

Attributes: parent (str): Required. The agent to create a flow for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. flow (google.cloud.dialogflowcx_v3.types.Flow): Required. The flow to create. language_code (str): The language of the following fields in flow:

    -  ``Flow.event_handlers.trigger_fulfillment.messages``
    -  ``Flow.event_handlers.trigger_fulfillment.conditional_cases``
    -  ``Flow.transition_routes.trigger_fulfillment.messages``
    -  ``Flow.transition_routes.trigger_fulfillment.conditional_cases``


    If not specified, the agent's default language is used.
    `Many
    languages <https://cloud.google.com/dialogflow/cx/docs/reference/language>`__
    are supported. Note: languages must be enabled in the agent
    before they can be used.

CreateIntentRequest

The request message for [Intents.CreateIntent][google.cloud.dialogflow.cx.v3.Intents.CreateIntent].

Attributes: parent (str): Required. The agent to create an intent for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. intent (google.cloud.dialogflowcx_v3.types.Intent): Required. The intent to create. language_code (str): The language of the following fields in intent:

    -  ``Intent.training_phrases.parts.text``


    If not specified, the agent's default language is used.
    `Many
    languages <https://cloud.google.com/dialogflow/cx/docs/reference/language>`__
    are supported. Note: languages must be enabled in the agent
    before they can be used.

CreatePageRequest

The request message for [Pages.CreatePage][google.cloud.dialogflow.cx.v3.Pages.CreatePage].

Attributes: parent (str): Required. The flow to create a page for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>. page (google.cloud.dialogflowcx_v3.types.Page): Required. The page to create. language_code (str): The language of the following fields in page:

    -  ``Page.entry_fulfillment.messages``
    -  ``Page.entry_fulfillment.conditional_cases``
    -  ``Page.event_handlers.trigger_fulfillment.messages``
    -  ``Page.event_handlers.trigger_fulfillment.conditional_cases``
    -  ``Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages``
    -


    ``Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases``


    -  ``Page.form.parameters.fill_behavior.reprompt_event_handlers.messages``
    -


    ``Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases``


    -  ``Page.transition_routes.trigger_fulfillment.messages``
    -  ``Page.transition_routes.trigger_fulfillment.conditional_cases``


    If not specified, the agent's default language is used.
    `Many
    languages <https://cloud.google.com/dialogflow/cx/docs/reference/language>`__
    are supported. Note: languages must be enabled in the agent
    before they can be used.

CreateSecuritySettingsRequest

The request message for [SecuritySettings.CreateSecuritySettings][]. Attributes: parent (str): Required. The location to create an [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] for. Format: projects/<Project ID>/locations/<Location ID>. security_settings (google.cloud.dialogflowcx_v3.types.SecuritySettings): Required. The security settings to create.

CreateSessionEntityTypeRequest

The request message for [SessionEntityTypes.CreateSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.CreateSessionEntityType].

Attributes: parent (str): Required. The session to create a session entity type for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default 'draft' environment. session_entity_type (google.cloud.dialogflowcx_v3.types.SessionEntityType): Required. The session entity type to create.

CreateTestCaseRequest

The request message for [TestCases.CreateTestCase][google.cloud.dialogflow.cx.v3.TestCases.CreateTestCase].

Attributes: parent (str): Required. The agent to create the test case for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. test_case (google.cloud.dialogflowcx_v3.types.TestCase): Required. The test case to create.

CreateTransitionRouteGroupRequest

The request message for [TransitionRouteGroups.CreateTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.CreateTransitionRouteGroup].

Attributes: parent (str): Required. The flow to create an [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>. transition_route_group (google.cloud.dialogflowcx_v3.types.TransitionRouteGroup): Required. The transition route group to create. language_code (str): The language of the following fields in TransitionRouteGroup:

    -  ``TransitionRouteGroup.transition_routes.trigger_fulfillment.messages``
    -


    ``TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases``


    If not specified, the agent's default language is used.
    `Many
    languages <https://cloud.google.com/dialogflow/cx/docs/reference/language>`__
    are supported. Note: languages must be enabled in the agent
    before they can be used.

CreateVersionOperationMetadata

Metadata associated with the long running operation for [Versions.CreateVersion][google.cloud.dialogflow.cx.v3.Versions.CreateVersion].

Attributes: version (str): Name of the created version. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

CreateVersionRequest

The request message for [Versions.CreateVersion][google.cloud.dialogflow.cx.v3.Versions.CreateVersion].

Attributes: parent (str): Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to create an [Version][google.cloud.dialogflow.cx.v3.Version] for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>. version (google.cloud.dialogflowcx_v3.types.Version): Required. The version to create.

CreateWebhookRequest

The request message for [Webhooks.CreateWebhook][google.cloud.dialogflow.cx.v3.Webhooks.CreateWebhook].

Attributes: parent (str): Required. The agent to create a webhook for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. webhook (google.cloud.dialogflowcx_v3.types.Webhook): Required. The webhook to create.

DeleteAgentRequest

The request message for [Agents.DeleteAgent][google.cloud.dialogflow.cx.v3.Agents.DeleteAgent].

Attributes: name (str): Required. The name of the agent to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

DeleteEntityTypeRequest

The request message for [EntityTypes.DeleteEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.DeleteEntityType].

Attributes: name (str): Required. The name of the entity type to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>. force (bool): This field has no effect for entity type not being used. For entity types that are used by intents or pages:

    -  If ``force`` is set to false, an error will be returned
       with message indicating the referencing resources.
    -  If ``force`` is set to true, Dialogflow will remove the
       entity type, as well as any references to the entity type
       (i.e. Page
       [parameter][google.cloud.dialogflow.cx.v3.Form.Parameter]
       of the entity type will be changed to '@sys.any' and
       intent
       [parameter][google.cloud.dialogflow.cx.v3.Intent.Parameter]
       of the entity type will be removed).

DeleteEnvironmentRequest

The request message for [Environments.DeleteEnvironment][google.cloud.dialogflow.cx.v3.Environments.DeleteEnvironment].

Attributes: name (str): Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment] to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

DeleteExperimentRequest

The request message for [Experiments.DeleteExperiment][google.cloud.dialogflow.cx.v3.Experiments.DeleteExperiment].

DeleteFlowRequest

The request message for [Flows.DeleteFlow][google.cloud.dialogflow.cx.v3.Flows.DeleteFlow].

Attributes: name (str): Required. The name of the flow to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>. force (bool): This field has no effect for flows with no incoming transitions. For flows with incoming transitions:

    -  If ``force`` is set to false, an error will be returned
       with message indicating the incoming transitions.
    -  If ``force`` is set to true, Dialogflow will remove the
       flow, as well as any transitions to the flow (i.e.
       [Target flow][EventHandler.target_flow] in event handlers
       or [Target flow][TransitionRoute.target_flow] in
       transition routes that point to this flow will be
       cleared).

DeleteIntentRequest

The request message for [Intents.DeleteIntent][google.cloud.dialogflow.cx.v3.Intents.DeleteIntent].

Attributes: name (str): Required. The name of the intent to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

DeletePageRequest

The request message for [Pages.DeletePage][google.cloud.dialogflow.cx.v3.Pages.DeletePage].

Attributes: 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>. force (bool): This field has no effect for pages with no incoming transitions. For pages with incoming transitions:

    -  If ``force`` is set to false, an error will be returned
       with message indicating the incoming transitions.
    -  If ``force`` is set to true, Dialogflow will remove the
       page, as well as any transitions to the page (i.e.
       [Target page][EventHandler.target_page] in event handlers
       or [Target page][TransitionRoute.target_page] in
       transition routes that point to this page will be
       cleared).

DeleteSecuritySettingsRequest

The request message for [SecuritySettings.DeleteSecuritySettings][]. Attributes: name (str): Required. The name of the [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] to delete. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>.

DeleteSessionEntityTypeRequest

The request message for [SessionEntityTypes.DeleteSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.DeleteSessionEntityType].

Attributes: name (str): Required. The name of the session entity type to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>. If Environment ID is not specified, we assume default 'draft' environment.

DeleteTransitionRouteGroupRequest

The request message for [TransitionRouteGroups.DeleteTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.DeleteTransitionRouteGroup].

Attributes: name (str): Required. The name of the [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID>. force (bool): This field has no effect for transition route group that no page is using. If the transition route group is referenced by any page:

    -  If ``force`` is set to false, an error will be returned
       with message indicating pages that reference the
       transition route group.
    -  If ``force`` is set to true, Dialogflow will remove the
       transition route group, as well as any reference to it.

DeleteVersionRequest

The request message for [Versions.DeleteVersion][google.cloud.dialogflow.cx.v3.Versions.DeleteVersion].

Attributes: name (str): Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version] to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

DeleteWebhookRequest

The request message for [Webhooks.DeleteWebhook][google.cloud.dialogflow.cx.v3.Webhooks.DeleteWebhook].

Attributes: name (str): Required. The name of the webhook to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. force (bool): This field has no effect for webhook not being used. For webhooks that are used by pages/flows/transition route groups:

    -  If ``force`` is set to false, an error will be returned
       with message indicating the referenced resources.
    -  If ``force`` is set to true, Dialogflow will remove the
       webhook, as well as any references to the webhook (i.e.
       [Webhook][google.cloud.dialogflow.cx.v3.Fulfillment.webhook]
       and
       [tag][google.cloud.dialogflow.cx.v3.Fulfillment.tag]in
       fulfillments that point to this webhook will be removed).

DetectIntentRequest

The request to detect user's intent. Attributes: session (str): Required. The name of the session this query is sent to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters.

    For more information, see the `sessions
    guide <https://cloud.google.com/dialogflow/cx/docs/concept/session>`__.


    Note: Always use agent versions for production traffic. See
    `Versions and
    environments <https://cloud.google.com/dialogflow/cx/docs/concept/version>`__.
query_params (google.cloud.dialogflowcx_v3.types.QueryParameters):
    The parameters of this query.
query_input (google.cloud.dialogflowcx_v3.types.QueryInput):
    Required. The input specification.
output_audio_config (google.cloud.dialogflowcx_v3.types.OutputAudioConfig):
    Instructs the speech synthesizer how to
    generate the output audio.

DetectIntentResponse

The message returned from the DetectIntent method. Attributes: response_id (str): Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues. query_result (google.cloud.dialogflowcx_v3.types.QueryResult): The result of the conversational query. output_audio (bytes): The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the [query_result.response_messages][google.cloud.dialogflow.cx.v3.QueryResult.response_messages] field. If multiple default text responses exist, they will be concatenated when generating audio. If no default platform text responses exist, the generated audio content will be empty.

    In some scenarios, multiple output audio fields may be
    present in the response structure. In these cases, only the
    top-most-level audio output has content.
output_audio_config (google.cloud.dialogflowcx_v3.types.OutputAudioConfig):
    The config used by the speech synthesizer to
    generate the output audio.
response_type (google.cloud.dialogflowcx_v3.types.DetectIntentResponse.ResponseType):
    Response type.
allow_cancellation (bool):
    Indicates whether the partial response can be
    cancelled when a later response arrives. e.g. if
    the agent specified some music as partial
    response, it can be cancelled.

DtmfInput

Represents the input for dtmf event. Attributes: digits (str): The dtmf digits. finish_digit (str): The finish digit (if any).

EntityType

Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application.

When you define an entity, you can also include synonyms that all map to that entity. For example, "soft drink", "soda", "pop", and so on.

There are three types of entities:

System - entities that are defined by the Dialogflow API for common data types such as date, time, currency, and so on. A system entity is represented by the EntityType type.
Custom - entities that are defined by you that represent actionable data that is meaningful to your application. For example, you could define a pizza.sauce entity for red or white pizza sauce, a pizza.cheese entity for the different types of cheese on a pizza, a pizza.topping entity for different toppings, and so on. A custom entity is represented by the EntityType type.
User - entities that are built for an individual user such as favorites, preferences, playlists, and so on. A user entity is represented by the [SessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityType] type.

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

Attributes: name (str): The unique identifier of the entity type. Required for [EntityTypes.UpdateEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.UpdateEntityType]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>. display_name (str): Required. The human-readable name of the entity type, unique within the agent. kind (google.cloud.dialogflowcx_v3.types.EntityType.Kind): Required. Indicates the kind of entity type. auto_expansion_mode (google.cloud.dialogflowcx_v3.types.EntityType.AutoExpansionMode): Indicates whether the entity type can be automatically expanded. entities (Sequence[google.cloud.dialogflowcx_v3.types.EntityType.Entity]): The collection of entity entries associated with the entity type. excluded_phrases (Sequence[google.cloud.dialogflowcx_v3.types.EntityType.ExcludedPhrase]): Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry giant\ (an adjective), you might consider adding giants\ (a noun) as an exclusion. If the kind of entity type is KIND_MAP, then the phrases specified by entities and excluded phrases should be mutually exclusive. enable_fuzzy_extraction (bool): Enables fuzzy entity extraction during classification. redact (bool): Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name when logging.

Environment

Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.

Attributes: name (str): The name of the environment. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>. display_name (str): Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters. description (str): The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected. version_configs (Sequence[google.cloud.dialogflowcx_v3.types.Environment.VersionConfig]): Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from [Start Flow][Agent.start_flow] in the agent. Otherwise, an error will be returned. update_time (google.protobuf.timestamp_pb2.Timestamp): Output only. Update time of this environment.

EventHandler

An event handler specifies an [event][google.cloud.dialogflow.cx.v3.EventHandler.event] that can be handled during a session. When the specified event happens, the following actions are taken in order:

If there is a [trigger_fulfillment][google.cloud.dialogflow.cx.v3.EventHandler.trigger_fulfillment] associated with the event, it will be called.
If there is a [target_page][google.cloud.dialogflow.cx.v3.EventHandler.target_page] associated with the event, the session will transition into the specified page.
If there is a [target_flow][google.cloud.dialogflow.cx.v3.EventHandler.target_flow] associated with the event, the session will transition into the specified flow.

Attributes: name (str): Output only. The unique identifier of this event handler. event (str): Required. The name of the event to handle. trigger_fulfillment (google.cloud.dialogflowcx_v3.types.Fulfillment): The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. target_page (str): The target page to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>. target_flow (str): The target flow to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

EventInput

Represents the event to trigger. Attributes: event (str): Name of the event.

Experiment

Represents an experiment in an environment. Attributes: name (str): The name of the experiment. Format: projects/

ExportAgentRequest

The request message for [Agents.ExportAgent][google.cloud.dialogflow.cx.v3.Agents.ExportAgent].

Attributes: name (str): Required. The name of the agent to export. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. agent_uri (str): Optional. The Google Cloud Storage <https://cloud.google.com/storage/docs/>__ URI to export the agent to. The format of this URI must be gs://<bucket-name>/<object-name>. If left unspecified, the serialized agent is returned inline. environment (str): Optional. Environment name. If not set, draft environment is assumed. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

ExportAgentResponse

The response message for [Agents.ExportAgent][google.cloud.dialogflow.cx.v3.Agents.ExportAgent].

Attributes: agent_uri (str): The URI to a file containing the exported agent. This field is populated only if agent_uri is specified in [ExportAgentRequest][google.cloud.dialogflow.cx.v3.ExportAgentRequest]. agent_content (bytes): Uncompressed raw byte content for agent.

ExportFlowRequest

The request message for [Flows.ExportFlow][google.cloud.dialogflow.cx.v3.Flows.ExportFlow].

Attributes: name (str): Required. The name of the flow to export. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>. flow_uri (str): Optional. The Google Cloud Storage <https://cloud.google.com/storage/docs/>__ URI to export the flow to. The format of this URI must be gs://<bucket-name>/<object-name>. If left unspecified, the serialized flow is returned inline. include_referenced_flows (bool): Optional. Whether to export flows referenced by the specified flow.

ExportFlowResponse

The response message for [Flows.ExportFlow][google.cloud.dialogflow.cx.v3.Flows.ExportFlow].

Attributes: flow_uri (str): The URI to a file containing the exported flow. This field is populated only if flow_uri is specified in [ExportFlowRequest][google.cloud.dialogflow.cx.v3.ExportFlowRequest]. flow_content (bytes): Uncompressed raw byte content for flow.

ExportTestCasesMetadata

Metadata returned for the [TestCases.ExportTestCases][google.cloud.dialogflow.cx.v3.TestCases.ExportTestCases] long running operation.

ExportTestCasesRequest

The request message for [TestCases.ExportTestCases][google.cloud.dialogflow.cx.v3.TestCases.ExportTestCases].

Attributes: parent (str): Required. The agent where to export test cases from. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. gcs_uri (str): The Google Cloud Storage <https://cloud.google.com/storage/docs/> URI to export the test cases to. The format of this URI must be gs://<bucket-name>/<object-name>. If unspecified, the serialized test cases is returned inline. data_format (google.cloud.dialogflowcx_v3.types.ExportTestCasesRequest.DataFormat): The data format of the exported test cases. If not specified, BLOB is assumed. filter (str): The filter expression used to filter exported test cases, see API Filtering <https://aip.dev/160>. The expression is case insensitive and supports the following syntax:

    name = [OR name = ] ...


    For example:


    -  "name = t1 OR name = t2" matches the test case with the
       exact resource name "t1" or "t2".

ExportTestCasesResponse

The response message for [TestCases.ExportTestCases][google.cloud.dialogflow.cx.v3.TestCases.ExportTestCases].

Attributes: gcs_uri (str): The URI to a file containing the exported test cases. This field is populated only if gcs_uri is specified in [ExportTestCasesRequest][google.cloud.dialogflow.cx.v3.ExportTestCasesRequest]. content (bytes): Uncompressed raw byte content for test cases.

Flow

Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started.

Usually, when a transition route is followed by a matched intent, the intent will be "consumed". This means the intent won't activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow.

Attributes: name (str): The unique identifier of the flow. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>. display_name (str): Required. The human-readable name of the flow. description (str): The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected. transition_routes (Sequence[google.cloud.dialogflowcx_v3.types.TransitionRoute]): A flow's transition routes serve two purposes:

    -  They are responsible for matching the user's first
       utterances in the flow.
    -  They are inherited by every page's [transition
       routes][Page.transition_routes] and can support use cases
       such as the user saying "help" or "can I talk to a
       human?", which can be handled in a common way regardless
       of the current page. Transition routes defined in the
       page have higher priority than those defined in the flow.


    TransitionRoutes are evalauted in the following order:


    -  TransitionRoutes with intent specified..
    -  TransitionRoutes with only condition specified.


    TransitionRoutes with intent specified are inherited by
    pages in the flow.
event_handlers (Sequence[google.cloud.dialogflowcx_v3.types.EventHandler]):
    A flow's event handlers serve two purposes:


    -  They are responsible for handling events (e.g. no match,
       webhook errors) in the flow.
    -  They are inherited by every page's [event
       handlers][Page.event_handlers], which can be used to
       handle common events regardless of the current page.
       Event handlers defined in the page have higher priority
       than those defined in the flow.


    Unlike
    [transition_routes][google.cloud.dialogflow.cx.v3.Flow.transition_routes],
    these handlers are evaluated on a first-match basis. The
    first one that matches the event get executed, with the rest
    being ignored.
transition_route_groups (Sequence[str]):
    A flow's transition route group serve two purposes:


    -  They are responsible for matching the user's first
       utterances in the flow.
    -  They are inherited by every page's [transition route
       groups][Page.transition_route_groups]. Transition route
       groups defined in the page have higher priority than
       those defined in the flow.


    Format:\ ``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>``.
nlu_settings (google.cloud.dialogflowcx_v3.types.NluSettings):
    NLU related settings of the flow.

FlowValidationResult

The response message for [Flows.GetFlowValidationResult][google.cloud.dialogflow.cx.v3.Flows.GetFlowValidationResult].

Attributes: name (str): The unique identifier of the flow validation result. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/validationResult. validation_messages (Sequence[google.cloud.dialogflowcx_v3.types.ValidationMessage]): Contains all validation messages. update_time (google.protobuf.timestamp_pb2.Timestamp): Last time the flow was validated.

Form

A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a [page][google.cloud.dialogflow.cx.v3.Page]. When form filling is done, the filled parameters will be written to the [session][google.cloud.dialogflow.cx.v3.SessionInfo.parameters].

Attributes: parameters (Sequence[google.cloud.dialogflowcx_v3.types.Form.Parameter]): Parameters to collect from the user.

FulfillIntentRequest

Request of [FulfillIntent][] Attributes: match_intent_request (google.cloud.dialogflowcx_v3.types.MatchIntentRequest): Must be same as the corresponding MatchIntent request, otherwise the behavior is undefined. match (google.cloud.dialogflowcx_v3.types.Match): The matched intent/event to fulfill. output_audio_config (google.cloud.dialogflowcx_v3.types.OutputAudioConfig): Instructs the speech synthesizer how to generate output audio.

FulfillIntentResponse

Response of [FulfillIntent][] Attributes: response_id (str): Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues. query_result (google.cloud.dialogflowcx_v3.types.QueryResult): The result of the conversational query. output_audio (bytes): The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the [query_result.response_messages][google.cloud.dialogflow.cx.v3.QueryResult.response_messages] field. If multiple default text responses exist, they will be concatenated when generating audio. If no default platform text responses exist, the generated audio content will be empty.

    In some scenarios, multiple output audio fields may be
    present in the response structure. In these cases, only the
    top-most-level audio output has content.
output_audio_config (google.cloud.dialogflowcx_v3.types.OutputAudioConfig):
    The config used by the speech synthesizer to
    generate the output audio.

Fulfillment

A fulfillment can do one or more of the following actions at the same time:

Generate rich message responses.
Set parameter values.
Call the webhook.

Fulfillments can be called at various stages in the [Page][google.cloud.dialogflow.cx.v3.Page] or [Form][google.cloud.dialogflow.cx.v3.Form] lifecycle. For example, when a [DetectIntentRequest][google.cloud.dialogflow.cx.v3.DetectIntentRequest] drives a session to enter a new page, the page's entry fulfillment can add a static response to the [QueryResult][google.cloud.dialogflow.cx.v3.QueryResult] in the returning [DetectIntentResponse][google.cloud.dialogflow.cx.v3.DetectIntentResponse], call the webhook (for example, to load user data from a database), or both.

Attributes: messages (Sequence[google.cloud.dialogflowcx_v3.types.ResponseMessage]): The list of rich message responses to present to the user. webhook (str): The webhook to call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. return_partial_responses (bool): Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks. tag (str): The tag used by the webhook to identify which fulfillment is being called. This field is required if webhook is specified. set_parameter_actions (Sequence[google.cloud.dialogflowcx_v3.types.Fulfillment.SetParameterAction]): Set parameter values before executing the webhook. conditional_cases (Sequence[google.cloud.dialogflowcx_v3.types.Fulfillment.ConditionalCases]): Conditional cases for this fulfillment.

GetAgentRequest

The request message for [Agents.GetAgent][google.cloud.dialogflow.cx.v3.Agents.GetAgent].

Attributes: name (str): Required. The name of the agent. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

GetAgentValidationResultRequest

The request message for [Agents.GetAgentValidationResult][google.cloud.dialogflow.cx.v3.Agents.GetAgentValidationResult].

Attributes: name (str): Required. The agent name. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/validationResult. language_code (str): If not specified, the agent's default language is used.

GetEntityTypeRequest

The request message for [EntityTypes.GetEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.GetEntityType].

Attributes: name (str): Required. The name of the entity type. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>. language_code (str): The language to retrieve the entity type for. The following fields are language dependent:

    -  ``EntityType.entities.value``
    -  ``EntityType.entities.synonyms``
    -  ``EntityType.excluded_phrases.value``


    If not specified, the agent's default language is used.
    `Many
    languages <https://cloud.google.com/dialogflow/cx/docs/reference/language>`__
    are supported. Note: languages must be enabled in the agent
    before they can be used.

GetEnvironmentRequest

The request message for [Environments.GetEnvironment][google.cloud.dialogflow.cx.v3.Environments.GetEnvironment].

Attributes: name (str): Required. The name of the [Environment][google.cloud.dialogflow.cx.v3.Environment]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

GetExperimentRequest

The request message for [Experiments.GetExperiment][google.cloud.dialogflow.cx.v3.Experiments.GetExperiment].

GetFlowRequest

The response message for [Flows.GetFlow][google.cloud.dialogflow.cx.v3.Flows.GetFlow].

Attributes: name (str): Required. The name of the flow to get. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>. language_code (str): The language to retrieve the flow for. The following fields are language dependent:

    -  ``Flow.event_handlers.trigger_fulfillment.messages``
    -  ``Flow.event_handlers.trigger_fulfillment.conditional_cases``
    -  ``Flow.transition_routes.trigger_fulfillment.messages``
    -  ``Flow.transition_routes.trigger_fulfillment.conditional_cases``


    If not specified, the agent's default language is used.
    `Many
    languages <https://cloud.google.com/dialogflow/cx/docs/reference/language>`__
    are supported. Note: languages must be enabled in the agent
    before they can be used.

GetFlowValidationResultRequest

The request message for [Flows.GetFlowValidationResult][google.cloud.dialogflow.cx.v3.Flows.GetFlowValidationResult].

Attributes: name (str): Required. The flow name. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/validationResult. language_code (str): If not specified, the agent's default language is used.

GetIntentRequest

The request message for [Intents.GetIntent][google.cloud.dialogflow.cx.v3.Intents.GetIntent].

Attributes: name (str): Required. The name of the intent. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>. language_code (str): The language to retrieve the intent for. The following fields are language dependent:

    -  ``Intent.training_phrases.parts.text``


    If not specified, the agent's default language is used.
    `Many
    languages <https://cloud.google.com/dialogflow/cx/docs/reference/language>`__
    are supported. Note: languages must be enabled in the agent
    before they can be used.

GetPageRequest

The request message for [Pages.GetPage][google.cloud.dialogflow.cx.v3.Pages.GetPage].

Attributes: name (str): Required. The name of the page. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>. language_code (str): The language to retrieve the page for. The following fields are language dependent:

    -  ``Page.entry_fulfillment.messages``
    -  ``Page.entry_fulfillment.conditional_cases``
    -  ``Page.event_handlers.trigger_fulfillment.messages``
    -  ``Page.event_handlers.trigger_fulfillment.conditional_cases``
    -  ``Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages``
    -


    ``Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases``


    -  ``Page.form.parameters.fill_behavior.reprompt_event_handlers.messages``
    -


    ``Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases``


    -  ``Page.transition_routes.trigger_fulfillment.messages``
    -  ``Page.transition_routes.trigger_fulfillment.conditional_cases``


    If not specified, the agent's default language is used.
    `Many
    languages <https://cloud.google.com/dialogflow/cx/docs/reference/language>`__
    are supported. Note: languages must be enabled in the agent
    before they can be used.

GetSecuritySettingsRequest

The request message for [SecuritySettingsService.GetSecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettingsService.GetSecuritySettings].

Attributes: name (str): Required. Resource name of the settings. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<security settings ID>.

GetSessionEntityTypeRequest

The request message for [SessionEntityTypes.GetSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.GetSessionEntityType].

Attributes: name (str): Required. The name of the session entity type. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>. If Environment ID is not specified, we assume default 'draft' environment.

GetTestCaseRequest

The request message for [TestCases.GetTestCase][google.cloud.dialogflow.cx.v3.TestCases.GetTestCase].

Attributes: name (str): Required. The name of the testcase. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/testCases/<TestCase ID>.

GetTestCaseResultRequest

The request message for [TestCases.GetTestCaseResult][google.cloud.dialogflow.cx.v3.TestCases.GetTestCaseResult].

Attributes: name (str): Required. The name of the testcase. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/testCases/<TestCase ID>/results/<TestCaseResult ID>.

GetTransitionRouteGroupRequest

The request message for [TransitionRouteGroups.GetTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.GetTransitionRouteGroup].

Attributes: name (str): Required. The name of the [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID>. language_code (str): The language to retrieve the transition route group for. The following fields are language dependent:

    -  ``TransitionRouteGroup.transition_routes.trigger_fulfillment.messages``
    -


    ``TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases``


    If not specified, the agent's default language is used.
    `Many
    languages <https://cloud.google.com/dialogflow/cx/docs/reference/language>`__
    are supported. Note: languages must be enabled in the agent
    before they can be used.

GetVersionRequest

The request message for [Versions.GetVersion][google.cloud.dialogflow.cx.v3.Versions.GetVersion].

Attributes: name (str): Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

GetWebhookRequest

The request message for [Webhooks.GetWebhook][google.cloud.dialogflow.cx.v3.Webhooks.GetWebhook].

Attributes: name (str): Required. The name of the webhook. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>.

ImportFlowRequest

The request message for [Flows.ImportFlow][google.cloud.dialogflow.cx.v3.Flows.ImportFlow].

Attributes: parent (str): Required. The agent to import the flow into. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. flow_uri (str): The Google Cloud Storage <https://cloud.google.com/storage/docs/>__ URI to import flow from. The format of this URI must be gs://<bucket-name>/<object-name>. flow_content (bytes): Uncompressed raw byte content for flow. import_option (google.cloud.dialogflowcx_v3.types.ImportFlowRequest.ImportOption): Flow import mode. If not specified, KEEP is assumed.

ImportFlowResponse

The response message for [Flows.ImportFlow][google.cloud.dialogflow.cx.v3.Flows.ImportFlow].

Attributes: flow (str): The unique identifier of the new flow. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

ImportTestCasesMetadata

Metadata returned for the [TestCases.ImportTestCases][google.cloud.dialogflow.cx.v3.TestCases.ImportTestCases] long running operation.

Attributes: errors (Sequence[google.cloud.dialogflowcx_v3.types.TestCaseError]): Errors for failed test cases.

ImportTestCasesRequest

The request message for [TestCases.ImportTestCases][google.cloud.dialogflow.cx.v3.TestCases.ImportTestCases].

Attributes: parent (str): Required. The agent to import test cases to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. gcs_uri (str): The Google Cloud Storage <https://cloud.google.com/storage/docs/>__ URI to import test cases from. The format of this URI must be gs://<bucket-name>/<object-name>. content (bytes): Uncompressed raw byte content for test cases.

ImportTestCasesResponse

The response message for [TestCases.ImportTestCases][google.cloud.dialogflow.cx.v3.TestCases.ImportTestCases].

Attributes: names (Sequence[str]): The unique identifiers of the new test cases. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/testCases/<TestCase ID>.

InputAudioConfig

Instructs the speech recognizer on how to process the audio content.

Attributes: audio_encoding (google.cloud.dialogflowcx_v3.types.AudioEncoding): Required. Audio encoding of the audio content to process. sample_rate_hertz (int): Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation <https://cloud.google.com/speech-to-text/docs/basics>__ for more details. enable_word_info (bool): Optional. If true, Dialogflow returns [SpeechWordInfo][google.cloud.dialogflow.cx.v3.SpeechWordInfo] in [StreamingRecognitionResult][google.cloud.dialogflow.cx.v3.StreamingRecognitionResult] with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. phrase_hints (Sequence[str]): Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood.

    See `the Cloud Speech
    documentation <https://cloud.google.com/speech-to-text/docs/basics#phrase-hints>`__
    for more details.
model (str):
    Optional. Which Speech model to select for the given
    request. Select the model best suited to your domain to get
    best results. If a model is not explicitly specified, then
    we auto-select a model based on the parameters in the
    InputAudioConfig. If enhanced speech model is enabled for
    the agent and an enhanced version of the specified model for
    the language does not exist, then the speech is recognized
    using the standard version of the specified model. Refer to
    `Cloud Speech API
    documentation <https://cloud.google.com/speech-to-text/docs/basics#select-model>`__
    for more details.
model_variant (google.cloud.dialogflowcx_v3.types.SpeechModelVariant):
    Optional. Which variant of the [Speech
    model][google.cloud.dialogflow.cx.v3.InputAudioConfig.model]
    to use.
single_utterance (bool):
    Optional. If ``false`` (default), recognition does not cease
    until the client closes the stream. If ``true``, the
    recognizer will detect a single spoken utterance in input
    audio. Recognition ceases when it detects the audio's voice
    has stopped or paused. In this case, once a detected intent
    is received, the client should close the stream and start a
    new request with a new stream as needed. Note: This setting
    is relevant only for streaming methods.

Intent

An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.

Attributes: name (str): The unique identifier of the intent. Required for the [Intents.UpdateIntent][google.cloud.dialogflow.cx.v3.Intents.UpdateIntent] method. [Intents.CreateIntent][google.cloud.dialogflow.cx.v3.Intents.CreateIntent] populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>. display_name (str): Required. The human-readable name of the intent, unique within the agent. training_phrases (Sequence[google.cloud.dialogflowcx_v3.types.Intent.TrainingPhrase]): The collection of training phrases the agent is trained on to identify the intent. parameters (Sequence[google.cloud.dialogflowcx_v3.types.Intent.Parameter]): The collection of parameters associated with the intent. priority (int): The priority of this intent. Higher numbers represent higher priorities.

    -  If the supplied value is unspecified or 0, the service
       translates the value to 500,000, which corresponds to the
       ``Normal`` priority in the console.
    -  If the supplied value is negative, the intent is ignored
       in runtime detect intent requests.
is_fallback (bool):
    Indicates whether this is a fallback intent.
    Currently only default fallback intent is
    allowed in the agent, which is added upon agent
    creation.
    Adding training phrases to fallback intent is
    useful in the case of requests that are
    mistakenly matched, since training phrases
    assigned to fallback intents act as negative
    examples that triggers no-match event.
labels (Sequence[google.cloud.dialogflowcx_v3.types.Intent.LabelsEntry]):
    The key/value metadata to label an intent. Labels can
    contain lowercase letters, digits and the symbols '-' and
    '_'. International characters are allowed, including letters
    from unicase alphabets. Keys must start with a letter. Keys
    and values can be no longer than 63 characters and no more
    than 128 bytes.


    Prefix "sys-" is reserved for Dialogflow defined labels.
    Currently allowed Dialogflow defined labels include:


    -  sys-head
    -  sys-contextual The above labels do not require value.
       "sys-head" means the intent is a head intent.
       "sys.contextual" means the intent is a contextual intent.
description (str):
    Human readable description for better
    understanding an intent like its scope, content,
    result etc. Maximum character limit: 140
    characters.

IntentCoverage

Intent coverage represents the percentage of all possible intents in the agent that are triggered in any of a parent's test cases.

Attributes: intents (Sequence[google.cloud.dialogflowcx_v3.types.IntentCoverage.Intent]): The list of Intents present in the agent coverage_score (float): The percent of intents in the agent that are covered.

IntentInput

Represents the intent to trigger programmatically rather than as a result of natural language processing.

Attributes: intent (str): Required. The unique identifier of the intent. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

IntentView

Represents the options for views of an intent. An intent can be a sizable object. Therefore, we provide a resource view that does not return training phrases in the response.

ListAgentsRequest

The request message for [Agents.ListAgents][google.cloud.dialogflow.cx.v3.Agents.ListAgents].

Attributes: parent (str): Required. The location to list all agents for. Format: projects/<Project ID>/locations/<Location ID>. page_size (int): The maximum number of items to return in a single page. By default 100 and at most 1000. page_token (str): The next_page_token value returned from a previous list request.

ListAgentsResponse

The response message for [Agents.ListAgents][google.cloud.dialogflow.cx.v3.Agents.ListAgents].

Attributes: agents (Sequence[google.cloud.dialogflowcx_v3.types.Agent]): The list of agents. There will be a maximum number of items returned based on the page_size field in the request. next_page_token (str): Token to retrieve the next page of results, or empty if there are no more results in the list.

ListContinuousTestResultsRequest

The request message for [Environments.ListContinuousTestResults][google.cloud.dialogflow.cx.v3.Environments.ListContinuousTestResults].

Attributes: parent (str): Required. The environment to list results for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/ environments/<Environment ID>. page_size (int): The maximum number of items to return in a single page. By default 100 and at most 1000. page_token (str): The next_page_token value returned from a previous list request.

ListContinuousTestResultsResponse

The response message for [Environments.ListTestCaseResults][]. Attributes: continuous_test_results (Sequence[google.cloud.dialogflowcx_v3.types.ContinuousTestResult]): The list of continuous test results. next_page_token (str): Token to retrieve the next page of results, or empty if there are no more results in the list.

ListEntityTypesRequest

The request message for [EntityTypes.ListEntityTypes][google.cloud.dialogflow.cx.v3.EntityTypes.ListEntityTypes].

Attributes: parent (str): Required. The agent to list all entity types for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. language_code (str): The language to list entity types for. The following fields are language dependent:

    -  ``EntityType.entities.value``
    -  ``EntityType.entities.synonyms``
    -  ``EntityType.excluded_phrases.value``


    If not specified, the agent's default language is used.
    `Many
    languages <https://cloud.google.com/dialogflow/cx/docs/reference/language>`__
    are supported. Note: languages must be enabled in the agent
    before they can be used.
page_size (int):
    The maximum number of items to return in a
    single page. By default 100 and at most 1000.
page_token (str):
    The next_page_token value returned from a previous list
    request.

ListEntityTypesResponse

The response message for [EntityTypes.ListEntityTypes][google.cloud.dialogflow.cx.v3.EntityTypes.ListEntityTypes].

Attributes: entity_types (Sequence[google.cloud.dialogflowcx_v3.types.EntityType]): The list of entity types. There will be a maximum number of items returned based on the page_size field in the request. next_page_token (str): Token to retrieve the next page of results, or empty if there are no more results in the list.

ListEnvironmentsRequest

The request message for [Environments.ListEnvironments][google.cloud.dialogflow.cx.v3.Environments.ListEnvironments].

Attributes: parent (str): Required. The [Agent][google.cloud.dialogflow.cx.v3.Agent] to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. page_size (int): The maximum number of items to return in a single page. By default 20 and at most 100. page_token (str): The next_page_token value returned from a previous list request.

ListEnvironmentsResponse

The response message for [Environments.ListEnvironments][google.cloud.dialogflow.cx.v3.Environments.ListEnvironments].

Attributes: environments (Sequence[google.cloud.dialogflowcx_v3.types.Environment]): The list of environments. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn't the last page. next_page_token (str): Token to retrieve the next page of results, or empty if there are no more results in the list.

ListExperimentsRequest

The request message for [Experiments.ListExperiments][google.cloud.dialogflow.cx.v3.Experiments.ListExperiments].

Attributes: parent (str): Required. The [Environment][google.cloud.dialogflow.cx.v3.Environment] to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>. page_size (int): The maximum number of items to return in a single page. By default 20 and at most 100. page_token (str): The next_page_token value returned from a previous list request.

ListExperimentsResponse

The response message for [Experiments.ListExperiments][google.cloud.dialogflow.cx.v3.Experiments.ListExperiments].

Attributes: experiments (Sequence[google.cloud.dialogflowcx_v3.types.Experiment]): The list of experiments. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn't the last page. next_page_token (str): Token to retrieve the next page of results, or empty if there are no more results in the list.

ListFlowsRequest

The request message for [Flows.ListFlows][google.cloud.dialogflow.cx.v3.Flows.ListFlows].

Attributes: parent (str): Required. The agent containing the flows. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. page_size (int): The maximum number of items to return in a single page. By default 100 and at most 1000. page_token (str): The next_page_token value returned from a previous list request. language_code (str): The language to list flows for. The following fields are language dependent:

    -  ``Flow.event_handlers.trigger_fulfillment.messages``
    -  ``Flow.event_handlers.trigger_fulfillment.conditional_cases``
    -  ``Flow.transition_routes.trigger_fulfillment.messages``
    -  ``Flow.transition_routes.trigger_fulfillment.conditional_cases``


    If not specified, the agent's default language is used.
    `Many
    languages <https://cloud.google.com/dialogflow/cx/docs/reference/language>`__
    are supported. Note: languages must be enabled in the agent
    before they can be used.

ListFlowsResponse

The response message for [Flows.ListFlows][google.cloud.dialogflow.cx.v3.Flows.ListFlows].

Attributes: flows (Sequence[google.cloud.dialogflowcx_v3.types.Flow]): The list of flows. There will be a maximum number of items returned based on the page_size field in the request. next_page_token (str): Token to retrieve the next page of results, or empty if there are no more results in the list.

ListIntentsRequest

The request message for [Intents.ListIntents][google.cloud.dialogflow.cx.v3.Intents.ListIntents].

Attributes: parent (str): Required. The agent to list all intents for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. language_code (str): The language to list intents for. The following fields are language dependent:

    -  ``Intent.training_phrases.parts.text``


    If not specified, the agent's default language is used.
    `Many
    languages <https://cloud.google.com/dialogflow/cx/docs/reference/language>`__
    are supported. Note: languages must be enabled in the agent
    before they can be used.
intent_view (google.cloud.dialogflowcx_v3.types.IntentView):
    The resource view to apply to the returned
    intent.
page_size (int):
    The maximum number of items to return in a
    single page. By default 100 and at most 1000.
page_token (str):
    The next_page_token value returned from a previous list
    request.

ListIntentsResponse

The response message for [Intents.ListIntents][google.cloud.dialogflow.cx.v3.Intents.ListIntents].

Attributes: intents (Sequence[google.cloud.dialogflowcx_v3.types.Intent]): The list of intents. There will be a maximum number of items returned based on the page_size field in the request. next_page_token (str): Token to retrieve the next page of results, or empty if there are no more results in the list.

ListPagesRequest

The request message for [Pages.ListPages][google.cloud.dialogflow.cx.v3.Pages.ListPages].

Attributes: parent (str): Required. The flow to list all pages for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>. language_code (str): The language to list pages for. The following fields are language dependent:

    -  ``Page.entry_fulfillment.messages``
    -  ``Page.entry_fulfillment.conditional_cases``
    -  ``Page.event_handlers.trigger_fulfillment.messages``
    -  ``Page.event_handlers.trigger_fulfillment.conditional_cases``
    -  ``Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages``
    -


    ``Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases``


    -  ``Page.form.parameters.fill_behavior.reprompt_event_handlers.messages``
    -


    ``Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases``


    -  ``Page.transition_routes.trigger_fulfillment.messages``
    -  ``Page.transition_routes.trigger_fulfillment.conditional_cases``


    If not specified, the agent's default language is used.
    `Many
    languages <https://cloud.google.com/dialogflow/cx/docs/reference/language>`__
    are supported. Note: languages must be enabled in the agent
    before they can be used.
page_size (int):
    The maximum number of items to return in a
    single page. By default 100 and at most 1000.
page_token (str):
    The next_page_token value returned from a previous list
    request.

ListPagesResponse

The response message for [Pages.ListPages][google.cloud.dialogflow.cx.v3.Pages.ListPages].

Attributes: pages (Sequence[google.cloud.dialogflowcx_v3.types.Page]): The list of pages. There will be a maximum number of items returned based on the page_size field in the request. next_page_token (str): Token to retrieve the next page of results, or empty if there are no more results in the list.

ListSecuritySettingsRequest

The request message for [SecuritySettings.ListSecuritySettings][]. Attributes: parent (str): Required. The location to list all security settings for. Format: projects/<Project ID>/locations/<Location ID>. page_size (int): The maximum number of items to return in a single page. By default 20 and at most 100. page_token (str): The next_page_token value returned from a previous list request.

ListSecuritySettingsResponse

The response message for [SecuritySettings.ListSecuritySettings][]. Attributes: security_settings (Sequence[google.cloud.dialogflowcx_v3.types.SecuritySettings]): The list of security settings. next_page_token (str): Token to retrieve the next page of results, or empty if there are no more results in the list.

ListSessionEntityTypesRequest

The request message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.cx.v3.SessionEntityTypes.ListSessionEntityTypes].

Attributes: parent (str): Required. The session to list all session entity types from. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default 'draft' environment. page_size (int): The maximum number of items to return in a single page. By default 100 and at most 1000. page_token (str): The next_page_token value returned from a previous list request.

ListSessionEntityTypesResponse

The response message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.cx.v3.SessionEntityTypes.ListSessionEntityTypes].

Attributes: session_entity_types (Sequence[google.cloud.dialogflowcx_v3.types.SessionEntityType]): The list of session entity types. There will be a maximum number of items returned based on the page_size field in the request. next_page_token (str): Token to retrieve the next page of results, or empty if there are no more results in the list.

ListTestCaseResultsRequest

The request message for [TestCases.ListTestCaseResults][google.cloud.dialogflow.cx.v3.TestCases.ListTestCaseResults].

Attributes: parent (str): Required. The test case to list results for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/ testCases/<TestCase ID>. Specify a - as a wildcard for TestCase ID to list results across multiple test cases. page_size (int): The maximum number of items to return in a single page. By default 100 and at most 1000. page_token (str): The next_page_token value returned from a previous list request. filter (str): The filter expression used to filter test case results. See API Filtering <https://aip.dev/160>__.

    The expression is case insensitive. Only 'AND' is supported
    for logical operators. The supported syntax is listed below
    in detail:


     [AND ] ... [AND latest]


    The supported fields and operators are: field operator
    ``environment`` ``=``, ``IN`` (Use value ``draft`` for draft
    environment) ``test_time`` ``>``, ``<``


    ``latest`` only returns the latest test result in all
    results for each test case.


    Examples:


    -  "environment=draft AND latest" matches the latest test
       result for each test case in the draft environment.
    -  "environment IN (e1,e2)" matches any test case results
       with an environment resource name of either "e1" or "e2".
    -  "test_time > 1602540713" matches any test case results
       with test time later than a unix timestamp in seconds
       1602540713.

ListTestCaseResultsResponse

The response message for [TestCases.ListTestCaseResults][google.cloud.dialogflow.cx.v3.TestCases.ListTestCaseResults].

Attributes: test_case_results (Sequence[google.cloud.dialogflowcx_v3.types.TestCaseResult]): The list of test case results. next_page_token (str): Token to retrieve the next page of results, or empty if there are no more results in the list.

ListTestCasesRequest

The request message for [TestCases.ListTestCases][google.cloud.dialogflow.cx.v3.TestCases.ListTestCases].

Attributes: parent (str): Required. The agent to list all pages for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. page_size (int): The maximum number of items to return in a single page. By default 20. Note that when TestCaseView = FULL, the maximum page size allowed is 20. When TestCaseView = BASIC, the maximum page size allowed is 500. page_token (str): The next_page_token value returned from a previous list request. view (google.cloud.dialogflowcx_v3.types.ListTestCasesRequest.TestCaseView): Specifies whether response should include all fields or just the metadata.

ListTestCasesResponse

The response message for [TestCases.ListTestCases][google.cloud.dialogflow.cx.v3.TestCases.ListTestCases].

Attributes: test_cases (Sequence[google.cloud.dialogflowcx_v3.types.TestCase]): The list of test cases. There will be a maximum number of items returned based on the page_size field in the request. next_page_token (str): Token to retrieve the next page of results, or empty if there are no more results in the list.

ListTransitionRouteGroupsRequest

The request message for [TransitionRouteGroups.ListTransitionRouteGroups][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.ListTransitionRouteGroups].

Attributes: parent (str): Required. The flow to list all transition route groups for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>. page_size (int): The maximum number of items to return in a single page. By default 100 and at most 1000. page_token (str): The next_page_token value returned from a previous list request. language_code (str): The language to list transition route groups for. The following fields are language dependent:

    -  ``TransitionRouteGroup.transition_routes.trigger_fulfillment.messages``
    -


    ``TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases``


    If not specified, the agent's default language is used.
    `Many
    languages <https://cloud.google.com/dialogflow/cx/docs/reference/language>`__
    are supported. Note: languages must be enabled in the agent
    before they can be used.

ListTransitionRouteGroupsResponse

The response message for [TransitionRouteGroups.ListTransitionRouteGroups][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.ListTransitionRouteGroups].

Attributes: transition_route_groups (Sequence[google.cloud.dialogflowcx_v3.types.TransitionRouteGroup]): The list of transition route groups. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn't the last page. next_page_token (str): Token to retrieve the next page of results, or empty if there are no more results in the list.

ListVersionsRequest

The request message for [Versions.ListVersions][google.cloud.dialogflow.cx.v3.Versions.ListVersions].

Attributes: parent (str): Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to list all versions for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>. page_size (int): The maximum number of items to return in a single page. By default 20 and at most 100. page_token (str): The next_page_token value returned from a previous list request.

ListVersionsResponse

The response message for [Versions.ListVersions][google.cloud.dialogflow.cx.v3.Versions.ListVersions].

Attributes: versions (Sequence[google.cloud.dialogflowcx_v3.types.Version]): A list of versions. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn't the last page. next_page_token (str): Token to retrieve the next page of results, or empty if there are no more results in the list.

ListWebhooksRequest

The request message for [Webhooks.ListWebhooks][google.cloud.dialogflow.cx.v3.Webhooks.ListWebhooks].

Attributes: parent (str): Required. The agent to list all webhooks for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. page_size (int): The maximum number of items to return in a single page. By default 100 and at most 1000. page_token (str): The next_page_token value returned from a previous list request.

ListWebhooksResponse

The response message for [Webhooks.ListWebhooks][google.cloud.dialogflow.cx.v3.Webhooks.ListWebhooks].

Attributes: webhooks (Sequence[google.cloud.dialogflowcx_v3.types.Webhook]): The list of webhooks. There will be a maximum number of items returned based on the page_size field in the request. next_page_token (str): Token to retrieve the next page of results, or empty if there are no more results in the list.

LoadVersionRequest

The request message for [Versions.LoadVersion][google.cloud.dialogflow.cx.v3.Versions.LoadVersion].

Attributes: name (str): Required. The [Version][google.cloud.dialogflow.cx.v3.Version] to be loaded to draft flow. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>. allow_override_agent_resources (bool): This field is used to prevent accidental overwrite of other agent resources, which can potentially impact other flow's behavior. If allow_override_agent_resources is false, conflicted agent-level resources will not be overridden (i.e. intents, entities, webhooks).

LookupEnvironmentHistoryRequest

The request message for [Environments.LookupEnvironmentHistory][google.cloud.dialogflow.cx.v3.Environments.LookupEnvironmentHistory].

Attributes: name (str): Required. Resource name of the environment to look up the history for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>. page_size (int): The maximum number of items to return in a single page. By default 100 and at most 1000. page_token (str): The next_page_token value returned from a previous list request.

LookupEnvironmentHistoryResponse

The response message for [Environments.LookupEnvironmentHistory][google.cloud.dialogflow.cx.v3.Environments.LookupEnvironmentHistory].

Attributes: environments (Sequence[google.cloud.dialogflowcx_v3.types.Environment]): Represents a list of snapshots for an environment. Time of the snapshots is stored in [update_time][google.cloud.dialogflow.cx.v3.Environment.update_time]. next_page_token (str): Token to retrieve the next page of results, or empty if there are no more results in the list.

Match

Represents one match result of [MatchIntent][]. Attributes: intent (google.cloud.dialogflowcx_v3.types.Intent): The [Intent][google.cloud.dialogflow.cx.v3.Intent] that matched the query. Some, not all fields are filled in this message, including but not limited to: name and display_name. Only filled for [INTENT][google.cloud.dialogflow.cx.v3.Match.MatchType] match type. event (str): The event that matched the query. Only filled for [EVENT][google.cloud.dialogflow.cx.v3.Match.MatchType] match type. parameters (google.protobuf.struct_pb2.Struct): The collection of parameters extracted from the query. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:

MapKey type: string
MapKey value: parameter name
MapValue type:
- If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map
MapValue value:
- If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value resolved_input (str): Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing. match_type (google.cloud.dialogflowcx_v3.types.Match.MatchType): Type of this [Match][google.cloud.dialogflow.cx.v3.Match]. confidence (float): The confidence of this match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation.

MatchIntentRequest

Request of [MatchIntent][]. Attributes: session (str): Required. The name of the session this query is sent to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters.

    For more information, see the `sessions
    guide <https://cloud.google.com/dialogflow/cx/docs/concept/session>`__.
query_params (google.cloud.dialogflowcx_v3.types.QueryParameters):
    The parameters of this query.
query_input (google.cloud.dialogflowcx_v3.types.QueryInput):
    Required. The input specification.

MatchIntentResponse

Response of [MatchIntent][]. Attributes: text (str): If [natural language text][google.cloud.dialogflow.cx.v3.TextInput] was provided as input, this field will contain a copy of the text. trigger_intent (str): If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as input, this field will contain a copy of the intent identifier. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>. transcript (str): If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, this field will contain the transcript for the audio. trigger_event (str): If an [event][google.cloud.dialogflow.cx.v3.EventInput] was provided as input, this field will contain a copy of the event name. matches (Sequence[google.cloud.dialogflowcx_v3.types.Match]): Match results, if more than one, ordered descendingly by the confidence we have that the particular intent matches the query. current_page (google.cloud.dialogflowcx_v3.types.Page): The current [Page][google.cloud.dialogflow.cx.v3.Page]. Some, not all fields are filled in this message, including but not limited to name and display_name.

NluSettings

Settings related to NLU. Attributes: model_type (google.cloud.dialogflowcx_v3.types.NluSettings.ModelType): Indicates the type of NLU model. classification_threshold (float): To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. model_training_mode (google.cloud.dialogflowcx_v3.types.NluSettings.ModelTrainingMode): Indicates NLU model training mode.

OutputAudioConfig

Instructs the speech synthesizer how to generate the output audio content.

Attributes: audio_encoding (google.cloud.dialogflowcx_v3.types.OutputAudioEncoding): Required. Audio encoding of the synthesized audio content. sample_rate_hertz (int): Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality). synthesize_speech_config (google.cloud.dialogflowcx_v3.types.SynthesizeSpeechConfig): Optional. Configuration of how speech should be synthesized.

OutputAudioEncoding

Audio encoding of the output audio format in Text-To-Speech.

Page

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

Attributes: name (str): The unique identifier of the page. Required for the [Pages.UpdatePage][google.cloud.dialogflow.cx.v3.Pages.UpdatePage] method. [Pages.CreatePage][google.cloud.dialogflow.cx.v3.Pages.CreatePage] populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>. display_name (str): Required. The human-readable name of the page, unique within the agent. entry_fulfillment (google.cloud.dialogflowcx_v3.types.Fulfillment): The fulfillment to call when the session is entering the page. form (google.cloud.dialogflowcx_v3.types.Form): The form associated with the page, used for collecting parameters relevant to the page. transition_route_groups (Sequence[str]): Ordered list of [TransitionRouteGroups][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] associated with the page. Transition route groups must be unique within a page.

    -  If multiple transition routes within a page scope refer
       to the same intent, then the precedence order is: page's
       transition route -> page's transition route group ->
       flow's transition routes.


    -  If multiple transition route groups within a page contain
       the same intent, then the first group in the ordered list
       takes precedence.


    Format:\ ``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>``.
transition_routes (Sequence[google.cloud.dialogflowcx_v3.types.TransitionRoute]):
    A list of transitions for the transition rules of this page.
    They route the conversation to another page in the same
    flow, or another flow.


    When we are in a certain page, the TransitionRoutes are
    evalauted in the following order:


    -  TransitionRoutes defined in the page with intent
       specified.
    -  TransitionRoutes defined in the [transition route
       groups][google.cloud.dialogflow.cx.v3.Page.transition_route_groups]
       with intent specified.
    -  TransitionRoutes defined in flow with intent specified.
    -  TransitionRoutes defined in the [transition route
       groups][google.cloud.dialogflow.cx.v3.Flow.transition_route_groups]
       with intent specified.
    -  TransitionRoutes defined in the page with only condition
       specified.
    -  TransitionRoutes defined in the [transition route
       groups][google.cloud.dialogflow.cx.v3.Page.transition_route_groups]
       with only condition specified.
event_handlers (Sequence[google.cloud.dialogflowcx_v3.types.EventHandler]):
    Handlers associated with the page to handle
    events such as webhook errors, no match or no
    input.

PageInfo

Represents page information communicated to and from the webhook.

Attributes: current_page (str): Always present for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Ignored for [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. The unique identifier of the current page. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>. form_info (google.cloud.dialogflowcx_v3.types.PageInfo.FormInfo): Optional for both [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest] and [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. Information about the form.

QueryInput

Represents the query input. It can contain one of:

A conversational query in the form of text.
An intent query that specifies which intent to trigger.
Natural language speech audio to be processed.
An event to be triggered.

Attributes: text (google.cloud.dialogflowcx_v3.types.TextInput): The natural language text to be processed. intent (google.cloud.dialogflowcx_v3.types.IntentInput): The intent to be triggered. audio (google.cloud.dialogflowcx_v3.types.AudioInput): The natural language speech audio to be processed. event (google.cloud.dialogflowcx_v3.types.EventInput): The event to be triggered. dtmf (google.cloud.dialogflowcx_v3.types.DtmfInput): The DTMF event to be handled. language_code (str): Required. The language of the input. See Language Support <https://cloud.google.com/dialogflow/cx/docs/reference/language>__ for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.

QueryParameters

Represents the parameters of a conversational query. Attributes: time_zone (str): The time zone of this conversational query from the time zone database <https://www.iana.org/time-zones>__, e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in the agent is used. geo_location (google.type.latlng_pb2.LatLng): The geo location of this conversational query. session_entity_types (Sequence[google.cloud.dialogflowcx_v3.types.SessionEntityType]): Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. payload (google.protobuf.struct_pb2.Struct): This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form:

    ::


       {
        "telephony": {
          "caller_id": "+18558363987"
        }
       }
parameters (google.protobuf.struct_pb2.Struct):
    Additional parameters to be put into [session
    parameters][SessionInfo.parameters]. To remove a parameter
    from the session, clients should explicitly set the
    parameter value to null.


    You can reference the session parameters in the agent with
    the following format: $session.params.parameter-id.


    Depending on your protocol or client library language, this
    is a map, associative array, symbol table, dictionary, or
    JSON object composed of a collection of (MapKey, MapValue)
    pairs:


    -  MapKey type: string
    -  MapKey value: parameter name
    -  MapValue type:


       -  If parameter's entity type is a composite entity: map
       -  Else: depending on parameter value type, could be one
          of string, number, boolean, null, list or map


    -  MapValue value:


       -  If parameter's entity type is a composite entity: map
          from composite entity property names to property
          values
       -  Else: parameter value
current_page (str):
    The unique identifier of the
    [page][google.cloud.dialogflow.cx.v3.Page] to override the
    [current page][QueryResult.current_page] in the session.
    Format:
    ``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>``.


    If ``current_page`` is specified, the previous state of the
    session will be ignored by Dialogflow, including the
    [previous page][QueryResult.current_page] and the [previous
    session parameters][QueryResult.parameters]. In most cases,
    [current_page][google.cloud.dialogflow.cx.v3.QueryParameters.current_page]
    and
    [parameters][google.cloud.dialogflow.cx.v3.QueryParameters.parameters]
    should be configured together to direct a session to a
    specific state.
disable_webhook (bool):
    Whether to disable webhook calls for this
    request.
analyze_query_text_sentiment (bool):
    Configures whether sentiment analysis should
    be performed. If not provided, sentiment
    analysis is not performed.
webhook_headers (Sequence[google.cloud.dialogflowcx_v3.types.QueryParameters.WebhookHeadersEntry]):
    This field can be used to pass HTTP headers
    for a webhook call. These headers will be sent
    to webhook along with the headers that have been
    configured through Dialogflow web console. The
    headers defined within this field will overwrite
    the headers configured through Dialogflow
    console if there is a conflict. Header names are
    case-insensitive. Google's specified headers are
    not allowed. Including: "Host", "Content-
    Length", "Connection", "From", "User-Agent",
    "Accept-Encoding", "If-Modified-Since", "If-
    None-Match", "X-Forwarded-For", etc.

QueryResult

Represents the result of a conversational query. Attributes: text (str): If [natural language text][google.cloud.dialogflow.cx.v3.TextInput] was provided as input, this field will contain a copy of the text. trigger_intent (str): If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as input, this field will contain a copy of the intent identifier. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>. transcript (str): If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, this field will contain the transcript for the audio. trigger_event (str): If an [event][google.cloud.dialogflow.cx.v3.EventInput] was provided as input, this field will contain the name of the event. language_code (str): The language that was triggered during intent detection. See Language Support <https://cloud.google.com/dialogflow/cx/docs/reference/language>__ for a list of the currently supported language codes. parameters (google.protobuf.struct_pb2.Struct): The collected [session parameters][google.cloud.dialogflow.cx.v3.SessionInfo.parameters].

    Depending on your protocol or client library language, this
    is a map, associative array, symbol table, dictionary, or
    JSON object composed of a collection of (MapKey, MapValue)
    pairs:


    -  MapKey type: string
    -  MapKey value: parameter name
    -  MapValue type:


       -  If parameter's entity type is a composite entity: map
       -  Else: depending on parameter value type, could be one
          of string, number, boolean, null, list or map


    -  MapValue value:


       -  If parameter's entity type is a composite entity: map
          from composite entity property names to property
          values
       -  Else: parameter value
response_messages (Sequence[google.cloud.dialogflowcx_v3.types.ResponseMessage]):
    The list of rich messages returned to the
    client. Responses vary from simple text messages
    to more sophisticated, structured payloads used
    to drive complex logic.
webhook_statuses (Sequence[google.rpc.status_pb2.Status]):
    The list of webhook call status in the order
    of call sequence.
webhook_payloads (Sequence[google.protobuf.struct_pb2.Struct]):
    The list of webhook payload in
    [WebhookResponse.payload][google.cloud.dialogflow.cx.v3.WebhookResponse.payload],
    in the order of call sequence. If some webhook call fails or
    doesn't return any payload, an empty ``Struct`` would be
    used instead.
current_page (google.cloud.dialogflowcx_v3.types.Page):
    The current [Page][google.cloud.dialogflow.cx.v3.Page].
    Some, not all fields are filled in this message, including
    but not limited to ``name`` and ``display_name``.
intent (google.cloud.dialogflowcx_v3.types.Intent):
    The [Intent][google.cloud.dialogflow.cx.v3.Intent] that
    matched the conversational query. Some, not all fields are
    filled in this message, including but not limited to:
    ``name`` and ``display_name``. This field is deprecated,
    please use
    [QueryResult.match][google.cloud.dialogflow.cx.v3.QueryResult.match]
    instead.
intent_detection_confidence (float):
    The intent detection confidence. Values range from 0.0
    (completely uncertain) to 1.0 (completely certain). This
    value is for informational purpose only and is only used to
    help match the best intent within the classification
    threshold. This value may change for the same end-user
    expression at any time due to a model retraining or change
    in implementation. This field is deprecated, please use
    [QueryResult.match][google.cloud.dialogflow.cx.v3.QueryResult.match]
    instead.
match (google.cloud.dialogflowcx_v3.types.Match):
    Intent match result, could be an intent or an
    event.
diagnostic_info (google.protobuf.struct_pb2.Struct):
    The free-form diagnostic info. For example,
    this field could contain webhook call latency.
    The string keys of the Struct's fields map can
    change without notice.
sentiment_analysis_result (google.cloud.dialogflowcx_v3.types.SentimentAnalysisResult):
    The sentiment analyss result, which depends on
    [``analyze_query_text_sentiment``]
    [google.cloud.dialogflow.cx.v3.QueryParameters.analyze_query_text_sentiment],
    specified in the request.

ResourceName

Resource name and display name. Attributes: name (str): Name. display_name (str): Display name.

ResponseMessage

Represents a response message that can be returned by a conversational agent.

Response messages are also used for output audio synthesis. The approach is as follows:

If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis.
If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design.
Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis.

This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.

Attributes: text (google.cloud.dialogflowcx_v3.types.ResponseMessage.Text): Returns a text response. payload (google.protobuf.struct_pb2.Struct): Returns a response containing a custom, platform-specific payload. conversation_success (google.cloud.dialogflowcx_v3.types.ResponseMessage.ConversationSuccess): Indicates that the conversation succeeded. output_audio_text (google.cloud.dialogflowcx_v3.types.ResponseMessage.OutputAudioText): A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. live_agent_handoff (google.cloud.dialogflowcx_v3.types.ResponseMessage.LiveAgentHandoff): Hands off conversation to a human agent. end_interaction (google.cloud.dialogflowcx_v3.types.ResponseMessage.EndInteraction): Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches END_SESSION page. It is not supposed to be defined by the user.

    It's guaranteed that there is at most one such message in
    each response.
play_audio (google.cloud.dialogflowcx_v3.types.ResponseMessage.PlayAudio):
    Signal that the client should play an audio clip hosted at a
    client-specific URI. Dialogflow uses this to construct
    [mixed_audio][google.cloud.dialogflow.cx.v3.ResponseMessage.mixed_audio].
    However, Dialogflow itself does not try to read or process
    the URI in any way.
mixed_audio (google.cloud.dialogflowcx_v3.types.ResponseMessage.MixedAudio):
    Output only. An audio response message composed of both the
    synthesized Dialogflow agent responses and responses defined
    via
    [play_audio][google.cloud.dialogflow.cx.v3.ResponseMessage.play_audio].
    This message is generated by Dialogflow only and not
    supposed to be defined by the user.

RestoreAgentRequest

The request message for [Agents.RestoreAgent][google.cloud.dialogflow.cx.v3.Agents.RestoreAgent].

Attributes: name (str): Required. The name of the agent to restore into. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. agent_uri (str): The Google Cloud Storage <https://cloud.google.com/storage/docs/>__ URI to restore agent from. The format of this URI must be gs://<bucket-name>/<object-name>. agent_content (bytes): Uncompressed raw byte content for agent. restore_option (google.cloud.dialogflowcx_v3.types.RestoreAgentRequest.RestoreOption): Agent restore mode. If not specified, KEEP is assumed.

RunContinuousTestMetadata

Metadata returned for the [Environments.RunContinuousTest][google.cloud.dialogflow.cx.v3.Environments.RunContinuousTest] long running operation.

Attributes: errors (Sequence[google.cloud.dialogflowcx_v3.types.TestError]): The test errors.

RunContinuousTestRequest

The request message for [Environments.RunContinuousTest][google.cloud.dialogflow.cx.v3.Environments.RunContinuousTest].

Attributes: environment (str): Required. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

RunContinuousTestResponse

The response message for [Environments.RunContinuousTest][google.cloud.dialogflow.cx.v3.Environments.RunContinuousTest].

Attributes: continuous_test_result (google.cloud.dialogflowcx_v3.types.ContinuousTestResult): The result for a continuous test run.

RunTestCaseMetadata

Metadata returned for the [TestCases.RunTestCase][google.cloud.dialogflow.cx.v3.TestCases.RunTestCase] long running operation.

RunTestCaseRequest

The request message for [TestCases.RunTestCase][google.cloud.dialogflow.cx.v3.TestCases.RunTestCase].

Attributes: name (str): Required. Format of test case name to run: projects/<Project ID>/locations/ <Location ID>/agents/<AgentID>/testCases/<TestCase ID>. environment (str): Optional. Environment name. If not set, draft environment is assumed. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

RunTestCaseResponse

The response message for [TestCases.RunTestCase][google.cloud.dialogflow.cx.v3.TestCases.RunTestCase].

Attributes: result (google.cloud.dialogflowcx_v3.types.TestCaseResult): The result.

SecuritySettings

Represents the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.

Attributes: name (str): Required. Resource name of the settings. Format: projects/<Project ID>/locations/<Location ID>/securitySettings/<Security Settings ID>. display_name (str): Required. The human-readable name of the security settings, unique within the location. redaction_strategy (google.cloud.dialogflowcx_v3.types.SecuritySettings.RedactionStrategy): Strategy that defines how we do redaction. redaction_scope (google.cloud.dialogflowcx_v3.types.SecuritySettings.RedactionScope): Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging. inspect_template (str): DLP inspect template name. Use this template to define inspect base settings.

    If empty, we use the default DLP inspect config.


    The template name will have one of the following formats:
    ``projects/<Project ID>/inspectTemplates/<Template ID>`` OR
    ``projects/<Project ID>/locations/<Location ID>/inspectTemplates/<Template ID>``
    OR
    ``organizations/<Organization ID>/inspectTemplates/<Template ID>``
retention_window_days (int):
    Retains data in interaction logging for the
    specified number of days. This does not apply to
    Cloud logging, which is owned by the user - not
    Dialogflow.
    User must Set a value lower than Dialogflow's
    default 30d TTL. Setting a value higher than
    that has no effect.
    A missing value or setting to 0 also means we
    use Dialogflow's default TTL.
    Note: Interaction logging is a limited access
    feature. Talk to your Google representative to
    check availability for you.
purge_data_types (Sequence[google.cloud.dialogflowcx_v3.types.SecuritySettings.PurgeDataType]):
    List of types of data to remove when
    retention settings triggers purge.

SentimentAnalysisResult

The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral.

Attributes: score (float): Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). magnitude (float): A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative).

SessionEntityType

Session entity types are referred to as User entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on.

You can redefine a session entity type at the session level to extend or replace a [custom entity type][google.cloud.dialogflow.cx.v3.EntityType] at the user session level (we refer to the entity types defined at the agent level as "custom entity types").

Note: session entity types apply to all queries, regardless of the language.

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

Attributes: name (str): Required. The unique identifier of the session entity type. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>. If Environment ID is not specified, we assume default 'draft' environment. entity_override_mode (google.cloud.dialogflowcx_v3.types.SessionEntityType.EntityOverrideMode): Required. Indicates whether the additional data should override or supplement the custom entity type definition. entities (Sequence[google.cloud.dialogflowcx_v3.types.EntityType.Entity]): Required. The collection of entities to override or supplement the custom entity type.

SessionInfo

Represents session information communicated to and from the webhook.

Attributes: session (str): Always present for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Ignored for [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. The unique identifier of the [session][google.cloud.dialogflow.cx.v3.DetectIntentRequest.session]. This field can be used by the webhook to identify a session. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID> if environment is specified. parameters (Sequence[google.cloud.dialogflowcx_v3.types.SessionInfo.ParametersEntry]): Optional for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Optional for [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. All parameters collected from forms and intents during the session. Parameters can be created, updated, or removed by the webhook. To remove a parameter from the session, the webhook should explicitly set the parameter value to null in [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. The map is keyed by parameters' display names.

SpeechModelVariant

Variant of the specified [Speech model][google.cloud.dialogflow.cx.v3.InputAudioConfig.model] to use.

See the Cloud Speech documentation <https://cloud.google.com/speech-to-text/docs/enhanced-models>__ for which models have different variants. For example, the "phone_call" model has both a standard and an enhanced variant. When you use an enhanced model, you will generally receive higher quality results than for a standard model.

SpeechToTextSettings

Settings related to speech recognition. Attributes: enable_speech_adaptation (bool): Whether to use speech adaptation for speech recognition.

SpeechWordInfo

Information for a word recognized by the speech recognizer. Attributes: word (str): The word this info is for. start_offset (google.protobuf.duration_pb2.Duration): Time offset relative to the beginning of the audio that corresponds to the start of the spoken word. This is an experimental feature and the accuracy of the time offset can vary. end_offset (google.protobuf.duration_pb2.Duration): Time offset relative to the beginning of the audio that corresponds to the end of the spoken word. This is an experimental feature and the accuracy of the time offset can vary. confidence (float): The Speech confidence between 0.0 and 1.0 for this word. A higher number indicates an estimated greater likelihood that the recognized word is correct. The default of 0.0 is a sentinel value indicating that confidence was not set.

    This field is not guaranteed to be fully stable
    over time for the same audio input. Users should
    also not rely on it to always be provided.

SsmlVoiceGender

Gender of the voice as described in SSML voice element <https://www.w3.org/TR/speech-synthesis11/#edef_voice>__.

StartExperimentRequest

The request message for [Experiments.StartExperiment][google.cloud.dialogflow.cx.v3.Experiments.StartExperiment].

Attributes: name (str): Required. Resource name of the experiment to start. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID>.

StopExperimentRequest

The request message for [Experiments.StopExperiment][google.cloud.dialogflow.cx.v3.Experiments.StopExperiment].

Attributes: name (str): Required. Resource name of the experiment to stop. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID>.

StreamingDetectIntentRequest

The top-level message sent by the client to the [Sessions.StreamingDetectIntent][google.cloud.dialogflow.cx.v3.Sessions.StreamingDetectIntent] method.

Multiple request messages should be sent in order:

The first message must contain [session][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.session], [query_input][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.query_input] plus optionally [query_params][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.query_params]. If the client wants to receive an audio response, it should also contain [output_audio_config][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.output_audio_config].
If [query_input][google.cloud.dialogflow.cx.v3.StreamingDetectIntentRequest.query_input] was set to [query_input.audio.config][google.cloud.dialogflow.cx.v3.AudioInput.config], all subsequent messages must contain [query_input.audio.audio][google.cloud.dialogflow.cx.v3.AudioInput.audio] to continue with Speech recognition. If you decide to rather detect an intent from text input after you already started Speech recognition, please send a message with [query_input.text][google.cloud.dialogflow.cx.v3.QueryInput.text].

However, note that:

Dialogflow will bill you for the audio duration so far.
Dialogflow discards all Speech recognition results in favor of the input text.
Dialogflow will use the language code from the first message.

After you sent all input, you must half-close or abort the request stream.

Attributes: session (str): The name of the session this query is sent to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters. Note: session must be set in the first request.

    For more information, see the `sessions
    guide <https://cloud.google.com/dialogflow/cx/docs/concept/session>`__.


    Note: Always use agent versions for production traffic. See
    `Versions and
    environments <https://cloud.google.com/dialogflow/cx/docs/concept/version>`__.
query_params (google.cloud.dialogflowcx_v3.types.QueryParameters):
    The parameters of this query.
query_input (google.cloud.dialogflowcx_v3.types.QueryInput):
    Required. The input specification.
output_audio_config (google.cloud.dialogflowcx_v3.types.OutputAudioConfig):
    Instructs the speech synthesizer how to
    generate the output audio.
enable_partial_response (bool):
    Enable partial detect intent response. If this flag is not
    enabled, response stream still contains only one final
    ``DetectIntentResponse`` even if some ``Fulfillment``\ s in
    the agent have been configured to return partial responses.

StreamingDetectIntentResponse

The top-level message returned from the StreamingDetectIntent method.

Multiple response messages can be returned in order:

If the input was set to streaming audio, the first one or more messages contain recognition_result. Each recognition_result represents a more complete transcript of what the user said. The last recognition_result has is_final set to true.
If enable_partial_response is true, the following N messages (currently 1 <= N <= 4) contain detect_intent_response. The first (N-1) detect_intent_response\ s will have response_type set to PARTIAL. The last detect_intent_response has response_type set to FINAL. If response_type is false, response stream only contains the final detect_intent_response.

Attributes: recognition_result (google.cloud.dialogflowcx_v3.types.StreamingRecognitionResult): The result of speech recognition. detect_intent_response (google.cloud.dialogflowcx_v3.types.DetectIntentResponse): The response from detect intent.

StreamingRecognitionResult

Contains a speech recognition result corresponding to a portion of the audio that is currently being processed or an indication that this is the end of the single requested utterance.

Example:

transcript: "tube"
transcript: "to be a"
transcript: "to be"
transcript: "to be or not to be" is_final: true
transcript: " that's"
transcript: " that is"
message_type: END_OF_SINGLE_UTTERANCE
transcript: " that is the question" is_final: true

Only two of the responses contain final results (#4 and #8 indicated by is_final: true). Concatenating these generates the full transcript: "to be or not to be that is the question".

In each response we populate:

for TRANSCRIPT: transcript and possibly is_final.
for END_OF_SINGLE_UTTERANCE: only message_type.

Attributes: message_type (google.cloud.dialogflowcx_v3.types.StreamingRecognitionResult.MessageType): Type of the result message. transcript (str): Transcript text representing the words that the user spoke. Populated if and only if message_type = TRANSCRIPT. is_final (bool): If false, the StreamingRecognitionResult represents an interim result that may change. If true, the recognizer will not return any further hypotheses about this piece of the audio. May only be populated for message_type = TRANSCRIPT. confidence (float): The Speech confidence between 0.0 and 1.0 for the current portion of audio. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set.

    This field is typically only provided if ``is_final`` is
    true and you should not rely on it being accurate or even
    set.
stability (float):
    An estimate of the likelihood that the speech recognizer
    will not change its guess about this interim recognition
    result:


    -  If the value is unspecified or 0.0, Dialogflow didn't
       compute the stability. In particular, Dialogflow will
       only provide stability for ``TRANSCRIPT`` results with
       ``is_final = false``.
    -  Otherwise, the value is in (0.0, 1.0] where 0.0 means
       completely unstable and 1.0 means completely stable.
speech_word_info (Sequence[google.cloud.dialogflowcx_v3.types.SpeechWordInfo]):
    Word-specific information for the words recognized by Speech
    in
    [transcript][google.cloud.dialogflow.cx.v3.StreamingRecognitionResult.transcript].
    Populated if and only if ``message_type`` = ``TRANSCRIPT``
    and [InputAudioConfig.enable_word_info] is set.
speech_end_offset (google.protobuf.duration_pb2.Duration):
    Time offset of the end of this Speech recognition result
    relative to the beginning of the audio. Only populated for
    ``message_type`` = ``TRANSCRIPT``.

SynthesizeSpeechConfig

Configuration of how speech should be synthesized. Attributes: speaking_rate (float): Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. pitch (float): Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. volume_gain_db (float): Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. effects_profile_id (Sequence[str]): Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. voice (google.cloud.dialogflowcx_v3.types.VoiceSelectionParams): Optional. The desired voice of the synthesized audio.

TestCase

Represents a test case. Attributes: name (str): The unique identifier of the test case. [TestCases.CreateTestCase][google.cloud.dialogflow.cx.v3.TestCases.CreateTestCase] will populate the name automatically. Otherwise use format: projects/<Project ID>/locations/<LocationID>/agents/ <AgentID>/testCases/<TestCase ID>. tags (Sequence[str]): Tags are short descriptions that users may apply to test cases for organizational and filtering purposes. Each tag should start with "#" and has a limit of 30 characters. display_name (str): Required. The human-readable name of the test case, unique within the agent. Limit of 200 characters. notes (str): Additional freeform notes about the test case. Limit of 400 characters. test_config (google.cloud.dialogflowcx_v3.types.TestConfig): Config for the test case. test_case_conversation_turns (Sequence[google.cloud.dialogflowcx_v3.types.ConversationTurn]): The conversation turns uttered when the test case was created, in chronological order. These include the canonical set of agent utterances that should occur when the agent is working properly. creation_time (google.protobuf.timestamp_pb2.Timestamp): Output only. When the test was created. last_test_result (google.cloud.dialogflowcx_v3.types.TestCaseResult): The latest test result.

TestCaseError

Error info for importing a test. Attributes: test_case (google.cloud.dialogflowcx_v3.types.TestCase): The test case. status (google.rpc.status_pb2.Status): The status associated with the test case.

TestCaseResult

Represents a result from running a test case in an agent environment.

Attributes: name (str): The resource name for the test case result. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/testCases/ <TestCase ID>/results/<TestCaseResult ID>. environment (str): Environment where the test was run. If not set, it indicates the draft environment. conversation_turns (Sequence[google.cloud.dialogflowcx_v3.types.ConversationTurn]): The conversation turns uttered during the test case replay in chronological order. test_result (google.cloud.dialogflowcx_v3.types.TestResult): Whether the test case passed in the agent environment. test_time (google.protobuf.timestamp_pb2.Timestamp): The time that the test was run.

TestConfig

Represents configurations for a test case. Attributes: tracking_parameters (Sequence[str]): Session parameters to be compared when calculating differences. flow (str): Flow name. If not set, default start flow is assumed. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

TestError

Error info for running a test. Attributes: test_case (str): The test case resource name. status (google.rpc.status_pb2.Status): The status associated with the test. test_time (google.protobuf.timestamp_pb2.Timestamp): The timestamp when the test was completed.

TestResult

The test result for a test case and an agent environment.

TestRunDifference

The description of differences between original and replayed agent output.

Attributes: type_ (google.cloud.dialogflowcx_v3.types.TestRunDifference.DiffType): The type of diff. description (str): A description of the diff, showing the actual output vs expected output.

TextInput

Represents the natural language text to be processed. Attributes: text (str): Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters.

TrainFlowRequest

The request message for [Flows.TrainFlow][google.cloud.dialogflow.cx.v3.Flows.TrainFlow].

Attributes: name (str): Required. The flow to train. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

TransitionCoverage

Transition coverage represents the percentage of all possible page transitions (page-level transition routes and event handlers, excluding transition route groups) present within any of a parent's test cases.

Attributes: transitions (Sequence[google.cloud.dialogflowcx_v3.types.TransitionCoverage.Transition]): The list of Transitions present in the agent. coverage_score (float): The percent of transitions in the agent that are covered.

TransitionRoute

A transition route specifies a [intent][google.cloud.dialogflow.cx.v3.Intent] that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order:

If there is a [trigger_fulfillment][google.cloud.dialogflow.cx.v3.TransitionRoute.trigger_fulfillment] associated with the transition, it will be called.
If there is a [target_page][google.cloud.dialogflow.cx.v3.TransitionRoute.target_page] associated with the transition, the session will transition into the specified page.
If there is a [target_flow][google.cloud.dialogflow.cx.v3.TransitionRoute.target_flow] associated with the transition, the session will transition into the specified flow.

Attributes: name (str): Output only. The unique identifier of this transition route. intent (str): The unique identifier of an [Intent][google.cloud.dialogflow.cx.v3.Intent]. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. condition (str): The condition to evaluate against [form parameters][google.cloud.dialogflow.cx.v3.Form.parameters] or [session parameters][google.cloud.dialogflow.cx.v3.SessionInfo.parameters].

    See the `conditions
    reference <https://cloud.google.com/dialogflow/cx/docs/reference/condition>`__.
    At least one of ``intent`` or ``condition`` must be
    specified. When both ``intent`` and ``condition`` are
    specified, the transition can only happen when both are
    fulfilled.
trigger_fulfillment (google.cloud.dialogflowcx_v3.types.Fulfillment):
    The fulfillment to call when the condition is satisfied. At
    least one of ``trigger_fulfillment`` and ``target`` must be
    specified. When both are defined, ``trigger_fulfillment`` is
    executed first.
target_page (str):
    The target page to transition to. Format:
    ``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>``.
target_flow (str):
    The target flow to transition to. Format:
    ``projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>``.

TransitionRouteGroup

An TransitionRouteGroup represents a group of [TransitionRoutes][google.cloud.dialogflow.cx.v3.TransitionRoute] to be used by a [Page][google.cloud.dialogflow.cx.v3.Page].

Attributes: name (str): The unique identifier of the transition route group. [TransitionRouteGroups.CreateTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.CreateTransitionRouteGroup] populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID>. display_name (str): Required. The human-readable name of the transition route group, unique within the [Agent][google.cloud.dialogflow.cx.v3.Agent]. The display name can be no longer than 30 characters. transition_routes (Sequence[google.cloud.dialogflowcx_v3.types.TransitionRoute]): Transition routes associated with the [TransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].

TransitionRouteGroupCoverage

Transition route group coverage represents the percentage of all possible transition routes present within any of a parent's test cases. The results are grouped by the transition route group.

Attributes: coverages (Sequence[google.cloud.dialogflowcx_v3.types.TransitionRouteGroupCoverage.Coverage]): Transition route group coverages. coverage_score (float): The percent of transition routes in all the transition route groups that are covered.

UpdateAgentRequest

The request message for [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent].

Attributes: agent (google.cloud.dialogflowcx_v3.types.Agent): Required. The agent to update. 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.

UpdateEntityTypeRequest

The request message for [EntityTypes.UpdateEntityType][google.cloud.dialogflow.cx.v3.EntityTypes.UpdateEntityType].

Attributes: entity_type (google.cloud.dialogflowcx_v3.types.EntityType): Required. The entity type to update. language_code (str): The language of the following fields in entity_type:

    -  ``EntityType.entities.value``
    -  ``EntityType.entities.synonyms``
    -  ``EntityType.excluded_phrases.value``


    If not specified, the agent's default language is used.
    `Many
    languages <https://cloud.google.com/dialogflow/cx/docs/reference/language>`__
    are supported. Note: languages must be enabled in the agent
    before they can be used.
update_mask (google.protobuf.field_mask_pb2.FieldMask):
    The mask to control which fields get updated.

UpdateEnvironmentRequest

The request message for [Environments.UpdateEnvironment][google.cloud.dialogflow.cx.v3.Environments.UpdateEnvironment].

Attributes: environment (google.cloud.dialogflowcx_v3.types.Environment): Required. The environment to update. update_mask (google.protobuf.field_mask_pb2.FieldMask): Required. The mask to control which fields get updated.

UpdateExperimentRequest

The request message for [Experiments.UpdateExperiment][google.cloud.dialogflow.cx.v3.Experiments.UpdateExperiment].

Attributes: experiment (google.cloud.dialogflowcx_v3.types.Experiment): Required. The experiment to update. update_mask (google.protobuf.field_mask_pb2.FieldMask): Required. The mask to control which fields get updated.

UpdateFlowRequest

The request message for [Flows.UpdateFlow][google.cloud.dialogflow.cx.v3.Flows.UpdateFlow].

Attributes: flow (google.cloud.dialogflowcx_v3.types.Flow): Required. The flow to update. update_mask (google.protobuf.field_mask_pb2.FieldMask): Required. The mask to control which fields get updated. If update_mask is not specified, an error will be returned. language_code (str): The language of the following fields in flow:

    -  ``Flow.event_handlers.trigger_fulfillment.messages``
    -  ``Flow.event_handlers.trigger_fulfillment.conditional_cases``
    -  ``Flow.transition_routes.trigger_fulfillment.messages``
    -  ``Flow.transition_routes.trigger_fulfillment.conditional_cases``


    If not specified, the agent's default language is used.
    `Many
    languages <https://cloud.google.com/dialogflow/cx/docs/reference/language>`__
    are supported. Note: languages must be enabled in the agent
    before they can be used.

UpdateIntentRequest

The request message for [Intents.UpdateIntent][google.cloud.dialogflow.cx.v3.Intents.UpdateIntent].

Attributes: intent (google.cloud.dialogflowcx_v3.types.Intent): Required. The intent to update. language_code (str): The language of the following fields in intent:

    -  ``Intent.training_phrases.parts.text``


    If not specified, the agent's default language is used.
    `Many
    languages <https://cloud.google.com/dialogflow/cx/docs/reference/language>`__
    are supported. Note: languages must be enabled in the agent
    before they can be used.
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.

UpdatePageRequest

The request message for [Pages.UpdatePage][google.cloud.dialogflow.cx.v3.Pages.UpdatePage].

Attributes: page (google.cloud.dialogflowcx_v3.types.Page): Required. The page to update. language_code (str): The language of the following fields in page:

    -  ``Page.entry_fulfillment.messages``
    -  ``Page.entry_fulfillment.conditional_cases``
    -  ``Page.event_handlers.trigger_fulfillment.messages``
    -  ``Page.event_handlers.trigger_fulfillment.conditional_cases``
    -  ``Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages``
    -


    ``Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases``


    -  ``Page.form.parameters.fill_behavior.reprompt_event_handlers.messages``
    -


    ``Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases``


    -  ``Page.transition_routes.trigger_fulfillment.messages``
    -  ``Page.transition_routes.trigger_fulfillment.conditional_cases``


    If not specified, the agent's default language is used.
    `Many
    languages <https://cloud.google.com/dialogflow/cx/docs/reference/language>`__
    are supported. Note: languages must be enabled in the agent
    before they can be used.
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.

UpdateSecuritySettingsRequest

The request message for [SecuritySettingsService.UpdateSecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettingsService.UpdateSecuritySettings].

Attributes: security_settings (google.cloud.dialogflowcx_v3.types.SecuritySettings): Required. [SecuritySettings] object that contains values for each of the fields to update. update_mask (google.protobuf.field_mask_pb2.FieldMask): Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated.

UpdateSessionEntityTypeRequest

The request message for [SessionEntityTypes.UpdateSessionEntityType][google.cloud.dialogflow.cx.v3.SessionEntityTypes.UpdateSessionEntityType].

Attributes: session_entity_type (google.cloud.dialogflowcx_v3.types.SessionEntityType): Required. The session entity type to update. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type ID> or projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>. If Environment ID is not specified, we assume default 'draft' environment. update_mask (google.protobuf.field_mask_pb2.FieldMask): The mask to control which fields get updated.

UpdateTestCaseRequest

The request message for [TestCases.UpdateTestCase][google.cloud.dialogflow.cx.v3.TestCases.UpdateTestCase].

Attributes: test_case (google.cloud.dialogflowcx_v3.types.TestCase): Required. The test case to update. update_mask (google.protobuf.field_mask_pb2.FieldMask): Required. The mask to specify which fields should be updated. The [creationTime][google.cloud.dialogflow.cx.v3.TestCase.creation_time] and [lastTestResult][google.cloud.dialogflow.cx.v3.TestCase.last_test_result] cannot be updated.

UpdateTransitionRouteGroupRequest

The request message for [TransitionRouteGroups.UpdateTransitionRouteGroup][google.cloud.dialogflow.cx.v3.TransitionRouteGroups.UpdateTransitionRouteGroup].

Attributes: transition_route_group (google.cloud.dialogflowcx_v3.types.TransitionRouteGroup): Required. The transition route group to update. update_mask (google.protobuf.field_mask_pb2.FieldMask): The mask to control which fields get updated. language_code (str): The language of the following fields in TransitionRouteGroup:

    -  ``TransitionRouteGroup.transition_routes.trigger_fulfillment.messages``
    -


    ``TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases``


    If not specified, the agent's default language is used.
    `Many
    languages <https://cloud.google.com/dialogflow/cx/docs/reference/language>`__
    are supported. Note: languages must be enabled in the agent
    before they can be used.

UpdateVersionRequest

The request message for [Versions.UpdateVersion][google.cloud.dialogflow.cx.v3.Versions.UpdateVersion].

Attributes: version (google.cloud.dialogflowcx_v3.types.Version): Required. The version to update. update_mask (google.protobuf.field_mask_pb2.FieldMask): Required. The mask to control which fields get updated. Currently only description and display_name can be updated.

UpdateWebhookRequest

The request message for [Webhooks.UpdateWebhook][google.cloud.dialogflow.cx.v3.Webhooks.UpdateWebhook].

Attributes: webhook (google.cloud.dialogflowcx_v3.types.Webhook): Required. The webhook to update. 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.

ValidateAgentRequest

The request message for [Agents.ValidateAgent][google.cloud.dialogflow.cx.v3.Agents.ValidateAgent].

Attributes: name (str): Required. The agent to validate. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>. language_code (str): If not specified, the agent's default language is used.

ValidateFlowRequest

The request message for [Flows.ValidateFlow][google.cloud.dialogflow.cx.v3.Flows.ValidateFlow].

Attributes: name (str): Required. The flow to validate. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>. language_code (str): If not specified, the agent's default language is used.

ValidationMessage

Agent/flow validation message. Attributes: resource_type (google.cloud.dialogflowcx_v3.types.ValidationMessage.ResourceType): The type of the resources where the message is found. resources (Sequence[str]): The names of the resources where the message is found. resource_names (Sequence[google.cloud.dialogflowcx_v3.types.ResourceName]): The resource names of the resources where the message is found. severity (google.cloud.dialogflowcx_v3.types.ValidationMessage.Severity): Indicates the severity of the message. detail (str): The message detail.

VariantsHistory

The history of variants update. Attributes: version_variants (google.cloud.dialogflowcx_v3.types.VersionVariants): The flow versions as the variants. update_time (google.protobuf.timestamp_pb2.Timestamp): Update time of the variants.

Version

Represents a version of a flow. Attributes: name (str): Format: projects/

VersionVariants

A list of flow version variants. Attributes: variants (Sequence[google.cloud.dialogflowcx_v3.types.VersionVariants.Variant]): A list of flow version variants.

VoiceSelectionParams

Description of which voice to use for speech synthesis. Attributes: name (str): Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and [ssml_gender][google.cloud.dialogflow.cx.v3.VoiceSelectionParams.ssml_gender].

    For the list of available voices, please refer to `Supported
    voices and
    languages <https://cloud.google.com/text-to-speech/docs/voices>`__.
ssml_gender (google.cloud.dialogflowcx_v3.types.SsmlVoiceGender):
    Optional. The preferred gender of the voice. If not set, the
    service will choose a voice based on the other parameters
    such as language_code and
    [name][google.cloud.dialogflow.cx.v3.VoiceSelectionParams.name].
    Note that this is only a preference, not requirement. If a
    voice of the appropriate gender is not available, the
    synthesizer substitutes a voice with a different gender
    rather than failing the request.

Webhook

Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.

Attributes: name (str): The unique identifier of the webhook. Required for the [Webhooks.UpdateWebhook][google.cloud.dialogflow.cx.v3.Webhooks.UpdateWebhook] method. [Webhooks.CreateWebhook][google.cloud.dialogflow.cx.v3.Webhooks.CreateWebhook] populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>. display_name (str): Required. The human-readable name of the webhook, unique within the agent. generic_web_service (google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService): Configuration for a generic web service. service_directory (google.cloud.dialogflowcx_v3.types.Webhook.ServiceDirectoryConfig): Configuration for a Service Directory <https://cloud.google.com/service-directory>__ service. timeout (google.protobuf.duration_pb2.Duration): Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds. disabled (bool): Indicates whether the webhook is disabled.

WebhookRequest

The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases.

Attributes: detect_intent_response_id (str): Always present. The unique identifier of the [DetectIntentResponse][google.cloud.dialogflow.cx.v3.DetectIntentResponse] that will be returned to the API caller. text (str): If [natural language text][google.cloud.dialogflow.cx.v3.TextInput] was provided as input, this field will contain a copy of the text. trigger_intent (str): If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as input, this field will contain a copy of the intent identifier. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>. transcript (str): If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, this field will contain the transcript for the audio. trigger_event (str): If an [event][google.cloud.dialogflow.cx.v3.EventInput] was provided as input, this field will contain the name of the event. language_code (str): The language code specified in the [original request][QueryInput.language_code]. fulfillment_info (google.cloud.dialogflowcx_v3.types.WebhookRequest.FulfillmentInfo): Always present. Information about the fulfillment that triggered this webhook call. intent_info (google.cloud.dialogflowcx_v3.types.WebhookRequest.IntentInfo): Information about the last matched intent. page_info (google.cloud.dialogflowcx_v3.types.PageInfo): Information about page status. session_info (google.cloud.dialogflowcx_v3.types.SessionInfo): Information about session status. messages (Sequence[google.cloud.dialogflowcx_v3.types.ResponseMessage]): The list of rich message responses to present to the user. Webhook can choose to append or replace this list in [WebhookResponse.fulfillment_response][google.cloud.dialogflow.cx.v3.WebhookResponse.fulfillment_response]; payload (google.protobuf.struct_pb2.Struct): Custom data set in [QueryParameters.payload][google.cloud.dialogflow.cx.v3.QueryParameters.payload]. sentiment_analysis_result (google.cloud.dialogflowcx_v3.types.WebhookRequest.SentimentAnalysisResult): The sentiment analysis result of the current user request. The field is filled when sentiment analysis is configured to be enabled for the request.

WebhookResponse

The response message for a webhook call. Attributes: fulfillment_response (google.cloud.dialogflowcx_v3.types.WebhookResponse.FulfillmentResponse): The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user. page_info (google.cloud.dialogflowcx_v3.types.PageInfo): Information about page status. This field can be omitted by the webhook if it does not intend to modify page status. session_info (google.cloud.dialogflowcx_v3.types.SessionInfo): Information about session status. This field can be omitted by the webhook if it does not intend to modify session status. payload (google.protobuf.struct_pb2.Struct): Value to append directly to [QueryResult.webhook_payloads][google.cloud.dialogflow.cx.v3.QueryResult.webhook_payloads]. target_page (str): The target page to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>. target_flow (str): The target flow to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.