google-api-python-client 2.140.0__py2.py3-none-any.whl → 2.142.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/discoveryengine.v1.json

@@ -454,10 +454,71 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+},
+"trainCustomModel": {
+"description": "Trains a custom model.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:trainCustomModel",
+"httpMethod": "POST",
+"id": "discoveryengine.projects.locations.collections.dataStores.trainCustomModel",
+"parameterOrder": [
+"dataStore"
+],
+"parameters": {
+"dataStore": {
+"description": "Required. The resource name of the Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+dataStore}:trainCustomModel",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1TrainCustomModelRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 }
 },
 "resources": {
 "branches": {
+"methods": {
+"batchGetDocumentsMetadata": {
+"description": "Gets index freshness metadata for Documents. Supported for website search only.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.locations.collections.dataStores.branches.batchGetDocumentsMetadata",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"matcher.urisMatcher.uris": {
+"description": "The exact URIs to match by.",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"parent": {
+"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/batchGetDocumentsMetadata",
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
 "resources": {
 "documents": {
 "methods": {
@@ -1189,6 +1250,35 @@
 }
 }
 },
+"customModels": {
+"methods": {
+"list": {
+"description": "Gets a list of all the custom models.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/customModels",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.locations.collections.dataStores.customModels.list",
+"parameterOrder": [
+"dataStore"
+],
+"parameters": {
+"dataStore": {
+"description": "Required. The resource name of the parent Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+dataStore}/customModels",
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1ListCustomModelsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
 "models": {
 "resources": {
 "operations": {
@@ -3690,6 +3780,39 @@
 },
 "resources": {
 "branches": {
+"methods": {
+"batchGetDocumentsMetadata": {
+"description": "Gets index freshness metadata for Documents. Supported for website search only.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.locations.dataStores.branches.batchGetDocumentsMetadata",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"matcher.urisMatcher.uris": {
+"description": "The exact URIs to match by.",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"parent": {
+"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/batchGetDocumentsMetadata",
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
 "resources": {
 "documents": {
 "methods": {
@@ -5851,7 +5974,7 @@
 }
 }
 },
-"revision": "20240729",
+"revision": "20240813",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "GoogleApiHttpBody": {
@@ -6021,7 +6144,7 @@
 "type": "string"
 },
 "projectId": {
-"description": "The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
+"description": "The project ID that contains the AlloyDB source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
 "type": "string"
 },
 "tableId": {
@@ -6045,7 +6168,8 @@
 "OUT_OF_DOMAIN_QUERY_IGNORED",
 "POTENTIAL_POLICY_VIOLATION",
 "NO_RELEVANT_CONTENT",
-"JAIL_BREAKING_QUERY_IGNORED"
+"JAIL_BREAKING_QUERY_IGNORED",
+"CUSTOMER_POLICY_VIOLATION"
 ],
 "enumDescriptions": [
 "Default value. The answer skipped reason is not specified.",
@@ -6054,7 +6178,8 @@
 "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.",
 "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.",
 "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.",
-"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query."
+"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.",
+"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer."
 ],
 "type": "string"
 },
@@ -6298,12 +6423,14 @@
 "enum": [
 "TYPE_UNSPECIFIED",
 "ADVERSARIAL_QUERY",
-"NON_ANSWER_SEEKING_QUERY"
+"NON_ANSWER_SEEKING_QUERY",
+"JAIL_BREAKING_QUERY"
 ],
 "enumDescriptions": [
 "Unspecified query classification type.",
 "Adversarial query classification type.",
-"Non-answer-seeking query classification type."
+"Non-answer-seeking query classification type.",
+"Jail-breaking query classification type."
 ],
 "type": "string"
 },
@@ -6585,12 +6712,14 @@
 "enum": [
 "TYPE_UNSPECIFIED",
 "ADVERSARIAL_QUERY",
-"NON_ANSWER_SEEKING_QUERY"
+"NON_ANSWER_SEEKING_QUERY",
+"JAIL_BREAKING_QUERY"
 ],
 "enumDescriptions": [
 "Unspecified query classification type.",
 "Adversarial query classification type.",
-"Non-answer-seeking query classification type."
+"Non-answer-seeking query classification type.",
+"Jail-breaking query classification type."
 ],
 "type": "string"
 }
@@ -6942,6 +7071,63 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse": {
+"description": "Response message for DocumentService.BatchGetDocumentsMetadata method.",
+"id": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse",
+"properties": {
+"documentsMetadata": {
+"description": "The metadata of the Documents.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata": {
+"description": "The metadata of a Document.",
+"id": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata",
+"properties": {
+"lastRefreshedTime": {
+"description": "The timestamp of the last time the Document was last indexed.",
+"format": "google-datetime",
+"type": "string"
+},
+"matcherValue": {
+"$ref": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue",
+"description": "The value of the matcher that was used to match the Document."
+},
+"status": {
+"description": "The status of the document.",
+"enum": [
+"STATUS_UNSPECIFIED",
+"STATUS_INDEXED",
+"STATUS_NOT_IN_TARGET_SITE",
+"STATUS_NOT_IN_INDEX"
+],
+"enumDescriptions": [
+"Should never be set.",
+"The Document is indexed.",
+"The Document is not indexed because its URI is not in the TargetSite.",
+"The Document is not indexed."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue": {
+"description": "The value of the matcher that was used to match the Document.",
+"id": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue",
+"properties": {
+"uri": {
+"description": "If match by URI, the URI of the Document.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest": {
 "description": "Request message for SiteSearchEngineService.BatchVerifyTargetSites method.",
 "id": "GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest",
@@ -6969,7 +7155,7 @@
 "description": "BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format."
 },
 "projectId": {
-"description": "The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
+"description": "The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
 "type": "string"
 },
 "tableId": {
@@ -7120,7 +7306,7 @@
 "type": "string"
 },
 "projectId": {
-"description": "The project ID that the Bigtable source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
+"description": "The project ID that contains the Bigtable source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
 "type": "string"
 },
 "tableId": {
@@ -7210,6 +7396,11 @@
 "description": "Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices, and anti_citation_indices should not be returned.",
 "type": "boolean"
 },
+"score": {
+"description": "Confidence score for the claim in the answer candidate, in the range of [0, 1].",
+"format": "double",
+"type": "number"
+},
 "startPos": {
 "description": "Position indicating the start of the claim in the answer candidate, measured in bytes.",
 "format": "int32",
@@ -7359,7 +7550,7 @@
 "type": "boolean"
 },
 "projectId": {
-"description": "The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
+"description": "The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
 "type": "string"
 },
 "tableId": {
@@ -7520,7 +7711,7 @@
 "id": "GoogleCloudDiscoveryengineV1Control",
 "properties": {
 "associatedServingConfigIds": {
-"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.",
+"description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.",
 "items": {
 "type": "string"
 },
@@ -7912,6 +8103,67 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1CustomTuningModel": {
+"description": "Metadata that describes a custom tuned model.",
+"id": "GoogleCloudDiscoveryengineV1CustomTuningModel",
+"properties": {
+"createTime": {
+"deprecated": true,
+"description": "Timestamp the Model was created at.",
+"format": "google-datetime",
+"type": "string"
+},
+"displayName": {
+"description": "The display name of the model.",
+"type": "string"
+},
+"metrics": {
+"additionalProperties": {
+"format": "double",
+"type": "number"
+},
+"description": "The metrics of the trained model.",
+"type": "object"
+},
+"modelState": {
+"description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).",
+"enum": [
+"MODEL_STATE_UNSPECIFIED",
+"TRAINING_PAUSED",
+"TRAINING",
+"TRAINING_COMPLETE",
+"READY_FOR_SERVING",
+"TRAINING_FAILED",
+"NO_IMPROVEMENT"
+],
+"enumDescriptions": [
+"Default value.",
+"The model is in a paused training state.",
+"The model is currently training.",
+"The model has successfully completed training.",
+"The model is ready for serving.",
+"The model training failed.",
+"The model training finished successfully but metrics did not improve."
+],
+"type": "string"
+},
+"modelVersion": {
+"description": "The version of the model.",
+"format": "int64",
+"type": "string"
+},
+"name": {
+"description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.",
+"type": "string"
+},
+"trainingStartTime": {
+"description": "Timestamp the model training was initiated.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1DataStore": {
 "description": "DataStore captures global settings and configs at the DataStore level.",
 "id": "GoogleCloudDiscoveryengineV1DataStore",
@@ -7922,13 +8174,15 @@
 "CONTENT_CONFIG_UNSPECIFIED",
 "NO_CONTENT",
 "CONTENT_REQUIRED",
-"PUBLIC_WEBSITE"
+"PUBLIC_WEBSITE",
+"GOOGLE_WORKSPACE"
 ],
 "enumDescriptions": [
 "Default value.",
 "Only contains documents without any Document.content.",
 "Only contains documents with Document.content.",
-"The data store is used for public website search."
+"The data store is used for public website search.",
+"The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig."
 ],
 "type": "string"
 },
@@ -7995,6 +8249,10 @@
 "startingSchema": {
 "$ref": "GoogleCloudDiscoveryengineV1Schema",
 "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)."
+},
+"workspaceConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1WorkspaceConfig",
+"description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE."
 }
 },
 "type": "object"
@@ -8178,6 +8436,11 @@
 "description": "The Document resource ID.",
 "type": "string"
 },
+"joined": {
+"description": "Output only. Whether the referenced Document can be found in the data store.",
+"readOnly": true,
+"type": "boolean"
+},
 "name": {
 "description": "The Document resource full name, of the form: `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`",
 "type": "string"
@@ -8221,7 +8484,7 @@
 "additionalProperties": {
 "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig"
 },
-"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported.",
+"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.",
 "type": "object"
 }
 },
@@ -8575,6 +8838,13 @@
 "gcsStagingDir": {
 "description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory.",
 "type": "string"
+},
+"resourceTypes": {
+"description": "The FHIR resource types to import. The resource types should be a subset of all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). Default to all supported FHIR resource types if empty.",
+"items": {
+"type": "string"
+},
+"type": "array"
 }
 },
 "type": "object"
@@ -9094,6 +9364,20 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1ListCustomModelsResponse": {
+"description": "Response message for SearchTuningService.ListCustomModels method.",
+"id": "GoogleCloudDiscoveryengineV1ListCustomModelsResponse",
+"properties": {
+"models": {
+"description": "List of custom tuning models.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1CustomTuningModel"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1ListDataStoresResponse": {
 "description": "Response message for DataStoreService.ListDataStores method.",
 "id": "GoogleCloudDiscoveryengineV1ListDataStoresResponse",
@@ -10479,7 +10763,8 @@
 "POTENTIAL_POLICY_VIOLATION",
 "LLM_ADDON_NOT_ENABLED",
 "NO_RELEVANT_CONTENT",
-"JAIL_BREAKING_QUERY_IGNORED"
+"JAIL_BREAKING_QUERY_IGNORED",
+"CUSTOMER_POLICY_VIOLATION"
 ],
 "enumDescriptions": [
 "Default value. The summary skipped reason is not specified.",
@@ -10489,7 +10774,8 @@
 "The potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.",
 "The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.",
 "The no relevant content case. Google skips the summary if there is no relevant content in the retrieved search results.",
-"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to `true`."
+"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to `true`.",
+"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer."
 ],
 "type": "string"
 },
@@ -10758,7 +11044,7 @@
 "type": "string"
 },
 "projectId": {
-"description": "The project ID that the Spanner source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
+"description": "The project ID that contains the Spanner source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.",
 "type": "string"
 },
 "tableId": {
@@ -10910,6 +11196,103 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1TrainCustomModelMetadata": {
+"description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata",
+"properties": {
+"createTime": {
+"description": "Operation create time.",
+"format": "google-datetime",
+"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"
+},
+"GoogleCloudDiscoveryengineV1TrainCustomModelRequest": {
+"description": "Request message for SearchTuningService.TrainCustomModel method.",
+"id": "GoogleCloudDiscoveryengineV1TrainCustomModelRequest",
+"properties": {
+"errorConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig",
+"description": "The desired location of errors incurred during the data ingestion and training."
+},
+"gcsTrainingInput": {
+"$ref": "GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput",
+"description": "Cloud Storage training input."
+},
+"modelId": {
+"description": "If not provided, a UUID will be generated.",
+"type": "string"
+},
+"modelType": {
+"description": "Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput": {
+"description": "Cloud Storage training data input.",
+"id": "GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput",
+"properties": {
+"corpusDataPath": {
+"description": "The Cloud Storage corpus data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: `{\"_id\": \"doc1\", title: \"relevant doc\", \"text\": \"relevant text\"}`",
+"type": "string"
+},
+"queryDataPath": {
+"description": "The gcs query data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {\"_id\": \"query1\", \"text\": \"example query\"}",
+"type": "string"
+},
+"testDataPath": {
+"description": "Cloud Storage test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path.",
+"type": "string"
+},
+"trainDataPath": {
+"description": "Cloud Storage training data path whose format should be `gs:///`. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in `[0, inf+)`. The larger the number is, the more relevant the pair is. Example: * `query-id\\tcorpus-id\\tscore` * `query1\\tdoc1\\t1`",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1TrainCustomModelResponse": {
+"description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.",
+"id": "GoogleCloudDiscoveryengineV1TrainCustomModelResponse",
+"properties": {
+"errorConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig",
+"description": "Echoes the destination for the complete errors in the request if set."
+},
+"errorSamples": {
+"description": "A sample of errors encountered while processing the data.",
+"items": {
+"$ref": "GoogleRpcStatus"
+},
+"type": "array"
+},
+"metrics": {
+"additionalProperties": {
+"format": "double",
+"type": "number"
+},
+"description": "The metrics of the trained model.",
+"type": "object"
+},
+"modelName": {
+"description": "Fully qualified name of the CustomTuningModel.",
+"type": "string"
+},
+"modelStatus": {
+"description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1TransactionInfo": {
 "description": "A transaction represents the entire purchase transaction.",
 "id": "GoogleCloudDiscoveryengineV1TransactionInfo",
@@ -11094,6 +11477,37 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1WorkspaceConfig": {
+"description": "Config to store data store type configuration for workspace data",
+"id": "GoogleCloudDiscoveryengineV1WorkspaceConfig",
+"properties": {
+"dasherCustomerId": {
+"description": "Obfuscated Dasher customer ID.",
+"type": "string"
+},
+"type": {
+"description": "The Google Workspace data source.",
+"enum": [
+"TYPE_UNSPECIFIED",
+"GOOGLE_DRIVE",
+"GOOGLE_MAIL",
+"GOOGLE_SITES",
+"GOOGLE_CALENDAR",
+"GOOGLE_GROUPS"
+],
+"enumDescriptions": [
+"Default value.",
+"The data store is used to store content from Google Drive.",
+"The data store is used to store content from Gmail.",
+"The data store is used to store content from Google Sites.",
+"The data store is used to store content from Google Calendar.",
+"The data store is used to store content from Google Groups."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaAclConfig": {
 "description": "Access Control Configuration.",
 "id": "GoogleCloudDiscoveryengineV1alphaAclConfig",
@@ -11123,7 +11537,8 @@
 "OUT_OF_DOMAIN_QUERY_IGNORED",
 "POTENTIAL_POLICY_VIOLATION",
 "NO_RELEVANT_CONTENT",
-"JAIL_BREAKING_QUERY_IGNORED"
+"JAIL_BREAKING_QUERY_IGNORED",
+"CUSTOMER_POLICY_VIOLATION"
 ],
 "enumDescriptions": [
 "Default value. The answer skipped reason is not specified.",
@@ -11132,7 +11547,8 @@
 "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.",
 "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.",
 "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.",
-"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query."
+"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.",
+"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer."
 ],
 "type": "string"
 },
@@ -11271,12 +11687,14 @@
 "enum": [
 "TYPE_UNSPECIFIED",
 "ADVERSARIAL_QUERY",
-"NON_ANSWER_SEEKING_QUERY"
+"NON_ANSWER_SEEKING_QUERY",
+"JAIL_BREAKING_QUERY"
 ],
 "enumDescriptions": [
 "Unspecified query classification type.",
 "Adversarial query classification type.",
-"Non-answer-seeking query classification type."
+"Non-answer-seeking query classification type.",
+"Jail-breaking query classification type."
 ],
 "type": "string"
 }
@@ -11672,7 +12090,7 @@
 "id": "GoogleCloudDiscoveryengineV1alphaControl",
 "properties": {
 "associatedServingConfigIds": {
-"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.",
+"description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.",
 "items": {
 "type": "string"
 },
@@ -11968,13 +12386,15 @@
 "CONTENT_CONFIG_UNSPECIFIED",
 "NO_CONTENT",
 "CONTENT_REQUIRED",
-"PUBLIC_WEBSITE"
+"PUBLIC_WEBSITE",
+"GOOGLE_WORKSPACE"
 ],
 "enumDescriptions": [
 "Default value.",
 "Only contains documents without any Document.content.",
 "Only contains documents with Document.content.",
-"The data store is used for public website search."
+"The data store is used for public website search.",
+"The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig."
 ],
 "type": "string"
 },
@@ -12050,6 +12470,10 @@
 "startingSchema": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaSchema",
 "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)."
+},
+"workspaceConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig",
+"description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE."
 }
 },
 "type": "object"
@@ -12165,7 +12589,7 @@
 "additionalProperties": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig"
 },
-"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported.",
+"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.",
 "type": "object"
 }
 },
@@ -12689,34 +13113,6 @@
 },
 "type": "object"
 },
-"GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata": {
-"description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.",
-"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata",
-"properties": {
-"createTime": {
-"description": "Operation create time.",
-"format": "google-datetime",
-"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"
-},
-"GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse": {
-"description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.",
-"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse",
-"properties": {
-"status": {
-"$ref": "GoogleRpcStatus",
-"description": "The status of the export operation."
-}
-},
-"type": "object"
-},
 "GoogleCloudDiscoveryengineV1alphaFieldConfig": {
 "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.",
 "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig",
@@ -12728,12 +13124,14 @@
 "ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED",
 "METATAGS",
 "PAGEMAP",
+"URI_PATTERN_MAPPING",
 "SCHEMA_ORG"
 ],
 "enumDescriptions": [
 "Value used when unset.",
 "Retrieve value from meta tag.",
 "Retrieve value from page map.",
+"Retrieve value from the attributes set by SiteSearchEngineService.SetUriPatternDocumentData API.",
 "Retrieve value from schema.org data."
 ],
 "type": "string"
@@ -14686,6 +15084,37 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaWorkspaceConfig": {
+"description": "Config to store data store type configuration for workspace data",
+"id": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig",
+"properties": {
+"dasherCustomerId": {
+"description": "Obfuscated Dasher customer ID.",
+"type": "string"
+},
+"type": {
+"description": "The Google Workspace data source.",
+"enum": [
+"TYPE_UNSPECIFIED",
+"GOOGLE_DRIVE",
+"GOOGLE_MAIL",
+"GOOGLE_SITES",
+"GOOGLE_CALENDAR",
+"GOOGLE_GROUPS"
+],
+"enumDescriptions": [
+"Default value.",
+"The data store is used to store content from Google Drive.",
+"The data store is used to store content from Gmail.",
+"The data store is used to store content from Google Sites.",
+"The data store is used to store content from Google Calendar.",
+"The data store is used to store content from Google Groups."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": {
 "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata",
@@ -14775,7 +15204,7 @@
 "id": "GoogleCloudDiscoveryengineV1betaControl",
 "properties": {
 "associatedServingConfigIds": {
-"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.",
+"description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.",
 "items": {
 "type": "string"
 },
@@ -15056,13 +15485,15 @@
 "CONTENT_CONFIG_UNSPECIFIED",
 "NO_CONTENT",
 "CONTENT_REQUIRED",
-"PUBLIC_WEBSITE"
+"PUBLIC_WEBSITE",
+"GOOGLE_WORKSPACE"
 ],
 "enumDescriptions": [
 "Default value.",
 "Only contains documents without any Document.content.",
 "Only contains documents with Document.content.",
-"The data store is used for public website search."
+"The data store is used for public website search.",
+"The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig."
 ],
 "type": "string"
 },
@@ -15133,6 +15564,10 @@
 "startingSchema": {
 "$ref": "GoogleCloudDiscoveryengineV1betaSchema",
 "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)."
+},
+"workspaceConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig",
+"description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE."
 }
 },
 "type": "object"
@@ -15248,7 +15683,7 @@
 "additionalProperties": {
 "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig"
 },
-"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported.",
+"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.",
 "type": "object"
 }
 },
@@ -16282,6 +16717,24 @@
 "description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.",
 "type": "string"
 },
+"relevanceThreshold": {
+"description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.",
+"enum": [
+"RELEVANCE_THRESHOLD_UNSPECIFIED",
+"LOWEST",
+"LOW",
+"MEDIUM",
+"HIGH"
+],
+"enumDescriptions": [
+"Default value. In this case, server behavior defaults to Google defined threshold.",
+"Lowest relevance threshold.",
+"Low relevance threshold.",
+"Medium relevance threshold.",
+"High relevance threshold."
+],
+"type": "string"
+},
 "safeSearch": {
 "description": "Whether to turn on safe search. This is only supported for website search.",
 "type": "boolean"
@@ -17078,6 +17531,37 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaWorkspaceConfig": {
+"description": "Config to store data store type configuration for workspace data",
+"id": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig",
+"properties": {
+"dasherCustomerId": {
+"description": "Obfuscated Dasher customer ID.",
+"type": "string"
+},
+"type": {
+"description": "The Google Workspace data source.",
+"enum": [
+"TYPE_UNSPECIFIED",
+"GOOGLE_DRIVE",
+"GOOGLE_MAIL",
+"GOOGLE_SITES",
+"GOOGLE_CALENDAR",
+"GOOGLE_GROUPS"
+],
+"enumDescriptions": [
+"Default value.",
+"The data store is used to store content from Google Drive.",
+"The data store is used to store content from Gmail.",
+"The data store is used to store content from Google Sites.",
+"The data store is used to store content from Google Calendar.",
+"The data store is used to store content from Google Groups."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleLongrunningCancelOperationRequest": {
 "description": "The request message for Operations.CancelOperation.",
 "id": "GoogleLongrunningCancelOperationRequest",