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)
googleapis · Mar 5, 2024 · 39896cf · 39896cf
1 parent cf98c53
commit 39896cf
Show file tree

Hide file tree

Showing 25 changed files with 2,129 additions and 27 deletions.
diff --git a/docs/dyn/discoveryengine_v1alpha.locations.html b/docs/dyn/discoveryengine_v1alpha.locations.html
diff --git a/...discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html b/...discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html
diff --git a/.../dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html b/.../dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html
@@ -114,6 +114,14 @@ <h3>Method Details</h3>
     The object takes the form of:
 
 { # Request message for ConversationalSearchService.ConverseConversation method.
+  &quot;boostSpec&quot;: { # 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)
+    &quot;conditionBoostSpecs&quot;: [ # 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.
+        &quot;boost&quot;: 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.
+        &quot;condition&quot;: &quot;A String&quot;, # 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 &quot;doc_1&quot; or &quot;doc_2&quot;, and color &quot;Red&quot; or &quot;Blue&quot;: * (document_id: ANY(&quot;doc_1&quot;, &quot;doc_2&quot;)) AND (color: ANY(&quot;Red&quot;, &quot;Blue&quot;))
+      },
+    ],
+  },
   &quot;conversation&quot;: { # 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.
     &quot;endTime&quot;: &quot;A String&quot;, # Output only. The time the conversation finished.
     &quot;messages&quot;: [ # Conversation messages.
@@ -346,6 +354,18 @@ <h3>Method Details</h3>
   &quot;searchResults&quot;: [ # Search Results.
     { # Represents the search results.
       &quot;document&quot;: { # 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.
+        &quot;aclInfo&quot;: { # ACL Information of the Document. # Access control information for the document.
+          &quot;readers&quot;: [
+            { # AclRestriction to model complex inheritance restrictions. Example: Modeling a &quot;Both Permit&quot; inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --&gt; Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { &quot;acl_info&quot;: { &quot;readers&quot;: [ { &quot;principals&quot;: [ { &quot;group_id&quot;: &quot;group_1&quot; }, { &quot;user_id&quot;: &quot;user_1&quot; } ] } ] } } Page_P ACL Restriction. { &quot;acl_info&quot;: { &quot;readers&quot;: [ { &quot;principals&quot;: [ { &quot;group_id&quot;: &quot;group_2&quot; }, { &quot;group_id&quot;: &quot;group_3&quot; }, { &quot;user_id&quot;: &quot;user_2&quot; } ], }, { &quot;principals&quot;: [ { &quot;group_id&quot;: &quot;group_1&quot; }, { &quot;user_id&quot;: &quot;user_1&quot; } ], } ] } }
+              &quot;principals&quot;: [ # List of principals.
+                { # Principal identifier of a user or a group.
+                  &quot;groupId&quot;: &quot;A String&quot;, # 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.
+                  &quot;userId&quot;: &quot;A String&quot;, # 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.
+                },
+              ],
+            },
+          ],
+        },
         &quot;content&quot;: { # 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.
           &quot;mimeType&quot;: &quot;A String&quot;, # 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.
           &quot;rawBytes&quot;: &quot;A String&quot;, # 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!?$*&amp;()&#x27;-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.
@@ -355,6 +375,7 @@ <h3>Method Details</h3>
           &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
         },
         &quot;id&quot;: &quot;A String&quot;, # 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.
+        &quot;indexTime&quot;: &quot;A String&quot;, # 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.
         &quot;jsonData&quot;: &quot;A String&quot;, # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
         &quot;name&quot;: &quot;A String&quot;, # 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.
         &quot;parentDocumentId&quot;: &quot;A String&quot;, # 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.