google-api-python-client 2.124.0__py2.py3-none-any.whl → 2.125.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json

@@ -5110,6 +5110,38 @@
 ]
 }
 }
+},
+"rankingConfigs": {
+"methods": {
+"rank": {
+"description": "Ranks a list of text records based on the given input query.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/rankingConfigs/{rankingConfigsId}:rank",
+"httpMethod": "POST",
+"id": "discoveryengine.projects.locations.rankingConfigs.rank",
+"parameterOrder": [
+"rankingConfig"
+],
+"parameters": {
+"rankingConfig": {
+"description": "Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/rankingConfigs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+rankingConfig}:rank",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaRankRequest"
+},
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaRankResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
 }
 }
 },
@@ -5186,7 +5218,7 @@
 }
 }
 },
-"revision": "20240318",
+"revision": "20240329",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "GoogleApiHttpBody": {
@@ -5478,12 +5510,14 @@
 "enum": [
 "INDUSTRY_VERTICAL_UNSPECIFIED",
 "GENERIC",
-"MEDIA"
+"MEDIA",
+"HEALTHCARE_FHIR"
 ],
 "enumDescriptions": [
 "Value used when unset.",
 "The generic vertical for documents that are not specific to any industry vertical.",
-"The media industry vertical."
+"The media industry vertical.",
+"The healthcare FHIR vertical."
 ],
 "type": "string"
 },
@@ -5498,13 +5532,15 @@
 "SOLUTION_TYPE_UNSPECIFIED",
 "SOLUTION_TYPE_RECOMMENDATION",
 "SOLUTION_TYPE_SEARCH",
-"SOLUTION_TYPE_CHAT"
+"SOLUTION_TYPE_CHAT",
+"SOLUTION_TYPE_GENERATIVE_CHAT"
 ],
 "enumDescriptions": [
 "Default value.",
 "Used for Recommendations AI.",
 "Used for Discovery Search.",
-"Used for use cases related to the Generative AI agent."
+"Used for use cases related to the Generative AI agent.",
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
 ],
 "type": "string"
 },
@@ -5731,12 +5767,14 @@
 "enum": [
 "INDUSTRY_VERTICAL_UNSPECIFIED",
 "GENERIC",
-"MEDIA"
+"MEDIA",
+"HEALTHCARE_FHIR"
 ],
 "enumDescriptions": [
 "Value used when unset.",
 "The generic vertical for documents that are not specific to any industry vertical.",
-"The media industry vertical."
+"The media industry vertical.",
+"The healthcare FHIR vertical."
 ],
 "type": "string"
 },
@@ -5754,13 +5792,15 @@
 "SOLUTION_TYPE_UNSPECIFIED",
 "SOLUTION_TYPE_RECOMMENDATION",
 "SOLUTION_TYPE_SEARCH",
-"SOLUTION_TYPE_CHAT"
+"SOLUTION_TYPE_CHAT",
+"SOLUTION_TYPE_GENERATIVE_CHAT"
 ],
 "enumDescriptions": [
 "Default value.",
 "Used for Recommendations AI.",
 "Used for Discovery Search.",
-"Used for use cases related to the Generative AI agent."
+"Used for use cases related to the Generative AI agent.",
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
 ],
 "type": "string"
 },
@@ -6398,10 +6438,164 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaBigtableOptions": {
+"description": "The Bigtable Options object that contains information to support the import.",
+"id": "GoogleCloudDiscoveryengineV1alphaBigtableOptions",
+"properties": {
+"families": {
+"additionalProperties": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily"
+},
+"description": "The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored.",
+"type": "object"
+},
+"keyFieldName": {
+"description": "The field name used for saving row key value in the UCS document. The name has to match a-zA-Z0-9*",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn": {
+"id": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn",
+"properties": {
+"encoding": {
+"description": "Optional. The encoding mode of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.",
+"enum": [
+"ENCODING_UNSPECIFIED",
+"TEXT",
+"BINARY"
+],
+"enumDescriptions": [
+"",
+"",
+""
+],
+"type": "string"
+},
+"fieldName": {
+"description": "The field name to use for this column in the UCS document. The name has to match a-zA-Z0-9* If not set, we will parse it from the qualifier bytes with best effort. However, field name collisions could happen, where parsing behavior is undefined.",
+"type": "string"
+},
+"qualifier": {
+"description": "Required. Qualifier of the column. If cannot decode with utf-8, store a base-64 encoded string.",
+"format": "byte",
+"type": "string"
+},
+"type": {
+"description": "Optional. The type of values in this column family. The values are expected to be encoded using HBase Bytes.toBytes function when the encoding value is set to BINARY.",
+"enum": [
+"TYPE_UNSPECIFIED",
+"STRING",
+"NUMBER",
+"INTEGER",
+"VAR_INTEGER",
+"BIG_NUMERIC",
+"BOOLEAN",
+"JSON"
+],
+"enumDescriptions": [
+"",
+"",
+"",
+"",
+"",
+"",
+"",
+""
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily": {
+"id": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily",
+"properties": {
+"columns": {
+"description": "The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn"
+},
+"type": "array"
+},
+"encoding": {
+"description": "Optional. The encoding mode of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.",
+"enum": [
+"ENCODING_UNSPECIFIED",
+"TEXT",
+"BINARY"
+],
+"enumDescriptions": [
+"",
+"",
+""
+],
+"type": "string"
+},
+"fieldName": {
+"description": "The field name to use for this column family in the UCS document. The name has to match a-zA-Z0-9* If not set, we will parse it from the family name with best effort. However, due to difference naming pattern, there could be field name collisions, where parsing behavior is undefined.",
+"type": "string"
+},
+"type": {
+"description": "Optional. The type of values in this column family. The values are expected to be encoded using HBase Bytes.toBytes function when the encoding value is set to BINARY.",
+"enum": [
+"TYPE_UNSPECIFIED",
+"STRING",
+"NUMBER",
+"INTEGER",
+"VAR_INTEGER",
+"BIG_NUMERIC",
+"BOOLEAN",
+"JSON"
+],
+"enumDescriptions": [
+"",
+"",
+"",
+"",
+"",
+"",
+"",
+""
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaBigtableSource": {
+"description": "The Cloud Bigtable source for importing data",
+"id": "GoogleCloudDiscoveryengineV1alphaBigtableSource",
+"properties": {
+"bigtableOptions": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaBigtableOptions",
+"description": "Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations."
+},
+"instanceId": {
+"description": "Required. The instance ID of the Cloud Bigtable that needs to be exported.",
+"type": "string"
+},
+"projectId": {
+"description": "The project ID (can be project # or 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.",
+"type": "string"
+},
+"tableId": {
+"description": "Required. The table ID of the Cloud Bigtable that needs to be exported.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaChunk": {
 "description": "Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.",
 "id": "GoogleCloudDiscoveryengineV1alphaChunk",
 "properties": {
+"chunkMetadata": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata",
+"description": "Output only. Metadata of the current chunk.",
+"readOnly": true
+},
 "content": {
 "description": "Content is a string from a document (parsed content).",
 "type": "string"
@@ -6426,6 +6620,31 @@
 "name": {
 "description": "The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
 "type": "string"
+},
+"pageSpan": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaChunkPageSpan",
+"description": "Page span of the chunk."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata": {
+"description": "Metadata of the current chunk. This field is only populated on SearchService.Search API.",
+"id": "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata",
+"properties": {
+"nextChunks": {
+"description": "The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaChunk"
+},
+"type": "array"
+},
+"previousChunks": {
+"description": "The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaChunk"
+},
+"type": "array"
 }
 },
 "type": "object"
@@ -6445,6 +6664,54 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaChunkPageSpan": {
+"description": "Page span of the chunk.",
+"id": "GoogleCloudDiscoveryengineV1alphaChunkPageSpan",
+"properties": {
+"pageEnd": {
+"description": "The end page of the chunk.",
+"format": "int32",
+"type": "integer"
+},
+"pageStart": {
+"description": "The start page of the chunk.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaCloudSqlSource": {
+"description": "Cloud SQL source import data from.",
+"id": "GoogleCloudDiscoveryengineV1alphaCloudSqlSource",
+"properties": {
+"databaseId": {
+"description": "Required. The Cloud SQL database to copy the data from with a length limit of 256 characters.",
+"type": "string"
+},
+"gcsStagingDir": {
+"description": "Optional. 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 Cloud SQL export to a specific Cloud Storage directory. Please ensure that the Cloud SQL service account has the necessary GCS Storage Admin permissions to access the specified GCS directory.",
+"type": "string"
+},
+"instanceId": {
+"description": "Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters.",
+"type": "string"
+},
+"offload": {
+"description": "Optional. Option for serverless export. Enabling this option will incur additional cost. More info: https://cloud.google.com/sql/pricing#serverless",
+"type": "boolean"
+},
+"projectId": {
+"description": "Optional. The project ID (can be project # or 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.",
+"type": "string"
+},
+"tableId": {
+"description": "Required. The Cloud SQL table to copy the data from with a length limit of 256 characters.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest": {
 "description": "Request message for CompletionService.CompleteQuery method.",
 "id": "GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest",
@@ -6855,12 +7122,14 @@
 "enum": [
 "INDUSTRY_VERTICAL_UNSPECIFIED",
 "GENERIC",
-"MEDIA"
+"MEDIA",
+"HEALTHCARE_FHIR"
 ],
 "enumDescriptions": [
 "Value used when unset.",
 "The generic vertical for documents that are not specific to any industry vertical.",
-"The media industry vertical."
+"The media industry vertical.",
+"The healthcare FHIR vertical."
 ],
 "type": "string"
 },
@@ -6875,13 +7144,15 @@
 "SOLUTION_TYPE_UNSPECIFIED",
 "SOLUTION_TYPE_RECOMMENDATION",
 "SOLUTION_TYPE_SEARCH",
-"SOLUTION_TYPE_CHAT"
+"SOLUTION_TYPE_CHAT",
+"SOLUTION_TYPE_GENERATIVE_CHAT"
 ],
 "enumDescriptions": [
 "Default value.",
 "Used for Recommendations AI.",
 "Used for Discovery Search.",
-"Used for use cases related to the Generative AI agent."
+"Used for use cases related to the Generative AI agent.",
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
 ],
 "type": "string"
 },
@@ -7324,12 +7595,14 @@
 "enum": [
 "INDUSTRY_VERTICAL_UNSPECIFIED",
 "GENERIC",
-"MEDIA"
+"MEDIA",
+"HEALTHCARE_FHIR"
 ],
 "enumDescriptions": [
 "Value used when unset.",
 "The generic vertical for documents that are not specific to any industry vertical.",
-"The media industry vertical."
+"The media industry vertical.",
+"The healthcare FHIR vertical."
 ],
 "type": "string"
 },
@@ -7360,13 +7633,15 @@
 "SOLUTION_TYPE_UNSPECIFIED",
 "SOLUTION_TYPE_RECOMMENDATION",
 "SOLUTION_TYPE_SEARCH",
-"SOLUTION_TYPE_CHAT"
+"SOLUTION_TYPE_CHAT",
+"SOLUTION_TYPE_GENERATIVE_CHAT"
 ],
 "enumDescriptions": [
 "Default value.",
 "Used for Recommendations AI.",
 "Used for Discovery Search.",
-"Used for use cases related to the Generative AI agent."
+"Used for use cases related to the Generative AI agent.",
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
 ],
 "type": "string"
 },
@@ -7695,6 +7970,21 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaFhirStoreSource": {
+"description": "Cloud FhirStore source import data from.",
+"id": "GoogleCloudDiscoveryengineV1alphaFhirStoreSource",
+"properties": {
+"fhirStore": {
+"description": "Required. The full resource name of the FHIR store to import data from, in the format of `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`.",
+"type": "string"
+},
+"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"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaFieldConfig": {
 "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.",
 "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig",
@@ -7820,6 +8110,29 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaFirestoreSource": {
+"description": "Firestore source import data from.",
+"id": "GoogleCloudDiscoveryengineV1alphaFirestoreSource",
+"properties": {
+"collectionId": {
+"description": "Required. The Firestore collection to copy the data from with a length limit of 1500 characters.",
+"type": "string"
+},
+"databaseId": {
+"description": "Required. The Firestore database to copy the data from with a length limit of 256 characters.",
+"type": "string"
+},
+"gcsStagingDir": {
+"description": "Optional. 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 Firestore export to a specific Cloud Storage directory. Please ensure that the Firestore service account has the necessary GCS Storage Admin permissions to access the specified GCS directory.",
+"type": "string"
+},
+"projectId": {
+"description": "Optional. The project ID (can be project # or 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.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaGcsSource": {
 "description": "Cloud Storage location for input content.",
 "id": "GoogleCloudDiscoveryengineV1alphaGcsSource",
@@ -7838,6 +8151,17 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaGroundingConfig": {
+"description": "Grounding configuration.",
+"id": "GoogleCloudDiscoveryengineV1alphaGroundingConfig",
+"properties": {
+"name": {
+"description": "Required. Name of the GroundingConfig, of the form `projects/{project}/locations/{location}/groundingConfig`.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec": {
 "description": "Defines guided search spec.",
 "id": "GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec",
@@ -7894,6 +8218,47 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata": {
+"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata",
+"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"
+},
+"GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse": {
+"description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.",
+"id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse",
+"properties": {
+"errorSamples": {
+"description": "A sample of errors encountered while processing the request.",
+"items": {
+"$ref": "GoogleRpcStatus"
+},
+"type": "array"
+},
+"failureCount": {
+"description": "Count of CompletionSuggestions that failed to be imported.",
+"format": "int64",
+"type": "string"
+},
+"successCount": {
+"description": "Count of CompletionSuggestions successfully imported.",
+"format": "int64",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata": {
 "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata",
@@ -7926,23 +8291,39 @@
 "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest",
 "properties": {
 "autoGenerateIds": {
-"description": "Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.",
+"description": "Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource * CloudSqlSource * FirestoreSource * BigtableSource",
 "type": "boolean"
 },
 "bigquerySource": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource",
 "description": "BigQuery input source."
 },
+"bigtableSource": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaBigtableSource",
+"description": "Cloud Bigtable input source."
+},
+"cloudSqlSource": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaCloudSqlSource",
+"description": "Cloud SQL input source."
+},
 "errorConfig": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig",
 "description": "The desired location of errors incurred during the Import."
 },
+"fhirStoreSource": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaFhirStoreSource",
+"description": "FhirStore input source."
+},
+"firestoreSource": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaFirestoreSource",
+"description": "Firestore input source."
+},
 "gcsSource": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource",
 "description": "Cloud Storage location for the input content."
 },
 "idField": {
-"description": "The field in the Cloud Storage and BigQuery sources that indicates the unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{\"my_id\": \"some_uuid\"}`. For BigQuerySource it is the column name of the BigQuery table where the unique ids are stored. The values of the JSON field or the BigQuery column are used as the Document.ids. The JSON field or the BigQuery column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is `custom`. And only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources.",
+"description": "The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{\"my_id\": \"some_uuid\"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource * CloudSqlSource * FirestoreSource * BigtableSource",
 "type": "string"
 },
 "inlineSource": {
@@ -7962,6 +8343,10 @@
 "Calculates diff and replaces the entire document dataset. Existing documents may be deleted if they are not present in the source location."
 ],
 "type": "string"
+},
+"spannerSource": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSpannerSource",
+"description": "Spanner input source."
 }
 },
 "type": "object"
@@ -8651,6 +9036,75 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaRankRequest": {
+"description": "Request message for RankService.Rank method.",
+"id": "GoogleCloudDiscoveryengineV1alphaRankRequest",
+"properties": {
+"ignoreRecordDetailsInResponse": {
+"description": "If true, the response will contain only record ID and score. By default, it is false, the response will contain record details.",
+"type": "boolean"
+},
+"model": {
+"description": "The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified.",
+"type": "string"
+},
+"query": {
+"description": "The query to use.",
+"type": "string"
+},
+"records": {
+"description": "Required. A list of records to rank.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaRankingRecord"
+},
+"type": "array"
+},
+"topN": {
+"description": "The number of results to return. If this is unset or no bigger than zero, returns all results.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaRankResponse": {
+"description": "Response message for RankService.Rank method.",
+"id": "GoogleCloudDiscoveryengineV1alphaRankResponse",
+"properties": {
+"records": {
+"description": "A list of records sorted by descending score.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaRankingRecord"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaRankingRecord": {
+"description": "Record message for RankService.Rank method.",
+"id": "GoogleCloudDiscoveryengineV1alphaRankingRecord",
+"properties": {
+"content": {
+"description": "The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.",
+"type": "string"
+},
+"id": {
+"description": "The unique ID to represent the record.",
+"type": "string"
+},
+"score": {
+"description": "The score of this record based on the given query and selected model.",
+"format": "float",
+"type": "number"
+},
+"title": {
+"description": "The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaRecommendRequest": {
 "description": "Request message for Recommend method.",
 "id": "GoogleCloudDiscoveryengineV1alphaRecommendRequest",
@@ -9120,6 +9574,10 @@
 "description": "A specification for configuring the behavior of content search.",
 "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec",
 "properties": {
+"chunkSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec",
+"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS"
+},
 "extractiveContentSpec": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec",
 "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response."
@@ -9149,6 +9607,23 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec": {
+"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS",
+"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec",
+"properties": {
+"numNextChunks": {
+"description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.",
+"format": "int32",
+"type": "integer"
+},
+"numPreviousChunks": {
+"description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec": {
 "description": "A specification for configuring the extractive content in a search response.",
 "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec",
@@ -9737,6 +10212,13 @@
 "description": "Document reference.",
 "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference",
 "properties": {
+"chunkContents": {
+"description": "List of cited chunk contents derived from document content.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent"
+},
+"type": "array"
+},
 "document": {
 "description": "Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.",
 "type": "string"
@@ -9752,6 +10234,21 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent": {
+"description": "Chunk content.",
+"id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent",
+"properties": {
+"content": {
+"description": "Chunk textual content.",
+"type": "string"
+},
+"pageIdentifier": {
+"description": "Page identifier.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes": {
 "description": "Safety Attribute categories and their associated confidence scores.",
 "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes",
@@ -9901,13 +10398,15 @@
 "SOLUTION_TYPE_UNSPECIFIED",
 "SOLUTION_TYPE_RECOMMENDATION",
 "SOLUTION_TYPE_SEARCH",
-"SOLUTION_TYPE_CHAT"
+"SOLUTION_TYPE_CHAT",
+"SOLUTION_TYPE_GENERATIVE_CHAT"
 ],
 "enumDescriptions": [
 "Default value.",
 "Used for Recommendations AI.",
 "Used for Discovery Search.",
-"Used for use cases related to the Generative AI agent."
+"Used for use cases related to the Generative AI agent.",
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
 ],
 "type": "string"
 },
@@ -10003,6 +10502,33 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaSpannerSource": {
+"description": "The Spanner source for importing data",
+"id": "GoogleCloudDiscoveryengineV1alphaSpannerSource",
+"properties": {
+"databaseId": {
+"description": "Required. The database ID of the source Spanner table.",
+"type": "string"
+},
+"enableDataBoost": {
+"description": "Optional. Whether to apply data boost on Spanner export. Enabling this option will incur additional cost. More info: https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas",
+"type": "boolean"
+},
+"instanceId": {
+"description": "Required. The instance ID of the source Spanner table.",
+"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.",
+"type": "string"
+},
+"tableId": {
+"description": "Required. The table name of the Spanner database that needs to be imported.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry": {
 "description": "Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.",
 "id": "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry",
@@ -10214,6 +10740,14 @@
 },
 "type": "array"
 },
+"metrics": {
+"additionalProperties": {
+"format": "double",
+"type": "number"
+},
+"description": "The metrics of the trained model.",
+"type": "object"
+},
 "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 is in progress. * **ready**: The model is ready for serving.",
 "type": "string"
@@ -10556,6 +11090,10 @@
 "description": "Whether to enable safe search.",
 "type": "boolean"
 },
+"enableSearchAsYouType": {
+"description": "Whether to enable search-as-you-type behavior for the search widget",
+"type": "boolean"
+},
 "enableSnippetResultSummary": {
 "description": "Turn on or off summary for each snippets result.",
 "type": "boolean"
@@ -10587,12 +11125,14 @@
 "enum": [
 "INDUSTRY_VERTICAL_UNSPECIFIED",
 "GENERIC",
-"MEDIA"
+"MEDIA",
+"HEALTHCARE_FHIR"
 ],
 "enumDescriptions": [
 "Value used when unset.",
 "The generic vertical for documents that are not specific to any industry vertical.",
-"The media industry vertical."
+"The media industry vertical.",
+"The healthcare FHIR vertical."
 ],
 "readOnly": true,
 "type": "string"
@@ -10631,13 +11171,15 @@
 "SOLUTION_TYPE_UNSPECIFIED",
 "SOLUTION_TYPE_RECOMMENDATION",
 "SOLUTION_TYPE_SEARCH",
-"SOLUTION_TYPE_CHAT"
+"SOLUTION_TYPE_CHAT",
+"SOLUTION_TYPE_GENERATIVE_CHAT"
 ],
 "enumDescriptions": [
 "Default value.",
 "Used for Recommendations AI.",
 "Used for Discovery Search.",
-"Used for use cases related to the Generative AI agent."
+"Used for use cases related to the Generative AI agent.",
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
 ],
 "type": "string"
 },
@@ -10671,7 +11213,7 @@
 "type": "string"
 },
 "name": {
-"description": "The name of the collection. It should be collection resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection_id}`. For widget service usage, such look up widget config, returned name should be skipped.",
+"description": "The name of the collection. It should be collection resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as LookUpWidgetConfig, the project number and location part is erased in this field.",
 "type": "string"
 }
 },
@@ -10691,7 +11233,7 @@
 "type": "string"
 },
 "name": {
-"description": "The name of the data store. It should be data store resource name Format: `projects/{project_number}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For widget service usage, such look up widget config, returned name should be skipped.",
+"description": "The name of the data store. It should be data store resource name Format: `projects/{project_number}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as LookUpWidgetConfig, the project number and location part is erased in this field.",
 "type": "string"
 }
 },
@@ -10721,7 +11263,7 @@
 "type": "string"
 },
 "name": {
-"description": "The name of the data store. It should be data store resource name Format: `projects/{project_number}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For widget service usage, such look up widget config, returned name should be skipped.",
+"description": "The name of the data store. It should be data store resource name Format: `projects/{project_number}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as LookUpWidgetConfig, the project number and location part is erased in this field.",
 "type": "string"
 }
 },
@@ -10993,12 +11535,14 @@
 "enum": [
 "INDUSTRY_VERTICAL_UNSPECIFIED",
 "GENERIC",
-"MEDIA"
+"MEDIA",
+"HEALTHCARE_FHIR"
 ],
 "enumDescriptions": [
 "Value used when unset.",
 "The generic vertical for documents that are not specific to any industry vertical.",
-"The media industry vertical."
+"The media industry vertical.",
+"The healthcare FHIR vertical."
 ],
 "type": "string"
 },
@@ -11013,13 +11557,15 @@
 "SOLUTION_TYPE_UNSPECIFIED",
 "SOLUTION_TYPE_RECOMMENDATION",
 "SOLUTION_TYPE_SEARCH",
-"SOLUTION_TYPE_CHAT"
+"SOLUTION_TYPE_CHAT",
+"SOLUTION_TYPE_GENERATIVE_CHAT"
 ],
 "enumDescriptions": [
 "Default value.",
 "Used for Recommendations AI.",
 "Used for Discovery Search.",
-"Used for use cases related to the Generative AI agent."
+"Used for use cases related to the Generative AI agent.",
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
 ],
 "type": "string"
 },
@@ -11246,12 +11792,14 @@
 "enum": [
 "INDUSTRY_VERTICAL_UNSPECIFIED",
 "GENERIC",
-"MEDIA"
+"MEDIA",
+"HEALTHCARE_FHIR"
 ],
 "enumDescriptions": [
 "Value used when unset.",
 "The generic vertical for documents that are not specific to any industry vertical.",
-"The media industry vertical."
+"The media industry vertical.",
+"The healthcare FHIR vertical."
 ],
 "type": "string"
 },
@@ -11269,13 +11817,15 @@
 "SOLUTION_TYPE_UNSPECIFIED",
 "SOLUTION_TYPE_RECOMMENDATION",
 "SOLUTION_TYPE_SEARCH",
-"SOLUTION_TYPE_CHAT"
+"SOLUTION_TYPE_CHAT",
+"SOLUTION_TYPE_GENERATIVE_CHAT"
 ],
 "enumDescriptions": [
 "Default value.",
 "Used for Recommendations AI.",
 "Used for Discovery Search.",
-"Used for use cases related to the Generative AI agent."
+"Used for use cases related to the Generative AI agent.",
+"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution."
 ],
 "type": "string"
 },
@@ -11384,6 +11934,17 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaGroundingConfig": {
+"description": "Grounding configuration.",
+"id": "GoogleCloudDiscoveryengineV1betaGroundingConfig",
+"properties": {
+"name": {
+"description": "Required. Name of the GroundingConfig, of the form `projects/{project}/locations/{location}/groundingConfig`.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata": {
 "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata",
@@ -11803,6 +12364,14 @@
 },
 "type": "array"
 },
+"metrics": {
+"additionalProperties": {
+"format": "double",
+"type": "number"
+},
+"description": "The metrics of the trained model.",
+"type": "object"
+},
 "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 is in progress. * **ready**: The model is ready for serving.",
 "type": "string"
@@ -11810,6 +12379,17 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaTuneEngineMetadata": {
+"description": "Metadata associated with a tune operation.",
+"id": "GoogleCloudDiscoveryengineV1betaTuneEngineMetadata",
+"properties": {
+"engine": {
+"description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata": {
 "description": "Metadata for UpdateSchema LRO.",
 "id": "GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata",