google-api-python-client 2.141.0__py2.py3-none-any.whl → 2.142.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json

@@ -5185,7 +5185,7 @@
 }
 }
 },
-"revision": "20240731",
+"revision": "20240812",
 "rootUrl": "https://dialogflow.googleapis.com/",
 "schemas": {
 "GoogleCloudDialogflowCxV3AdvancedSettings": {
@@ -5489,17 +5489,6 @@
 },
 "type": "object"
 },
-"GoogleCloudDialogflowCxV3CreateDocumentOperationMetadata": {
-"description": "Metadata for CreateDocument operation.",
-"id": "GoogleCloudDialogflowCxV3CreateDocumentOperationMetadata",
-"properties": {
-"genericMetadata": {
-"$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata",
-"description": "The generic information of the operation."
-}
-},
-"type": "object"
-},
 "GoogleCloudDialogflowCxV3CreateVersionOperationMetadata": {
 "description": "Metadata associated with the long running operation for Versions.CreateVersion.",
 "id": "GoogleCloudDialogflowCxV3CreateVersionOperationMetadata",
@@ -5538,17 +5527,6 @@
 },
 "type": "object"
 },
-"GoogleCloudDialogflowCxV3DeleteDocumentOperationMetadata": {
-"description": "Metadata for DeleteDocument operation.",
-"id": "GoogleCloudDialogflowCxV3DeleteDocumentOperationMetadata",
-"properties": {
-"genericMetadata": {
-"$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata",
-"description": "The generic information of the operation."
-}
-},
-"type": "object"
-},
 "GoogleCloudDialogflowCxV3DeployFlowMetadata": {
 "description": "Metadata returned for the Environments.DeployFlow long running operation.",
 "id": "GoogleCloudDialogflowCxV3DeployFlowMetadata",
@@ -6015,55 +5993,6 @@
 },
 "type": "object"
 },
-"GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata": {
-"description": "Metadata in google::longrunning::Operation for Knowledge operations.",
-"id": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata",
-"properties": {
-"state": {
-"description": "Required. Output only. The current state of this operation.",
-"enum": [
-"STATE_UNSPECIFIED",
-"PENDING",
-"RUNNING",
-"DONE"
-],
-"enumDescriptions": [
-"State unspecified.",
-"The operation has been created.",
-"The operation is currently running.",
-"The operation is done, either cancelled or completed."
-],
-"readOnly": true,
-"type": "string"
-}
-},
-"type": "object"
-},
-"GoogleCloudDialogflowCxV3ImportDocumentsOperationMetadata": {
-"description": "Metadata for ImportDocuments operation.",
-"id": "GoogleCloudDialogflowCxV3ImportDocumentsOperationMetadata",
-"properties": {
-"genericMetadata": {
-"$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata",
-"description": "The generic information of the operation."
-}
-},
-"type": "object"
-},
-"GoogleCloudDialogflowCxV3ImportDocumentsResponse": {
-"description": "Response message for Documents.ImportDocuments.",
-"id": "GoogleCloudDialogflowCxV3ImportDocumentsResponse",
-"properties": {
-"warnings": {
-"description": "Includes details about skipped documents or any other warnings.",
-"items": {
-"$ref": "GoogleRpcStatus"
-},
-"type": "array"
-}
-},
-"type": "object"
-},
 "GoogleCloudDialogflowCxV3ImportEntityTypesMetadata": {
 "description": "Metadata returned for the EntityTypes.ImportEntityTypes long running operation.",
 "id": "GoogleCloudDialogflowCxV3ImportEntityTypesMetadata",
@@ -6615,17 +6544,6 @@
 },
 "type": "object"
 },
-"GoogleCloudDialogflowCxV3ReloadDocumentOperationMetadata": {
-"description": "Metadata for ReloadDocument operation.",
-"id": "GoogleCloudDialogflowCxV3ReloadDocumentOperationMetadata",
-"properties": {
-"genericMetadata": {
-"$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata",
-"description": "The generic information of the operation."
-}
-},
-"type": "object"
-},
 "GoogleCloudDialogflowCxV3ResponseMessage": {
 "description": "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.",
 "id": "GoogleCloudDialogflowCxV3ResponseMessage",
@@ -6833,7 +6751,7 @@
 "type": "boolean"
 },
 "text": {
-"description": "Required. A collection of text responses.",
+"description": "Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.",
 "items": {
 "type": "string"
 },
@@ -7190,17 +7108,6 @@
 },
 "type": "object"
 },
-"GoogleCloudDialogflowCxV3UpdateDocumentOperationMetadata": {
-"description": "Metadata for UpdateDocument operation.",
-"id": "GoogleCloudDialogflowCxV3UpdateDocumentOperationMetadata",
-"properties": {
-"genericMetadata": {
-"$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata",
-"description": "The generic information of the operation."
-}
-},
-"type": "object"
-},
 "GoogleCloudDialogflowCxV3Webhook": {
 "description": "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.",
 "id": "GoogleCloudDialogflowCxV3Webhook",
@@ -8078,6 +7985,10 @@
 "format": "float",
 "type": "number"
 },
+"boostControlSpec": {
+"$ref": "GoogleCloudDialogflowCxV3beta1BoostSpecConditionBoostSpecBoostControlSpec",
+"description": "Optional. Complex specification for custom ranking based on customer defined attribute value."
+},
 "condition": {
 "description": "Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": * (id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\",\"Blue\"))",
 "type": "string"
@@ -8085,6 +7996,66 @@
 },
 "type": "object"
 },
+"GoogleCloudDialogflowCxV3beta1BoostSpecConditionBoostSpecBoostControlSpec": {
+"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.",
+"id": "GoogleCloudDialogflowCxV3beta1BoostSpecConditionBoostSpecBoostControlSpec",
+"properties": {
+"attributeType": {
+"description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).",
+"enum": [
+"ATTRIBUTE_TYPE_UNSPECIFIED",
+"NUMERICAL",
+"FRESHNESS"
+],
+"enumDescriptions": [
+"Unspecified AttributeType.",
+"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.",
+"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. E.g. `5D`, `3DT12H30M`, `T24H`."
+],
+"type": "string"
+},
+"controlPoints": {
+"description": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.",
+"items": {
+"$ref": "GoogleCloudDialogflowCxV3beta1BoostSpecConditionBoostSpecBoostControlSpecControlPoint"
+},
+"type": "array"
+},
+"fieldName": {
+"description": "Optional. The name of the field whose value will be used to determine the boost amount.",
+"type": "string"
+},
+"interpolationType": {
+"description": "Optional. The interpolation type to be applied to connect the control points listed below.",
+"enum": [
+"INTERPOLATION_TYPE_UNSPECIFIED",
+"LINEAR"
+],
+"enumDescriptions": [
+"Interpolation type is unspecified. In this case, it defaults to Linear.",
+"Piecewise linear interpolation will be applied."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDialogflowCxV3beta1BoostSpecConditionBoostSpecBoostControlSpecControlPoint": {
+"description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).",
+"id": "GoogleCloudDialogflowCxV3beta1BoostSpecConditionBoostSpecBoostControlSpecControlPoint",
+"properties": {
+"attributeValue": {
+"description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.",
+"type": "string"
+},
+"boostAmount": {
+"description": "Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.",
+"format": "float",
+"type": "number"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowCxV3beta1BoostSpecs": {
 "description": "Boost specifications for data stores.",
 "id": "GoogleCloudDialogflowCxV3beta1BoostSpecs",
@@ -8606,17 +8577,6 @@
 },
 "type": "object"
 },
-"GoogleCloudDialogflowCxV3beta1CreateDocumentOperationMetadata": {
-"description": "Metadata for CreateDocument operation.",
-"id": "GoogleCloudDialogflowCxV3beta1CreateDocumentOperationMetadata",
-"properties": {
-"genericMetadata": {
-"$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata",
-"description": "The generic information of the operation."
-}
-},
-"type": "object"
-},
 "GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata": {
 "description": "Metadata associated with the long running operation for Versions.CreateVersion.",
 "id": "GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata",
@@ -8881,17 +8841,6 @@
 },
 "type": "object"
 },
-"GoogleCloudDialogflowCxV3beta1DeleteDocumentOperationMetadata": {
-"description": "Metadata for DeleteDocument operation.",
-"id": "GoogleCloudDialogflowCxV3beta1DeleteDocumentOperationMetadata",
-"properties": {
-"genericMetadata": {
-"$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata",
-"description": "The generic information of the operation."
-}
-},
-"type": "object"
-},
 "GoogleCloudDialogflowCxV3beta1DeployFlowMetadata": {
 "description": "Metadata returned for the Environments.DeployFlow long running operation.",
 "id": "GoogleCloudDialogflowCxV3beta1DeployFlowMetadata",
@@ -10505,55 +10454,6 @@
 },
 "type": "object"
 },
-"GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata": {
-"description": "Metadata in google::longrunning::Operation for Knowledge operations.",
-"id": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata",
-"properties": {
-"state": {
-"description": "Required. Output only. The current state of this operation.",
-"enum": [
-"STATE_UNSPECIFIED",
-"PENDING",
-"RUNNING",
-"DONE"
-],
-"enumDescriptions": [
-"State unspecified.",
-"The operation has been created.",
-"The operation is currently running.",
-"The operation is done, either cancelled or completed."
-],
-"readOnly": true,
-"type": "string"
-}
-},
-"type": "object"
-},
-"GoogleCloudDialogflowCxV3beta1ImportDocumentsOperationMetadata": {
-"description": "Metadata for ImportDocuments operation.",
-"id": "GoogleCloudDialogflowCxV3beta1ImportDocumentsOperationMetadata",
-"properties": {
-"genericMetadata": {
-"$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata",
-"description": "The generic information of the operation."
-}
-},
-"type": "object"
-},
-"GoogleCloudDialogflowCxV3beta1ImportDocumentsResponse": {
-"description": "Response message for Documents.ImportDocuments.",
-"id": "GoogleCloudDialogflowCxV3beta1ImportDocumentsResponse",
-"properties": {
-"warnings": {
-"description": "Includes details about skipped documents or any other warnings.",
-"items": {
-"$ref": "GoogleRpcStatus"
-},
-"type": "array"
-}
-},
-"type": "object"
-},
 "GoogleCloudDialogflowCxV3beta1ImportEntityTypesMetadata": {
 "description": "Metadata returned for the EntityTypes.ImportEntityTypes long running operation.",
 "id": "GoogleCloudDialogflowCxV3beta1ImportEntityTypesMetadata",
@@ -12483,17 +12383,6 @@ false
 },
 "type": "object"
 },
-"GoogleCloudDialogflowCxV3beta1ReloadDocumentOperationMetadata": {
-"description": "Metadata for ReloadDocument operation.",
-"id": "GoogleCloudDialogflowCxV3beta1ReloadDocumentOperationMetadata",
-"properties": {
-"genericMetadata": {
-"$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata",
-"description": "The generic information of the operation."
-}
-},
-"type": "object"
-},
 "GoogleCloudDialogflowCxV3beta1ResourceName": {
 "description": "Resource name and display name.",
 "id": "GoogleCloudDialogflowCxV3beta1ResourceName",
@@ -12704,7 +12593,7 @@ false
 "type": "boolean"
 },
 "text": {
-"description": "Required. A collection of text responses.",
+"description": "Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.",
 "items": {
 "type": "string"
 },
@@ -13470,6 +13359,10 @@ false
 "$ref": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationApiKeyConfig",
 "description": "Config for API key auth."
 },
+"bearerTokenConfig": {
+"$ref": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationBearerTokenConfig",
+"description": "Config for bearer token auth."
+},
 "oauthConfig": {
 "$ref": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationOAuthConfig",
 "description": "Config for OAuth."
@@ -13510,6 +13403,17 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDialogflowCxV3beta1ToolAuthenticationBearerTokenConfig": {
+"description": "Config for authentication using bearer token.",
+"id": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationBearerTokenConfig",
+"properties": {
+"token": {
+"description": "Required. The text token appended to the text `Bearer` to the request Authorization header. [Session parameters reference](https://cloud.google.com/dialogflow/cx/docs/concept/parameter#session-ref) can be used to pass the token dynamically, e.g. `$session.params.parameter-id`.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowCxV3beta1ToolAuthenticationOAuthConfig": {
 "description": "Config for authentication with OAuth.",
 "id": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationOAuthConfig",
@@ -13544,7 +13448,22 @@ false
 "GoogleCloudDialogflowCxV3beta1ToolAuthenticationServiceAgentAuthConfig": {
 "description": "Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).",
 "id": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationServiceAgentAuthConfig",
-"properties": {},
+"properties": {
+"serviceAgentAuth": {
+"description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.",
+"enum": [
+"SERVICE_AGENT_AUTH_UNSPECIFIED",
+"ID_TOKEN",
+"ACCESS_TOKEN"
+],
+"enumDescriptions": [
+"Service agent auth type unspecified. Default to ID_TOKEN.",
+"Use [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. This can be used to access Cloud Function and Cloud Run after you grant Invoker role to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`.",
+"Use [access token](https://cloud.google.com/docs/authentication/token-types#access) generated from service agent. This can be used to access other Google Cloud APIs after you grant required roles to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`."
+],
+"type": "string"
+}
+},
 "type": "object"
 },
 "GoogleCloudDialogflowCxV3beta1ToolCall": {
@@ -14043,17 +13962,6 @@ false
 },
 "type": "object"
 },
-"GoogleCloudDialogflowCxV3beta1UpdateDocumentOperationMetadata": {
-"description": "Metadata for UpdateDocument operation.",
-"id": "GoogleCloudDialogflowCxV3beta1UpdateDocumentOperationMetadata",
-"properties": {
-"genericMetadata": {
-"$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata",
-"description": "The generic information of the operation."
-}
-},
-"type": "object"
-},
 "GoogleCloudDialogflowCxV3beta1UserUtterance": {
 "description": "UserUtterance represents one message sent by the customer.",
 "id": "GoogleCloudDialogflowCxV3beta1UserUtterance",
@@ -19160,7 +19068,7 @@ true
 "id": "GoogleCloudDialogflowV2beta1ResponseMessageText",
 "properties": {
 "text": {
-"description": "A collection of text responses.",
+"description": "A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.",
 "items": {
 "type": "string"
 },
@@ -19550,88 +19458,6 @@ true
 },
 "type": "object"
 },
-"GoogleCloudDialogflowV3alpha1CreateDocumentOperationMetadata": {
-"description": "Metadata for CreateDocument operation.",
-"id": "GoogleCloudDialogflowV3alpha1CreateDocumentOperationMetadata",
-"properties": {
-"genericMetadata": {
-"$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata",
-"description": "The generic information of the operation."
-}
-},
-"type": "object"
-},
-"GoogleCloudDialogflowV3alpha1DeleteDocumentOperationMetadata": {
-"description": "Metadata for DeleteDocument operation.",
-"id": "GoogleCloudDialogflowV3alpha1DeleteDocumentOperationMetadata",
-"properties": {
-"genericMetadata": {
-"$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata",
-"description": "The generic information of the operation."
-}
-},
-"type": "object"
-},
-"GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata": {
-"description": "Metadata in google::longrunning::Operation for Knowledge operations.",
-"id": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata",
-"properties": {
-"state": {
-"description": "Required. Output only. The current state of this operation.",
-"enum": [
-"STATE_UNSPECIFIED",
-"PENDING",
-"RUNNING",
-"DONE"
-],
-"enumDescriptions": [
-"State unspecified.",
-"The operation has been created.",
-"The operation is currently running.",
-"The operation is done, either cancelled or completed."
-],
-"readOnly": true,
-"type": "string"
-}
-},
-"type": "object"
-},
-"GoogleCloudDialogflowV3alpha1ImportDocumentsOperationMetadata": {
-"description": "Metadata for ImportDocuments operation.",
-"id": "GoogleCloudDialogflowV3alpha1ImportDocumentsOperationMetadata",
-"properties": {
-"genericMetadata": {
-"$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata",
-"description": "The generic information of the operation."
-}
-},
-"type": "object"
-},
-"GoogleCloudDialogflowV3alpha1ImportDocumentsResponse": {
-"description": "Response message for Documents.ImportDocuments.",
-"id": "GoogleCloudDialogflowV3alpha1ImportDocumentsResponse",
-"properties": {
-"warnings": {
-"description": "Includes details about skipped documents or any other warnings.",
-"items": {
-"$ref": "GoogleRpcStatus"
-},
-"type": "array"
-}
-},
-"type": "object"
-},
-"GoogleCloudDialogflowV3alpha1ReloadDocumentOperationMetadata": {
-"description": "Metadata for ReloadDocument operation.",
-"id": "GoogleCloudDialogflowV3alpha1ReloadDocumentOperationMetadata",
-"properties": {
-"genericMetadata": {
-"$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata",
-"description": "The generic information of the operation."
-}
-},
-"type": "object"
-},
 "GoogleCloudDialogflowV3alpha1TurnSignals": {
 "description": "Collection of all signals that were extracted for a single turn of the conversation.",
 "id": "GoogleCloudDialogflowV3alpha1TurnSignals",
@@ -19701,17 +19527,6 @@ true
 },
 "type": "object"
 },
-"GoogleCloudDialogflowV3alpha1UpdateDocumentOperationMetadata": {
-"description": "Metadata for UpdateDocument operation.",
-"id": "GoogleCloudDialogflowV3alpha1UpdateDocumentOperationMetadata",
-"properties": {
-"genericMetadata": {
-"$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata",
-"description": "The generic information of the operation."
-}
-},
-"type": "object"
-},
 "GoogleCloudLocationListLocationsResponse": {
 "description": "The response message for Locations.ListLocations.",
 "id": "GoogleCloudLocationListLocationsResponse",