From 39896cf3bff4557f38352f336d45af9ff0d719da Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 5 Mar 2024 07:08:05 +0000 Subject: [PATCH] feat(discoveryengine): update the api #### discoveryengine:v1alpha The following keys were added: - resources.projects.resources.locations.methods.getAclConfig (Total Keys: 11) - resources.projects.resources.locations.methods.updateAclConfig (Total Keys: 12) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.methods.patch.parameters.updateMask (Total Keys: 3) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.methods.patch.parameters.updateMask (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.documentProcessingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.startingSchema.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DigitalParsingConfig (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfig (Total Keys: 10) - schemas.GoogleCloudDiscoveryengineV1OcrParsingConfig (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata.properties.ignoredCount (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaAclConfig (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1alphaConverseConversationRequest.properties.boostSpec.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.aclEnabled.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.documentProcessingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.idpConfig (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.startingSchema.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDocument.properties.aclInfo.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDocument.properties.indexTime (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1alphaDocumentAclInfo (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.allowMultipleDataStoresSearchEngine.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaIdpConfig (Total Keys: 7) - schemas.GoogleCloudDiscoveryengineV1alphaPrincipal (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata.properties.ignoredCount (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest.properties.errorConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest.properties.gcsSource.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.customFineTuningSpec.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.enableWebApp.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.documentProcessingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.startingSchema.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaDigitalParsingConfig (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig (Total Keys: 10) - schemas.GoogleCloudDiscoveryengineV1betaOcrParsingConfig (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata.properties.ignoredCount (Total Keys: 2) #### discoveryengine:v1beta The following keys were added: - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.documentProcessingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.startingSchema.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DigitalParsingConfig (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfig (Total Keys: 10) - schemas.GoogleCloudDiscoveryengineV1OcrParsingConfig (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata.properties.ignoredCount (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaAclConfig (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.aclEnabled.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.documentProcessingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.idpConfig (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.startingSchema.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig.properties.chunkingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.allowMultipleDataStoresSearchEngine.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaIdpConfig (Total Keys: 7) - schemas.GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata.properties.ignoredCount (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1betaConverseConversationRequest.properties.boostSpec.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.documentProcessingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.startingSchema.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaDigitalParsingConfig (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1betaDocument.properties.indexTime (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig (Total Keys: 10) - schemas.GoogleCloudDiscoveryengineV1betaOcrParsingConfig (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata.properties.ignoredCount (Total Keys: 2) --- .../discoveryengine_v1alpha.locations.html | 40 +- ...ections.dataStores.branches.documents.html | 105 ++++- ....collections.dataStores.conversations.html | 21 + ...ects.locations.collections.dataStores.html | 321 ++++++++++++++- ...collections.dataStores.servingConfigs.html | 31 +- ...ons.collections.engines.conversations.html | 21 + ...rojects.locations.collections.engines.html | 7 + ...ns.collections.engines.servingConfigs.html | 31 +- ...cations.dataStores.branches.documents.html | 105 ++++- ...ts.locations.dataStores.conversations.html | 21 + ...v1alpha.projects.locations.dataStores.html | 321 ++++++++++++++- ...s.locations.dataStores.servingConfigs.html | 31 +- ...veryengine_v1alpha.projects.locations.html | 69 ++++ ...ections.dataStores.branches.documents.html | 7 + ....collections.dataStores.conversations.html | 9 + ...ects.locations.collections.dataStores.html | 162 +++++++- ...collections.dataStores.servingConfigs.html | 4 +- ...ons.collections.engines.conversations.html | 9 + ...ns.collections.engines.servingConfigs.html | 4 +- ...cations.dataStores.branches.documents.html | 7 + ...ts.locations.dataStores.conversations.html | 9 + ..._v1beta.projects.locations.dataStores.html | 162 +++++++- ...s.locations.dataStores.servingConfigs.html | 4 +- .../documents/discoveryengine.v1alpha.json | 379 +++++++++++++++++- .../documents/discoveryengine.v1beta.json | 276 ++++++++++++- 25 files changed, 2129 insertions(+), 27 deletions(-) diff --git a/docs/dyn/discoveryengine_v1alpha.locations.html b/docs/dyn/discoveryengine_v1alpha.locations.html index 000751d32d..6d8511f518 100644 --- a/docs/dyn/discoveryengine_v1alpha.locations.html +++ b/docs/dyn/discoveryengine_v1alpha.locations.html @@ -159,6 +159,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSnippetResultSummary": True or False, # Turn on or off summary for each snippets result. "enableSummarization": True or False, # Turn on or off summarization for the search response. + "enableWebApp": True or False, # Whether to enable standalone web app. "facetField": [ # The configuration and appearance of facets in the end user view. { # Facet fields that store the mapping of fields to end user widget appearance. "displayName": "A String", # Optional. The field name that end users will see. @@ -242,6 +243,14 @@

Method Details

"configId": "A String", # Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration, set of models used to make the user event collection. "conversationId": "A String", # The id of the Conversation to get. Use "-" to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. "converseConversationRequest": { # Request message for ConversationalSearchService.ConverseConversation method. # Required. The ConverseConversationRequest request to perform converse a conversation. The ServingConfig id will be `default_search` by default. + "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) + "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. + { # Boost applies to documents which match a condition. + "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. + "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue")) + }, + ], + }, "conversation": { # External conversation proto definition. # The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session. "endTime": "A String", # Output only. The time the conversation finished. "messages": [ # Conversation messages. @@ -477,6 +486,18 @@

Method Details

"searchResults": [ # Search Results. { # Represents the search results. "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as retrievable are populated. + "aclInfo": { # ACL Information of the Document. # Access control information for the document. + "readers": [ + { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } } + "principals": [ # List of principals. + { # Principal identifier of a user or a group. + "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. + "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. + }, + ], + }, + ], + }, "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. @@ -486,6 +507,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -528,7 +550,7 @@

Method Details

"conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. { # Boost applies to documents which match a condition. "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. - "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) + "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue")) }, ], }, @@ -560,6 +582,9 @@

Method Details

"summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most five results can be used to generate a summary. }, }, + "customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. + "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model. + }, "embeddingSpec": { # The specification that uses customized query embedding vector to do semantic document retrieval. # Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path. "embeddingVectors": [ # The embedding vector used for retrieval. Limit to 1. { # Embedding vector. @@ -693,6 +718,18 @@

Method Details

"results": [ # A list of matched documents. The order represents the ranking. { # Represents the search results. "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as retrievable are populated. + "aclInfo": { # ACL Information of the Document. # Access control information for the document. + "readers": [ + { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } } + "principals": [ # List of principals. + { # Principal identifier of a user or a group. + "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. + "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. + }, + ], + }, + ], + }, "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. @@ -702,6 +739,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html index cf0139957f..19149deec7 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html @@ -96,7 +96,7 @@

Instance Methods

list_next()

Retrieves the next page of results.

- patch(name, allowMissing=None, body=None, x__xgafv=None)

+ patch(name, allowMissing=None, body=None, updateMask=None, x__xgafv=None)

Updates a Document.

purge(parent, body=None, x__xgafv=None)

@@ -117,6 +117,18 @@

Method Details

The object takes the form of: { # Document captures all raw metadata information of items to be recommended or searched. + "aclInfo": { # ACL Information of the Document. # Access control information for the document. + "readers": [ + { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } } + "principals": [ # List of principals. + { # Principal identifier of a user or a group. + "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. + "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. + }, + ], + }, + ], + }, "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. @@ -126,6 +138,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -145,6 +158,18 @@

Method Details

An object of the form: { # Document captures all raw metadata information of items to be recommended or searched. + "aclInfo": { # ACL Information of the Document. # Access control information for the document. + "readers": [ + { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } } + "principals": [ # List of principals. + { # Principal identifier of a user or a group. + "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. + "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. + }, + ], + }, + ], + }, "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. @@ -154,6 +179,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -197,6 +223,18 @@

Method Details

An object of the form: { # Document captures all raw metadata information of items to be recommended or searched. + "aclInfo": { # ACL Information of the Document. # Access control information for the document. + "readers": [ + { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } } + "principals": [ # List of principals. + { # Principal identifier of a user or a group. + "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. + "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. + }, + ], + }, + ], + }, "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. @@ -206,6 +244,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -252,6 +291,18 @@

Method Details

"inlineSource": { # The inline source for the input config for ImportDocuments method. # The Inline source for the input content for documents. "documents": [ # Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items. { # Document captures all raw metadata information of items to be recommended or searched. + "aclInfo": { # ACL Information of the Document. # Access control information for the document. + "readers": [ + { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } } + "principals": [ # List of principals. + { # Principal identifier of a user or a group. + "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. + "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. + }, + ], + }, + ], + }, "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. @@ -261,6 +312,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -322,6 +374,18 @@

Method Details

{ # Response message for DocumentService.ListDocuments method. "documents": [ # The Documents. { # Document captures all raw metadata information of items to be recommended or searched. + "aclInfo": { # ACL Information of the Document. # Access control information for the document. + "readers": [ + { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } } + "principals": [ # List of principals. + { # Principal identifier of a user or a group. + "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. + "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. + }, + ], + }, + ], + }, "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. @@ -331,6 +395,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -359,7 +424,7 @@

Method Details

- patch(name, allowMissing=None, body=None, x__xgafv=None) + patch(name, allowMissing=None, body=None, updateMask=None, x__xgafv=None) 
Updates a Document.
 
 Args:
@@ -368,6 +433,18 @@ 
Method Details

     The object takes the form of:
 
 { # Document captures all raw metadata information of items to be recommended or searched.
+  "aclInfo": { # ACL Information of the Document. # Access control information for the document.
+    "readers": [
+      { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } }
+        "principals": [ # List of principals.
+          { # Principal identifier of a user or a group.
+            "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config.
+            "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config.
+          },
+        ],
+      },
+    ],
+  },
   "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store.
     "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.
     "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.
@@ -377,6 +454,7 @@ 
Method Details

     "a_key": "", # Properties of the object.
   },
   "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
+  "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.
   "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
   "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
   "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
@@ -387,6 +465,7 @@ 
Method Details

 }
 
   allowMissing: boolean, If set to true, and the Document is not found, a new Document will be created.
+  updateMask: string, Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -396,6 +475,18 @@ 
Method Details

   An object of the form:
 
     { # Document captures all raw metadata information of items to be recommended or searched.
+  "aclInfo": { # ACL Information of the Document. # Access control information for the document.
+    "readers": [
+      { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } }
+        "principals": [ # List of principals.
+          { # Principal identifier of a user or a group.
+            "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config.
+            "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config.
+          },
+        ],
+      },
+    ],
+  },
   "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store.
     "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.
     "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.
@@ -405,6 +496,7 @@ 
Method Details

     "a_key": "", # Properties of the object.
   },
   "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
+  "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.
   "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
   "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
   "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
@@ -425,8 +517,17 @@ 
Method Details

     The object takes the form of:
 
 { # Request message for DocumentService.PurgeDocuments method.
+  "errorConfig": { # Configuration of destination for Purge related errors. # The desired location of errors incurred during the purge.
+    "gcsPrefix": "A String", # Cloud Storage prefix for purge errors. This must be an empty, existing Cloud Storage directory. Purge errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
+  },
   "filter": "A String", # Required. Filter matching documents to purge. Only currently supported value is `*` (all items).
   "force": True or False, # Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.
+  "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line.
+    "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.
+    "inputUris": [ # Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
+      "A String",
+    ],
+  },
 }
 
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html
index 355abc83e2..8349df9f64 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html
@@ -114,6 +114,14 @@ 
Method Details

     The object takes the form of:
 
 { # Request message for ConversationalSearchService.ConverseConversation method.
+  "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
+    "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+      { # Boost applies to documents which match a condition.
+        "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
+        "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))
+      },
+    ],
+  },
   "conversation": { # External conversation proto definition. # The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.
     "endTime": "A String", # Output only. The time the conversation finished.
     "messages": [ # Conversation messages.
@@ -346,6 +354,18 @@ 
Method Details

   "searchResults": [ # Search Results.
     { # Represents the search results.
       "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as retrievable are populated.
+        "aclInfo": { # ACL Information of the Document. # Access control information for the document.
+          "readers": [
+            { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } }
+              "principals": [ # List of principals.
+                { # Principal identifier of a user or a group.
+                  "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config.
+                  "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config.
+                },
+              ],
+            },
+          ],
+        },
         "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store.
           "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.
           "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.
@@ -355,6 +375,7 @@ 
Method Details

           "a_key": "", # Properties of the object.
         },
         "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
+        "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.
         "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
         "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
         "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html
index e870a7b55a..eeb741fc5d 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html
@@ -202,15 +202,78 @@ 
Method Details

     The object takes the form of:
 
 { # DataStore captures global settings and configs at the DataStore level.
+  "aclEnabled": True or False, # 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.
   "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
   "createTime": "A String", # Output only. Timestamp the DataStore was created at.
   "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store.
   "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+  "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment.
+    "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing.
+      "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
+      },
+      "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser.
+      },
+      "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs.
+        "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
+          "A String",
+        ],
+        "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
+      },
+    },
+    "name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
+    "ocrConfig": { # The OCR options for parsing documents. # [DEPRECATED] This field is deprecated. To specify OCR parsing config, please specify `ocr_parsing_config` in `default_parsing_config` field The OCR config. Currently it only applies to PDFs.
+      "enabled": True or False, # Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply. We will only perform OCR on the first 80 pages of the PDF files.
+      "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
+        "A String",
+      ],
+      "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
+    },
+    "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.
+      "a_key": { # Related configurations applied to a specific type of document parser.
+        "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
+        },
+        "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser.
+        },
+        "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs.
+          "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
+            "A String",
+          ],
+          "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
+        },
+      },
+    },
+  },
+  "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config.
+    "externalIdpConfig": { # Third party IDP Config. # External Identity provider config.
+      "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id"
+    },
+    "idpType": "A String", # Identity provider type configured.
+  },
   "industryVertical": "A String", # Immutable. The industry vertical that the data store registers.
   "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
   "solutionTypes": [ # The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
     "A String",
   ],
+  "startingSchema": { # Defines the structure and layout of a type of document data. # 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).
+    "fieldConfigs": [ # Output only. Configurations for fields of the schema.
+      { # Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.
+        "completableOption": "A String", # If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.
+        "dynamicFacetableOption": "A String", # If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error.
+        "fieldPath": "A String", # Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.
+        "fieldType": "A String", # Output only. Raw type of the field.
+        "indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.
+        "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified.
+        "recsFilterableOption": "A String", # 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.
+        "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error.
+        "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
+      },
+    ],
+    "jsonSchema": "A String", # The JSON representation of the schema.
+    "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+    "structSchema": { # The structured representation of the schema.
+      "a_key": "", # Properties of the object.
+    },
+  },
 }
 
   createAdvancedSiteSearch: boolean, A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.
@@ -294,15 +357,78 @@ 
Method Details

   An object of the form:
 
     { # DataStore captures global settings and configs at the DataStore level.
+  "aclEnabled": True or False, # 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.
   "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
   "createTime": "A String", # Output only. Timestamp the DataStore was created at.
   "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store.
   "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+  "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment.
+    "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing.
+      "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
+      },
+      "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser.
+      },
+      "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs.
+        "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
+          "A String",
+        ],
+        "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
+      },
+    },
+    "name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
+    "ocrConfig": { # The OCR options for parsing documents. # [DEPRECATED] This field is deprecated. To specify OCR parsing config, please specify `ocr_parsing_config` in `default_parsing_config` field The OCR config. Currently it only applies to PDFs.
+      "enabled": True or False, # Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply. We will only perform OCR on the first 80 pages of the PDF files.
+      "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
+        "A String",
+      ],
+      "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
+    },
+    "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.
+      "a_key": { # Related configurations applied to a specific type of document parser.
+        "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
+        },
+        "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser.
+        },
+        "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs.
+          "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
+            "A String",
+          ],
+          "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
+        },
+      },
+    },
+  },
+  "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config.
+    "externalIdpConfig": { # Third party IDP Config. # External Identity provider config.
+      "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id"
+    },
+    "idpType": "A String", # Identity provider type configured.
+  },
   "industryVertical": "A String", # Immutable. The industry vertical that the data store registers.
   "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
   "solutionTypes": [ # The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
     "A String",
   ],
+  "startingSchema": { # Defines the structure and layout of a type of document data. # 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).
+    "fieldConfigs": [ # Output only. Configurations for fields of the schema.
+      { # Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.
+        "completableOption": "A String", # If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.
+        "dynamicFacetableOption": "A String", # If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error.
+        "fieldPath": "A String", # Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.
+        "fieldType": "A String", # Output only. Raw type of the field.
+        "indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.
+        "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified.
+        "recsFilterableOption": "A String", # 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.
+        "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error.
+        "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
+      },
+    ],
+    "jsonSchema": "A String", # The JSON representation of the schema.
+    "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+    "structSchema": { # The structured representation of the schema.
+      "a_key": "", # Properties of the object.
+    },
+  },
 }
@@ -341,7 +467,7 @@

Method Details

], "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. }, - "parsingConfigOverrides": { # 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 or layout parsing are supported. + "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. "a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, @@ -397,15 +523,78 @@

Method Details

{ # Response message for DataStoreService.ListDataStores method. "dataStores": [ # All the customer's DataStores. { # DataStore captures global settings and configs at the DataStore level. + "aclEnabled": True or False, # 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. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + "name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. + "ocrConfig": { # The OCR options for parsing documents. # [DEPRECATED] This field is deprecated. To specify OCR parsing config, please specify `ocr_parsing_config` in `default_parsing_config` field The OCR config. Currently it only applies to PDFs. + "enabled": True or False, # Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply. We will only perform OCR on the first 80 pages of the PDF files. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + "a_key": { # Related configurations applied to a specific type of document parser. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + }, + }, + "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. + "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. + "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id" + }, + "idpType": "A String", # Identity provider type configured. + }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "solutionTypes": [ # The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. "A String", ], + "startingSchema": { # Defines the structure and layout of a type of document data. # 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). + "fieldConfigs": [ # Output only. Configurations for fields of the schema. + { # Configurations for fields of a schema. For example, configuring a field is indexable, or searchable. + "completableOption": "A String", # If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error. + "dynamicFacetableOption": "A String", # If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error. + "fieldPath": "A String", # Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`. + "fieldType": "A String", # Output only. Raw type of the field. + "indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. + "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. + "recsFilterableOption": "A String", # 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. + "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. + "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. + }, + ], + "jsonSchema": "A String", # The JSON representation of the schema. + "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "structSchema": { # The structured representation of the schema. + "a_key": "", # Properties of the object. + }, + }, }, ], "nextPageToken": "A String", # A token that can be sent as ListDataStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. @@ -436,15 +625,78 @@

Method Details

The object takes the form of: { # DataStore captures global settings and configs at the DataStore level. + "aclEnabled": True or False, # 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. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + "name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. + "ocrConfig": { # The OCR options for parsing documents. # [DEPRECATED] This field is deprecated. To specify OCR parsing config, please specify `ocr_parsing_config` in `default_parsing_config` field The OCR config. Currently it only applies to PDFs. + "enabled": True or False, # Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply. We will only perform OCR on the first 80 pages of the PDF files. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + "a_key": { # Related configurations applied to a specific type of document parser. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + }, + }, + "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. + "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. + "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id" + }, + "idpType": "A String", # Identity provider type configured. + }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "solutionTypes": [ # The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. "A String", ], + "startingSchema": { # Defines the structure and layout of a type of document data. # 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). + "fieldConfigs": [ # Output only. Configurations for fields of the schema. + { # Configurations for fields of a schema. For example, configuring a field is indexable, or searchable. + "completableOption": "A String", # If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error. + "dynamicFacetableOption": "A String", # If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error. + "fieldPath": "A String", # Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`. + "fieldType": "A String", # Output only. Raw type of the field. + "indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. + "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. + "recsFilterableOption": "A String", # 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. + "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. + "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. + }, + ], + "jsonSchema": "A String", # The JSON representation of the schema. + "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "structSchema": { # The structured representation of the schema. + "a_key": "", # Properties of the object. + }, + }, } updateMask: string, Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. @@ -457,15 +709,78 @@

Method Details

An object of the form: { # DataStore captures global settings and configs at the DataStore level. + "aclEnabled": True or False, # 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. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + "name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. + "ocrConfig": { # The OCR options for parsing documents. # [DEPRECATED] This field is deprecated. To specify OCR parsing config, please specify `ocr_parsing_config` in `default_parsing_config` field The OCR config. Currently it only applies to PDFs. + "enabled": True or False, # Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply. We will only perform OCR on the first 80 pages of the PDF files. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + "a_key": { # Related configurations applied to a specific type of document parser. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + }, + }, + "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. + "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. + "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id" + }, + "idpType": "A String", # Identity provider type configured. + }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "solutionTypes": [ # The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. "A String", ], + "startingSchema": { # Defines the structure and layout of a type of document data. # 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). + "fieldConfigs": [ # Output only. Configurations for fields of the schema. + { # Configurations for fields of a schema. For example, configuring a field is indexable, or searchable. + "completableOption": "A String", # If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error. + "dynamicFacetableOption": "A String", # If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error. + "fieldPath": "A String", # Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`. + "fieldType": "A String", # Output only. Raw type of the field. + "indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. + "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. + "recsFilterableOption": "A String", # 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. + "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. + "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. + }, + ], + "jsonSchema": "A String", # The JSON representation of the schema. + "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "structSchema": { # The structured representation of the schema. + "a_key": "", # Properties of the object. + }, + }, } @@ -550,7 +865,7 @@

Method Details

], "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. }, - "parsingConfigOverrides": { # 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 or layout parsing are supported. + "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. "a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, @@ -596,7 +911,7 @@

Method Details

], "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. }, - "parsingConfigOverrides": { # 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 or layout parsing are supported. + "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. "a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html index f5e318c904..d926dde113 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html @@ -608,6 +608,18 @@

Method Details

"results": [ # A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least). { # RecommendationResult represents a generic recommendation result with associated metadata. "document": { # Document captures all raw metadata information of items to be recommended or searched. # Set if `returnDocument` is set to true in RecommendRequest.params. + "aclInfo": { # ACL Information of the Document. # Access control information for the document. + "readers": [ + { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } } + "principals": [ # List of principals. + { # Principal identifier of a user or a group. + "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. + "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. + }, + ], + }, + ], + }, "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. @@ -617,6 +629,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -649,7 +662,7 @@

Method Details

"conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. { # Boost applies to documents which match a condition. "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. - "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) + "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue")) }, ], }, @@ -681,6 +694,9 @@

Method Details

"summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most five results can be used to generate a summary. }, }, + "customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. + "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model. + }, "embeddingSpec": { # The specification that uses customized query embedding vector to do semantic document retrieval. # Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path. "embeddingVectors": [ # The embedding vector used for retrieval. Limit to 1. { # Embedding vector. @@ -812,6 +828,18 @@

Method Details

"results": [ # A list of matched documents. The order represents the ranking. { # Represents the search results. "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as retrievable are populated. + "aclInfo": { # ACL Information of the Document. # Access control information for the document. + "readers": [ + { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } } + "principals": [ # List of principals. + { # Principal identifier of a user or a group. + "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. + "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. + }, + ], + }, + ], + }, "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. @@ -821,6 +849,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html index 9dd53d8524..6183f746b2 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html @@ -114,6 +114,14 @@

Method Details

The object takes the form of: { # Request message for ConversationalSearchService.ConverseConversation method. + "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) + "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. + { # Boost applies to documents which match a condition. + "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. + "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue")) + }, + ], + }, "conversation": { # External conversation proto definition. # The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session. "endTime": "A String", # Output only. The time the conversation finished. "messages": [ # Conversation messages. @@ -346,6 +354,18 @@

Method Details

"searchResults": [ # Search Results. { # Represents the search results. "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as retrievable are populated. + "aclInfo": { # ACL Information of the Document. # Access control information for the document. + "readers": [ + { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } } + "principals": [ # List of principals. + { # Principal identifier of a user or a group. + "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. + "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. + }, + ], + }, + ], + }, "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. @@ -355,6 +375,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html index 6910954d11..091f392fb2 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html @@ -135,6 +135,7 @@

Method Details

The object takes the form of: { # Metadata that describes the training and serving parameters of an Engine. + "allowMultipleDataStoresSearchEngine": True or False, # Whether the search engine can associate with multiple data stores. If true, the generic search engine can associate with one or more data stores. This is an input-only field. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. @@ -264,6 +265,7 @@

Method Details

An object of the form: { # Metadata that describes the training and serving parameters of an Engine. + "allowMultipleDataStoresSearchEngine": True or False, # Whether the search engine can associate with multiple data stores. If true, the generic search engine can associate with one or more data stores. This is an input-only field. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. @@ -334,6 +336,7 @@

Method Details

{ # Response message for EngineService.ListEngines method. "engines": [ # All the customer's Engines. { # Metadata that describes the training and serving parameters of an Engine. + "allowMultipleDataStoresSearchEngine": True or False, # Whether the search engine can associate with multiple data stores. If true, the generic search engine can associate with one or more data stores. This is an input-only field. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. @@ -411,6 +414,7 @@

Method Details

The object takes the form of: { # Metadata that describes the training and serving parameters of an Engine. + "allowMultipleDataStoresSearchEngine": True or False, # Whether the search engine can associate with multiple data stores. If true, the generic search engine can associate with one or more data stores. This is an input-only field. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. @@ -470,6 +474,7 @@

Method Details

An object of the form: { # Metadata that describes the training and serving parameters of an Engine. + "allowMultipleDataStoresSearchEngine": True or False, # Whether the search engine can associate with multiple data stores. If true, the generic search engine can associate with one or more data stores. This is an input-only field. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. @@ -541,6 +546,7 @@

Method Details

An object of the form: { # Metadata that describes the training and serving parameters of an Engine. + "allowMultipleDataStoresSearchEngine": True or False, # Whether the search engine can associate with multiple data stores. If true, the generic search engine can associate with one or more data stores. This is an input-only field. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. @@ -612,6 +618,7 @@

Method Details

An object of the form: { # Metadata that describes the training and serving parameters of an Engine. + "allowMultipleDataStoresSearchEngine": True or False, # Whether the search engine can associate with multiple data stores. If true, the generic search engine can associate with one or more data stores. This is an input-only field. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html index f327f06c62..d607ca6ed5 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html @@ -608,6 +608,18 @@

Method Details

"results": [ # A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least). { # RecommendationResult represents a generic recommendation result with associated metadata. "document": { # Document captures all raw metadata information of items to be recommended or searched. # Set if `returnDocument` is set to true in RecommendRequest.params. + "aclInfo": { # ACL Information of the Document. # Access control information for the document. + "readers": [ + { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } } + "principals": [ # List of principals. + { # Principal identifier of a user or a group. + "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. + "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. + }, + ], + }, + ], + }, "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. @@ -617,6 +629,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -649,7 +662,7 @@

Method Details

"conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. { # Boost applies to documents which match a condition. "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. - "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) + "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue")) }, ], }, @@ -681,6 +694,9 @@

Method Details

"summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most five results can be used to generate a summary. }, }, + "customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. + "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model. + }, "embeddingSpec": { # The specification that uses customized query embedding vector to do semantic document retrieval. # Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path. "embeddingVectors": [ # The embedding vector used for retrieval. Limit to 1. { # Embedding vector. @@ -812,6 +828,18 @@

Method Details

"results": [ # A list of matched documents. The order represents the ranking. { # Represents the search results. "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as retrievable are populated. + "aclInfo": { # ACL Information of the Document. # Access control information for the document. + "readers": [ + { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } } + "principals": [ # List of principals. + { # Principal identifier of a user or a group. + "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. + "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. + }, + ], + }, + ], + }, "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. @@ -821,6 +849,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html index 28c37f271f..8d44971f85 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html @@ -96,7 +96,7 @@

Instance Methods

list_next()

Retrieves the next page of results.

- patch(name, allowMissing=None, body=None, x__xgafv=None)

+ patch(name, allowMissing=None, body=None, updateMask=None, x__xgafv=None)

Updates a Document.

purge(parent, body=None, x__xgafv=None)

@@ -117,6 +117,18 @@

Method Details

The object takes the form of: { # Document captures all raw metadata information of items to be recommended or searched. + "aclInfo": { # ACL Information of the Document. # Access control information for the document. + "readers": [ + { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } } + "principals": [ # List of principals. + { # Principal identifier of a user or a group. + "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. + "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. + }, + ], + }, + ], + }, "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. @@ -126,6 +138,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -145,6 +158,18 @@

Method Details

An object of the form: { # Document captures all raw metadata information of items to be recommended or searched. + "aclInfo": { # ACL Information of the Document. # Access control information for the document. + "readers": [ + { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } } + "principals": [ # List of principals. + { # Principal identifier of a user or a group. + "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. + "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. + }, + ], + }, + ], + }, "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. @@ -154,6 +179,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -197,6 +223,18 @@

Method Details

An object of the form: { # Document captures all raw metadata information of items to be recommended or searched. + "aclInfo": { # ACL Information of the Document. # Access control information for the document. + "readers": [ + { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } } + "principals": [ # List of principals. + { # Principal identifier of a user or a group. + "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. + "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. + }, + ], + }, + ], + }, "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. @@ -206,6 +244,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -252,6 +291,18 @@

Method Details

"inlineSource": { # The inline source for the input config for ImportDocuments method. # The Inline source for the input content for documents. "documents": [ # Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items. { # Document captures all raw metadata information of items to be recommended or searched. + "aclInfo": { # ACL Information of the Document. # Access control information for the document. + "readers": [ + { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } } + "principals": [ # List of principals. + { # Principal identifier of a user or a group. + "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. + "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. + }, + ], + }, + ], + }, "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. @@ -261,6 +312,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -322,6 +374,18 @@

Method Details

{ # Response message for DocumentService.ListDocuments method. "documents": [ # The Documents. { # Document captures all raw metadata information of items to be recommended or searched. + "aclInfo": { # ACL Information of the Document. # Access control information for the document. + "readers": [ + { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } } + "principals": [ # List of principals. + { # Principal identifier of a user or a group. + "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. + "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. + }, + ], + }, + ], + }, "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. @@ -331,6 +395,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -359,7 +424,7 @@

Method Details

- patch(name, allowMissing=None, body=None, x__xgafv=None) + patch(name, allowMissing=None, body=None, updateMask=None, x__xgafv=None) 
Updates a Document.
 
 Args:
@@ -368,6 +433,18 @@ 
Method Details

     The object takes the form of:
 
 { # Document captures all raw metadata information of items to be recommended or searched.
+  "aclInfo": { # ACL Information of the Document. # Access control information for the document.
+    "readers": [
+      { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } }
+        "principals": [ # List of principals.
+          { # Principal identifier of a user or a group.
+            "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config.
+            "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config.
+          },
+        ],
+      },
+    ],
+  },
   "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store.
     "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.
     "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.
@@ -377,6 +454,7 @@ 
Method Details

     "a_key": "", # Properties of the object.
   },
   "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
+  "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.
   "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
   "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
   "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
@@ -387,6 +465,7 @@ 
Method Details

 }
 
   allowMissing: boolean, If set to true, and the Document is not found, a new Document will be created.
+  updateMask: string, Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -396,6 +475,18 @@ 
Method Details

   An object of the form:
 
     { # Document captures all raw metadata information of items to be recommended or searched.
+  "aclInfo": { # ACL Information of the Document. # Access control information for the document.
+    "readers": [
+      { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } }
+        "principals": [ # List of principals.
+          { # Principal identifier of a user or a group.
+            "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config.
+            "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config.
+          },
+        ],
+      },
+    ],
+  },
   "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store.
     "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.
     "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.
@@ -405,6 +496,7 @@ 
Method Details

     "a_key": "", # Properties of the object.
   },
   "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
+  "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.
   "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
   "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
   "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
@@ -425,8 +517,17 @@ 
Method Details

     The object takes the form of:
 
 { # Request message for DocumentService.PurgeDocuments method.
+  "errorConfig": { # Configuration of destination for Purge related errors. # The desired location of errors incurred during the purge.
+    "gcsPrefix": "A String", # Cloud Storage prefix for purge errors. This must be an empty, existing Cloud Storage directory. Purge errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
+  },
   "filter": "A String", # Required. Filter matching documents to purge. Only currently supported value is `*` (all items).
   "force": True or False, # Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.
+  "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line.
+    "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.
+    "inputUris": [ # Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
+      "A String",
+    ],
+  },
 }
 
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html
index 7281d4b6a6..1bc27d536b 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html
@@ -114,6 +114,14 @@ 
Method Details

     The object takes the form of:
 
 { # Request message for ConversationalSearchService.ConverseConversation method.
+  "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
+    "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+      { # Boost applies to documents which match a condition.
+        "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
+        "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))
+      },
+    ],
+  },
   "conversation": { # External conversation proto definition. # The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.
     "endTime": "A String", # Output only. The time the conversation finished.
     "messages": [ # Conversation messages.
@@ -346,6 +354,18 @@ 
Method Details

   "searchResults": [ # Search Results.
     { # Represents the search results.
       "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as retrievable are populated.
+        "aclInfo": { # ACL Information of the Document. # Access control information for the document.
+          "readers": [
+            { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } }
+              "principals": [ # List of principals.
+                { # Principal identifier of a user or a group.
+                  "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config.
+                  "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config.
+                },
+              ],
+            },
+          ],
+        },
         "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store.
           "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.
           "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.
@@ -355,6 +375,7 @@ 
Method Details

           "a_key": "", # Properties of the object.
         },
         "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
+        "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.
         "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
         "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
         "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html
index 33b0b6dc1b..a2551ea03c 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html
@@ -199,15 +199,78 @@ 
Method Details

     The object takes the form of:
 
 { # DataStore captures global settings and configs at the DataStore level.
+  "aclEnabled": True or False, # 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.
   "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
   "createTime": "A String", # Output only. Timestamp the DataStore was created at.
   "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store.
   "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+  "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment.
+    "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing.
+      "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
+      },
+      "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser.
+      },
+      "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs.
+        "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
+          "A String",
+        ],
+        "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
+      },
+    },
+    "name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
+    "ocrConfig": { # The OCR options for parsing documents. # [DEPRECATED] This field is deprecated. To specify OCR parsing config, please specify `ocr_parsing_config` in `default_parsing_config` field The OCR config. Currently it only applies to PDFs.
+      "enabled": True or False, # Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply. We will only perform OCR on the first 80 pages of the PDF files.
+      "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
+        "A String",
+      ],
+      "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
+    },
+    "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.
+      "a_key": { # Related configurations applied to a specific type of document parser.
+        "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
+        },
+        "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser.
+        },
+        "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs.
+          "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
+            "A String",
+          ],
+          "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
+        },
+      },
+    },
+  },
+  "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config.
+    "externalIdpConfig": { # Third party IDP Config. # External Identity provider config.
+      "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id"
+    },
+    "idpType": "A String", # Identity provider type configured.
+  },
   "industryVertical": "A String", # Immutable. The industry vertical that the data store registers.
   "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
   "solutionTypes": [ # The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
     "A String",
   ],
+  "startingSchema": { # Defines the structure and layout of a type of document data. # 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).
+    "fieldConfigs": [ # Output only. Configurations for fields of the schema.
+      { # Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.
+        "completableOption": "A String", # If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.
+        "dynamicFacetableOption": "A String", # If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error.
+        "fieldPath": "A String", # Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.
+        "fieldType": "A String", # Output only. Raw type of the field.
+        "indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.
+        "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified.
+        "recsFilterableOption": "A String", # 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.
+        "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error.
+        "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
+      },
+    ],
+    "jsonSchema": "A String", # The JSON representation of the schema.
+    "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+    "structSchema": { # The structured representation of the schema.
+      "a_key": "", # Properties of the object.
+    },
+  },
 }
 
   createAdvancedSiteSearch: boolean, A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.
@@ -291,15 +354,78 @@ 
Method Details

   An object of the form:
 
     { # DataStore captures global settings and configs at the DataStore level.
+  "aclEnabled": True or False, # 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.
   "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
   "createTime": "A String", # Output only. Timestamp the DataStore was created at.
   "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store.
   "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+  "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment.
+    "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing.
+      "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
+      },
+      "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser.
+      },
+      "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs.
+        "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
+          "A String",
+        ],
+        "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
+      },
+    },
+    "name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
+    "ocrConfig": { # The OCR options for parsing documents. # [DEPRECATED] This field is deprecated. To specify OCR parsing config, please specify `ocr_parsing_config` in `default_parsing_config` field The OCR config. Currently it only applies to PDFs.
+      "enabled": True or False, # Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply. We will only perform OCR on the first 80 pages of the PDF files.
+      "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
+        "A String",
+      ],
+      "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
+    },
+    "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.
+      "a_key": { # Related configurations applied to a specific type of document parser.
+        "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
+        },
+        "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser.
+        },
+        "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs.
+          "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.
+            "A String",
+          ],
+          "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text.
+        },
+      },
+    },
+  },
+  "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config.
+    "externalIdpConfig": { # Third party IDP Config. # External Identity provider config.
+      "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id"
+    },
+    "idpType": "A String", # Identity provider type configured.
+  },
   "industryVertical": "A String", # Immutable. The industry vertical that the data store registers.
   "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
   "solutionTypes": [ # The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
     "A String",
   ],
+  "startingSchema": { # Defines the structure and layout of a type of document data. # 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).
+    "fieldConfigs": [ # Output only. Configurations for fields of the schema.
+      { # Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.
+        "completableOption": "A String", # If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.
+        "dynamicFacetableOption": "A String", # If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error.
+        "fieldPath": "A String", # Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.
+        "fieldType": "A String", # Output only. Raw type of the field.
+        "indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.
+        "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified.
+        "recsFilterableOption": "A String", # 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.
+        "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error.
+        "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
+      },
+    ],
+    "jsonSchema": "A String", # The JSON representation of the schema.
+    "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+    "structSchema": { # The structured representation of the schema.
+      "a_key": "", # Properties of the object.
+    },
+  },
 }
@@ -338,7 +464,7 @@

Method Details

], "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. }, - "parsingConfigOverrides": { # 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 or layout parsing are supported. + "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. "a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, @@ -394,15 +520,78 @@

Method Details

{ # Response message for DataStoreService.ListDataStores method. "dataStores": [ # All the customer's DataStores. { # DataStore captures global settings and configs at the DataStore level. + "aclEnabled": True or False, # 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. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + "name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. + "ocrConfig": { # The OCR options for parsing documents. # [DEPRECATED] This field is deprecated. To specify OCR parsing config, please specify `ocr_parsing_config` in `default_parsing_config` field The OCR config. Currently it only applies to PDFs. + "enabled": True or False, # Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply. We will only perform OCR on the first 80 pages of the PDF files. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + "a_key": { # Related configurations applied to a specific type of document parser. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + }, + }, + "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. + "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. + "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id" + }, + "idpType": "A String", # Identity provider type configured. + }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "solutionTypes": [ # The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. "A String", ], + "startingSchema": { # Defines the structure and layout of a type of document data. # 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). + "fieldConfigs": [ # Output only. Configurations for fields of the schema. + { # Configurations for fields of a schema. For example, configuring a field is indexable, or searchable. + "completableOption": "A String", # If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error. + "dynamicFacetableOption": "A String", # If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error. + "fieldPath": "A String", # Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`. + "fieldType": "A String", # Output only. Raw type of the field. + "indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. + "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. + "recsFilterableOption": "A String", # 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. + "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. + "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. + }, + ], + "jsonSchema": "A String", # The JSON representation of the schema. + "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "structSchema": { # The structured representation of the schema. + "a_key": "", # Properties of the object. + }, + }, }, ], "nextPageToken": "A String", # A token that can be sent as ListDataStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. @@ -433,15 +622,78 @@

Method Details

The object takes the form of: { # DataStore captures global settings and configs at the DataStore level. + "aclEnabled": True or False, # 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. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + "name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. + "ocrConfig": { # The OCR options for parsing documents. # [DEPRECATED] This field is deprecated. To specify OCR parsing config, please specify `ocr_parsing_config` in `default_parsing_config` field The OCR config. Currently it only applies to PDFs. + "enabled": True or False, # Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply. We will only perform OCR on the first 80 pages of the PDF files. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + "a_key": { # Related configurations applied to a specific type of document parser. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + }, + }, + "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. + "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. + "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id" + }, + "idpType": "A String", # Identity provider type configured. + }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "solutionTypes": [ # The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. "A String", ], + "startingSchema": { # Defines the structure and layout of a type of document data. # 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). + "fieldConfigs": [ # Output only. Configurations for fields of the schema. + { # Configurations for fields of a schema. For example, configuring a field is indexable, or searchable. + "completableOption": "A String", # If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error. + "dynamicFacetableOption": "A String", # If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error. + "fieldPath": "A String", # Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`. + "fieldType": "A String", # Output only. Raw type of the field. + "indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. + "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. + "recsFilterableOption": "A String", # 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. + "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. + "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. + }, + ], + "jsonSchema": "A String", # The JSON representation of the schema. + "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "structSchema": { # The structured representation of the schema. + "a_key": "", # Properties of the object. + }, + }, } updateMask: string, Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. @@ -454,15 +706,78 @@

Method Details

An object of the form: { # DataStore captures global settings and configs at the DataStore level. + "aclEnabled": True or False, # 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. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + "name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. + "ocrConfig": { # The OCR options for parsing documents. # [DEPRECATED] This field is deprecated. To specify OCR parsing config, please specify `ocr_parsing_config` in `default_parsing_config` field The OCR config. Currently it only applies to PDFs. + "enabled": True or False, # Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply. We will only perform OCR on the first 80 pages of the PDF files. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + "a_key": { # Related configurations applied to a specific type of document parser. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + }, + }, + "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. + "externalIdpConfig": { # Third party IDP Config. # External Identity provider config. + "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id" + }, + "idpType": "A String", # Identity provider type configured. + }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "solutionTypes": [ # The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. "A String", ], + "startingSchema": { # Defines the structure and layout of a type of document data. # 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). + "fieldConfigs": [ # Output only. Configurations for fields of the schema. + { # Configurations for fields of a schema. For example, configuring a field is indexable, or searchable. + "completableOption": "A String", # If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error. + "dynamicFacetableOption": "A String", # If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error. + "fieldPath": "A String", # Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`. + "fieldType": "A String", # Output only. Raw type of the field. + "indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error. + "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. + "recsFilterableOption": "A String", # 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. + "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error. + "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. + }, + ], + "jsonSchema": "A String", # The JSON representation of the schema. + "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "structSchema": { # The structured representation of the schema. + "a_key": "", # Properties of the object. + }, + }, } @@ -496,7 +811,7 @@

Method Details

], "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. }, - "parsingConfigOverrides": { # 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 or layout parsing are supported. + "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. "a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, @@ -542,7 +857,7 @@

Method Details

], "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. }, - "parsingConfigOverrides": { # 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 or layout parsing are supported. + "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. "a_key": { # Related configurations applied to a specific type of document parser. "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html index 0ff7c7335f..69cfd40b07 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html @@ -608,6 +608,18 @@

Method Details

"results": [ # A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least). { # RecommendationResult represents a generic recommendation result with associated metadata. "document": { # Document captures all raw metadata information of items to be recommended or searched. # Set if `returnDocument` is set to true in RecommendRequest.params. + "aclInfo": { # ACL Information of the Document. # Access control information for the document. + "readers": [ + { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } } + "principals": [ # List of principals. + { # Principal identifier of a user or a group. + "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. + "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. + }, + ], + }, + ], + }, "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. @@ -617,6 +629,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -649,7 +662,7 @@

Method Details

"conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. { # Boost applies to documents which match a condition. "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. - "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) + "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue")) }, ], }, @@ -681,6 +694,9 @@

Method Details

"summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most five results can be used to generate a summary. }, }, + "customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. + "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model. + }, "embeddingSpec": { # The specification that uses customized query embedding vector to do semantic document retrieval. # Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path. "embeddingVectors": [ # The embedding vector used for retrieval. Limit to 1. { # Embedding vector. @@ -812,6 +828,18 @@

Method Details

"results": [ # A list of matched documents. The order represents the ranking. { # Represents the search results. "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as retrievable are populated. + "aclInfo": { # ACL Information of the Document. # Access control information for the document. + "readers": [ + { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } } + "principals": [ # List of principals. + { # Principal identifier of a user or a group. + "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. + "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. + }, + ], + }, + ], + }, "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. @@ -821,6 +849,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.html index debc965e94..4efd4f0260 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.html @@ -95,6 +95,12 @@

Instance Methods

estimateDataSize(location, body=None, x__xgafv=None)

Estimates the data size to be used by a customer.

+

+ getAclConfig(name, x__xgafv=None)

+

Gets the AclConfig.

+

+ updateAclConfig(name, body=None, x__xgafv=None)

+

Default Acl Configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.

Method Details

close() @@ -171,4 +177,67 @@

Method Details

}
+
+ getAclConfig(name, x__xgafv=None) + 
Gets the AclConfig.
+
+Args:
+  name: string, Required. Resource name of AclConfig, such as `projects/*/locations/*/aclConfig`. If the caller does not have permission to access the AclConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Access Control Configuration.
+  "idpConfig": { # Identity Provider Config. # Identity provider config.
+    "externalIdpConfig": { # Third party IDP Config. # External Identity provider config.
+      "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id"
+    },
+    "idpType": "A String", # Identity provider type configured.
+  },
+  "name": "A String", # Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ +
+ updateAclConfig(name, body=None, x__xgafv=None) + 
Default Acl Configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.
+
+Args:
+  name: string, Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Access Control Configuration.
+  "idpConfig": { # Identity Provider Config. # Identity provider config.
+    "externalIdpConfig": { # Third party IDP Config. # External Identity provider config.
+      "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id"
+    },
+    "idpType": "A String", # Identity provider type configured.
+  },
+  "name": "A String", # Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Access Control Configuration.
+  "idpConfig": { # Identity Provider Config. # Identity provider config.
+    "externalIdpConfig": { # Third party IDP Config. # External Identity provider config.
+      "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id"
+    },
+    "idpType": "A String", # Identity provider type configured.
+  },
+  "name": "A String", # Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html index 637215596b..40c6aeb5ee 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html @@ -126,6 +126,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -154,6 +155,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -206,6 +208,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -261,6 +264,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -331,6 +335,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -377,6 +382,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -405,6 +411,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.conversations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.conversations.html index 8446c58ce1..725c69e6cd 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.conversations.html @@ -114,6 +114,14 @@

Method Details

The object takes the form of: { # Request message for ConversationalSearchService.ConverseConversation method. + "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) + "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. + { # Boost applies to documents which match a condition. + "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. + "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue")) + }, + ], + }, "conversation": { # External conversation proto definition. # The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session. "endTime": "A String", # Output only. The time the conversation finished. "messages": [ # Conversation messages. @@ -354,6 +362,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html index 821eb79da2..381f112514 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html @@ -160,7 +160,7 @@

Method Details

dataStore: string, Required. The parent data store resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. (required) includeTailSuggestions: boolean, Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. query: string, Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. - queryModel: string, Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. + queryModel: string, Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. * userPseudoId: string, A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. x__xgafv: string, V1 error format. Allowed values @@ -197,11 +197,43 @@

Method Details

"createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + "name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. + "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + "a_key": { # Related configurations applied to a specific type of document parser. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + }, + }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "solutionTypes": [ # The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. "A String", ], + "startingSchema": { # Defines the structure and layout of a type of document data. # 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). + "jsonSchema": "A String", # The JSON representation of the schema. + "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "structSchema": { # The structured representation of the schema. + "a_key": "", # Properties of the object. + }, + }, } createAdvancedSiteSearch: boolean, A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. @@ -289,11 +321,43 @@

Method Details

"createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + "name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. + "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + "a_key": { # Related configurations applied to a specific type of document parser. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + }, + }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "solutionTypes": [ # The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. "A String", ], + "startingSchema": { # Defines the structure and layout of a type of document data. # 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). + "jsonSchema": "A String", # The JSON representation of the schema. + "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "structSchema": { # The structured representation of the schema. + "a_key": "", # Properties of the object. + }, + }, } @@ -340,11 +404,43 @@

Method Details

"createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + "name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. + "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + "a_key": { # Related configurations applied to a specific type of document parser. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + }, + }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "solutionTypes": [ # The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. "A String", ], + "startingSchema": { # Defines the structure and layout of a type of document data. # 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). + "jsonSchema": "A String", # The JSON representation of the schema. + "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "structSchema": { # The structured representation of the schema. + "a_key": "", # Properties of the object. + }, + }, }, ], "nextPageToken": "A String", # A token that can be sent as ListDataStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. @@ -379,11 +475,43 @@

Method Details

"createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + "name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. + "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + "a_key": { # Related configurations applied to a specific type of document parser. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + }, + }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "solutionTypes": [ # The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. "A String", ], + "startingSchema": { # Defines the structure and layout of a type of document data. # 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). + "jsonSchema": "A String", # The JSON representation of the schema. + "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "structSchema": { # The structured representation of the schema. + "a_key": "", # Properties of the object. + }, + }, } updateMask: string, Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. @@ -400,11 +528,43 @@

Method Details

"createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + "name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. + "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + "a_key": { # Related configurations applied to a specific type of document parser. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + }, + }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "solutionTypes": [ # The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. "A String", ], + "startingSchema": { # Defines the structure and layout of a type of document data. # 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). + "jsonSchema": "A String", # The JSON representation of the schema. + "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "structSchema": { # The structured representation of the schema. + "a_key": "", # Properties of the object. + }, + }, } diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html index a14f65e7d0..77c1b84d8b 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html @@ -585,6 +585,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -617,7 +618,7 @@

Method Details

"conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. { # Boost applies to documents which match a condition. "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. - "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) + "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue")) }, ], }, @@ -788,6 +789,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.conversations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.conversations.html index c588b1e96b..09a58222de 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.conversations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.conversations.html @@ -114,6 +114,14 @@

Method Details

The object takes the form of: { # Request message for ConversationalSearchService.ConverseConversation method. + "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) + "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. + { # Boost applies to documents which match a condition. + "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. + "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue")) + }, + ], + }, "conversation": { # External conversation proto definition. # The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session. "endTime": "A String", # Output only. The time the conversation finished. "messages": [ # Conversation messages. @@ -354,6 +362,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html index 50ab4e2fda..d0b86a0792 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html @@ -585,6 +585,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -617,7 +618,7 @@

Method Details

"conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. { # Boost applies to documents which match a condition. "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. - "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) + "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue")) }, ], }, @@ -788,6 +789,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html index bb72b59351..ed42eafac3 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html @@ -126,6 +126,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -154,6 +155,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -206,6 +208,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -261,6 +264,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -331,6 +335,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -377,6 +382,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -405,6 +411,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.conversations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.conversations.html index 591dcffd6c..de09cda5e5 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.conversations.html @@ -114,6 +114,14 @@

Method Details

The object takes the form of: { # Request message for ConversationalSearchService.ConverseConversation method. + "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) + "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. + { # Boost applies to documents which match a condition. + "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. + "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue")) + }, + ], + }, "conversation": { # External conversation proto definition. # The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session. "endTime": "A String", # Output only. The time the conversation finished. "messages": [ # Conversation messages. @@ -354,6 +362,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html index 6c0bfb4f0e..22aed96b52 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html @@ -160,7 +160,7 @@

Method Details

dataStore: string, Required. The parent data store resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. (required) includeTailSuggestions: boolean, Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. query: string, Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. - queryModel: string, Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. + queryModel: string, Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. * userPseudoId: string, A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. x__xgafv: string, V1 error format. Allowed values @@ -197,11 +197,43 @@

Method Details

"createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + "name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. + "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + "a_key": { # Related configurations applied to a specific type of document parser. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + }, + }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "solutionTypes": [ # The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. "A String", ], + "startingSchema": { # Defines the structure and layout of a type of document data. # 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). + "jsonSchema": "A String", # The JSON representation of the schema. + "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "structSchema": { # The structured representation of the schema. + "a_key": "", # Properties of the object. + }, + }, } createAdvancedSiteSearch: boolean, A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. @@ -289,11 +321,43 @@

Method Details

"createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + "name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. + "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + "a_key": { # Related configurations applied to a specific type of document parser. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + }, + }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "solutionTypes": [ # The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. "A String", ], + "startingSchema": { # Defines the structure and layout of a type of document data. # 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). + "jsonSchema": "A String", # The JSON representation of the schema. + "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "structSchema": { # The structured representation of the schema. + "a_key": "", # Properties of the object. + }, + }, } @@ -340,11 +404,43 @@

Method Details

"createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + "name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. + "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + "a_key": { # Related configurations applied to a specific type of document parser. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + }, + }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "solutionTypes": [ # The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. "A String", ], + "startingSchema": { # Defines the structure and layout of a type of document data. # 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). + "jsonSchema": "A String", # The JSON representation of the schema. + "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "structSchema": { # The structured representation of the schema. + "a_key": "", # Properties of the object. + }, + }, }, ], "nextPageToken": "A String", # A token that can be sent as ListDataStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. @@ -379,11 +475,43 @@

Method Details

"createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + "name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. + "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + "a_key": { # Related configurations applied to a specific type of document parser. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + }, + }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "solutionTypes": [ # The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. "A String", ], + "startingSchema": { # Defines the structure and layout of a type of document data. # 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). + "jsonSchema": "A String", # The JSON representation of the schema. + "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "structSchema": { # The structured representation of the schema. + "a_key": "", # Properties of the object. + }, + }, } updateMask: string, Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. @@ -400,11 +528,43 @@

Method Details

"createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema asscociated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + "documentProcessingConfig": { # A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. # Configuration for Document understanding and enrichment. + "defaultParsingConfig": { # Related configurations applied to a specific type of document parser. # Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + "name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. + "parsingConfigOverrides": { # 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + "a_key": { # Related configurations applied to a specific type of document parser. + "digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. + }, + "ocrParsingConfig": { # The OCR parsing configurations for documents. # Configurations applied to OCR parser. Currently it only applies to PDFs. + "enhancedDocumentElements": [ # Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. + "A String", + ], + "useNativeText": True or False, # If true, will use native text instead of OCR text on pages containing native text. + }, + }, + }, + }, "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. "name": "A String", # Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "solutionTypes": [ # The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. "A String", ], + "startingSchema": { # Defines the structure and layout of a type of document data. # 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). + "jsonSchema": "A String", # The JSON representation of the schema. + "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "structSchema": { # The structured representation of the schema. + "a_key": "", # Properties of the object. + }, + }, } diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html index 138a0428ae..6ebb46021f 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html @@ -585,6 +585,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. @@ -617,7 +618,7 @@

Method Details

"conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. { # Boost applies to documents which match a condition. "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. - "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) + "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue")) }, ], }, @@ -788,6 +789,7 @@

Method Details

"a_key": "", # Properties of the object. }, "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index 7d3647c185..c1606bc45c 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -252,6 +252,59 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"getAclConfig": { +"description": "Gets the AclConfig.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/aclConfig", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.getAclConfig", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Resource name of AclConfig, such as `projects/*/locations/*/aclConfig`. If the caller does not have permission to access the AclConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/aclConfig$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAclConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"updateAclConfig": { +"description": "Default Acl Configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/aclConfig", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.updateAclConfig", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/aclConfig$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAclConfig" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAclConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -826,6 +879,12 @@ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "required": true, "type": "string" +}, +"updateMask": { +"description": "Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } }, "path": "v1alpha/{+name}", @@ -3521,6 +3580,12 @@ "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "required": true, "type": "string" +}, +"updateMask": { +"description": "Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } }, "path": "v1alpha/{+name}", @@ -4881,7 +4946,7 @@ } } }, -"revision": "20240213", +"revision": "20240227", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -5164,6 +5229,10 @@ "description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, +"documentProcessingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", +"description": "Configuration for Document understanding and enrichment." +}, "industryVertical": { "description": "Immutable. The industry vertical that the data store registers.", "enum": [ @@ -5200,6 +5269,10 @@ "type": "string" }, "type": "array" +}, +"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)." } }, "type": "object" @@ -5272,6 +5345,12 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1DigitalParsingConfig": { +"description": "The digital parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1DigitalParsingConfig", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata", @@ -5295,6 +5374,43 @@ "properties": {}, "type": "object" }, +"GoogleCloudDiscoveryengineV1DocumentProcessingConfig": { +"description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", +"properties": { +"defaultParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", +"description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." +}, +"name": { +"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", +"type": "string" +}, +"parsingConfigOverrides": { +"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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { +"description": "Related configurations applied to a specific type of document parser.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", +"properties": { +"digitalParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DigitalParsingConfig", +"description": "Configurations applied to digital parser." +}, +"ocrParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1OcrParsingConfig", +"description": "Configurations applied to OCR parser. Currently it only applies to PDFs." +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata", @@ -5647,6 +5763,24 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1OcrParsingConfig": { +"description": "The OCR parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1OcrParsingConfig", +"properties": { +"enhancedDocumentElements": { +"description": "Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.", +"items": { +"type": "string" +}, +"type": "array" +}, +"useNativeText": { +"description": "If true, will use native text instead of OCR text on pages containing native text.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata": { "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata", @@ -5661,6 +5795,11 @@ "format": "int64", "type": "string" }, +"ignoredCount": { +"description": "Count of entries that were ignored as entries were not found.", +"format": "int64", +"type": "string" +}, "successCount": { "description": "Count of entries that were deleted successfully.", "format": "int64", @@ -5911,6 +6050,21 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaAclConfig": { +"description": "Access Control Configuration.", +"id": "GoogleCloudDiscoveryengineV1alphaAclConfig", +"properties": { +"idpConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", +"description": "Identity provider config." +}, +"name": { +"description": "Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaAdditionalParams": { "description": "AdditionalParams message for WidgetService methods for security and privacy enhancement.", "id": "GoogleCloudDiscoveryengineV1alphaAdditionalParams", @@ -6174,6 +6328,10 @@ "description": "Request message for ConversationalSearchService.ConverseConversation method.", "id": "GoogleCloudDiscoveryengineV1alphaConverseConversationRequest", "properties": { +"boostSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", +"description": "Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)" +}, "conversation": { "$ref": "GoogleCloudDiscoveryengineV1alphaConversation", "description": "The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session." @@ -6361,6 +6519,10 @@ "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1alphaDataStore", "properties": { +"aclEnabled": { +"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" +}, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -6392,6 +6554,15 @@ "description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, +"documentProcessingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", +"description": "Configuration for Document understanding and enrichment." +}, +"idpConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", +"description": "Output only. Data store level identity provider config.", +"readOnly": true +}, "industryVertical": { "description": "Immutable. The industry vertical that the data store registers.", "enum": [ @@ -6428,6 +6599,10 @@ "type": "string" }, "type": "array" +}, +"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)." } }, "type": "object" @@ -6539,6 +6714,10 @@ "description": "Document captures all raw metadata information of items to be recommended or searched.", "id": "GoogleCloudDiscoveryengineV1alphaDocument", "properties": { +"aclInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfo", +"description": "Access control information for the document." +}, "content": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentContent", "description": "The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store." @@ -6556,6 +6735,12 @@ "description": "Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.", "type": "string" }, +"indexTime": { +"description": "Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "jsonData": { "description": "The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.", "type": "string" @@ -6583,6 +6768,33 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDocumentAclInfo": { +"description": "ACL Information of the Document.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfo", +"properties": { +"readers": { +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction": { +"description": "AclRestriction to model complex inheritance restrictions. Example: Modeling a \"Both Permit\" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { \"acl_info\": { \"readers\": [ { \"principals\": [ { \"group_id\": \"group_1\" }, { \"user_id\": \"user_1\" } ] } ] } } Page_P ACL Restriction. { \"acl_info\": { \"readers\": [ { \"principals\": [ { \"group_id\": \"group_2\" }, { \"group_id\": \"group_3\" }, { \"user_id\": \"user_2\" } ], }, { \"principals\": [ { \"group_id\": \"group_1\" }, { \"user_id\": \"user_1\" } ], } ] } }", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction", +"properties": { +"principals": { +"description": "List of principals.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaPrincipal" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaDocumentContent": { "description": "Unstructured data linked to this document.", "id": "GoogleCloudDiscoveryengineV1alphaDocumentContent", @@ -6655,7 +6867,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 or 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.", "type": "object" } }, @@ -6739,6 +6951,10 @@ "description": "Metadata that describes the training and serving parameters of an Engine.", "id": "GoogleCloudDiscoveryengineV1alphaEngine", "properties": { +"allowMultipleDataStoresSearchEngine": { +"description": "Whether the search engine can associate with multiple data stores. If true, the generic search engine can associate with one or more data stores. This is an input-only field.", +"type": "boolean" +}, "chatEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." @@ -7308,6 +7524,42 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaIdpConfig": { +"description": "Identity Provider Config.", +"id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", +"properties": { +"externalIdpConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", +"description": "External Identity provider config." +}, +"idpType": { +"description": "Identity provider type configured.", +"enum": [ +"IDP_TYPE_UNSPECIFIED", +"GSUITE", +"THIRD_PARTY" +], +"enumDescriptions": [ +"Default value. ACL search not enabled.", +"Google 1P provider.", +"Third party provider." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig": { +"description": "Third party IDP Config.", +"id": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", +"properties": { +"workforcePoolName": { +"description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", +"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", @@ -7883,6 +8135,21 @@ "properties": {}, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaPrincipal": { +"description": "Principal identifier of a user or a group.", +"id": "GoogleCloudDiscoveryengineV1alphaPrincipal", +"properties": { +"groupId": { +"description": "Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config.", +"type": "string" +}, +"userId": { +"description": "User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata": { "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata", @@ -7897,6 +8164,11 @@ "format": "int64", "type": "string" }, +"ignoredCount": { +"description": "Count of entries that were ignored as entries were not found.", +"format": "int64", +"type": "string" +}, "successCount": { "description": "Count of entries that were deleted successfully.", "format": "int64", @@ -7914,6 +8186,10 @@ "description": "Request message for DocumentService.PurgeDocuments method.", "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest", "properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig", +"description": "The desired location of errors incurred during the purge." +}, "filter": { "description": "Required. Filter matching documents to purge. Only currently supported value is `*` (all items).", "type": "string" @@ -7921,6 +8197,10 @@ "force": { "description": "Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.", "type": "boolean" +}, +"gcsSource": { +"$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", +"description": "Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line." } }, "type": "object" @@ -7944,6 +8224,17 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig": { +"description": "Configuration of destination for Purge related errors.", +"id": "GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig", +"properties": { +"gcsPrefix": { +"description": "Cloud Storage prefix for purge errors. This must be an empty, existing Cloud Storage directory. Purge errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata": { "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata", @@ -8378,6 +8669,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", "description": "A specification for configuring the behavior of content search." }, +"customFineTuningSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", +"description": "Custom fine tuning configs." +}, "embeddingSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", "description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path." @@ -8488,7 +8783,7 @@ "type": "number" }, "condition": { -"description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": * (id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\",\"Blue\"))", +"description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": * (document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))", "type": "string" } }, @@ -9896,6 +10191,10 @@ "description": "Turn on or off summarization for the search response.", "type": "boolean" }, +"enableWebApp": { +"description": "Whether to enable standalone web app.", +"type": "boolean" +}, "facetField": { "description": "The configuration and appearance of facets in the end user view.", "items": { @@ -10235,6 +10534,10 @@ "description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, +"documentProcessingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", +"description": "Configuration for Document understanding and enrichment." +}, "industryVertical": { "description": "Immutable. The industry vertical that the data store registers.", "enum": [ @@ -10271,6 +10574,10 @@ "type": "string" }, "type": "array" +}, +"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)." } }, "type": "object" @@ -10343,6 +10650,12 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaDigitalParsingConfig": { +"description": "The digital parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1betaDigitalParsingConfig", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata", @@ -10366,6 +10679,43 @@ "properties": {}, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig": { +"description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", +"properties": { +"defaultParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", +"description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." +}, +"name": { +"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", +"type": "string" +}, +"parsingConfigOverrides": { +"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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { +"description": "Related configurations applied to a specific type of document parser.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", +"properties": { +"digitalParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDigitalParsingConfig", +"description": "Configurations applied to digital parser." +}, +"ocrParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaOcrParsingConfig", +"description": "Configurations applied to OCR parser. Currently it only applies to PDFs." +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata", @@ -10718,6 +11068,24 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaOcrParsingConfig": { +"description": "The OCR parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1betaOcrParsingConfig", +"properties": { +"enhancedDocumentElements": { +"description": "Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.", +"items": { +"type": "string" +}, +"type": "array" +}, +"useNativeText": { +"description": "If true, will use native text instead of OCR text on pages containing native text.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": { "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata", @@ -10732,6 +11100,11 @@ "format": "int64", "type": "string" }, +"ignoredCount": { +"description": "Count of entries that were ignored as entries were not found.", +"format": "int64", +"type": "string" +}, "successCount": { "description": "Count of entries that were deleted successfully.", "format": "int64", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index 025a54abc4..31cd53118f 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -214,7 +214,7 @@ "type": "string" }, "queryModel": { -"description": "Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.", +"description": "Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. *", "location": "query", "type": "string" }, @@ -2738,7 +2738,7 @@ "type": "string" }, "queryModel": { -"description": "Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.", +"description": "Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. *", "location": "query", "type": "string" }, @@ -4449,7 +4449,7 @@ } } }, -"revision": "20240213", +"revision": "20240229", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4732,6 +4732,10 @@ "description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, +"documentProcessingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", +"description": "Configuration for Document understanding and enrichment." +}, "industryVertical": { "description": "Immutable. The industry vertical that the data store registers.", "enum": [ @@ -4768,6 +4772,10 @@ "type": "string" }, "type": "array" +}, +"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)." } }, "type": "object" @@ -4840,6 +4848,12 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1DigitalParsingConfig": { +"description": "The digital parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1DigitalParsingConfig", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata", @@ -4863,6 +4877,43 @@ "properties": {}, "type": "object" }, +"GoogleCloudDiscoveryengineV1DocumentProcessingConfig": { +"description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", +"properties": { +"defaultParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", +"description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." +}, +"name": { +"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", +"type": "string" +}, +"parsingConfigOverrides": { +"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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { +"description": "Related configurations applied to a specific type of document parser.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", +"properties": { +"digitalParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DigitalParsingConfig", +"description": "Configurations applied to digital parser." +}, +"ocrParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1OcrParsingConfig", +"description": "Configurations applied to OCR parser. Currently it only applies to PDFs." +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata", @@ -5215,6 +5266,24 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1OcrParsingConfig": { +"description": "The OCR parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1OcrParsingConfig", +"properties": { +"enhancedDocumentElements": { +"description": "Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.", +"items": { +"type": "string" +}, +"type": "array" +}, +"useNativeText": { +"description": "If true, will use native text instead of OCR text on pages containing native text.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata": { "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata", @@ -5229,6 +5298,11 @@ "format": "int64", "type": "string" }, +"ignoredCount": { +"description": "Count of entries that were ignored as entries were not found.", +"format": "int64", +"type": "string" +}, "successCount": { "description": "Count of entries that were deleted successfully.", "format": "int64", @@ -5479,6 +5553,21 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaAclConfig": { +"description": "Access Control Configuration.", +"id": "GoogleCloudDiscoveryengineV1alphaAclConfig", +"properties": { +"idpConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", +"description": "Identity provider config." +}, +"name": { +"description": "Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata", @@ -5582,6 +5671,10 @@ "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1alphaDataStore", "properties": { +"aclEnabled": { +"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" +}, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -5613,6 +5706,15 @@ "description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, +"documentProcessingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", +"description": "Configuration for Document understanding and enrichment." +}, +"idpConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", +"description": "Output only. Data store level identity provider config.", +"readOnly": true +}, "industryVertical": { "description": "Immutable. The industry vertical that the data store registers.", "enum": [ @@ -5649,6 +5751,10 @@ "type": "string" }, "type": "array" +}, +"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)." } }, "type": "object" @@ -5754,6 +5860,10 @@ "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", "properties": { +"chunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", +"description": "Whether chunking mode is enabled." +}, "defaultParsingConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." @@ -5771,8 +5881,35 @@ "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 or 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig": { +"description": "Configuration for chunking config.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", +"properties": { +"layoutBasedChunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"description": "Configuration for the layout based chunking." +} +}, "type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { +"description": "Configuration for the layout based chunking.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"properties": { +"chunkSize": { +"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", +"format": "int32", +"type": "integer" +}, +"includeAncestorHeadings": { +"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", +"type": "boolean" } }, "type": "object" @@ -5823,6 +5960,10 @@ "description": "Metadata that describes the training and serving parameters of an Engine.", "id": "GoogleCloudDiscoveryengineV1alphaEngine", "properties": { +"allowMultipleDataStoresSearchEngine": { +"description": "Whether the search engine can associate with multiple data stores. If true, the generic search engine can associate with one or more data stores. This is an input-only field.", +"type": "boolean" +}, "chatEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." @@ -6268,6 +6409,42 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaIdpConfig": { +"description": "Identity Provider Config.", +"id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", +"properties": { +"externalIdpConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", +"description": "External Identity provider config." +}, +"idpType": { +"description": "Identity provider type configured.", +"enum": [ +"IDP_TYPE_UNSPECIFIED", +"GSUITE", +"THIRD_PARTY" +], +"enumDescriptions": [ +"Default value. ACL search not enabled.", +"Google 1P provider.", +"Third party provider." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig": { +"description": "Third party IDP Config.", +"id": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", +"properties": { +"workforcePoolName": { +"description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", +"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", @@ -6481,6 +6658,11 @@ "format": "int64", "type": "string" }, +"ignoredCount": { +"description": "Count of entries that were ignored as entries were not found.", +"format": "int64", +"type": "string" +}, "successCount": { "description": "Count of entries that were deleted successfully.", "format": "int64", @@ -7167,6 +7349,10 @@ "description": "Request message for ConversationalSearchService.ConverseConversation method.", "id": "GoogleCloudDiscoveryengineV1betaConverseConversationRequest", "properties": { +"boostSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", +"description": "Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)" +}, "conversation": { "$ref": "GoogleCloudDiscoveryengineV1betaConversation", "description": "The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session." @@ -7370,6 +7556,10 @@ "description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, +"documentProcessingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", +"description": "Configuration for Document understanding and enrichment." +}, "industryVertical": { "description": "Immutable. The industry vertical that the data store registers.", "enum": [ @@ -7406,6 +7596,10 @@ "type": "string" }, "type": "array" +}, +"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)." } }, "type": "object" @@ -7478,6 +7672,12 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaDigitalParsingConfig": { +"description": "The digital parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1betaDigitalParsingConfig", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata", @@ -7528,6 +7728,12 @@ "description": "Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.", "type": "string" }, +"indexTime": { +"description": "Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "jsonData": { "description": "The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.", "type": "string" @@ -7606,6 +7812,43 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig": { +"description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", +"properties": { +"defaultParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", +"description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." +}, +"name": { +"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", +"type": "string" +}, +"parsingConfigOverrides": { +"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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { +"description": "Related configurations applied to a specific type of document parser.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", +"properties": { +"digitalParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDigitalParsingConfig", +"description": "Configurations applied to digital parser." +}, +"ocrParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaOcrParsingConfig", +"description": "Configurations applied to OCR parser. Currently it only applies to PDFs." +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaDoubleList": { "description": "Double list.", "id": "GoogleCloudDiscoveryengineV1betaDoubleList", @@ -8331,6 +8574,24 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaOcrParsingConfig": { +"description": "The OCR parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1betaOcrParsingConfig", +"properties": { +"enhancedDocumentElements": { +"description": "Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.", +"items": { +"type": "string" +}, +"type": "array" +}, +"useNativeText": { +"description": "If true, will use native text instead of OCR text on pages containing native text.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaPageInfo": { "description": "Detailed page information.", "id": "GoogleCloudDiscoveryengineV1betaPageInfo", @@ -8393,6 +8654,11 @@ "format": "int64", "type": "string" }, +"ignoredCount": { +"description": "Count of entries that were ignored as entries were not found.", +"format": "int64", +"type": "string" +}, "successCount": { "description": "Count of entries that were deleted successfully.", "format": "int64", @@ -8804,7 +9070,7 @@ "type": "number" }, "condition": { -"description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": * (id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\",\"Blue\"))", +"description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": * (document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))", "type": "string" } },