google-api-python-client 2.164.0__py2.py3-none-any.whl → 2.166.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json

@@ -3496,6 +3496,35 @@
 },
 "suggestions": {
 "methods": {
+"generate": {
+"description": "Generates all the suggestions using generators configured in the conversation profile. A generator is used only if its trigger event is matched.",
+"flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/suggestions:generate",
+"httpMethod": "POST",
+"id": "dialogflow.projects.conversations.suggestions.generate",
+"parameterOrder": [
+"conversation"
+],
+"parameters": {
+"conversation": {
+"description": "Required. The conversation for which the suggestions are generated. Format: `projects//locations//conversations/`. The conversation must be created with a conversation profile which has generators configured in it to be able to get suggestions.",
+"location": "path",
+"pattern": "^projects/[^/]+/conversations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v2beta1/{+conversation}/suggestions:generate",
+"request": {
+"$ref": "GoogleCloudDialogflowV2beta1GenerateSuggestionsRequest"
+},
+"response": {
+"$ref": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/dialogflow"
+]
+},
 "searchKnowledge": {
 "description": "Get answers for the given query based on knowledge documents.",
 "flatPath": "v2beta1/projects/{projectsId}/conversations/{conversationsId}/suggestions:searchKnowledge",
@@ -6668,6 +6697,35 @@
 "https://www.googleapis.com/auth/dialogflow"
 ]
 },
+"ingestContextReferences": {
+"description": "Data ingestion API. Ingests context references for an existing conversation.",
+"flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}:ingestContextReferences",
+"httpMethod": "POST",
+"id": "dialogflow.projects.locations.conversations.ingestContextReferences",
+"parameterOrder": [
+"conversation"
+],
+"parameters": {
+"conversation": {
+"description": "Required. Resource identifier of the conversation to ingest context information for. Format: `projects//locations//conversations/`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v2beta1/{+conversation}:ingestContextReferences",
+"request": {
+"$ref": "GoogleCloudDialogflowV2beta1IngestContextReferencesRequest"
+},
+"response": {
+"$ref": "GoogleCloudDialogflowV2beta1IngestContextReferencesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/dialogflow"
+]
+},
 "list": {
 "description": "Returns the list of all conversations in the specified project.",
 "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations",
@@ -7071,6 +7129,35 @@
 },
 "suggestions": {
 "methods": {
+"generate": {
+"description": "Generates all the suggestions using generators configured in the conversation profile. A generator is used only if its trigger event is matched.",
+"flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/suggestions:generate",
+"httpMethod": "POST",
+"id": "dialogflow.projects.locations.conversations.suggestions.generate",
+"parameterOrder": [
+"conversation"
+],
+"parameters": {
+"conversation": {
+"description": "Required. The conversation for which the suggestions are generated. Format: `projects//locations//conversations/`. The conversation must be created with a conversation profile which has generators configured in it to be able to get suggestions.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v2beta1/{+conversation}/suggestions:generate",
+"request": {
+"$ref": "GoogleCloudDialogflowV2beta1GenerateSuggestionsRequest"
+},
+"response": {
+"$ref": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/dialogflow"
+]
+},
 "searchKnowledge": {
 "description": "Get answers for the given query based on knowledge documents.",
 "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/suggestions:searchKnowledge",
@@ -8509,7 +8596,7 @@
 }
 }
 },
-"revision": "20250305",
+"revision": "20250310",
 "rootUrl": "https://dialogflow.googleapis.com/",
 "schemas": {
 "GoogleCloudDialogflowCxV3AdvancedSettings": {
@@ -13814,6 +13901,17 @@
 },
 "type": "object"
 },
+"GoogleCloudDialogflowV2FreeFormSuggestion": {
+"description": "Suggestion generated using free form generator.",
+"id": "GoogleCloudDialogflowV2FreeFormSuggestion",
+"properties": {
+"response": {
+"description": "Required. Free form suggestion.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowV2GcsDestination": {
 "description": "Google Cloud Storage location for the output.",
 "id": "GoogleCloudDialogflowV2GcsDestination",
@@ -13825,6 +13923,58 @@
 },
 "type": "object"
 },
+"GoogleCloudDialogflowV2GenerateSuggestionsResponse": {
+"description": "The response message for Conversations.GenerateSuggestions.",
+"id": "GoogleCloudDialogflowV2GenerateSuggestionsResponse",
+"properties": {
+"generatorSuggestionAnswers": {
+"description": "The answers generated for the conversation based on context.",
+"items": {
+"$ref": "GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer"
+},
+"type": "array"
+},
+"latestMessage": {
+"description": "The name of the latest conversation message used as context for compiling suggestion. Format: `projects//locations//conversations//messages/`.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer": {
+"description": "A GeneratorSuggestion answer.",
+"id": "GoogleCloudDialogflowV2GenerateSuggestionsResponseGeneratorSuggestionAnswer",
+"properties": {
+"answerRecord": {
+"description": "Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback.",
+"type": "string"
+},
+"generatorSuggestion": {
+"$ref": "GoogleCloudDialogflowV2GeneratorSuggestion",
+"description": "Suggestion details."
+},
+"sourceGenerator": {
+"description": "The name of the generator used to generate this suggestion. Format: `projects//locations//generators/`.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDialogflowV2GeneratorSuggestion": {
+"description": "Suggestion generated using a Generator.",
+"id": "GoogleCloudDialogflowV2GeneratorSuggestion",
+"properties": {
+"freeFormSuggestion": {
+"$ref": "GoogleCloudDialogflowV2FreeFormSuggestion",
+"description": "Optional. Free form suggestion."
+},
+"summarySuggestion": {
+"$ref": "GoogleCloudDialogflowV2SummarySuggestion",
+"description": "Optional. Suggested summary."
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowV2HumanAgentAssistantEvent": {
 "description": "Represents a notification sent to Cloud Pub/Sub subscribers for human agent assistant events in a specific conversation.",
 "id": "GoogleCloudDialogflowV2HumanAgentAssistantEvent",
@@ -15507,6 +15657,10 @@ true
 "$ref": "GoogleRpcStatus",
 "description": "Error status if the request failed."
 },
+"generateSuggestionsResponse": {
+"$ref": "GoogleCloudDialogflowV2GenerateSuggestionsResponse",
+"description": "Suggestions generated using generators triggered by customer or agent messages."
+},
 "suggestArticlesResponse": {
 "$ref": "GoogleCloudDialogflowV2SuggestArticlesResponse",
 "description": "SuggestArticlesResponse if request is for ARTICLE_SUGGESTION."
@@ -15526,6 +15680,35 @@ true
 },
 "type": "object"
 },
+"GoogleCloudDialogflowV2SummarySuggestion": {
+"description": "Suggested summary of the conversation.",
+"id": "GoogleCloudDialogflowV2SummarySuggestion",
+"properties": {
+"summarySections": {
+"description": "Required. All the parts of generated summary.",
+"items": {
+"$ref": "GoogleCloudDialogflowV2SummarySuggestionSummarySection"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudDialogflowV2SummarySuggestionSummarySection": {
+"description": "A component of the generated summary.",
+"id": "GoogleCloudDialogflowV2SummarySuggestionSummarySection",
+"properties": {
+"section": {
+"description": "Required. Name of the section.",
+"type": "string"
+},
+"summary": {
+"description": "Required. Summary text for the section.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata": {
 "description": "Metadata for a ConversationModels.UndeployConversationModel operation.",
 "id": "GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata",
@@ -16697,6 +16880,14 @@ true
 "readOnly": true,
 "type": "string"
 },
+"ingestedContextReferences": {
+"additionalProperties": {
+"$ref": "GoogleCloudDialogflowV2beta1ConversationContextReference"
+},
+"description": "Output only. The context reference updates provided by external systems.",
+"readOnly": true,
+"type": "object"
+},
 "lifecycleState": {
 "description": "Output only. The current state of the Conversation.",
 "enum": [
@@ -16750,6 +16941,75 @@ true
 },
 "type": "object"
 },
+"GoogleCloudDialogflowV2beta1ConversationContextReference": {
+"description": "Represents a piece of ingested context information.",
+"id": "GoogleCloudDialogflowV2beta1ConversationContextReference",
+"properties": {
+"contextContents": {
+"description": "Required. The list of content updates for a context reference.",
+"items": {
+"$ref": "GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent"
+},
+"type": "array"
+},
+"createTime": {
+"description": "Output only. The time the context reference was first created.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"languageCode": {
+"description": "Optional. The language of the information ingested, defaults to \"en-US\" if not set.",
+"type": "string"
+},
+"updateMode": {
+"description": "Required. The mode in which context reference contents are updated.",
+"enum": [
+"UPDATE_MODE_UNSPECIFIED",
+"APPEND",
+"OVERWRITE"
+],
+"enumDescriptions": [
+"Unspecified update mode.",
+"Context content updates are applied in append mode.",
+"Context content updates are applied in overwrite mode."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent": {
+"description": "Contents ingested.",
+"id": "GoogleCloudDialogflowV2beta1ConversationContextReferenceContextContent",
+"properties": {
+"content": {
+"description": "Required. The information ingested in a single request.",
+"type": "string"
+},
+"contentFormat": {
+"description": "Required. The format of the ingested string.",
+"enum": [
+"CONTENT_FORMAT_UNSPECIFIED",
+"JSON",
+"PLAIN_TEXT"
+],
+"enumDescriptions": [
+"Unspecified content format.",
+"Content was provided in JSON format.",
+"Content was provided as plain text."
+],
+"type": "string"
+},
+"ingestionTime": {
+"description": "Output only. The time when this information was incorporated into the relevant context reference.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowV2beta1ConversationEvent": {
 "description": "Represents a notification sent to Pub/Sub subscribers for conversation lifecycle events.",
 "id": "GoogleCloudDialogflowV2beta1ConversationEvent",
@@ -17488,6 +17748,28 @@ true
 },
 "type": "object"
 },
+"GoogleCloudDialogflowV2beta1FreeFormContext": {
+"description": "Free form generator context that customer can configure.",
+"id": "GoogleCloudDialogflowV2beta1FreeFormContext",
+"properties": {
+"text": {
+"description": "Optional. Free form text input to LLM.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDialogflowV2beta1FreeFormSuggestion": {
+"description": "Suggestion generated using free form generator.",
+"id": "GoogleCloudDialogflowV2beta1FreeFormSuggestion",
+"properties": {
+"response": {
+"description": "Required. Free form suggestion.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowV2beta1Fulfillment": {
 "description": "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).",
 "id": "GoogleCloudDialogflowV2beta1Fulfillment",
@@ -17608,6 +17890,13 @@ true
 "description": "The request message for Conversations.GenerateStatelessSuggestion.",
 "id": "GoogleCloudDialogflowV2beta1GenerateStatelessSuggestionRequest",
 "properties": {
+"contextReferences": {
+"additionalProperties": {
+"$ref": "GoogleCloudDialogflowV2beta1ConversationContextReference"
+},
+"description": "Optional. A section of ingested context information. The key is the name of the context reference and the value contains the contents of the context reference. The key is used to incorporate ingested context references to enhance the generator.",
+"type": "object"
+},
 "conversationContext": {
 "$ref": "GoogleCloudDialogflowV2beta1ConversationContext",
 "description": "Optional. Context of the conversation, including transcripts."
@@ -17626,12 +17915,16 @@ true
 "enum": [
 "TRIGGER_EVENT_UNSPECIFIED",
 "END_OF_UTTERANCE",
-"MANUAL_CALL"
+"MANUAL_CALL",
+"CUSTOMER_MESSAGE",
+"AGENT_MESSAGE"
 ],
 "enumDescriptions": [
 "Default value for TriggerEvent.",
 "Triggers when each chat message or voice utterance ends.",
-"Triggers on the conversation manually by API calls, such as Conversations.GenerateStatelessSuggestion and Conversations.GenerateSuggestions."
+"Triggers on the conversation manually by API calls, such as Conversations.GenerateStatelessSuggestion and Conversations.GenerateSuggestions.",
+"Triggers after each customer message only.",
+"Triggers after each agent message only."
 ],
 "type": "string"
 },
@@ -17731,6 +18024,75 @@ true
 },
 "type": "object"
 },
+"GoogleCloudDialogflowV2beta1GenerateSuggestionsRequest": {
+"description": "The request message for Conversations.GenerateSuggestions.",
+"id": "GoogleCloudDialogflowV2beta1GenerateSuggestionsRequest",
+"properties": {
+"latestMessage": {
+"description": "Optional. The name of the latest conversation message for which the request is triggered. Format: `projects//locations//conversations//messages/`.",
+"type": "string"
+},
+"triggerEvents": {
+"description": "Optional. A list of trigger events. Only generators configured in the conversation_profile whose trigger_event is listed here will be triggered.",
+"items": {
+"enum": [
+"TRIGGER_EVENT_UNSPECIFIED",
+"END_OF_UTTERANCE",
+"MANUAL_CALL",
+"CUSTOMER_MESSAGE",
+"AGENT_MESSAGE"
+],
+"enumDescriptions": [
+"Default value for TriggerEvent.",
+"Triggers when each chat message or voice utterance ends.",
+"Triggers on the conversation manually by API calls, such as Conversations.GenerateStatelessSuggestion and Conversations.GenerateSuggestions.",
+"Triggers after each customer message only.",
+"Triggers after each agent message only."
+],
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse": {
+"description": "The response message for Conversations.GenerateSuggestions.",
+"id": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse",
+"properties": {
+"generatorSuggestionAnswers": {
+"description": "The answers generated for the conversation based on context.",
+"items": {
+"$ref": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer"
+},
+"type": "array"
+},
+"latestMessage": {
+"description": "The name of the latest conversation message used as context for compiling suggestion. Format: `projects//locations//conversations//messages/`.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer": {
+"description": "A GeneratorSuggestion answer.",
+"id": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponseGeneratorSuggestionAnswer",
+"properties": {
+"answerRecord": {
+"description": "Answer record that uniquely identifies the suggestion. This can be used to provide suggestion feedback.",
+"type": "string"
+},
+"generatorSuggestion": {
+"$ref": "GoogleCloudDialogflowV2beta1GeneratorSuggestion",
+"description": "Suggestion details."
+},
+"sourceGenerator": {
+"description": "The name of the generator used to generate this suggestion. Format: `projects//locations//generators/`.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowV2beta1Generator": {
 "description": "LLM generator.",
 "id": "GoogleCloudDialogflowV2beta1Generator",
@@ -17745,6 +18107,10 @@ true
 "description": "Optional. Human readable description of the generator.",
 "type": "string"
 },
+"freeFormContext": {
+"$ref": "GoogleCloudDialogflowV2beta1FreeFormContext",
+"description": "Input of free from generator to LLM."
+},
 "inferenceParameter": {
 "$ref": "GoogleCloudDialogflowV2beta1InferenceParameter",
 "description": "Optional. Inference parameters for this generator."
@@ -17754,6 +18120,10 @@ true
 "readOnly": true,
 "type": "string"
 },
+"publishedModel": {
+"description": "Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`.",
+"type": "string"
+},
 "summarizationContext": {
 "$ref": "GoogleCloudDialogflowV2beta1SummarizationContext",
 "description": "Input of Summarization feature."
@@ -17763,12 +18133,16 @@ true
 "enum": [
 "TRIGGER_EVENT_UNSPECIFIED",
 "END_OF_UTTERANCE",
-"MANUAL_CALL"
+"MANUAL_CALL",
+"CUSTOMER_MESSAGE",
+"AGENT_MESSAGE"
 ],
 "enumDescriptions": [
 "Default value for TriggerEvent.",
 "Triggers when each chat message or voice utterance ends.",
-"Triggers on the conversation manually by API calls, such as Conversations.GenerateStatelessSuggestion and Conversations.GenerateSuggestions."
+"Triggers on the conversation manually by API calls, such as Conversations.GenerateStatelessSuggestion and Conversations.GenerateSuggestions.",
+"Triggers after each customer message only.",
+"Triggers after each agent message only."
 ],
 "type": "string"
 },
@@ -17785,6 +18159,10 @@ true
 "description": "Suggestion generated using a Generator.",
 "id": "GoogleCloudDialogflowV2beta1GeneratorSuggestion",
 "properties": {
+"freeFormSuggestion": {
+"$ref": "GoogleCloudDialogflowV2beta1FreeFormSuggestion",
+"description": "Optional. Free form suggestion."
+},
 "summarySuggestion": {
 "$ref": "GoogleCloudDialogflowV2beta1SummarySuggestion",
 "description": "Optional. Suggested summary."
@@ -18283,6 +18661,34 @@ true
 },
 "type": "object"
 },
+"GoogleCloudDialogflowV2beta1IngestContextReferencesRequest": {
+"description": "The request message for ConversationsService.IngestContextReferences.",
+"id": "GoogleCloudDialogflowV2beta1IngestContextReferencesRequest",
+"properties": {
+"contextReferences": {
+"additionalProperties": {
+"$ref": "GoogleCloudDialogflowV2beta1ConversationContextReference"
+},
+"description": "Required. The context references to ingest. The key is the name of the context reference and the value contains the contents of the context reference. The key is used to incorporate ingested context references to enhance the generator.",
+"type": "object"
+}
+},
+"type": "object"
+},
+"GoogleCloudDialogflowV2beta1IngestContextReferencesResponse": {
+"description": "The response message for ConversationsService.IngestContextReferences.",
+"id": "GoogleCloudDialogflowV2beta1IngestContextReferencesResponse",
+"properties": {
+"ingestedContextReferences": {
+"additionalProperties": {
+"$ref": "GoogleCloudDialogflowV2beta1ConversationContextReference"
+},
+"description": "All context references ingested.",
+"type": "object"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata": {
 "description": "Metadata for initializing a location-level encryption specification.",
 "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata",
@@ -21988,6 +22394,10 @@ true
 "$ref": "GoogleRpcStatus",
 "description": "Error status if the request failed."
 },
+"generateSuggestionsResponse": {
+"$ref": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse",
+"description": "Suggestions generated using generators triggered by customer or agent messages."
+},
 "suggestArticlesResponse": {
 "$ref": "GoogleCloudDialogflowV2beta1SuggestArticlesResponse",
 "description": "SuggestArticlesResponse if request is for ARTICLE_SUGGESTION."
@@ -22066,7 +22476,9 @@ true
 "REASON_FOR_CANCELLATION",
 "CUSTOMER_SATISFACTION",
 "ENTITIES",
-"CUSTOMER_DEFINED"
+"CUSTOMER_DEFINED",
+"SITUATION_CONCISE",
+"ACTION_CONCISE"
 ],
 "enumDescriptions": [
 "Undefined section type, does not return anything.",
@@ -22076,7 +22488,9 @@ true
 "Reason for cancellation if the customer requests for a cancellation. \"N/A\" otherwise. Section name: \"reason_for_cancellation\".",
 "\"Unsatisfied\" or \"Satisfied\" depending on the customer's feelings at the end of the conversation. Section name: \"customer_satisfaction\".",
 "Key entities extracted from the conversation, such as ticket number, order number, dollar amount, etc. Section names are prefixed by \"entities/\".",
-"Customer defined sections."
+"Customer defined sections.",
+"Concise version of the situation section. This type is only available if type SITUATION is not selected.",
+"Concise version of the action section. This type is only available if type ACTION is not selected."
 ],
 "type": "string"
 }