feat(discoveryengine): update the api

#### discoveryengine:v1alpha The following keys were deleted: - schemas.GoogleCloudDiscoveryengineV1alphaGroundingConfig (Total Keys: 3) The following keys were added: - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.answer (Total Keys: 12) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.patch (Total Keys: 15) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.resources.answers.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.answer (Total Keys: 12) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.patch (Total Keys: 15) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.resources.answers.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.answer (Total Keys: 12) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.patch (Total Keys: 15) - resources.projects.resources.locations.resources.dataStores.resources.sessions.resources.answers.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.evaluations.resources.operations.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.groundingConfigs.methods.check (Total Keys: 12) - schemas.GoogleCloudDiscoveryengineV1ImportDocumentsMetadata.properties.totalCount (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaAnswer (Total Keys: 196) - schemas.GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse (Total Keys: 18) - schemas.GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1alphaFactChunk (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1alphaGroundingFact (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata.properties.totalCount (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest.properties.updateMask (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaListSessionsResponse (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1alphaQuery (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec.properties.boostControlSpec.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec (Total Keys: 12) - schemas.GoogleCloudDiscoveryengineV1alphaSession (Total Keys: 17) - schemas.GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata.properties.totalCount (Total Keys: 2) #### discoveryengine:v1beta The following keys were deleted: - schemas.GoogleCloudDiscoveryengineV1alphaGroundingConfig (Total Keys: 3) The following keys were added: - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.answer (Total Keys: 12) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.patch (Total Keys: 15) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.resources.answers.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.answer (Total Keys: 12) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.patch (Total Keys: 15) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.resources.answers.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.answer (Total Keys: 12) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.patch (Total Keys: 15) - resources.projects.resources.locations.resources.dataStores.resources.sessions.resources.answers.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.groundingConfigs.methods.check (Total Keys: 12) - schemas.GoogleCloudDiscoveryengineV1ImportDocumentsMetadata.properties.totalCount (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaAnswer (Total Keys: 102) - schemas.GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata.properties.totalCount (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaQuery (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1alphaSession (Total Keys: 17) - schemas.GoogleCloudDiscoveryengineV1betaAnswer (Total Keys: 195) - schemas.GoogleCloudDiscoveryengineV1betaCheckGroundingRequest (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1betaCheckGroundingResponse (Total Keys: 18) - schemas.GoogleCloudDiscoveryengineV1betaCheckGroundingSpec (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1betaFactChunk (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata.properties.totalCount (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1betaImportDocumentsRequest.properties.updateMask (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1betaListSessionsResponse (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1betaQuery (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec.properties.boostControlSpec.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec (Total Keys: 12) - schemas.GoogleCloudDiscoveryengineV1betaSession (Total Keys: 17)
googleapis · Apr 9, 2024 · 9813760 · 9813760
1 parent beecc6f
commit 9813760
Show file tree

Hide file tree

Showing 55 changed files with 10,772 additions and 1,508 deletions.
diff --git a/docs/dyn/discoveryengine_v1alpha.locations.html b/docs/dyn/discoveryengine_v1alpha.locations.html
@@ -290,6 +290,17 @@ <h3>Method Details</h3>
       &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. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
+          &quot;boostControlSpec&quot;: { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+            &quot;attributeType&quot;: &quot;A String&quot;, # The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
+            &quot;controlPoints&quot;: [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+              { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
+                &quot;attributeValue&quot;: &quot;A String&quot;, # Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
+                &quot;boostAmount&quot;: 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+              },
+            ],
+            &quot;fieldName&quot;: &quot;A String&quot;, # The name of the field whose value will be used to determine the boost amount.
+            &quot;interpolationType&quot;: &quot;A String&quot;, # The interpolation type to be applied to connect the control points listed below.
+          },
           &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;))`
         },
       ],
@@ -564,7 +575,7 @@ <h3>Method Details</h3>
             &quot;title&quot;: &quot;A String&quot;, # Title of the document.
             &quot;uri&quot;: &quot;A String&quot;, # Uri of the document.
           },
-          &quot;id&quot;: &quot;A String&quot;, # Unique chunk id of the current chunk.
+          &quot;id&quot;: &quot;A String&quot;, # Unique chunk ID of the current chunk.
           &quot;name&quot;: &quot;A String&quot;, # The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
           &quot;pageSpan&quot;: { # Page span of the chunk. # Page span of the chunk.
             &quot;pageEnd&quot;: 42, # The end page of the chunk.
@@ -636,6 +647,17 @@ <h3>Method Details</h3>
       &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. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
+          &quot;boostControlSpec&quot;: { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+            &quot;attributeType&quot;: &quot;A String&quot;, # The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
+            &quot;controlPoints&quot;: [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+              { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
+                &quot;attributeValue&quot;: &quot;A String&quot;, # Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
+                &quot;boostAmount&quot;: 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+              },
+            ],
+            &quot;fieldName&quot;: &quot;A String&quot;, # The name of the field whose value will be used to determine the boost amount.
+            &quot;interpolationType&quot;: &quot;A String&quot;, # The interpolation type to be applied to connect the control points listed below.
+          },
           &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;))`
         },
       ],
@@ -730,7 +752,7 @@ <h3>Method Details</h3>
     },
     &quot;offset&quot;: 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
     &quot;orderBy&quot;: &quot;A String&quot;, # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
-    &quot;pageSize&quot;: 42, # Maximum number of Documents to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 100. Values above 100 are coerced to 100. If this field is negative, an `INVALID_ARGUMENT` is returned.
+    &quot;pageSize&quot;: 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
     &quot;pageToken&quot;: &quot;A String&quot;, # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
     &quot;params&quot;: { # Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. Example: user_country_code: &quot;au&quot; For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. Example: search_type: 1
       &quot;a_key&quot;: &quot;&quot;,
@@ -832,7 +854,7 @@ <h3>Method Details</h3>
             &quot;title&quot;: &quot;A String&quot;, # Title of the document.
             &quot;uri&quot;: &quot;A String&quot;, # Uri of the document.
           },
-          &quot;id&quot;: &quot;A String&quot;, # Unique chunk id of the current chunk.
+          &quot;id&quot;: &quot;A String&quot;, # Unique chunk ID of the current chunk.
           &quot;name&quot;: &quot;A String&quot;, # The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
           &quot;pageSpan&quot;: { # Page span of the chunk. # Page span of the chunk.
             &quot;pageEnd&quot;: 42, # The end page of the chunk.

diff --git a/...ryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.chunks.html b/...ryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.chunks.html
@@ -123,7 +123,7 @@ <h3>Method Details</h3>
     &quot;title&quot;: &quot;A String&quot;, # Title of the document.
     &quot;uri&quot;: &quot;A String&quot;, # Uri of the document.
   },
-  &quot;id&quot;: &quot;A String&quot;, # Unique chunk id of the current chunk.
+  &quot;id&quot;: &quot;A String&quot;, # Unique chunk ID of the current chunk.
   &quot;name&quot;: &quot;A String&quot;, # The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
   &quot;pageSpan&quot;: { # Page span of the chunk. # Page span of the chunk.
     &quot;pageEnd&quot;: 42, # The end page of the chunk.
@@ -167,7 +167,7 @@ <h3>Method Details</h3>
         &quot;title&quot;: &quot;A String&quot;, # Title of the document.
         &quot;uri&quot;: &quot;A String&quot;, # Uri of the document.
       },
-      &quot;id&quot;: &quot;A String&quot;, # Unique chunk id of the current chunk.
+      &quot;id&quot;: &quot;A String&quot;, # Unique chunk ID of the current chunk.
       &quot;name&quot;: &quot;A String&quot;, # The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
       &quot;pageSpan&quot;: { # Page span of the chunk. # Page span of the chunk.
         &quot;pageEnd&quot;: 42, # The end page of the chunk.