google-api-python-client 2.171.0__py3-none-any.whl → 2.173.0__py3-none-any.whl

googleapiclient/discovery_cache/documents/discoveryengine.v1.json

@@ -196,7 +196,7 @@
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
+"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$",
 "required": true,
@@ -308,7 +308,7 @@
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
+"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/cmekConfigs/[^/]+$",
 "required": true,
@@ -7052,7 +7052,7 @@
 }
 }
 },
-"revision": "20250521",
+"revision": "20250609",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "GoogleApiDistribution": {
@@ -8822,6 +8822,33 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesMetadata": {
+"description": "Metadata related to the progress of the UserLicenseService.BatchUpdateUserLicenses operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesMetadata",
+"properties": {
+"createTime": {
+"description": "Operation create time.",
+"format": "google-datetime",
+"type": "string"
+},
+"failureCount": {
+"description": "Count of user licenses that failed to be updated.",
+"format": "int64",
+"type": "string"
+},
+"successCount": {
+"description": "Count of user licenses successfully updated.",
+"format": "int64",
+"type": "string"
+},
+"updateTime": {
+"description": "Operation last update time. If the operation is done, this is also the finish time.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest": {
 "description": "Request message for UserLicenseService.BatchUpdateUserLicenses method.",
 "id": "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest",
@@ -8830,10 +8857,6 @@
 "description": "Optional. If true, if user licenses removed associated license config, the user license will be deleted. By default which is false, the user license will be updated to unassigned state.",
 "type": "boolean"
 },
-"gcsSource": {
-"$ref": "GoogleCloudDiscoveryengineV1GcsSource",
-"description": "Cloud Storage location for the input content."
-},
 "inlineSource": {
 "$ref": "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource",
 "description": "The inline source for the input content for document embeddings."
@@ -8860,6 +8883,27 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesResponse": {
+"description": "Response message for UserLicenseService.BatchUpdateUserLicenses method.",
+"id": "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesResponse",
+"properties": {
+"errorSamples": {
+"description": "A sample of errors encountered while processing the request.",
+"items": {
+"$ref": "GoogleRpcStatus"
+},
+"type": "array"
+},
+"userLicenses": {
+"description": "UserLicenses successfully updated.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1UserLicense"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest": {
 "description": "Request message for SiteSearchEngineService.BatchVerifyTargetSites method.",
 "id": "GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest",
@@ -9408,7 +9452,7 @@
 "type": "string"
 },
 "name": {
-"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
+"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.",
 "type": "string"
 },
 "notebooklmState": {
@@ -9445,7 +9489,8 @@
 "DELETING",
 "DELETE_FAILED",
 "UNUSABLE",
-"ACTIVE_ROTATING"
+"ACTIVE_ROTATING",
+"DELETED"
 ],
 "enumDescriptions": [
 "The CmekConfig state is unknown.",
@@ -9455,7 +9500,8 @@
 "The CmekConfig is deleting.",
 "The CmekConfig deletion process failed.",
 "The CmekConfig is not usable, most likely due to some internal issue.",
-"The KMS key version is being rotated."
+"The KMS key version is being rotated.",
+"The KMS key is soft deleted. Some cleanup policy will eventually be applied."
 ],
 "readOnly": true,
 "type": "string"
@@ -11598,7 +11644,7 @@
 "enumDescriptions": [
 "Defaults to `INCREMENTAL`.",
 "Inserts new documents or updates existing documents.",
-"Calculates diff and replaces the entire document dataset. Existing documents may be deleted if they are not present in the source location."
+"Calculates diff and replaces the entire document dataset. Existing documents may be deleted if they are not present in the source location. When using this mode, there won't be any downtime on the dataset targeted. Any document that should remain unchanged or that should be updated will continue serving while the operation is running."
 ],
 "type": "string"
 },
@@ -12192,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"
@@ -12536,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": {
@@ -14122,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": {
@@ -14132,7 +14183,7 @@
 },
 "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"
 }
 },
 "type": "object"
@@ -15646,7 +15697,7 @@
 "type": "string"
 },
 "name": {
-"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
+"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.",
 "type": "string"
 },
 "notebooklmState": {
@@ -15683,7 +15734,8 @@
 "DELETING",
 "DELETE_FAILED",
 "UNUSABLE",
-"ACTIVE_ROTATING"
+"ACTIVE_ROTATING",
+"DELETED"
 ],
 "enumDescriptions": [
 "The CmekConfig state is unknown.",
@@ -15693,7 +15745,8 @@
 "The CmekConfig is deleting.",
 "The CmekConfig deletion process failed.",
 "The CmekConfig is not usable, most likely due to some internal issue.",
-"The KMS key version is being rotated."
+"The KMS key version is being rotated.",
+"The KMS key is soft deleted. Some cleanup policy will eventually be applied."
 ],
 "readOnly": true,
 "type": "string"
@@ -16499,12 +16552,12 @@
 "description": "The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector."
 },
 "incrementalRefreshInterval": {
-"description": "Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days.",
+"description": "Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors.",
 "format": "google-duration",
 "type": "string"
 },
 "incrementalSyncDisabled": {
-"description": "Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled.",
+"description": "Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors.",
 "type": "boolean"
 },
 "kmsKeyName": {
@@ -17775,7 +17828,7 @@
 "properties": {
 "querySetSpec": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec",
-"description": "Required. The specification of the query set."
+"description": "Optional. The specification of the query set."
 },
 "searchRequest": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest",
@@ -17789,7 +17842,7 @@
 "id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec",
 "properties": {
 "sampleQuerySet": {
-"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.",
+"description": "Optional. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.",
 "type": "string"
 }
 },
@@ -18808,7 +18861,8 @@
 "id": "GoogleCloudDiscoveryengineV1alphaQuery",
 "properties": {
 "queryId": {
-"description": "Unique Id for the query.",
+"description": "Output only. Unique Id for the query.",
+"readOnly": true,
 "type": "string"
 },
 "text": {
@@ -19248,7 +19302,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 * `base_rank`: the default rank of the result",
 "type": "string"
 },
 "rankingExpressionBackend": {
@@ -19256,12 +19310,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"
 },
@@ -19315,6 +19380,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."
@@ -19997,7 +20066,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": {
@@ -20007,7 +20076,7 @@
 },
 "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"
 }
 },
 "type": "object"
@@ -20569,6 +20638,54 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesMetadata": {
+"description": "Metadata related to the progress of the UserLicenseService.BatchUpdateUserLicenses operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesMetadata",
+"properties": {
+"createTime": {
+"description": "Operation create time.",
+"format": "google-datetime",
+"type": "string"
+},
+"failureCount": {
+"description": "Count of user licenses that failed to be updated.",
+"format": "int64",
+"type": "string"
+},
+"successCount": {
+"description": "Count of user licenses successfully updated.",
+"format": "int64",
+"type": "string"
+},
+"updateTime": {
+"description": "Operation last update time. If the operation is done, this is also the finish time.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesResponse": {
+"description": "Response message for UserLicenseService.BatchUpdateUserLicenses method.",
+"id": "GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesResponse",
+"properties": {
+"errorSamples": {
+"description": "A sample of errors encountered while processing the request.",
+"items": {
+"$ref": "GoogleRpcStatus"
+},
+"type": "array"
+},
+"userLicenses": {
+"description": "UserLicenses successfully updated.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1betaUserLicense"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaCmekConfig": {
 "description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.",
 "id": "GoogleCloudDiscoveryengineV1betaCmekConfig",
@@ -20593,7 +20710,7 @@
 "type": "string"
 },
 "name": {
-"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
+"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.",
 "type": "string"
 },
 "notebooklmState": {
@@ -20630,7 +20747,8 @@
 "DELETING",
 "DELETE_FAILED",
 "UNUSABLE",
-"ACTIVE_ROTATING"
+"ACTIVE_ROTATING",
+"DELETED"
 ],
 "enumDescriptions": [
 "The CmekConfig state is unknown.",
@@ -20640,7 +20758,8 @@
 "The CmekConfig is deleting.",
 "The CmekConfig deletion process failed.",
 "The CmekConfig is not usable, most likely due to some internal issue.",
-"The KMS key version is being rotated."
+"The KMS key version is being rotated.",
+"The KMS key is soft deleted. Some cleanup policy will eventually be applied."
 ],
 "readOnly": true,
 "type": "string"
@@ -21906,7 +22025,7 @@
 "properties": {
 "querySetSpec": {
 "$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec",
-"description": "Required. The specification of the query set."
+"description": "Optional. The specification of the query set."
 },
 "searchRequest": {
 "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest",
@@ -21920,7 +22039,7 @@
 "id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec",
 "properties": {
 "sampleQuerySet": {
-"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.",
+"description": "Optional. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.",
 "type": "string"
 }
 },
@@ -22770,7 +22889,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 * `base_rank`: the default rank of the result",
 "type": "string"
 },
 "rankingExpressionBackend": {
@@ -22778,12 +22897,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"
 },
@@ -23791,6 +23921,62 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaUserLicense": {
+"description": "User License information assigned by the admin.",
+"id": "GoogleCloudDiscoveryengineV1betaUserLicense",
+"properties": {
+"createTime": {
+"description": "Output only. User created timestamp.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"lastLoginTime": {
+"description": "Output only. User last logged in time. If the user has not logged in yet, this field will be empty.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"licenseAssignmentState": {
+"description": "Output only. License assignment state of the user. If the user is assigned with a license config, the user loggin will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user;",
+"enum": [
+"LICENSE_ASSIGNMENT_STATE_UNSPECIFIED",
+"ASSIGNED",
+"UNASSIGNED",
+"NO_LICENSE",
+"NO_LICENSE_ATTEMPTED_LOGIN"
+],
+"enumDescriptions": [
+"Default value.",
+"License assigned to the user.",
+"No license assigned to the user. Deprecated, translated to NO_LICENSE.",
+"No license assigned to the user.",
+"User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin)."
+],
+"readOnly": true,
+"type": "string"
+},
+"licenseConfig": {
+"description": "Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user.",
+"type": "string"
+},
+"updateTime": {
+"description": "Output only. User update timestamp.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"userPrincipal": {
+"description": "Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal.",
+"type": "string"
+},
+"userProfile": {
+"description": "Optional. The user profile. We user user full name(First name + Last name) as user profile.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaWorkspaceConfig": {
 "description": "Config to store data store type configuration for workspace data",
 "id": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig",