google-cloud-discovery_engine-v1 1.0.2 → 1.2.0

data/proto_docs/google/cloud/discoveryengine/v1/data_store.rb

@@ -61,6 +61,16 @@ module Google
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. Timestamp the
         #     {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore} was created at.
+        # @!attribute [r] billing_estimation
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::DataStore::BillingEstimation]
+        #     Output only. Data size estimation for billing.
+        # @!attribute [rw] workspace_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig]
+        #     Config to store data store type configuration for workspace data. This
+        #     must be set when
+        #     {::Google::Cloud::DiscoveryEngine::V1::DataStore#content_config DataStore.content_config}
+        #     is set as
+        #     {::Google::Cloud::DiscoveryEngine::V1::DataStore::ContentConfig::GOOGLE_WORKSPACE DataStore.ContentConfig.GOOGLE_WORKSPACE}.
         # @!attribute [rw] document_processing_config
         #   @return [::Google::Cloud::DiscoveryEngine::V1::DocumentProcessingConfig]
         #     Configuration for Document understanding and enrichment.
@@ -84,6 +94,30 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
+          # Estimation of data size per data store.
+          # @!attribute [rw] structured_data_size
+          #   @return [::Integer]
+          #     Data size for structured data in terms of bytes.
+          # @!attribute [rw] unstructured_data_size
+          #   @return [::Integer]
+          #     Data size for unstructured data in terms of bytes.
+          # @!attribute [rw] website_data_size
+          #   @return [::Integer]
+          #     Data size for websites in terms of bytes.
+          # @!attribute [rw] structured_data_update_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Last updated timestamp for structured data.
+          # @!attribute [rw] unstructured_data_update_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Last updated timestamp for unstructured data.
+          # @!attribute [rw] website_data_update_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Last updated timestamp for websites.
+          class BillingEstimation
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # Content config of the data store.
           module ContentConfig
             # Default value.
@@ -99,6 +133,60 @@ module Google
 
             # The data store is used for public website search.
             PUBLIC_WEBSITE = 3
+
+            # The data store is used for workspace search. Details of workspace
+            # data store are specified in the
+            # {::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig WorkspaceConfig}.
+            GOOGLE_WORKSPACE = 4
+          end
+        end
+
+        # Config to store data store type configuration for workspace data
+        # @!attribute [rw] type
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig::Type]
+        #     The Google Workspace data source.
+        # @!attribute [rw] dasher_customer_id
+        #   @return [::String]
+        #     Obfuscated Dasher customer ID.
+        # @!attribute [rw] super_admin_service_account
+        #   @return [::String]
+        #     Optional. The super admin service account for the workspace that will be
+        #     used for access token generation. For now we only use it for Native Google
+        #     Drive connector data ingestion.
+        # @!attribute [rw] super_admin_email_address
+        #   @return [::String]
+        #     Optional. The super admin email address for the workspace that will be used
+        #     for access token generation. For now we only use it for Native Google Drive
+        #     connector data ingestion.
+        class WorkspaceConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Specifies the type of Workspace App supported by this DataStore
+          module Type
+            # Defaults to an unspecified Workspace type.
+            TYPE_UNSPECIFIED = 0
+
+            # Workspace Data Store contains Drive data
+            GOOGLE_DRIVE = 1
+
+            # Workspace Data Store contains Mail data
+            GOOGLE_MAIL = 2
+
+            # Workspace Data Store contains Sites data
+            GOOGLE_SITES = 3
+
+            # Workspace Data Store contains Calendar data
+            GOOGLE_CALENDAR = 4
+
+            # Workspace Data Store contains Chat data
+            GOOGLE_CHAT = 5
+
+            # Workspace Data Store contains Groups data
+            GOOGLE_GROUPS = 6
+
+            # Workspace Data Store contains Keep data
+            GOOGLE_KEEP = 7
           end
         end
       end

data/proto_docs/google/cloud/discoveryengine/v1/data_store_service.rb

@@ -49,6 +49,16 @@ module Google
         #     If the data store is not configured as site
         #     search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will
         #     be ignored.
+        # @!attribute [rw] skip_default_schema_creation
+        #   @return [::Boolean]
+        #     A boolean flag indicating whether to skip the default schema creation for
+        #     the data store. Only enable this flag if you are certain that the default
+        #     schema is incompatible with your use case.
+        #
+        #     If set to true, you must manually create a schema for the data store before
+        #     any documents can be ingested.
+        #
+        #     This flag cannot be specified if `data_store.starting_schema` is specified.
         class CreateDataStoreRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/discoveryengine/v1/document.rb

@@ -73,6 +73,14 @@ module Google
         #
         #     This field is OUTPUT_ONLY. If this field is not populated, it means the
         #     document has never been indexed.
+        # @!attribute [r] index_status
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Document::IndexStatus]
+        #     Output only. The index status of the document.
+        #
+        #     * If document is indexed successfully, the index_time field is populated.
+        #     * Otherwise, if document is not indexed due to errors, the error_samples
+        #       field is populated.
+        #     * Otherwise, index_status is unset.
         class Document
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -108,6 +116,20 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
+
+          # Index status of the document.
+          # @!attribute [rw] index_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The time when the document was indexed.
+          #     If this field is populated, it means the document has been indexed.
+          # @!attribute [rw] error_samples
+          #   @return [::Array<::Google::Rpc::Status>]
+          #     A sample of errors encountered while indexing the document.
+          #     If this field is populated, the document is not indexed due to errors.
+          class IndexStatus
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
       end
     end

data/proto_docs/google/cloud/discoveryengine/v1/document_processing_config.rb

@@ -22,11 +22,11 @@ module Google
     module DiscoveryEngine
       module V1
         # A singleton resource of
-        # {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}. It's empty when
-        # {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore} is created, which
-        # defaults to digital parser. The first call to
-        # [DataStoreService.UpdateDocumentProcessingConfig][] method will initialize
-        # the config.
+        # {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}. If it's empty when
+        # {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore} is created and
+        # {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore} is set to
+        # {::Google::Cloud::DiscoveryEngine::V1::DataStore::ContentConfig::CONTENT_REQUIRED DataStore.ContentConfig.CONTENT_REQUIRED},
+        # the default parser will default to digital parser.
         # @!attribute [rw] name
         #   @return [::String]
         #     The full resource name of the Document Processing Config.
@@ -54,6 +54,10 @@ module Google
         #     layout parsing are supported.
         #     * `pptx`: Override parsing config for PPTX files, only digital parsing and
         #     layout parsing are supported.
+        #     * `xlsm`: Override parsing config for XLSM files, only digital parsing and
+        #     layout parsing are supported.
+        #     * `xlsx`: Override parsing config for XLSX files, only digital parsing and
+        #     layout parsing are supported.
         class DocumentProcessingConfig
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -179,6 +179,126 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::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::V1::BatchGetDocumentsMetadataRequest::Matcher]
+        #     Required. Matcher for the
+        #     {::Google::Cloud::DiscoveryEngine::V1::Document Document}s.
+        class BatchGetDocumentsMetadataRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Matcher for the {::Google::Cloud::DiscoveryEngine::V1::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::V1::Document Document}s by
+          # FHIR resource names.
+          # @!attribute [rw] fhir_resources
+          #   @return [::Array<::String>]
+          #     Required. The FHIR resources to match by.
+          #     Format:
+          #     projects/\\{project}/locations/\\{location}/datasets/\\{dataset}/fhirStores/\\{fhir_store}/fhir/\\{resource_type}/\\{fhir_resource_id}
+          class FhirMatcher
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Matcher for the {::Google::Cloud::DiscoveryEngine::V1::Document Document}s.
+          # Currently supports matching by exact URIs.
+          # @!attribute [rw] uris_matcher
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::BatchGetDocumentsMetadataRequest::UrisMatcher]
+          #     Matcher by exact URIs.
+          # @!attribute [rw] fhir_matcher
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::BatchGetDocumentsMetadataRequest::FhirMatcher]
+          #     Matcher by FHIR resource names.
+          class Matcher
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1::DocumentService::Client#batch_get_documents_metadata DocumentService.BatchGetDocumentsMetadata}
+        # method.
+        # @!attribute [rw] documents_metadata
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::BatchGetDocumentsMetadataResponse::DocumentMetadata>]
+        #     The metadata of the {::Google::Cloud::DiscoveryEngine::V1::Document Document}s.
+        class BatchGetDocumentsMetadataResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The metadata of a {::Google::Cloud::DiscoveryEngine::V1::Document Document}.
+          # @!attribute [rw] matcher_value
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::BatchGetDocumentsMetadataResponse::DocumentMetadata::MatcherValue]
+          #     The value of the matcher that was used to match the
+          #     {::Google::Cloud::DiscoveryEngine::V1::Document Document}.
+          # @!attribute [rw] state
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::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::V1::Document Document} was last indexed.
+          # @!attribute [rw] data_ingestion_source
+          #   @return [::String]
+          #     The data ingestion source of the
+          #     {::Google::Cloud::DiscoveryEngine::V1::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::V1::Document Document}.
+            # @!attribute [rw] uri
+            #   @return [::String]
+            #     If match by URI, the URI of the
+            #     {::Google::Cloud::DiscoveryEngine::V1::Document Document}.
+            # @!attribute [rw] fhir_resource
+            #   @return [::String]
+            #     Required. Format:
+            #     projects/\\{project}/locations/\\{location}/datasets/\\{dataset}/fhirStores/\\{fhir_store}/fhir/\\{resource_type}/\\{fhir_resource_id}
+            class MatcherValue
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # The state of the {::Google::Cloud::DiscoveryEngine::V1::Document Document}.
+          module State
+            # Should never be set.
+            STATE_UNSPECIFIED = 0
+
+            # The {::Google::Cloud::DiscoveryEngine::V1::Document Document} is indexed.
+            INDEXED = 1
+
+            # The {::Google::Cloud::DiscoveryEngine::V1::Document Document} is not indexed
+            # because its URI is not in the
+            # {::Google::Cloud::DiscoveryEngine::V1::TargetSite TargetSite}.
+            NOT_IN_TARGET_SITE = 2
+
+            # The {::Google::Cloud::DiscoveryEngine::V1::Document Document} is not indexed.
+            NOT_IN_INDEX = 3
+          end
+        end
       end
     end
   end

data/proto_docs/google/cloud/discoveryengine/v1/engine.rb

@@ -47,7 +47,7 @@ module Google
         #     characters.
         #
         #     Format:
-        #     `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`
+        #     `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
         #     engine should be 1-63 characters, and valid characters are
         #     /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
         # @!attribute [rw] display_name
@@ -93,6 +93,10 @@ module Google
         # @!attribute [rw] common_config
         #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::CommonConfig]
         #     Common config spec that specifies the metadata of the engine.
+        # @!attribute [rw] disable_analytics
+        #   @return [::Boolean]
+        #     Optional. Whether to disable analytics for searches performed on this
+        #     engine.
         class Engine
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods