google-api-python-client 2.146.0__py2.py3-none-any.whl → 2.148.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json

@@ -7517,7 +7517,7 @@
 }
 }
 },
-"revision": "20240906",
+"revision": "20240920",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "GoogleApiDistribution": {
@@ -8149,6 +8149,11 @@
 "description": "DataStore captures global settings and configs at the DataStore level.",
 "id": "GoogleCloudDiscoveryengineV1DataStore",
 "properties": {
+"billingEstimation": {
+"$ref": "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation",
+"description": "Output only. Data size estimation for billing.",
+"readOnly": true
+},
 "contentConfig": {
 "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.",
 "enum": [
@@ -8242,6 +8247,43 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1DataStoreBillingEstimation": {
+"description": "Estimation of data size per data store.",
+"id": "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation",
+"properties": {
+"structuredDataSize": {
+"description": "Data size for structured data in terms of bytes.",
+"format": "int64",
+"type": "string"
+},
+"structuredDataUpdateTime": {
+"description": "Last updated timestamp for structured data.",
+"format": "google-datetime",
+"type": "string"
+},
+"unstructuredDataSize": {
+"description": "Data size for unstructured data in terms of bytes.",
+"format": "int64",
+"type": "string"
+},
+"unstructuredDataUpdateTime": {
+"description": "Last updated timestamp for unstructured data.",
+"format": "google-datetime",
+"type": "string"
+},
+"websiteDataSize": {
+"description": "Data size for websites in terms of bytes.",
+"format": "int64",
+"type": "string"
+},
+"websiteDataUpdateTime": {
+"description": "Last updated timestamp for websites.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": {
 "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata",
@@ -9841,14 +9883,15 @@
 "type": "string"
 },
 "documentContexts": {
-"description": "List of document contexts.",
+"description": "List of document contexts. The content will be used for Answer Generation. This is supposed to be the main content of the document that can be long and comprehensive.",
 "items": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext"
 },
 "type": "array"
 },
 "extractiveAnswers": {
-"description": "List of extractive answers.",
+"deprecated": true,
+"description": "Deprecated: This field is deprecated and will have no effect on the Answer generation. Please use document_contexts and extractive_segments fields. List of extractive answers.",
 "items": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer"
 },
@@ -9877,7 +9920,7 @@
 "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext",
 "properties": {
 "content": {
-"description": "Document content.",
+"description": "Document content to be used for answer generation.",
 "type": "string"
 },
 "pageIdentifier": {
@@ -9903,7 +9946,7 @@
 "type": "object"
 },
 "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment": {
-"description": "Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)",
+"description": "Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) Answer generation will only use it if document_contexts is empty. This is supposed to be shorter snippets.",
 "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment",
 "properties": {
 "content": {
@@ -11543,6 +11586,11 @@
 "description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.",
 "type": "boolean"
 },
+"billingEstimation": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation",
+"description": "Output only. Data size estimation for billing.",
+"readOnly": true
+},
 "contentConfig": {
 "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.",
 "enum": [
@@ -11649,6 +11697,43 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation": {
+"description": "Estimation of data size per data store.",
+"id": "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation",
+"properties": {
+"structuredDataSize": {
+"description": "Data size for structured data in terms of bytes.",
+"format": "int64",
+"type": "string"
+},
+"structuredDataUpdateTime": {
+"description": "Last updated timestamp for structured data.",
+"format": "google-datetime",
+"type": "string"
+},
+"unstructuredDataSize": {
+"description": "Data size for unstructured data in terms of bytes.",
+"format": "int64",
+"type": "string"
+},
+"unstructuredDataUpdateTime": {
+"description": "Last updated timestamp for unstructured data.",
+"format": "google-datetime",
+"type": "string"
+},
+"websiteDataSize": {
+"description": "Data size for websites in terms of bytes.",
+"format": "int64",
+"type": "string"
+},
+"websiteDataUpdateTime": {
+"description": "Last updated timestamp for websites.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": {
 "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata",
@@ -12728,6 +12813,10 @@
 "readOnly": true,
 "type": "string"
 },
+"metatagName": {
+"description": "Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag.",
+"type": "string"
+},
 "recsFilterableOption": {
 "description": "If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.",
 "enum": [
@@ -14970,6 +15059,10 @@
 "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"
 },
+"personalizationSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec",
+"description": "The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec."
+},
 "query": {
 "description": "Raw search query.",
 "type": "string"
@@ -15324,6 +15417,10 @@
 "dataStore": {
 "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.",
 "type": "string"
+},
+"filter": {
+"description": "Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)",
+"type": "string"
 }
 },
 "type": "object"
@@ -15474,6 +15571,27 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec": {
+"description": "The specification for personalization.",
+"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec",
+"properties": {
+"mode": {
+"description": "The personalization mode of the search request. Defaults to Mode.AUTO.",
+"enum": [
+"MODE_UNSPECIFIED",
+"AUTO",
+"DISABLED"
+],
+"enumDescriptions": [
+"Default value. In this case, server behavior defaults to Mode.AUTO.",
+"Personalization is enabled if data quality requirements are met.",
+"Disable personalization."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec": {
 "description": "Specification to determine under which conditions query expansion should occur.",
 "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec",
@@ -15919,13 +16037,15 @@
 "ONE_BOX_TYPE_UNSPECIFIED",
 "PEOPLE",
 "ORGANIZATION",
-"SLACK"
+"SLACK",
+"KNOWLEDGE_GRAPH"
 ],
 "enumDescriptions": [
 "Default value. Should not be used.",
 "One Box result contains people results.",
 "One Box result contains organization results.",
-"One Box result contains slack results."
+"One Box result contains slack results.",
+"One Box result contains Knowledge Graph search responses."
 ],
 "type": "string"
 },
@@ -16262,6 +16382,10 @@
 },
 "type": "array"
 },
+"personalizationSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec",
+"description": "The specification for personalization spec. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec."
+},
 "rankingExpression": {
 "description": "The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.",
 "type": "string"
@@ -17389,6 +17513,11 @@
 "description": "DataStore captures global settings and configs at the DataStore level.",
 "id": "GoogleCloudDiscoveryengineV1betaDataStore",
 "properties": {
+"billingEstimation": {
+"$ref": "GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation",
+"description": "Output only. Data size estimation for billing.",
+"readOnly": true
+},
 "contentConfig": {
 "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.",
 "enum": [
@@ -17490,6 +17619,43 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation": {
+"description": "Estimation of data size per data store.",
+"id": "GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation",
+"properties": {
+"structuredDataSize": {
+"description": "Data size for structured data in terms of bytes.",
+"format": "int64",
+"type": "string"
+},
+"structuredDataUpdateTime": {
+"description": "Last updated timestamp for structured data.",
+"format": "google-datetime",
+"type": "string"
+},
+"unstructuredDataSize": {
+"description": "Data size for unstructured data in terms of bytes.",
+"format": "int64",
+"type": "string"
+},
+"unstructuredDataUpdateTime": {
+"description": "Last updated timestamp for unstructured data.",
+"format": "google-datetime",
+"type": "string"
+},
+"websiteDataSize": {
+"description": "Data size for websites in terms of bytes.",
+"format": "int64",
+"type": "string"
+},
+"websiteDataUpdateTime": {
+"description": "Last updated timestamp for websites.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": {
 "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata",
@@ -18640,6 +18806,10 @@
 "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"
 },
+"personalizationSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec",
+"description": "The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec."
+},
 "query": {
 "description": "Raw search query.",
 "type": "string"
@@ -18994,6 +19164,10 @@
 "dataStore": {
 "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.",
 "type": "string"
+},
+"filter": {
+"description": "Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)",
+"type": "string"
 }
 },
 "type": "object"
@@ -19144,6 +19318,27 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec": {
+"description": "The specification for personalization.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec",
+"properties": {
+"mode": {
+"description": "The personalization mode of the search request. Defaults to Mode.AUTO.",
+"enum": [
+"MODE_UNSPECIFIED",
+"AUTO",
+"DISABLED"
+],
+"enumDescriptions": [
+"Default value. In this case, server behavior defaults to Mode.AUTO.",
+"Personalization is enabled if data quality requirements are met.",
+"Disable personalization."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec": {
 "description": "Specification to determine under which conditions query expansion should occur.",
 "id": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec",