google-cloud-discovery_engine-v1beta 0.14.1 → 0.15.0

data/proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb

@@ -179,6 +179,110 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::DocumentService::Client#batch_get_documents_metadata DocumentService.BatchGetDocumentsMetadata}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent branch resource name, such as
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
+        # @!attribute [rw] matcher
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataRequest::Matcher]
+        #     Required. Matcher for the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s.
+        class BatchGetDocumentsMetadataRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Matcher for the {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s
+          # by exact uris.
+          # @!attribute [rw] uris
+          #   @return [::Array<::String>]
+          #     The exact URIs to match by.
+          class UrisMatcher
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Matcher for the {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s.
+          # Currently supports matching by exact URIs.
+          # @!attribute [rw] uris_matcher
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataRequest::UrisMatcher]
+          #     Matcher by exact URIs.
+          class Matcher
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::DocumentService::Client#batch_get_documents_metadata DocumentService.BatchGetDocumentsMetadata}
+        # method.
+        # @!attribute [rw] documents_metadata
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataResponse::DocumentMetadata>]
+        #     The metadata of the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s.
+        class BatchGetDocumentsMetadataResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The metadata of a {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
+          # @!attribute [rw] matcher_value
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataResponse::DocumentMetadata::MatcherValue]
+          #     The value of the matcher that was used to match the
+          #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
+          # @!attribute [rw] state
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataResponse::State]
+          #     The state of the document.
+          # @!attribute [rw] last_refreshed_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The timestamp of the last time the
+          #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} was last
+          #     indexed.
+          # @!attribute [rw] data_ingestion_source
+          #   @return [::String]
+          #     The data ingestion source of the
+          #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
+          #
+          #     Allowed values are:
+          #
+          #     * `batch`: Data ingested via Batch API, e.g., ImportDocuments.
+          #     * `streaming` Data ingested via Streaming API, e.g., FHIR streaming.
+          class DocumentMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The value of the matcher that was used to match the
+            # {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
+            # @!attribute [rw] uri
+            #   @return [::String]
+            #     If match by URI, the URI of the
+            #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
+            class MatcherValue
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # The state of the {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
+          module State
+            # Should never be set.
+            STATE_UNSPECIFIED = 0
+
+            # The {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} is indexed.
+            INDEXED = 1
+
+            # The {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} is not
+            # indexed because its URI is not in the
+            # {::Google::Cloud::DiscoveryEngine::V1beta::TargetSite TargetSite}.
+            NOT_IN_TARGET_SITE = 2
+
+            # The {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} is not
+            # indexed.
+            NOT_IN_INDEX = 3
+          end
+        end
       end
     end
   end

data/proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb

@@ -130,8 +130,9 @@ module Google
           #     field will be set to false. In that case, no grounding check was done for
           #     the claim and therefore
           #     {::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingResponse::Claim#citation_indices citation_indices},
+          #     [anti_citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.anti_citation_indices],
           #     and
-          #     [anti_citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.anti_citation_indices]
+          #     [score][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.score]
           #     should not be returned.
           class Claim
             include ::Google::Protobuf::MessageExts

data/proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb

@@ -69,7 +69,7 @@ module Google
         #     BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
         # @!attribute [rw] project_id
         #   @return [::String]
-        #     The project ID (can be project # or ID) that the BigQuery source is in with
+        #     The project ID or the project number that contains the BigQuery source. Has
         #     a length limit of 128 characters. If not specified, inherits the project
         #     ID from the parent request.
         # @!attribute [rw] dataset_id
@@ -114,7 +114,7 @@ module Google
         # The Spanner source for importing data
         # @!attribute [rw] project_id
         #   @return [::String]
-        #     The project ID that the Spanner source is in with a length limit of 128
+        #     The project ID that contains the Spanner source. Has a length limit of 128
         #     characters. If not specified, inherits the project ID from the parent
         #     request.
         # @!attribute [rw] instance_id
@@ -269,7 +269,7 @@ module Google
         # The Cloud Bigtable source for importing data.
         # @!attribute [rw] project_id
         #   @return [::String]
-        #     The project ID that the Bigtable source is in with a length limit of 128
+        #     The project ID that contains the Bigtable source. Has a length limit of 128
         #     characters. If not specified, inherits the project ID from the parent
         #     request.
         # @!attribute [rw] instance_id
@@ -298,6 +298,12 @@ module Google
         #     Intermediate Cloud Storage directory used for the import with a length
         #     limit of 2,000 characters. Can be specified if one wants to have the
         #     FhirStore export to a specific Cloud Storage directory.
+        # @!attribute [rw] resource_types
+        #   @return [::Array<::String>]
+        #     The FHIR resource types to import. The resource types should be a subset of
+        #     all [supported FHIR resource
+        #     types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification).
+        #     Default to all supported FHIR resource types if empty.
         class FhirStoreSource
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -306,8 +312,8 @@ module Google
         # Cloud SQL source import data from.
         # @!attribute [rw] project_id
         #   @return [::String]
-        #     The project ID that the Cloud SQL source is in with a length limit of 128
-        #     characters. If not specified, inherits the project ID from the parent
+        #     The project ID that contains the Cloud SQL source. Has a length limit of
+        #     128 characters. If not specified, inherits the project ID from the parent
         #     request.
         # @!attribute [rw] instance_id
         #   @return [::String]
@@ -342,8 +348,8 @@ module Google
         # AlloyDB source import data from.
         # @!attribute [rw] project_id
         #   @return [::String]
-        #     The project ID that the AlloyDB source is in
-        #     with a length limit of 128 characters. If not specified, inherits the
+        #     The project ID that contains the AlloyDB source.
+        #     Has a length limit of 128 characters. If not specified, inherits the
         #     project ID from the parent request.
         # @!attribute [rw] location_id
         #   @return [::String]

data/proto_docs/google/cloud/discoveryengine/v1beta/purge_config.rb

@@ -98,9 +98,30 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Configuration of destination for Purge related errors.
+        # @!attribute [rw] gcs_prefix
+        #   @return [::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.
+        class PurgeErrorConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Request message for
         # {::Google::Cloud::DiscoveryEngine::V1beta::DocumentService::Client#purge_documents DocumentService.PurgeDocuments}
         # method.
+        # @!attribute [rw] gcs_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::GcsSource]
+        #     Cloud Storage location for the input content.
+        #     Supported `data_schema`:
+        #     * `document_id`: One valid
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#id Document.id} per line.
+        # @!attribute [rw] inline_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::PurgeDocumentsRequest::InlineSource]
+        #     Inline source for the input content for purge.
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The parent resource name, such as
@@ -110,6 +131,9 @@ module Google
         #     Required. Filter matching documents to purge. Only currently supported
         #     value is
         #     `*` (all items).
+        # @!attribute [rw] error_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::PurgeErrorConfig]
+        #     The desired location of errors incurred during the purge.
         # @!attribute [rw] force
         #   @return [::Boolean]
         #     Actually performs the purge. If `force` is set to false, return the
@@ -117,6 +141,20 @@ module Google
         class PurgeDocumentsRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The inline source for the input config for
+          # {::Google::Cloud::DiscoveryEngine::V1beta::DocumentService::Client#purge_documents DocumentService.PurgeDocuments}
+          # method.
+          # @!attribute [rw] documents
+          #   @return [::Array<::String>]
+          #     Required. A list of full resource name of documents to purge. In the
+          #     format
+          #     `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+          #     Recommended max of 100 items.
+          class InlineSource
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
 
         # Response message for

data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb

@@ -120,9 +120,12 @@ module Google
         #     object. Leave it unset if ordered by relevance. `order_by` expression is
         #     case-sensitive.
         #
-        #     For more information on ordering for retail search, see
-        #     [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
-        #
+        #     For more information on ordering the website search results, see
+        #     [Order web search
+        #     results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
+        #     For more information on ordering the healthcare search results, see
+        #     [Order healthcare search
+        #     results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
         #     If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
         # @!attribute [rw] user_info
         #   @return [::Google::Cloud::DiscoveryEngine::V1beta::UserInfo]
@@ -303,6 +306,13 @@ module Google
         #     Session specification.
         #
         #     Can be used only when `session` is set.
+        # @!attribute [rw] relevance_threshold
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::RelevanceThreshold]
+        #     The relevance threshold of the search results.
+        #
+        #     Default to Google defined threshold, leveraging a balance of
+        #     precision and recall to deliver both highly accurate results and
+        #     comprehensive coverage of relevant information.
         class SearchRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -773,6 +783,14 @@ module Google
             #     navigational queries. If this field is set to `true`, we skip
             #     generating summaries for non-summary seeking queries and return
             #     fallback messages instead.
+            # @!attribute [rw] ignore_low_relevant_content
+            #   @return [::Boolean]
+            #     Specifies whether to filter out queries that have low relevance. The
+            #     default value is `false`.
+            #
+            #     If this field is set to `false`, all search results are used regardless
+            #     of relevance to generate answers. If set to `true`, only queries with
+            #     high relevance search results will generate answers.
             # @!attribute [rw] model_prompt_spec
             #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::ModelPromptSpec]
             #     If specified, the spec will be used to modify the prompt provided to
@@ -1061,6 +1079,27 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
+
+          # The relevance threshold of the search results. The higher relevance
+          # threshold is, the higher relevant results are shown and the less number of
+          # results are returned.
+          module RelevanceThreshold
+            # Default value. In this case, server behavior defaults to Google defined
+            # threshold.
+            RELEVANCE_THRESHOLD_UNSPECIFIED = 0
+
+            # Lowest relevance threshold.
+            LOWEST = 1
+
+            # Low relevance threshold.
+            LOW = 2
+
+            # Medium relevance threshold.
+            MEDIUM = 3
+
+            # High relevance threshold.
+            HIGH = 4
+          end
         end
 
         # Response message for
@@ -1088,7 +1127,8 @@ module Google
         #     A unique search token. This should be included in the
         #     {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent UserEvent} logs resulting
         #     from this search, which enables accurate attribution of search model
-        #     performance.
+        #     performance. This also helps to identify a request during the customer
+        #     support scenarios.
         # @!attribute [rw] redirect_uri
         #   @return [::String]
         #     The URI of a customer-defined redirect page. If redirect action is
@@ -1132,6 +1172,10 @@ module Google
         #     Only set if
         #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#session SearchRequest.session}
         #     is provided. See its description for more details.
+        # @!attribute [rw] one_box_results
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::OneBoxResult>]
+        #     A list of One Box results. There can be multiple One Box results of
+        #     different types.
         class SearchResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1350,14 +1394,14 @@ module Google
 
               # The adversarial query ignored case.
               #
-              # Only populated when
+              # Only used when
               # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_adversarial_query SummarySpec.ignore_adversarial_query}
               # is set to `true`.
               ADVERSARIAL_QUERY_IGNORED = 1
 
               # The non-summary seeking query ignored case.
               #
-              # Only populated when
+              # Only used when
               # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_non_summary_seeking_query SummarySpec.ignore_non_summary_seeking_query}
               # is set to `true`.
               NON_SUMMARY_SEEKING_QUERY_IGNORED = 2
@@ -1385,6 +1429,20 @@ module Google
               # Google skips the summary if there is no relevant content in the
               # retrieved search results.
               NO_RELEVANT_CONTENT = 6
+
+              # The jail-breaking query ignored case.
+              #
+              # For example, "Reply in the tone of a competing company's CEO".
+              # Only used when
+              # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
+              # is set to `true`.
+              JAIL_BREAKING_QUERY_IGNORED = 7
+
+              # The customer policy violation case.
+              #
+              # Google skips the summary if there is a customer policy violation
+              # detected. The policy is defined by the customer.
+              CUSTOMER_POLICY_VIOLATION = 8
             end
           end
 
@@ -1454,6 +1512,9 @@ module Google
               #   @return [::Array<::String>]
               #     Values of the string field. The record will only be returned if the
               #     field value matches one of the values specified here.
+              # @!attribute [rw] query_segment
+              #   @return [::String]
+              #     Identifies the keywords within the search query that match a filter.
               class StringConstraint
                 include ::Google::Protobuf::MessageExts
                 extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1470,6 +1531,9 @@ module Google
               # @!attribute [rw] value
               #   @return [::Float]
               #     The value specified in the numerical constraint.
+              # @!attribute [rw] query_segment
+              #   @return [::String]
+              #     Identifies the keywords within the search query that match a filter.
               class NumberConstraint
                 include ::Google::Protobuf::MessageExts
                 extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1506,6 +1570,12 @@ module Google
               #     The reference address that was inferred from the input query. The
               #     proximity of the reference address to the geolocation field will be
               #     used to filter the results.
+              # @!attribute [rw] latitude
+              #   @return [::Float]
+              #     The latitude of the geolocation inferred from the input query.
+              # @!attribute [rw] longitude
+              #   @return [::Float]
+              #     The longitude of the geolocation inferred from the input query.
               # @!attribute [rw] radius_in_meters
               #   @return [::Float]
               #     The radius in meters around the address. The record is returned if
@@ -1576,6 +1646,34 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
+
+          # OneBoxResult is a holder for all results of specific type that we want
+          # to display in UI differently.
+          # @!attribute [rw] one_box_type
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::OneBoxResult::OneBoxType]
+          #     The type of One Box result.
+          # @!attribute [rw] search_results
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>]
+          #     The search results for this One Box.
+          class OneBoxResult
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The type of One Box result.
+            module OneBoxType
+              # Default value. Should not be used.
+              ONE_BOX_TYPE_UNSPECIFIED = 0
+
+              # One Box result contains people results.
+              PEOPLE = 1
+
+              # One Box result contains organization results.
+              ORGANIZATION = 2
+
+              # One Box result contains slack results.
+              SLACK = 3
+            end
+          end
         end
       end
     end

data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb

@@ -450,6 +450,10 @@ module Google
         #   @return [::Array<::String>]
         #     The promotion IDs associated with this Document.
         #     Currently, this field is restricted to at most one ID.
+        # @!attribute [r] joined
+        #   @return [::Boolean]
+        #     Output only. Whether the referenced Document can be found in the data
+        #     store.
         class DocumentInfo
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-discovery_engine-v1beta
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.15.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-09 00:00:00.000000000 Z
+date: 2024-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common