google-api-python-client 2.129.0__py2.py3-none-any.whl → 2.131.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json

@@ -464,7 +464,7 @@
 ],
 "parameters": {
 "documentId": {
-"description": "Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
+"description": "Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "location": "query",
 "type": "string"
 },
@@ -538,7 +538,7 @@
 ]
 },
 "import": {
-"description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.",
+"description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated.",
 "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import",
 "httpMethod": "POST",
 "id": "discoveryengine.projects.locations.collections.dataStores.branches.documents.import",
@@ -575,7 +575,7 @@
 ],
 "parameters": {
 "pageSize": {
-"description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.",
+"description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.",
 "format": "int32",
 "location": "query",
 "type": "integer"
@@ -611,7 +611,7 @@
 ],
 "parameters": {
 "allowMissing": {
-"description": "If set to true, and the Document is not found, a new Document will be created.",
+"description": "If set to `true` and the Document is not found, a new Document is be created.",
 "location": "query",
 "type": "boolean"
 },
@@ -623,7 +623,7 @@
 "type": "string"
 },
 "updateMask": {
-"description": "Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.",
+"description": "Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -672,6 +672,34 @@
 },
 "operations": {
 "methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "discoveryengine.projects.locations.collections.dataStores.branches.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta/{+name}:cancel",
+"request": {
+"$ref": "GoogleLongrunningCancelOperationRequest"
+},
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
 "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}",
@@ -1124,7 +1152,7 @@
 "type": "string"
 },
 "schemaId": {
-"description": "Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.",
+"description": "Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.",
 "location": "query",
 "type": "string"
 }
@@ -1200,7 +1228,7 @@
 ],
 "parameters": {
 "pageSize": {
-"description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
+"description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.",
 "format": "int32",
 "location": "query",
 "type": "integer"
@@ -1236,7 +1264,7 @@
 ],
 "parameters": {
 "allowMissing": {
-"description": "If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored.",
+"description": "If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored.",
 "location": "query",
 "type": "boolean"
 },
@@ -1468,7 +1496,7 @@
 ],
 "parameters": {
 "servingConfig": {
-"description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.",
+"description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
 "required": true,
@@ -2283,7 +2311,7 @@
 ]
 },
 "import": {
-"description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.",
+"description": "Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.",
 "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:import",
 "httpMethod": "POST",
 "id": "discoveryengine.projects.locations.collections.dataStores.userEvents.import",
@@ -2983,7 +3011,7 @@
 ],
 "parameters": {
 "servingConfig": {
-"description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.",
+"description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$",
 "required": true,
@@ -3549,7 +3577,7 @@
 ],
 "parameters": {
 "documentId": {
-"description": "Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
+"description": "Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "location": "query",
 "type": "string"
 },
@@ -3623,7 +3651,7 @@
 ]
 },
 "import": {
-"description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.",
+"description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated.",
 "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import",
 "httpMethod": "POST",
 "id": "discoveryengine.projects.locations.dataStores.branches.documents.import",
@@ -3660,7 +3688,7 @@
 ],
 "parameters": {
 "pageSize": {
-"description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.",
+"description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.",
 "format": "int32",
 "location": "query",
 "type": "integer"
@@ -3696,7 +3724,7 @@
 ],
 "parameters": {
 "allowMissing": {
-"description": "If set to true, and the Document is not found, a new Document will be created.",
+"description": "If set to `true` and the Document is not found, a new Document is be created.",
 "location": "query",
 "type": "boolean"
 },
@@ -3708,7 +3736,7 @@
 "type": "string"
 },
 "updateMask": {
-"description": "Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.",
+"description": "Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -3757,6 +3785,34 @@
 },
 "operations": {
 "methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "discoveryengine.projects.locations.dataStores.branches.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta/{+name}:cancel",
+"request": {
+"$ref": "GoogleLongrunningCancelOperationRequest"
+},
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
 "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}",
@@ -4180,7 +4236,7 @@
 "type": "string"
 },
 "schemaId": {
-"description": "Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.",
+"description": "Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.",
 "location": "query",
 "type": "string"
 }
@@ -4256,7 +4312,7 @@
 ],
 "parameters": {
 "pageSize": {
-"description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
+"description": "The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.",
 "format": "int32",
 "location": "query",
 "type": "integer"
@@ -4292,7 +4348,7 @@
 ],
 "parameters": {
 "allowMissing": {
-"description": "If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored.",
+"description": "If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored.",
 "location": "query",
 "type": "boolean"
 },
@@ -4452,7 +4508,7 @@
 ],
 "parameters": {
 "servingConfig": {
-"description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.",
+"description": "Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
 "required": true,
@@ -5061,7 +5117,7 @@
 ]
 },
 "import": {
-"description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.",
+"description": "Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.",
 "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:import",
 "httpMethod": "POST",
 "id": "discoveryengine.projects.locations.dataStores.userEvents.import",
@@ -5361,7 +5417,7 @@
 }
 }
 },
-"revision": "20240509",
+"revision": "20240517",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "GoogleApiHttpBody": {
@@ -5907,7 +5963,7 @@
 "type": "string"
 },
 "industryVertical": {
-"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine.",
+"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.",
 "enum": [
 "INDUSTRY_VERTICAL_UNSPECIFIED",
 "GENERIC",
@@ -7413,7 +7469,7 @@
 "type": "string"
 },
 "industryVertical": {
-"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine.",
+"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.",
 "enum": [
 "INDUSTRY_VERTICAL_UNSPECIFIED",
 "GENERIC",
@@ -8465,7 +8521,7 @@
 "id": "GoogleCloudDiscoveryengineV1alphaSessionTurn",
 "properties": {
 "answer": {
-"description": "The resource name of the answer to the user query.",
+"description": "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"
 },
 "query": {
@@ -8871,7 +8927,7 @@
 "description": "Search specification."
 },
 "session": {
-"description": "The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol \u201c-\u201d as session id. A new id will be automatically generated and assigned.",
+"description": "The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned.",
 "type": "string"
 },
 "userPseudoId": {
@@ -10491,7 +10547,7 @@
 "type": "array"
 },
 "quantity": {
-"description": "Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`",
+"description": "Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`",
 "format": "int32",
 "type": "integer"
 },
@@ -10654,7 +10710,7 @@
 "type": "string"
 },
 "industryVertical": {
-"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine.",
+"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.",
 "enum": [
 "INDUSTRY_VERTICAL_UNSPECIFIED",
 "GENERIC",
@@ -10870,7 +10926,7 @@
 "id": "GoogleCloudDiscoveryengineV1betaFirestoreSource",
 "properties": {
 "collectionId": {
-"description": "Required. The Firestore collection to copy the data from with a length limit of 1,500 characters.",
+"description": "Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters.",
 "type": "string"
 },
 "databaseId": {
@@ -10893,11 +10949,11 @@
 "id": "GoogleCloudDiscoveryengineV1betaGcsSource",
 "properties": {
 "dataSchema": {
-"description": "The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.",
+"description": "The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.",
 "type": "string"
 },
 "inputUris": {
-"description": "Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).",
+"description": "Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).",
 "items": {
 "type": "string"
 },
@@ -11689,11 +11745,11 @@
 "id": "GoogleCloudDiscoveryengineV1betaRecommendRequest",
 "properties": {
 "filter": {
-"description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY(\"en\", \"es\")) AND NOT (categories: ANY(\"Movie\")) * (available: true) AND (launguage: ANY(\"en\", \"es\")) OR (categories: ANY(\"Movie\")) If your filter blocks all results, the API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in RecommendRequest.params to receive empty results instead. Note that the API will never return Documents with `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.",
+"description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY(\"en\", \"es\")) AND NOT (categories: ANY(\"Movie\")) * (available: true) AND (launguage: ANY(\"en\", \"es\")) OR (categories: ANY(\"Movie\")) If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.",
 "type": "string"
 },
 "pageSize": {
-"description": "Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service will choose a reasonable default. The maximum allowed value is 100. Values above 100 will be coerced to 100.",
+"description": "Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service chooses a reasonable default. The maximum allowed value is 100. Values above 100 are set to 100.",
 "format": "int32",
 "type": "integer"
 },
@@ -11701,7 +11757,7 @@
 "additionalProperties": {
 "type": "any"
 },
-"description": "Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.RecommendationResult.metadata. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax.",
+"description": "Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to `true`, the associated Document object is returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation score corresponding to each returned Document is set in RecommendResponse.RecommendationResult.metadata. The given score indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to `false`, the service returns generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax.",
 "type": "object"
 },
 "userEvent": {
@@ -11716,7 +11772,7 @@
 "type": "object"
 },
 "validateOnly": {
-"description": "Use validate only mode for this recommendation query. If set to true, a fake model will be used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready.",
+"description": "Use validate only mode for this recommendation query. If set to `true`, a fake model is used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready.",
 "type": "boolean"
 }
 },
@@ -11767,7 +11823,7 @@
 "additionalProperties": {
 "type": "any"
 },
-"description": "Additional Document metadata / annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params.",
+"description": "Additional Document metadata or annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params.",
 "type": "object"
 }
 },
@@ -11892,7 +11948,7 @@
 "properties": {
 "boostSpec": {
 "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec",
-"description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)"
+"description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)"
 },
 "branch": {
 "description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.",
@@ -11907,7 +11963,7 @@
 "description": "A specification for configuring the behavior of content search."
 },
 "dataStoreSpecs": {
-"description": "A list of data store specs to apply on a search call.",
+"description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.",
 "items": {
 "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec"
 },
@@ -11954,7 +12010,7 @@
 "additionalProperties": {
 "type": "any"
 },
-"description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. Example: user_country_code: \"au\" For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. Example: search_type: 1",
+"description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`",
 "type": "object"
 },
 "query": {
@@ -12043,7 +12099,7 @@
 "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`."
+"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]`. For example, `5D`, `3DT12H30M`, `T24H`."
 ],
 "type": "string"
 },
@@ -12224,7 +12280,7 @@
 "type": "object"
 },
 "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": {
-"description": "A struct to define data stores to filter on in a search call.",
+"description": "A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec",
 "properties": {
 "dataStore": {
@@ -12287,7 +12343,7 @@
 "description": "Required. The facet key specification."
 },
 "limit": {
-"description": "Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is returned.",
+"description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is returned.",
 "format": "int32",
 "type": "integer"
 }
@@ -12303,7 +12359,7 @@
 "type": "boolean"
 },
 "contains": {
-"description": "Only get facet values that contains the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.",
+"description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.",
 "items": {
 "type": "string"
 },
@@ -12382,7 +12438,7 @@
 "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec",
 "properties": {
 "mode": {
-"description": "The mode under which spell correction should take effect to replace the original search query. Default to Mode.AUTO.",
+"description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.",
 "enum": [
 "MODE_UNSPECIFIED",
 "SUGGESTION_ONLY",
@@ -12390,7 +12446,7 @@
 ],
 "enumDescriptions": [
 "Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.",
-"Search API will try to find a spell suggestion if there is any and put in the SearchResponse.corrected_query. The spell suggestion will not be used as the search query.",
+"Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.",
 "Automatic spell correction built by the Search API. Search will be based on the corrected query if found."
 ],
 "type": "string"
@@ -12474,7 +12530,7 @@
 "type": "boolean"
 },
 "key": {
-"description": "The key for this facet. E.g., \"colors\" or \"price\". It matches SearchRequest.FacetSpec.FacetKey.key.",
+"description": "The key for this facet. For example, `\"colors\"` or `\"price\"`. It matches SearchRequest.FacetSpec.FacetKey.key.",
 "type": "string"
 },
 "values": {
@@ -12548,11 +12604,11 @@
 "id": "GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResultRefinementAttribute",
 "properties": {
 "attributeKey": {
-"description": "Attribute key used to refine the results e.g. 'movie_type'.",
+"description": "Attribute key used to refine the results. For example, `\"movie_type\"`.",
 "type": "string"
 },
 "attributeValue": {
-"description": "Attribute value used to refine the results e.g. 'drama'.",
+"description": "Attribute value used to refine the results. For example, `\"drama\"`.",
 "type": "string"
 }
 },
@@ -12580,7 +12636,7 @@
 "properties": {
 "document": {
 "$ref": "GoogleCloudDiscoveryengineV1betaDocument",
-"description": "The document data snippet in the search response. Only fields that are marked as retrievable are populated."
+"description": "The document data snippet in the search response. Only fields that are marked as `retrievable` are populated."
 },
 "id": {
 "description": "Document.id of the searched Document.",
@@ -12597,7 +12653,7 @@
 "type": "object"
 },
 "GoogleCloudDiscoveryengineV1betaSearchResponseSummary": {
-"description": "Summary of the top N search result specified by the summary spec.",
+"description": "Summary of the top N search results specified by the summary spec.",
 "id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummary",
 "properties": {
 "safetyAttributes": {
@@ -12986,7 +13042,7 @@
 "id": "GoogleCloudDiscoveryengineV1betaSessionTurn",
 "properties": {
 "answer": {
-"description": "The resource name of the answer to the user query.",
+"description": "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"
 },
 "query": {
@@ -13394,7 +13450,7 @@
 "type": "object"
 },
 "GoogleCloudDiscoveryengineV1betaUserEvent": {
-"description": "UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.",
+"description": "UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.",
 "id": "GoogleCloudDiscoveryengineV1betaUserEvent",
 "properties": {
 "attributes": {
@@ -13464,7 +13520,7 @@
 "type": "string"
 },
 "tagIds": {
-"description": "A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups on the customer end.",
+"description": "A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups.",
 "items": {
 "type": "string"
 },
@@ -13500,6 +13556,12 @@
 },
 "type": "object"
 },
+"GoogleLongrunningCancelOperationRequest": {
+"description": "The request message for Operations.CancelOperation.",
+"id": "GoogleLongrunningCancelOperationRequest",
+"properties": {},
+"type": "object"
+},
 "GoogleLongrunningListOperationsResponse": {
 "description": "The response message for Operations.ListOperations.",
 "id": "GoogleLongrunningListOperationsResponse",

googleapiclient/discovery_cache/documents/displayvideo.v2.json

@@ -9267,7 +9267,7 @@
 }
 }
 },
-"revision": "20240509",
+"revision": "20240514",
 "rootUrl": "https://displayvideo.googleapis.com/",
 "schemas": {
 "ActivateManualTriggerRequest": {

googleapiclient/discovery_cache/documents/displayvideo.v3.json

@@ -9222,7 +9222,7 @@
 }
 }
 },
-"revision": "20240509",
+"revision": "20240514",
 "rootUrl": "https://displayvideo.googleapis.com/",
 "schemas": {
 "ActiveViewVideoViewabilityMetricConfig": {