google-api-python-client 2.149.0__py2.py3-none-any.whl → 2.151.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/dialogflow.v2.json

@@ -3284,7 +3284,7 @@
 ],
 "parameters": {
 "conversationId": {
-"description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.",
+"description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.",
 "location": "query",
 "type": "string"
 },
@@ -3782,7 +3782,7 @@
 ],
 "parameters": {
 "generatorId": {
-"description": "Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is not provided, an Id will be auto-generated. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.",
+"description": "Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is not provided, an Id will be auto-generated. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.",
 "location": "query",
 "type": "string"
 },
@@ -7257,7 +7257,7 @@
 ],
 "parameters": {
 "conversationId": {
-"description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.",
+"description": "Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.",
 "location": "query",
 "type": "string"
 },
@@ -7788,7 +7788,7 @@
 ],
 "parameters": {
 "generatorId": {
-"description": "Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression fomula `a-zA-Z*` with the characters length in range of [3,64]. If the field is not provided, an Id will be auto-generated. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.",
+"description": "Optional. The ID to use for the generator, which will become the final component of the generator's resource name. The generator ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is not provided, an Id will be auto-generated. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.",
 "location": "query",
 "type": "string"
 },
@@ -7848,7 +7848,7 @@
 ],
 "parameters": {
 "name": {
-"description": "Required. The generator resource name to retrieve. Format: `projects//locations/`/generators/`",
+"description": "Required. The generator resource name to retrieve. Format: `projects//locations//generators/`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/generators/[^/]+$",
 "required": true,
@@ -8714,7 +8714,7 @@
 }
 }
 },
-"revision": "20240924",
+"revision": "20241019",
 "rootUrl": "https://dialogflow.googleapis.com/",
 "schemas": {
 "GoogleCloudDialogflowCxV3AdvancedSettings": {
@@ -15765,6 +15765,11 @@ true
 "$ref": "GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigContextFilterSettings",
 "description": "Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped."
 },
+"contextSize": {
+"description": "Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST.",
+"format": "int32",
+"type": "integer"
+},
 "dialogflowQuerySource": {
 "$ref": "GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySource",
 "description": "Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST."
@@ -16246,6 +16251,13 @@ true
 },
 "type": "array"
 },
+"phraseSets": {
+"description": "A collection of phrase set resources to use for speech adaptation.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
 "sampleRateHertz": {
 "description": "Required. Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.",
 "format": "int32",
@@ -17302,6 +17314,14 @@ true
 "description": "Snippet Source for a Generative Prediction.",
 "id": "GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet",
 "properties": {
+"metadata": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Metadata of the document.",
+"type": "object"
+},
 "text": {
 "description": "Text taken from that URI.",
 "type": "string"
@@ -18217,6 +18237,14 @@ true
 "description": "The sources of the answers.",
 "id": "GoogleCloudDialogflowV2SearchKnowledgeAnswerAnswerSource",
 "properties": {
+"metadata": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Metadata associated with the article.",
+"type": "object"
+},
 "snippet": {
 "description": "The relevant snippet of the article.",
 "type": "string"
@@ -18244,6 +18272,18 @@ true
 "description": "Required. The conversation profile used to configure the search. Format: `projects//locations//conversationProfiles/`.",
 "type": "string"
 },
+"endUserMetadata": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { \"subscription plan\": \"Business Premium Plus\", \"devices owned\": [ {\"model\": \"Google Pixel 7\"}, {\"model\": \"Google Pixel Tablet\"} ] } ```",
+"type": "object"
+},
+"exactSearch": {
+"description": "Optional. Whether to search the query exactly without query rewrite.",
+"type": "boolean"
+},
 "latestMessage": {
 "description": "Optional. The name of the latest conversation message when the request is triggered. Format: `projects//locations//conversations//messages/`.",
 "type": "string"
@@ -18256,6 +18296,24 @@ true
 "$ref": "GoogleCloudDialogflowV2TextInput",
 "description": "Required. The natural language text query for knowledge search."
 },
+"querySource": {
+"description": "Optional. The source of the query in the request.",
+"enum": [
+"QUERY_SOURCE_UNSPECIFIED",
+"AGENT_QUERY",
+"SUGGESTED_QUERY"
+],
+"enumDescriptions": [
+"Unknown query source.",
+"The query is from agents.",
+"The query is a suggested query from Participants.SuggestKnowledgeAssist."
+],
+"type": "string"
+},
+"searchConfig": {
+"$ref": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfig",
+"description": "Optional. Configuration specific to search queries with data stores."
+},
 "sessionId": {
 "description": "Required. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters.",
 "type": "string"
@@ -18263,6 +18321,160 @@ true
 },
 "type": "object"
 },
+"GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfig": {
+"description": "Configuration specific to search queries with data stores.",
+"id": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfig",
+"properties": {
+"boostSpecs": {
+"description": "Optional. Boost specifications for data stores.",
+"items": {
+"$ref": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecs"
+},
+"type": "array"
+},
+"filterSpecs": {
+"description": "Optional. Filter specification for data store queries.",
+"items": {
+"$ref": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigFilterSpecs"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecs": {
+"description": "Boost specifications for data stores.",
+"id": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecs",
+"properties": {
+"dataStores": {
+"description": "Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store}",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"spec": {
+"description": "Optional. A list of boosting specifications.",
+"items": {
+"$ref": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpec"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpec": {
+"description": "Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec",
+"id": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpec",
+"properties": {
+"conditionBoostSpecs": {
+"description": "Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.",
+"items": {
+"$ref": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpec"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpec": {
+"description": "Boost applies to documents which match a condition.",
+"id": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpec",
+"properties": {
+"boost": {
+"description": "Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.",
+"format": "float",
+"type": "number"
+},
+"boostControlSpec": {
+"$ref": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpecBoostControlSpec",
+"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"
+}
+},
+"type": "object"
+},
+"GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpecBoostControlSpec": {
+"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": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpecBoostControlSpec",
+"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": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpecBoostControlSpecControlPoint"
+},
+"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"
+},
+"GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpecBoostControlSpecControlPoint": {
+"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": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpecBoostControlSpecControlPoint",
+"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"
+},
+"GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigFilterSpecs": {
+"description": "Filter specification for data store queries.",
+"id": "GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigFilterSpecs",
+"properties": {
+"dataStores": {
+"description": "Optional. The data store where the filter configuration is applied. Full resource name of data store, such as projects/{project}/locations/{location}/collections/{collectionId}/ dataStores/{dataStoreId}.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"filter": {
+"description": "Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowV2SearchKnowledgeResponse": {
 "description": "The response message for Conversations.SearchKnowledge.",
 "id": "GoogleCloudDialogflowV2SearchKnowledgeResponse",
@@ -18574,6 +18786,13 @@ true
 "description": "Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection.",
 "type": "string"
 },
+"phraseSets": {
+"description": "List of names of Cloud Speech phrase sets that are used for transcription.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
 "sampleRateHertz": {
 "description": "Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.",
 "format": "int32",
@@ -21141,6 +21360,14 @@ true
 "description": "Snippet Source for a Generative Prediction.",
 "id": "GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet",
 "properties": {
+"metadata": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Metadata of the document.",
+"type": "object"
+},
 "text": {
 "description": "Text taken from that URI.",
 "type": "string"