google-api-python-client 2.122.0__py2.py3-none-any.whl → 2.124.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/dialogflow.v3.json

@@ -4453,7 +4453,7 @@
 }
 }
 },
-"revision": "20240305",
+"revision": "20240314",
 "rootUrl": "https://dialogflow.googleapis.com/",
 "schemas": {
 "GoogleCloudDialogflowCxV3AdvancedSettings": {
@@ -5203,6 +5203,224 @@
 },
 "type": "object"
 },
+"GoogleCloudDialogflowCxV3DataStoreConnectionSignals": {
+"description": "Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ...",
+"id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignals",
+"properties": {
+"answer": {
+"description": "Optional. The final compiled answer.",
+"type": "string"
+},
+"answerGenerationModelCallSignals": {
+"$ref": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals",
+"description": "Optional. Diagnostic info related to the answer generation model call."
+},
+"answerParts": {
+"description": "Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces).",
+"items": {
+"$ref": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerPart"
+},
+"type": "array"
+},
+"citedSnippets": {
+"description": "Optional. Snippets cited by the answer generation model from the most to least relevant.",
+"items": {
+"$ref": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsCitedSnippet"
+},
+"type": "array"
+},
+"groundingSignals": {
+"$ref": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsGroundingSignals",
+"description": "Optional. Grounding signals."
+},
+"rewriterModelCallSignals": {
+"$ref": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsRewriterModelCallSignals",
+"description": "Optional. Diagnostic info related to the rewriter model call."
+},
+"rewrittenQuery": {
+"description": "Optional. Rewritten string query used for search.",
+"type": "string"
+},
+"safetySignals": {
+"$ref": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSafetySignals",
+"description": "Optional. Safety check result."
+},
+"searchSnippets": {
+"description": "Optional. Search snippets included in the answer generation prompt.",
+"items": {
+"$ref": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSearchSnippet"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals": {
+"description": "Diagnostic info related to the answer generation model call.",
+"id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals",
+"properties": {
+"modelOutput": {
+"description": "Output of the generative model.",
+"type": "string"
+},
+"renderedPrompt": {
+"description": "Prompt as sent to the model.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerPart": {
+"description": "Answer part with citation.",
+"id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerPart",
+"properties": {
+"supportingIndices": {
+"description": "Citations for this answer part. Indices of `search_snippets`.",
+"items": {
+"format": "int32",
+"type": "integer"
+},
+"type": "array"
+},
+"text": {
+"description": "Substring of the answer.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDialogflowCxV3DataStoreConnectionSignalsCitedSnippet": {
+"description": "Snippet cited by the answer generation model.",
+"id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsCitedSnippet",
+"properties": {
+"searchSnippet": {
+"$ref": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSearchSnippet",
+"description": "Details of the snippet."
+},
+"snippetIndex": {
+"description": "Index of the snippet in `search_snippets` field.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
+"GoogleCloudDialogflowCxV3DataStoreConnectionSignalsGroundingSignals": {
+"description": "Grounding signals.",
+"id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsGroundingSignals",
+"properties": {
+"decision": {
+"description": "Represents the decision of the grounding check.",
+"enum": [
+"GROUNDING_DECISION_UNSPECIFIED",
+"ACCEPTED_BY_GROUNDING",
+"REJECTED_BY_GROUNDING"
+],
+"enumDescriptions": [
+"Decision not specified.",
+"Grounding have accepted the answer.",
+"Grounding have rejected the answer."
+],
+"type": "string"
+},
+"score": {
+"description": "Grounding score bucket setting.",
+"enum": [
+"GROUNDING_SCORE_BUCKET_UNSPECIFIED",
+"VERY_LOW",
+"LOW",
+"MEDIUM",
+"HIGH",
+"VERY_HIGH"
+],
+"enumDescriptions": [
+"Score not specified.",
+"We have very low confidence that the answer is grounded.",
+"We have low confidence that the answer is grounded.",
+"We have medium confidence that the answer is grounded.",
+"We have high confidence that the answer is grounded.",
+"We have very high confidence that the answer is grounded."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDialogflowCxV3DataStoreConnectionSignalsRewriterModelCallSignals": {
+"description": "Diagnostic info related to the rewriter model call.",
+"id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsRewriterModelCallSignals",
+"properties": {
+"modelOutput": {
+"description": "Output of the generative model.",
+"type": "string"
+},
+"renderedPrompt": {
+"description": "Prompt as sent to the model.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSafetySignals": {
+"description": "Safety check results.",
+"id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSafetySignals",
+"properties": {
+"bannedPhraseMatch": {
+"description": "Specifies banned phrase match subject.",
+"enum": [
+"BANNED_PHRASE_MATCH_UNSPECIFIED",
+"BANNED_PHRASE_MATCH_NONE",
+"BANNED_PHRASE_MATCH_QUERY",
+"BANNED_PHRASE_MATCH_RESPONSE"
+],
+"enumDescriptions": [
+"No banned phrase check was executed.",
+"All banned phrase checks led to no match.",
+"A banned phrase matched the query.",
+"A banned phrase matched the response."
+],
+"type": "string"
+},
+"decision": {
+"description": "Safety decision.",
+"enum": [
+"SAFETY_DECISION_UNSPECIFIED",
+"ACCEPTED_BY_SAFETY_CHECK",
+"REJECTED_BY_SAFETY_CHECK"
+],
+"enumDescriptions": [
+"Decision not specified.",
+"No manual or automatic safety check fired.",
+"One ore more safety checks fired."
+],
+"type": "string"
+},
+"matchedBannedPhrase": {
+"description": "The matched banned phrase if there was a match.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSearchSnippet": {
+"description": "Search snippet details.",
+"id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsSearchSnippet",
+"properties": {
+"documentTitle": {
+"description": "Title of the enclosing document.",
+"type": "string"
+},
+"documentUri": {
+"description": "Uri for the document. Present if specified for the document.",
+"type": "string"
+},
+"text": {
+"description": "Text included in the prompt.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowCxV3DeleteDocumentOperationMetadata": {
 "description": "Metadata for DeleteDocument operation.",
 "id": "GoogleCloudDialogflowCxV3DeleteDocumentOperationMetadata",
@@ -7971,6 +8189,10 @@ false
 "description": "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\" } } ```",
 "type": "object"
 },
+"populateDataStoreConnectionSignals": {
+"description": "Optional. If set to true and data stores are involved in serving the request then DetectIntentResponse.query_result.data_store_connection_signals will be filled with data that can help evaluations.",
+"type": "boolean"
+},
 "searchConfig": {
 "$ref": "GoogleCloudDialogflowCxV3SearchConfig",
 "description": "Optional. Search configuration for UCS search queries."
@@ -8017,6 +8239,10 @@ false
 "$ref": "GoogleCloudDialogflowCxV3Page",
 "description": "The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`."
 },
+"dataStoreConnectionSignals": {
+"$ref": "GoogleCloudDialogflowCxV3DataStoreConnectionSignals",
+"description": "Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request."
+},
 "diagnosticInfo": {
 "additionalProperties": {
 "description": "Properties of the object.",
@@ -9598,6 +9824,10 @@ false
 ],
 "type": "string"
 },
+"oauthConfig": {
+"$ref": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig",
+"description": "Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header."
+},
 "parameterMapping": {
 "additionalProperties": {
 "type": "string"
@@ -9621,6 +9851,22 @@ false
 "description": "The HTTP request headers to send together with webhook requests.",
 "type": "object"
 },
+"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",
+"NONE",
+"ID_TOKEN",
+"ACCESS_TOKEN"
+],
+"enumDescriptions": [
+"Service agent auth type unspecified. Default to ID_TOKEN.",
+"No token used.",
+"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"
+},
 "uri": {
 "description": "Required. The webhook URI for receiving POST requests. It must use https protocol.",
 "type": "string"
@@ -9647,6 +9893,32 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig": {
+"description": "Represents configuration of OAuth client credential flow for 3rd party API authentication.",
+"id": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig",
+"properties": {
+"clientId": {
+"description": "Required. The client ID provided by the 3rd party platform.",
+"type": "string"
+},
+"clientSecret": {
+"description": "Required. The client secret provided by the 3rd party platform.",
+"type": "string"
+},
+"scopes": {
+"description": "Optional. The OAuth scopes to grant.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"tokenEndpoint": {
+"description": "Required. The token endpoint provided by the 3rd party platform to exchange an access token.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowCxV3WebhookRequest": {
 "description": "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. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.",
 "id": "GoogleCloudDialogflowCxV3WebhookRequest",
@@ -11892,6 +12164,10 @@ false
 ],
 "type": "string"
 },
+"oauthConfig": {
+"$ref": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig",
+"description": "Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header."
+},
 "parameterMapping": {
 "additionalProperties": {
 "type": "string"
@@ -11915,6 +12191,22 @@ false
 "description": "The HTTP request headers to send together with webhook requests.",
 "type": "object"
 },
+"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",
+"NONE",
+"ID_TOKEN",
+"ACCESS_TOKEN"
+],
+"enumDescriptions": [
+"Service agent auth type unspecified. Default to ID_TOKEN.",
+"No token used.",
+"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"
+},
 "uri": {
 "description": "Required. The webhook URI for receiving POST requests. It must use https protocol.",
 "type": "string"
@@ -11941,6 +12233,32 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig": {
+"description": "Represents configuration of OAuth client credential flow for 3rd party API authentication.",
+"id": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig",
+"properties": {
+"clientId": {
+"description": "Required. The client ID provided by the 3rd party platform.",
+"type": "string"
+},
+"clientSecret": {
+"description": "Required. The client secret provided by the 3rd party platform.",
+"type": "string"
+},
+"scopes": {
+"description": "Optional. The OAuth scopes to grant.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"tokenEndpoint": {
+"description": "Required. The token endpoint provided by the 3rd party platform to exchange an access token.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowCxV3beta1WebhookRequest": {
 "description": "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. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.",
 "id": "GoogleCloudDialogflowCxV3beta1WebhookRequest",