google-api-python-client 2.172.0__py3-none-any.whl → 2.174.0__py3-none-any.whl

googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json

@@ -5436,7 +5436,7 @@
 }
 }
 },
-"revision": "20250602",
+"revision": "20250617",
 "rootUrl": "https://dialogflow.googleapis.com/",
 "schemas": {
 "GoogleCloudDialogflowCxV3AdvancedSettings": {
@@ -6156,6 +6156,13 @@
 "description": "If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.",
 "type": "boolean"
 },
+"generators": {
+"description": "A list of Generators to be called during this fulfillment.",
+"items": {
+"$ref": "GoogleCloudDialogflowCxV3FulfillmentGeneratorSettings"
+},
+"type": "array"
+},
 "messages": {
 "description": "The list of rich message responses to present to the user.",
 "items": {
@@ -6232,6 +6239,28 @@
 },
 "type": "object"
 },
+"GoogleCloudDialogflowCxV3FulfillmentGeneratorSettings": {
+"description": "Generator settings used by the LLM to generate a text response.",
+"id": "GoogleCloudDialogflowCxV3FulfillmentGeneratorSettings",
+"properties": {
+"generator": {
+"description": "Required. The generator to call. Format: `projects//locations//agents//generators/`.",
+"type": "string"
+},
+"inputParameters": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Map from placeholder parameter in the Generator to corresponding session parameters. By default, Dialogflow uses the session parameter with the same name to fill in the generator template. e.g. If there is a placeholder parameter `city` in the Generator, Dialogflow default to fill in the `$city` with `$session.params.city`. However, you may choose to fill `$city` with `$session.params.desination-city`. - Map key: parameter ID - Map value: session parameter name",
+"type": "object"
+},
+"outputParameter": {
+"description": "Required. Output parameter which should contain the generator response.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowCxV3FulfillmentSetParameterAction": {
 "description": "Setting a parameter value.",
 "id": "GoogleCloudDialogflowCxV3FulfillmentSetParameterAction",
@@ -10942,6 +10971,13 @@
 "description": "If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.",
 "type": "boolean"
 },
+"generators": {
+"description": "A list of Generators to be called during this fulfillment.",
+"items": {
+"$ref": "GoogleCloudDialogflowCxV3beta1FulfillmentGeneratorSettings"
+},
+"type": "array"
+},
 "messages": {
 "description": "The list of rich message responses to present to the user.",
 "items": {
@@ -11018,6 +11054,28 @@
 },
 "type": "object"
 },
+"GoogleCloudDialogflowCxV3beta1FulfillmentGeneratorSettings": {
+"description": "Generator settings used by the LLM to generate a text response.",
+"id": "GoogleCloudDialogflowCxV3beta1FulfillmentGeneratorSettings",
+"properties": {
+"generator": {
+"description": "Required. The generator to call. Format: `projects//locations//agents//generators/`.",
+"type": "string"
+},
+"inputParameters": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Map from placeholder parameter in the Generator to corresponding session parameters. By default, Dialogflow uses the session parameter with the same name to fill in the generator template. e.g. If there is a placeholder parameter `city` in the Generator, Dialogflow default to fill in the `$city` with `$session.params.city`. However, you may choose to fill `$city` with `$session.params.desination-city`. - Map key: parameter ID - Map value: session parameter name",
+"type": "object"
+},
+"outputParameter": {
+"description": "Required. Output parameter which should contain the generator response.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterAction": {
 "description": "Setting a parameter value.",
 "id": "GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterAction",
@@ -13321,6 +13379,10 @@ false
 "$ref": "GoogleCloudDialogflowCxV3beta1LlmModelSettings",
 "description": "Optional. Use the specified LLM model settings for processing the request."
 },
+"parameterScope": {
+"description": "Scope for the parameters. If not specified, parameters will be treated as session parameters. Parameters with custom scope will not be put into session parameters. You can reference the parameters with custom scope in the agent with the following format: $parameter-scope.params.parameter-id.",
+"type": "string"
+},
 "parameters": {
 "additionalProperties": {
 "description": "Properties of the object.",
@@ -13961,6 +14023,10 @@ false
 "Text that contains the tokenized words of the phrase will be matched, e.g. \"foo\" will match \"a foo bar\" and \"foo bar\", but not \"foobar\"."
 ],
 "type": "string"
+},
+"promptSecuritySettings": {
+"$ref": "GoogleCloudDialogflowCxV3beta1SafetySettingsPromptSecuritySettings",
+"description": "Optional. Settings for prompt security checks."
 }
 },
 "type": "object"
@@ -13980,6 +14046,17 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDialogflowCxV3beta1SafetySettingsPromptSecuritySettings": {
+"description": "Settings for prompt security checks.",
+"id": "GoogleCloudDialogflowCxV3beta1SafetySettingsPromptSecuritySettings",
+"properties": {
+"enablePromptSecurity": {
+"description": "Optional. Enable prompt security checks.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowCxV3beta1SearchConfig": {
 "description": "Search configuration for UCS search queries.",
 "id": "GoogleCloudDialogflowCxV3beta1SearchConfig",
@@ -16440,6 +16517,11 @@ false
 "format": "google-datetime",
 "type": "string"
 },
+"doneTime": {
+"description": "The time when the operation finished.",
+"format": "google-datetime",
+"type": "string"
+},
 "state": {
 "description": "State of CreateConversationModel operation.",
 "enum": [
@@ -16483,6 +16565,11 @@ false
 "description": "Timestamp when delete conversation model request was created. The time is measured on server side.",
 "format": "google-datetime",
 "type": "string"
+},
+"doneTime": {
+"description": "The time when the operation finished.",
+"format": "google-datetime",
+"type": "string"
 }
 },
 "type": "object"
@@ -16499,6 +16586,11 @@ false
 "description": "Timestamp when request to deploy conversation model was submitted. The time is measured on server side.",
 "format": "google-datetime",
 "type": "string"
+},
+"doneTime": {
+"description": "The time when the operation finished.",
+"format": "google-datetime",
+"type": "string"
 }
 },
 "type": "object"
@@ -17901,6 +17993,11 @@ true
 "description": "Metadata in google::longrunning::Operation for Knowledge operations.",
 "id": "GoogleCloudDialogflowV2KnowledgeOperationMetadata",
 "properties": {
+"doneTime": {
+"description": "The time when the operation finished.",
+"format": "google-datetime",
+"type": "string"
+},
 "exportOperationMetadata": {
 "$ref": "GoogleCloudDialogflowV2ExportOperationMetadata",
 "description": "Metadata for the Export Data Operation such as the destination of export."
@@ -18510,7 +18607,7 @@ true
 "id": "GoogleCloudDialogflowV2ToolCall",
 "properties": {
 "action": {
-"description": "Required. The name of the tool's action associated with this call.",
+"description": "Optional. The name of the tool's action associated with this call.",
 "type": "string"
 },
 "createTime": {
@@ -18528,7 +18625,7 @@ true
 "type": "object"
 },
 "tool": {
-"description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.",
+"description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.",
 "type": "string"
 }
 },
@@ -18539,7 +18636,7 @@ true
 "id": "GoogleCloudDialogflowV2ToolCallResult",
 "properties": {
 "action": {
-"description": "Required. The name of the tool's action associated with this call.",
+"description": "Optional. The name of the tool's action associated with this call.",
 "type": "string"
 },
 "content": {
@@ -18562,7 +18659,7 @@ true
 "type": "string"
 },
 "tool": {
-"description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.",
+"description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.",
 "type": "string"
 }
 },
@@ -18591,6 +18688,11 @@ true
 "description": "Timestamp when the request to undeploy conversation model was submitted. The time is measured on server side.",
 "format": "google-datetime",
 "type": "string"
+},
+"doneTime": {
+"description": "The time when the operation finished.",
+"format": "google-datetime",
+"type": "string"
 }
 },
 "type": "object"
@@ -20608,6 +20710,11 @@ true
 "description": "Metadata in google::longrunning::Operation for Knowledge operations.",
 "id": "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata",
 "properties": {
+"doneTime": {
+"description": "The time when the operation finished.",
+"format": "google-datetime",
+"type": "string"
+},
 "exportOperationMetadata": {
 "$ref": "GoogleCloudDialogflowV2beta1ExportOperationMetadata",
 "description": "Metadata for the Export Data Operation such as the destination of export."
@@ -21423,7 +21530,7 @@ true
 "id": "GoogleCloudDialogflowV2beta1ToolCall",
 "properties": {
 "action": {
-"description": "Required. The name of the tool's action associated with this call.",
+"description": "Optional. The name of the tool's action associated with this call.",
 "type": "string"
 },
 "createTime": {
@@ -21441,7 +21548,7 @@ true
 "type": "object"
 },
 "tool": {
-"description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.",
+"description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.",
 "type": "string"
 }
 },
@@ -21452,7 +21559,7 @@ true
 "id": "GoogleCloudDialogflowV2beta1ToolCallResult",
 "properties": {
 "action": {
-"description": "Required. The name of the tool's action associated with this call.",
+"description": "Optional. The name of the tool's action associated with this call.",
 "type": "string"
 },
 "content": {
@@ -21475,7 +21582,7 @@ true
 "type": "string"
 },
 "tool": {
-"description": "Required. The tool associated with this call. Format: `projects//locations//tools/`.",
+"description": "Optional. The tool associated with this call. Format: `projects//locations//tools/`.",
 "type": "string"
 }
 },

googleapiclient/discovery_cache/documents/discoveryengine.v1.json

@@ -7052,7 +7052,7 @@
 }
 }
 },
-"revision": "20250604",
+"revision": "20250617",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "GoogleApiDistribution": {
@@ -12238,6 +12238,10 @@
 "description": "Principal identifier of a user or a group.",
 "id": "GoogleCloudDiscoveryengineV1Principal",
 "properties": {
+"externalEntityId": {
+"description": "For 3P application identities which are not present in the customer identity provider.",
+"type": "string"
+},
 "groupId": {
 "description": "Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config.",
 "type": "string"
@@ -12582,7 +12586,8 @@
 "id": "GoogleCloudDiscoveryengineV1Query",
 "properties": {
 "queryId": {
-"description": "Unique Id for the query.",
+"description": "Output only. Unique Id for the query.",
+"readOnly": true,
 "type": "string"
 },
 "text": {
@@ -14168,7 +14173,7 @@
 "id": "GoogleCloudDiscoveryengineV1SessionTurn",
 "properties": {
 "answer": {
-"description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.",
+"description": "Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.",
 "type": "string"
 },
 "detailedAnswer": {
@@ -14178,13 +14183,13 @@
 },
 "query": {
 "$ref": "GoogleCloudDiscoveryengineV1Query",
-"description": "The user query."
+"description": "Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn"
 },
-"queryConfigs": {
+"queryConfig": {
 "additionalProperties": {
 "type": "string"
 },
-"description": "Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix \"google.\" will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with \"google..\". 3P services can use anything not starting with \"google.\"",
+"description": "Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). The prefix \"google.\" is reserved for Google-developed functionality.",
 "type": "object"
 }
 },
@@ -18863,7 +18868,8 @@
 "id": "GoogleCloudDiscoveryengineV1alphaQuery",
 "properties": {
 "queryId": {
-"description": "Unique Id for the query.",
+"description": "Output only. Unique Id for the query.",
+"readOnly": true,
 "type": "string"
 },
 "text": {
@@ -19303,7 +19309,7 @@
 "description": "The query expansion specification that specifies the conditions under which query expansion occurs."
 },
 "rankingExpression": {
-"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result",
+"description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result",
 "type": "string"
 },
 "rankingExpressionBackend": {
@@ -19311,12 +19317,23 @@
 "enum": [
 "RANKING_EXPRESSION_BACKEND_UNSPECIFIED",
 "BYOE",
-"CLEARBOX"
+"CLEARBOX",
+"RANK_BY_EMBEDDING",
+"RANK_BY_FORMULA"
+],
+"enumDeprecated": [
+false,
+true,
+true,
+false,
+false
 ],
 "enumDescriptions": [
 "Default option for unspecified/unknown values.",
-"Bring your own embedding (BYOE), the default way to evaluate the ranking expression.",
-"The expression is compiled into a Clearbox formula."
+"Deprecated: Use `RANK_BY_EMBEDDING` instead. Ranking by custom embedding model, the default way to evaluate the ranking expression. Legacy enum option, `RANK_BY_EMBEDDING` should be used instead.",
+"Deprecated: Use `RANK_BY_FORMULA` instead. Ranking by custom formula. Legacy enum option, `RANK_BY_FORMULA` should be used instead.",
+"Ranking by custom embedding model, the default way to evaluate the ranking expression.",
+"Ranking by custom formula."
 ],
 "type": "string"
 },
@@ -19370,6 +19387,10 @@
 "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec",
 "description": "The spell correction specification that specifies the mode under which spell correction takes effect."
 },
+"useLatestData": {
+"description": "Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users.",
+"type": "boolean"
+},
 "userInfo": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo",
 "description": "Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics."
@@ -20052,7 +20073,7 @@
 "id": "GoogleCloudDiscoveryengineV1alphaSessionTurn",
 "properties": {
 "answer": {
-"description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.",
+"description": "Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.",
 "type": "string"
 },
 "detailedAnswer": {
@@ -20062,13 +20083,13 @@
 },
 "query": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaQuery",
-"description": "The user query."
+"description": "Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn"
 },
-"queryConfigs": {
+"queryConfig": {
 "additionalProperties": {
 "type": "string"
 },
-"description": "Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix \"google.\" will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with \"google..\". 3P services can use anything not starting with \"google.\"",
+"description": "Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). The prefix \"google.\" is reserved for Google-developed functionality.",
 "type": "object"
 }
 },
@@ -22882,7 +22903,7 @@
 "description": "The query expansion specification that specifies the conditions under which query expansion occurs."
 },
 "rankingExpression": {
-"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result",
+"description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result",
 "type": "string"
 },
 "rankingExpressionBackend": {
@@ -22890,12 +22911,23 @@
 "enum": [
 "RANKING_EXPRESSION_BACKEND_UNSPECIFIED",
 "BYOE",
-"CLEARBOX"
+"CLEARBOX",
+"RANK_BY_EMBEDDING",
+"RANK_BY_FORMULA"
+],
+"enumDeprecated": [
+false,
+true,
+true,
+false,
+false
 ],
 "enumDescriptions": [
 "Default option for unspecified/unknown values.",
-"Bring your own embedding (BYOE), the default way to evaluate the ranking expression.",
-"The expression is compiled into a Clearbox formula."
+"Deprecated: Use `RANK_BY_EMBEDDING` instead. Ranking by custom embedding model, the default way to evaluate the ranking expression. Legacy enum option, `RANK_BY_EMBEDDING` should be used instead.",
+"Deprecated: Use `RANK_BY_FORMULA` instead. Ranking by custom formula. Legacy enum option, `RANK_BY_FORMULA` should be used instead.",
+"Ranking by custom embedding model, the default way to evaluate the ranking expression.",
+"Ranking by custom formula."
 ],
 "type": "string"
 },

googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json

@@ -9173,7 +9173,7 @@
 }
 }
 },
-"revision": "20250604",
+"revision": "20250617",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "ApiservingMediaRequestInfo": {
@@ -19873,6 +19873,10 @@
 "description": "Principal identifier of a user or a group.",
 "id": "GoogleCloudDiscoveryengineV1alphaPrincipal",
 "properties": {
+"externalEntityId": {
+"description": "For 3P application identities which are not present in the customer identity provider.",
+"type": "string"
+},
 "groupId": {
 "description": "Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config.",
 "type": "string"
@@ -20325,7 +20329,8 @@
 "id": "GoogleCloudDiscoveryengineV1alphaQuery",
 "properties": {
 "queryId": {
-"description": "Unique Id for the query.",
+"description": "Output only. Unique Id for the query.",
+"readOnly": true,
 "type": "string"
 },
 "text": {
@@ -21319,7 +21324,7 @@
 "description": "The query expansion specification that specifies the conditions under which query expansion occurs."
 },
 "rankingExpression": {
-"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result",
+"description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result",
 "type": "string"
 },
 "rankingExpressionBackend": {
@@ -21327,12 +21332,23 @@
 "enum": [
 "RANKING_EXPRESSION_BACKEND_UNSPECIFIED",
 "BYOE",
-"CLEARBOX"
+"CLEARBOX",
+"RANK_BY_EMBEDDING",
+"RANK_BY_FORMULA"
+],
+"enumDeprecated": [
+false,
+true,
+true,
+false,
+false
 ],
 "enumDescriptions": [
 "Default option for unspecified/unknown values.",
-"Bring your own embedding (BYOE), the default way to evaluate the ranking expression.",
-"The expression is compiled into a Clearbox formula."
+"Deprecated: Use `RANK_BY_EMBEDDING` instead. Ranking by custom embedding model, the default way to evaluate the ranking expression. Legacy enum option, `RANK_BY_EMBEDDING` should be used instead.",
+"Deprecated: Use `RANK_BY_FORMULA` instead. Ranking by custom formula. Legacy enum option, `RANK_BY_FORMULA` should be used instead.",
+"Ranking by custom embedding model, the default way to evaluate the ranking expression.",
+"Ranking by custom formula."
 ],
 "type": "string"
 },
@@ -21386,6 +21402,10 @@
 "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec",
 "description": "The spell correction specification that specifies the mode under which spell correction takes effect."
 },
+"useLatestData": {
+"description": "Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users.",
+"type": "boolean"
+},
 "userInfo": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo",
 "description": "Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics."
@@ -22967,7 +22987,7 @@
 "id": "GoogleCloudDiscoveryengineV1alphaSessionTurn",
 "properties": {
 "answer": {
-"description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.",
+"description": "Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.",
 "type": "string"
 },
 "detailedAnswer": {
@@ -22977,13 +22997,13 @@
 },
 "query": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaQuery",
-"description": "The user query."
+"description": "Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn"
 },
-"queryConfigs": {
+"queryConfig": {
 "additionalProperties": {
 "type": "string"
 },
-"description": "Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). We don't want to import directly the [AnswerGenerationSpec] structure as this will serve a more general purpose and a wider set of customers. This information is used in particular when rendering alternative answers to the same prompt, providing visual information about how each answer was generated. The prefix \"google.\" will be reserved for the key, and 1P services (Answer, Assistant, etc.) should always store their information with \"google..\". 3P services can use anything not starting with \"google.\"",
+"description": "Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). The prefix \"google.\" is reserved for Google-developed functionality.",
 "type": "object"
 }
 },
@@ -26922,7 +26942,7 @@
 "description": "The query expansion specification that specifies the conditions under which query expansion occurs."
 },
 "rankingExpression": {
-"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result",
+"description": "Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result",
 "type": "string"
 },
 "rankingExpressionBackend": {
@@ -26930,12 +26950,23 @@
 "enum": [
 "RANKING_EXPRESSION_BACKEND_UNSPECIFIED",
 "BYOE",
-"CLEARBOX"
+"CLEARBOX",
+"RANK_BY_EMBEDDING",
+"RANK_BY_FORMULA"
+],
+"enumDeprecated": [
+false,
+true,
+true,
+false,
+false
 ],
 "enumDescriptions": [
 "Default option for unspecified/unknown values.",
-"Bring your own embedding (BYOE), the default way to evaluate the ranking expression.",
-"The expression is compiled into a Clearbox formula."
+"Deprecated: Use `RANK_BY_EMBEDDING` instead. Ranking by custom embedding model, the default way to evaluate the ranking expression. Legacy enum option, `RANK_BY_EMBEDDING` should be used instead.",
+"Deprecated: Use `RANK_BY_FORMULA` instead. Ranking by custom formula. Legacy enum option, `RANK_BY_FORMULA` should be used instead.",
+"Ranking by custom embedding model, the default way to evaluate the ranking expression.",
+"Ranking by custom formula."
 ],
 "type": "string"
 },