Package types (2.35.0)

A Dialogflow agent is a virtual agent that handles conversations with your end-users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system.

For more information about agents, see the Agent guide <https://cloud.google.com/dialogflow/docs/agents-overview>__.

Detail feedback of Agent Assist result.

Represents a record of a human agent assist answer.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The request message for Participants.AnalyzeContent.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The response message for Participants.AnalyzeContent.

Represents a part of a message possibly annotated with an entity. The part can be an entity or purely a part of the message between two entities or message start/end.

Represents feedback the customer has about the quality & correctness of a certain answer in a conversation.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Answer records are records to manage answer history and feedbacks for Dialogflow.

Currently, answer record includes:

• human agent assistant article suggestion
• human agent assistant faq article

It doesn't include:

• DetectIntent intent matching
• DetectIntent knowledge

Answer records are not related to the conversation history in the Dialogflow Console. A Record is generated even when the end-user disables conversation history in the console. Records are created when there's a human agent assistant suggestion generated.

A typical workflow for customers provide feedback to an answer is:

1. For human agent assistant, customers get suggestion via ListSuggestions API. Together with the answers, AnswerRecord.name are returned to the customers.
2. The customer uses the AnswerRecord.name to call the [UpdateAnswerRecord][] method to send feedback about a specific answer that they believe is wrong.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents article answer.

Metadata for article suggestion models.

Represents the parameters of human assist query.

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.

Defines the Automated Agent to connect to a conversation.

Represents a response from an automated agent.

The request message for EntityTypes.BatchCreateEntities.

The request message for EntityTypes.BatchDeleteEntities.

The request message for EntityTypes.BatchDeleteEntityTypes.

The request message for Intents.BatchDeleteIntents.

The request message for EntityTypes.BatchUpdateEntities.

The request message for EntityTypes.BatchUpdateEntityTypes.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The response message for EntityTypes.BatchUpdateEntityTypes.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The response message for Intents.BatchUpdateIntents.

Metadata for a [ConversationProfile.ClearSuggestionFeatureConfig][] operation.

The request message for [ConversationProfiles.ClearFeature][].

Cloud conversation info for easier debugging. It will get populated in StreamingDetectIntentResponse or StreamingAnalyzeContentResponse when the flag enable_debugging_info is set to true in corresponding requests.

The request message for Conversations.CompleteConversation.

Dialogflow contexts are similar to natural language context. If a person says to you "they are orange", you need context in order to understand what "they" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent.

Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts.

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

Represents a conversation. A conversation is an interaction between an agent, including live agents and Dialogflow agents, and a support customer. Conversations can include phone calls and text-based chat sessions.

Context of the conversation, including transcripts.

Represents a conversation dataset that a user imports raw data into. The data inside ConversationDataset can not be changed after ImportConversationData finishes (and calling ImportConversationData on a dataset that already has data is not allowed).

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents a notification sent to Pub/Sub subscribers for conversation lifecycle events.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents metadata of a conversation.

Represents a conversation model.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents evaluation result of a conversation model.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents a phone number for telephony integration. It allows for connecting a particular conversation over telephony.

Defines the services to connect to incoming Dialogflow conversations.

The request message for Contexts.CreateContext.

Metadata for ConversationDatasets][CreateConversationDataset].

The request message for ConversationDatasets.CreateConversationDataset.

Metadata for a ConversationModels.CreateConversationModelEvaluation operation.

The request message for ConversationModels.CreateConversationModelEvaluation

Metadata for a ConversationModels.CreateConversationModel operation.

The request message for ConversationModels.CreateConversationModel

The request message for ConversationProfiles.CreateConversationProfile.

The request message for Conversations.CreateConversation.

Request message for Documents.CreateDocument.

The request message for EntityTypes.CreateEntityType.

The request message for Environments.CreateEnvironment.

Request message of CreateGenerator.

The request message for Intents.CreateIntent.

Request message for KnowledgeBases.CreateKnowledgeBase.

The request message for Participants.CreateParticipant.

The request message for SessionEntityTypes.CreateSessionEntityType.

The request message for Versions.CreateVersion.

The request message for Agents.DeleteAgent.

The request message for Contexts.DeleteAllContexts.

The request message for Contexts.DeleteContext.

Metadata for ConversationDatasets][DeleteConversationDataset].

The request message for ConversationDatasets.DeleteConversationDataset.

Metadata for a ConversationModels.DeleteConversationModel operation.

The request message for ConversationModels.DeleteConversationModel

The request message for ConversationProfiles.DeleteConversationProfile.

This operation fails if the conversation profile is still referenced from a phone number.

Request message for Documents.DeleteDocument.

The request message for EntityTypes.DeleteEntityType.

The request message for Environments.DeleteEnvironment.

Request of DeleteGenerator.

The request message for Intents.DeleteIntent.

Request message for KnowledgeBases.DeleteKnowledgeBase.

The request message for SessionEntityTypes.DeleteSessionEntityType.

The request message for Versions.DeleteVersion.

Metadata for a ConversationModels.DeployConversationModel operation.

The request message for ConversationModels.DeployConversationModel

The request to detect user's intent.

The message returned from the DetectIntent method.

Represents a Dialogflow assist answer.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A knowledge document to be used by a KnowledgeBase.

For more information, see the knowledge base guide <https://cloud.google.com/dialogflow/docs/how/knowledge-bases>__.

Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The message in the response that indicates the parameters of DTMF.

A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).

Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted.

Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent.

For more information, see the Entity guide <https://cloud.google.com/dialogflow/docs/entities-overview>__.

This message is a wrapper around a collection of entity types.

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.

For more information, see the versions and environments guide <https://cloud.google.com/dialogflow/docs/agents-versions>__.

The response message for Environments.GetEnvironmentHistory.

The configuration for model evaluation.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Events allow for matching intents by event name instead of the natural language input. For instance, input <event: { name: "welcome_event", parameters: { name: "Sam" } }> can trigger a personalized welcome response. The parameter name may be used by the agent in the response: "Hello #welcome_event.name! What can I do for you today?".

The request message for Agents.ExportAgent.

The response message for Agents.ExportAgent.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request message for Documents.ExportDocument.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Metadata related to the Export Data Operations (e.g. ExportDocument).

Represents answer from "frequently asked questions".

Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response. NEXT_ID: 10

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday.

For more information, see the fulfillment guide <https://cloud.google.com/dialogflow/docs/fulfillment-overview>__.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Google Cloud Storage location for the output.

Google Cloud Storage location for the inputs.

The request message for Conversations.GenerateStatelessSuggestion.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The response message for Conversations.GenerateStatelessSuggestion.

The request message for Conversations.GenerateStatelessSummary.

The response message for Conversations.GenerateStatelessSummary.

LLM generator.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Suggestion generated using a Generator.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The request message for Agents.GetAgent.

The request message for Contexts.GetContext.

The request message for ConversationDatasets.GetConversationDataset.

The request message for ConversationModels.GetConversationModelEvaluation

The request message for ConversationModels.GetConversationModel

The request message for ConversationProfiles.GetConversationProfile.

The request message for Conversations.GetConversation.

Request message for Documents.GetDocument.

The request to get location-level encryption specification.

The request message for EntityTypes.GetEntityType.

The request message for Environments.GetEnvironmentHistory.

The request message for Environments.GetEnvironment.

The request message for Fulfillments.GetFulfillment.

Request message of GetGenerator.

The request message for Intents.GetIntent.

Request message for KnowledgeBases.GetKnowledgeBase.

The request message for Participants.GetParticipant.

The request message for SessionEntityTypes.GetSessionEntityType.

The request message for Agents.GetValidationResult.

The request message for Versions.GetVersion.

Defines the Human Agent Assist to connect to a conversation.

Represents a notification sent to Cloud Pub/Sub subscribers for human agent assistant events in a specific conversation.

Defines the hand off to a live agent, typically on which external agent service provider to connect to a conversation.

Currently, this feature is not general available, please contact Google to get access.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The request message for Agents.ImportAgent.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Metadata for a ConversationDatasets.ImportConversationData operation.

Response used for ConversationDatasets.ImportConversationData long running operation.

The request message for ConversationDatasets.ImportConversationData.

The template used for importing documents.

Request message for Documents.ImportDocuments.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Response message for Documents.ImportDocuments.

The parameters of inference.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Metadata for initializing a location-level encryption specification.

The request to initialize a location-level encryption specification.

The response to initialize a location-level encryption specification.

Instructs the speech recognizer how to process the audio content.

Represents the configuration of importing a set of conversation files in Google Cloud Storage.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

InputDataset used to create model or do evaluation. NextID:5

Defines the language used in the input text.

An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification.

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

This message is a wrapper around a collection of intents.

Represents an intent suggestion.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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 by default.

Represents a Knowledge Assist answer.

A knowledge base represents a collection of knowledge documents that you provide to Dialogflow. Your knowledge documents contain information that may be useful during conversations with end-users. Some Dialogflow features use knowledge bases when looking for a response to an end-user input.

For more information, see the knowledge base guide <https://cloud.google.com/dialogflow/docs/how/knowledge-bases>__.

Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

Metadata in google::longrunning::Operation for Knowledge operations.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request message for AnswerRecords.ListAnswerRecords.

Response message for AnswerRecords.ListAnswerRecords.

The request message for Contexts.ListContexts.

The response message for Contexts.ListContexts.

The request message for ConversationDatasets.ListConversationDatasets.

The response message for ConversationDatasets.ListConversationDatasets.

The request message for ConversationModels.ListConversationModelEvaluations

The response message for ConversationModels.ListConversationModelEvaluations

The request message for ConversationModels.ListConversationModels

The response message for ConversationModels.ListConversationModels

The request message for ConversationProfiles.ListConversationProfiles.

The response message for ConversationProfiles.ListConversationProfiles.

The request message for Conversations.ListConversations.

The response message for Conversations.ListConversations.

Request message for Documents.ListDocuments.

Response message for Documents.ListDocuments.

The request message for EntityTypes.ListEntityTypes.

The response message for EntityTypes.ListEntityTypes.

The request message for Environments.ListEnvironments.

The response message for Environments.ListEnvironments.

Request message of ListGenerators.

Response of ListGenerators.

The request message for Intents.ListIntents.

The response message for Intents.ListIntents.

Request message for KnowledgeBases.ListKnowledgeBases.

Response message for KnowledgeBases.ListKnowledgeBases.

The request message for Conversations.ListMessages.

The response message for Conversations.ListMessages.

The request message for Participants.ListParticipants.

The response message for Participants.ListParticipants.

The request message for SessionEntityTypes.ListSessionEntityTypes.

The response message for SessionEntityTypes.ListSessionEntityTypes.

The request message for Versions.ListVersions.

The response message for Versions.ListVersions.

Defines logging behavior for conversation lifecycle events.

Represents a message posted into a conversation.

Represents the result of annotation for the message.

Represents a message entry of a conversation.

Defines notification behavior.

Represents the contents of the original request that was passed to the [Streaming]DetectIntent call.

Represents the natural language speech audio to be played to the end user.

Instructs the speech synthesizer on how to generate the output audio content. If this audio config is supplied in a request, it overrides all existing text-to-speech settings applied to the agent.

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

Represents a conversation participant (human agent, virtual agent, end-user).

Represents the query input. It can contain either:

1. An audio config which instructs the speech recognizer how to process the speech audio.

2. A conversational query in the form of text.

3. An event that specifies which intent to trigger.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents the parameters of the conversational query.

Represents the result of conversational query or event processing.

Request message for Documents.ReloadDocument.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The request message for Agents.RestoreAgent.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The request message for Agents.SearchAgents.

The response message for Agents.SearchAgents.

Represents a SearchKnowledge answer.

The request message for Conversations.SearchKnowledge.

The response message for Conversations.SearchKnowledge.

The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result.

Configures the types of sentiment analysis to perform.

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. For [Participants.DetectIntent][], it needs to be configured in DetectIntentRequest.query_params. For [Participants.StreamingDetectIntent][], it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config

A session represents a conversation between a Dialogflow agent and an end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes.

For more information, see the session entity guide <https://cloud.google.com/dialogflow/docs/entities-session>__.

The request message for Agents.SetAgent.

Metadata for a [ConversationProfile.SetSuggestionFeatureConfig][] operation.

The request message for [ConversationProfiles.SetSuggestionFeature][].

Represents a smart reply answer.

The evaluation metrics for smart reply model.

Metadata for smart reply models.

Hints for the speech recognizer to help with recognition in a specific conversation state.

Variant of the specified [Speech model][google.cloud.dialogflow.v2.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.

    Please see the `Dialogflow
    docs <https://cloud.google.com/dialogflow/docs/data-logging>`__
    for how to make your project eligible for enhanced models.
USE_STANDARD (2):
    Use standard model variant even if an enhanced model is
    available. See the `Cloud Speech
    documentation <https://cloud.google.com/speech-to-text/docs/enhanced-models>`__
    for details about enhanced models.
USE_ENHANCED (3):
    Use an enhanced model variant:

    -  If an enhanced variant does not exist for the given
       <xref uid="google.cloud.dialogflow.v2.InputAudioConfig.model">model</xref>
       and request language, Dialogflow falls back to the
       standard variant.

       The `Cloud Speech
       documentation <https://cloud.google.com/speech-to-text/docs/enhanced-models>`__
       describes which models have enhanced variants.

    -  If the API caller isn't eligible for enhanced models,
       Dialogflow returns an error. Please see the `Dialogflow
       docs <https://cloud.google.com/dialogflow/docs/data-logging>`__
       for how to make your project eligible.

Configures speech transcription for ConversationProfile.

Information for a word recognized by the speech recognizer.

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

The top-level message sent by the client to the Participants.StreamingAnalyzeContent method.

Multiple request messages should be sent in order:

1. The first message must contain participant, config and optionally query_params. If you want to receive an audio response, it should also contain reply_audio_config. The message must not contain input.

2. If config in the first message was set to audio_config, all subsequent messages must contain input_audio to continue with Speech recognition. However, note that:

   • Dialogflow will bill you for the audio so far.
   • Dialogflow discards all Speech recognition results in favor of the text input.

3. If StreamingAnalyzeContentRequest.config in the first message was set to StreamingAnalyzeContentRequest.text_config, then the second message must contain only input_text. Moreover, you must not send more than two messages.

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The top-level message returned from the StreamingAnalyzeContent method.

Multiple response messages can be returned in order:

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

2. In virtual agent stage: if enable_partial_automated_agent_reply is true, the following N (currently 1 <= N <= 4) messages contain automated_agent_reply and optionally reply_audio returned by the virtual agent. The first (N-1) automated_agent_reply\ s will have automated_agent_reply_type set to PARTIAL. The last automated_agent_reply has automated_agent_reply_type set to FINAL. If enable_partial_automated_agent_reply is not enabled, response stream only contains the final reply.

   In human assist stage: the following N (N >= 1) messages contain human_agent_suggestion_results, end_user_suggestion_results or message.

The top-level message sent by the client to the Sessions.StreamingDetectIntent method.

Multiple request messages should be sent in order:

1. The first message must contain session, query_input plus optionally query_params. If the client wants to receive an audio response, it should also contain output_audio_config. The message must not contain input_audio.

2. If query_input was set to query_input.audio_config, all subsequent messages must contain input_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.

   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.

The top-level message returned from the StreamingDetectIntent method.

Multiple response messages can be returned in order:

1. If the StreamingDetectIntentRequest.input_audio field was set, the recognition_result field is populated for one or more messages. See the StreamingRecognitionResult message for details about the result message sequence.

2. The next message contains response_id, query_result and optionally webhook_status if a WebHook was called.

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.

While end-user audio is being processed, Dialogflow sends a series of results. Each result may contain a transcript value. A transcript represents a portion of the utterance. While the recognizer is processing audio, transcript values may be interim values or finalized values. Once a transcript is finalized, the is_final value is set to true and processing continues for the next transcript.

If StreamingDetectIntentRequest.query_input.audio_config.single_utterance was true, and the recognizer has completed processing audio, the message_type value is set to `END_OF_SINGLE_UTTERANCE and the following (last) result contains the last finalized transcript.

The complete end-user utterance is determined by concatenating the finalized transcript values received for the series of results.

In the following example, single utterance is enabled. In the case where single utterance is not enabled, result 7 would not occur.

::

Concatenating the finalized transcripts with is_final set to true, the complete utterance becomes "to be or not to be that is the question".

The request message for Participants.SuggestArticles.

The response message for Participants.SuggestArticles.

The request message for Conversations.SuggestConversationSummary.

The response message for Conversations.SuggestConversationSummary.

The request message for Participants.SuggestFaqAnswers.

The request message for Participants.SuggestFaqAnswers.

The request message for Participants.SuggestKnowledgeAssist.

The response message for Participants.SuggestKnowledgeAssist.

The request message for Participants.SuggestSmartReplies.

The response message for Participants.SuggestSmartReplies.

The type of Human Agent Assistant API suggestion to perform, and the maximum number of results to return for that type. Multiple Feature objects can be specified in the features list.

Represents the selection of a suggestion.

One response of different type of suggestion response which is used in the response of Participants.AnalyzeContent and Participants.AnalyzeContent, as well as HumanAgentAssistantEvent.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Summarization context that customer can configure.

Represents the section of summarization.

List of summarization sections.

Suggested summary of the conversation.

Configuration of how speech should be synthesized.

DTMF <https://en.wikipedia.org/wiki/Dual-tone_multi-frequency_signaling>__ digit in Telephony Gateway.

A wrapper of repeated TelephonyDtmf digits.

Auxiliary proto messages.

Represents the natural language text to be processed.

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

The request message for Agents.TrainAgent.

The event that triggers the generator and LLM execution.

Metadata for a ConversationModels.UndeployConversationModel operation.

The request message for ConversationModels.UndeployConversationModel

Request message for AnswerRecords.UpdateAnswerRecord.

The request message for Contexts.UpdateContext.

The request message for ConversationProfiles.UpdateConversationProfile.

Request message for Documents.UpdateDocument.

The request message for EntityTypes.UpdateEntityType.

The request message for Environments.UpdateEnvironment.

The request message for Fulfillments.UpdateFulfillment.

Request of UpdateGenerator.

The request message for Intents.UpdateIntent.

Request message for KnowledgeBases.UpdateKnowledgeBase.

The request message for Participants.UpdateParticipant.

The request message for SessionEntityTypes.UpdateSessionEntityType.

The request message for Versions.UpdateVersion.

Represents a single validation error.

Represents the output of agent validation.

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.

For more information, see the versions and environments guide <https://cloud.google.com/dialogflow/docs/agents-versions>__.

Description of which voice to use for speech synthesis.

The request message for a webhook call.

The response message for a webhook call.

This response is validated by the Dialogflow server. If validation fails, an error will be returned in the QueryResult.diagnostic_info field. Setting JSON fields to an empty value with the wrong type is a common error. To avoid this error:

• Use "" for empty strings
• Use {} or null for empty objects
• Use [] or null for empty arrays

For more information, see the Protocol Buffers Language Guide <https://developers.google.com/protocol-buffers/docs/proto3#json>__.