google-apis-discoveryengine_v1alpha 0.29.0 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2adfc46570652a4e45febdabbc3bb6944df0eb93e6a2a73863e484a5899353c6
-  data.tar.gz: e4a5dd49b4921af29ef33c6d7d7fb15cef7089799c4e9bc2e29be563d86985c5
+  metadata.gz: 01e199e758f187d04e45eb8ab25881bf8a7e81a0ad6470b8245cc4b2930f40e7
+  data.tar.gz: 73bae6449468b3c97aa62d5d59cd2567bcd620f2b8eba795ef0b59dc9e8f2cfb
 SHA512:
-  metadata.gz: 1b825af8c6cef4c28d96f06b7fc0f6d445036cd33f2bf48b7e570d472f85ab69733c0a1c420aad4804caa94f38eaf0598062ee36232d419018e528b1d9d4b715
-  data.tar.gz: 5b2f498ff5b9028c7ab3a0ea4f3e22155c4cc3c7ff32f03a25d29fed970dc369b36f46ed238885cb97d5c8d75c71cae5debc4a25340a0d7ca549883423f49aa3
+  metadata.gz: 6ce15c7093817b9f2f2dcefb906e5def44bcf397926bf297db75dce2e7d44b190f7608fbd93258703ed61b7a1b0f18357605b65bd85ae5c669061c460a824fc1
+  data.tar.gz: d2d315a46cdd0c0b4d5826a7fef0029baf140c62605c86b219f691f8d7f700d4cfe299f3d9852f6ba15c17be50927a8762175e0c8e596062aabc130d291beea1

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-discoveryengine_v1alpha
 
+### v0.30.0 (2023-12-17)
+
+* Regenerated from discovery document revision 20231209
+
 ### v0.29.0 (2023-12-10)
 
 * Regenerated from discovery document revision 20231130

data/lib/google/apis/discoveryengine_v1alpha/classes.rb

@@ -1055,6 +1055,22 @@ module Google
         # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation]
         attr_accessor :conversation
       
+        # The filter syntax consists of an expression language for constructing a
+        # predicate from one or more fields of the documents being filtered. Filter
+        # expression is case-sensitive. This will be used to filter search results which
+        # may affect the summary response. If this field is unrecognizable, an `
+        # INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by
+        # mapping the LHS filter key to a key property defined in the Vertex AI Search
+        # backend -- this mapping is defined by the customer in their schema. For
+        # example a media customer might have a field 'name' in their schema. In this
+        # case the filter would look like this: filter --> name:'ANY("king kong")' For
+        # more information about filtering including syntax and filter operators, see [
+        # Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-
+        # metadata)
+        # Corresponds to the JSON property `filter`
+        # @return [String]
+        attr_accessor :filter
+      
         # Required. The resource name of the Conversation to get. Format: `projects/`
         # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
         # data_store_id`/conversations/`conversation_id``. Use `projects/`project_number`
@@ -1111,6 +1127,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @conversation = args[:conversation] if args.key?(:conversation)
+          @filter = args[:filter] if args.key?(:filter)
           @name = args[:name] if args.key?(:name)
           @query = args[:query] if args.key?(:query)
           @safe_search = args[:safe_search] if args.key?(:safe_search)
@@ -2177,6 +2194,160 @@ module Google
         end
       end
       
+      # Metadata related to the progress of the EstimateDataSize operation. This is
+      # returned by the google.longrunning.Operation.metadata field.
+      class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata
+        include Google::Apis::Core::Hashable
+      
+        # Operation create time.
+        # Corresponds to the JSON property `createTime`
+        # @return [String]
+        attr_accessor :create_time
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @create_time = args[:create_time] if args.key?(:create_time)
+        end
+      end
+      
+      # Request message for EstimateBillingService.EstimateDataSize method
+      class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest
+        include Google::Apis::Core::Hashable
+      
+        # Data source contains files either in GCS or BigQuery.
+        # Corresponds to the JSON property `fileDataSource`
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource]
+        attr_accessor :file_data_source
+      
+        # Data source is a set of website patterns that we crawl to get the total number
+        # of websites.
+        # Corresponds to the JSON property `websiteDataSource`
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource]
+        attr_accessor :website_data_source
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @file_data_source = args[:file_data_source] if args.key?(:file_data_source)
+          @website_data_source = args[:website_data_source] if args.key?(:website_data_source)
+        end
+      end
+      
+      # Data source contains files either in GCS or BigQuery.
+      class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource
+        include Google::Apis::Core::Hashable
+      
+        # BigQuery source import data from.
+        # Corresponds to the JSON property `bigquerySource`
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBigQuerySource]
+        attr_accessor :bigquery_source
+      
+        # Cloud Storage location for input content.
+        # Corresponds to the JSON property `gcsSource`
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGcsSource]
+        attr_accessor :gcs_source
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @bigquery_source = args[:bigquery_source] if args.key?(:bigquery_source)
+          @gcs_source = args[:gcs_source] if args.key?(:gcs_source)
+        end
+      end
+      
+      # Data source is a set of website patterns that we crawl to get the total number
+      # of websites.
+      class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource
+        include Google::Apis::Core::Hashable
+      
+        # Required. The URI patterns to estimate the data sizes. At most 10 patterns are
+        # allowed, otherwise an INVALID_ARGUMENT error is thrown.
+        # Corresponds to the JSON property `estimatorUriPatterns`
+        # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern>]
+        attr_accessor :estimator_uri_patterns
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @estimator_uri_patterns = args[:estimator_uri_patterns] if args.key?(:estimator_uri_patterns)
+        end
+      end
+      
+      # URI patterns that we use to crawl.
+      class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern
+        include Google::Apis::Core::Hashable
+      
+        # Whether we infer the generated URI or use the exact provided one.
+        # Corresponds to the JSON property `exactMatch`
+        # @return [Boolean]
+        attr_accessor :exact_match
+        alias_method :exact_match?, :exact_match
+      
+        # Whether the pattern is exclusive or not. If set to true, the pattern is
+        # considered exclusive. If unset or set to false, the pattern is considered
+        # inclusive by default.
+        # Corresponds to the JSON property `exclusive`
+        # @return [Boolean]
+        attr_accessor :exclusive
+        alias_method :exclusive?, :exclusive
+      
+        # User provided URI pattern. For example, `foo.com/bar/*`.
+        # Corresponds to the JSON property `providedUriPattern`
+        # @return [String]
+        attr_accessor :provided_uri_pattern
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @exact_match = args[:exact_match] if args.key?(:exact_match)
+          @exclusive = args[:exclusive] if args.key?(:exclusive)
+          @provided_uri_pattern = args[:provided_uri_pattern] if args.key?(:provided_uri_pattern)
+        end
+      end
+      
+      # Response of the EstimateDataSize request. If the long running operation was
+      # successful, then this message is returned by the google.longrunning.Operations.
+      # response field if the operation was successful.
+      class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse
+        include Google::Apis::Core::Hashable
+      
+        # Data size in terms of bytes.
+        # Corresponds to the JSON property `dataSizeBytes`
+        # @return [Fixnum]
+        attr_accessor :data_size_bytes
+      
+        # Total number of documents.
+        # Corresponds to the JSON property `documentCount`
+        # @return [Fixnum]
+        attr_accessor :document_count
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @data_size_bytes = args[:data_size_bytes] if args.key?(:data_size_bytes)
+          @document_count = args[:document_count] if args.key?(:document_count)
+        end
+      end
+      
       # Response message for SiteSearchEngineService.FetchDomainVerificationStatus
       # method.
       class GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse
@@ -4201,6 +4372,11 @@ module Google
         # @return [String]
         attr_accessor :language_code
       
+        # Specification of the prompt to use with the model.
+        # Corresponds to the JSON property `modelPromptSpec`
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec]
+        attr_accessor :model_prompt_spec
+      
         # Specification of the model.
         # Corresponds to the JSON property `modelSpec`
         # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec]
@@ -4224,16 +4400,37 @@ module Google
           @ignore_non_summary_seeking_query = args[:ignore_non_summary_seeking_query] if args.key?(:ignore_non_summary_seeking_query)
           @include_citations = args[:include_citations] if args.key?(:include_citations)
           @language_code = args[:language_code] if args.key?(:language_code)
+          @model_prompt_spec = args[:model_prompt_spec] if args.key?(:model_prompt_spec)
           @model_spec = args[:model_spec] if args.key?(:model_spec)
           @summary_result_count = args[:summary_result_count] if args.key?(:summary_result_count)
         end
       end
       
+      # Specification of the prompt to use with the model.
+      class GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec
+        include Google::Apis::Core::Hashable
+      
+        # Text at the beginning of the prompt that instructs the assistant. Examples are
+        # available in the user guide.
+        # Corresponds to the JSON property `preamble`
+        # @return [String]
+        attr_accessor :preamble
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @preamble = args[:preamble] if args.key?(:preamble)
+        end
+      end
+      
       # Specification of the model.
       class GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec
         include Google::Apis::Core::Hashable
       
-        # The string format of the model version. e.g. stable, latest, etc.
+        # The string format of the model version. e.g. stable, preview, etc.
         # Corresponds to the JSON property `version`
         # @return [String]
         attr_accessor :version
@@ -4825,6 +5022,11 @@ module Google
         # @return [String]
         attr_accessor :summary_text
       
+        # Summary with metadata information.
+        # Corresponds to the JSON property `summaryWithMetadata`
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata]
+        attr_accessor :summary_with_metadata
+      
         def initialize(**args)
            update!(**args)
         end
@@ -4834,6 +5036,110 @@ module Google
           @safety_attributes = args[:safety_attributes] if args.key?(:safety_attributes)
           @summary_skipped_reasons = args[:summary_skipped_reasons] if args.key?(:summary_skipped_reasons)
           @summary_text = args[:summary_text] if args.key?(:summary_text)
+          @summary_with_metadata = args[:summary_with_metadata] if args.key?(:summary_with_metadata)
+        end
+      end
+      
+      # Citation info for a segment.
+      class GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation
+        include Google::Apis::Core::Hashable
+      
+        # End of the attributed segment, exclusive.
+        # Corresponds to the JSON property `endIndex`
+        # @return [Fixnum]
+        attr_accessor :end_index
+      
+        # Citation sources for the attributed segment.
+        # Corresponds to the JSON property `sources`
+        # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource>]
+        attr_accessor :sources
+      
+        # Index indicates the start of the segment, measured in bytes/unicode.
+        # Corresponds to the JSON property `startIndex`
+        # @return [Fixnum]
+        attr_accessor :start_index
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @end_index = args[:end_index] if args.key?(:end_index)
+          @sources = args[:sources] if args.key?(:sources)
+          @start_index = args[:start_index] if args.key?(:start_index)
+        end
+      end
+      
+      # Citation metadata.
+      class GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata
+        include Google::Apis::Core::Hashable
+      
+        # Citations for segments.
+        # Corresponds to the JSON property `citations`
+        # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation>]
+        attr_accessor :citations
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @citations = args[:citations] if args.key?(:citations)
+        end
+      end
+      
+      # Citation source.
+      class GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource
+        include Google::Apis::Core::Hashable
+      
+        # Document reference index from SummaryWithMetadata.references. It is 0-indexed
+        # and the value will be zero if the reference_index is not set explicitly.
+        # Corresponds to the JSON property `referenceIndex`
+        # @return [Fixnum]
+        attr_accessor :reference_index
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @reference_index = args[:reference_index] if args.key?(:reference_index)
+        end
+      end
+      
+      # Document reference.
+      class GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference
+        include Google::Apis::Core::Hashable
+      
+        # Required. Document.name of the document. Full resource name of the referenced
+        # document, in the format `projects/*/locations/*/collections/*/dataStores/*/
+        # branches/*/documents/*`.
+        # Corresponds to the JSON property `document`
+        # @return [String]
+        attr_accessor :document
+      
+        # Title of the document.
+        # Corresponds to the JSON property `title`
+        # @return [String]
+        attr_accessor :title
+      
+        # GCS or HTTP uri for the document.
+        # Corresponds to the JSON property `uri`
+        # @return [String]
+        attr_accessor :uri
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @document = args[:document] if args.key?(:document)
+          @title = args[:title] if args.key?(:title)
+          @uri = args[:uri] if args.key?(:uri)
         end
       end
       
@@ -4864,6 +5170,37 @@ module Google
         end
       end
       
+      # Summary with metadata information.
+      class GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata
+        include Google::Apis::Core::Hashable
+      
+        # Citation metadata.
+        # Corresponds to the JSON property `citationMetadata`
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata]
+        attr_accessor :citation_metadata
+      
+        # Document References.
+        # Corresponds to the JSON property `references`
+        # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference>]
+        attr_accessor :references
+      
+        # Summary text with no citation information.
+        # Corresponds to the JSON property `summary`
+        # @return [String]
+        attr_accessor :summary
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @citation_metadata = args[:citation_metadata] if args.key?(:citation_metadata)
+          @references = args[:references] if args.key?(:references)
+          @summary = args[:summary] if args.key?(:summary)
+        end
+      end
+      
       # SiteSearchEngine captures DataStore level site search persisting
       # configurations. It is a singleton value per data store.
       class GoogleCloudDiscoveryengineV1alphaSiteSearchEngine
@@ -5045,6 +5382,149 @@ module Google
         end
       end
       
+      # Metadata related to the progress of the TrainCustomModel operation. This is
+      # returned by the google.longrunning.Operation.metadata field.
+      class GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata
+        include Google::Apis::Core::Hashable
+      
+        # Operation create time.
+        # Corresponds to the JSON property `createTime`
+        # @return [String]
+        attr_accessor :create_time
+      
+        # Operation last update time. If the operation is done, this is also the finish
+        # time.
+        # Corresponds to the JSON property `updateTime`
+        # @return [String]
+        attr_accessor :update_time
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @create_time = args[:create_time] if args.key?(:create_time)
+          @update_time = args[:update_time] if args.key?(:update_time)
+        end
+      end
+      
+      # Request message for SearchTuningService.TrainCustomModel method.
+      class GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest
+        include Google::Apis::Core::Hashable
+      
+        # Configuration of destination for Import related errors.
+        # Corresponds to the JSON property `errorConfig`
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportErrorConfig]
+        attr_accessor :error_config
+      
+        # Gcs training data input.
+        # Corresponds to the JSON property `gcsTrainingInput`
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput]
+        attr_accessor :gcs_training_input
+      
+        # Model to be trained. Supported values are: * **search-tuning**: Fine tuning
+        # the search system based on data provided.
+        # Corresponds to the JSON property `modelType`
+        # @return [String]
+        attr_accessor :model_type
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @error_config = args[:error_config] if args.key?(:error_config)
+          @gcs_training_input = args[:gcs_training_input] if args.key?(:gcs_training_input)
+          @model_type = args[:model_type] if args.key?(:model_type)
+        end
+      end
+      
+      # Gcs training data input.
+      class GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput
+        include Google::Apis::Core::Hashable
+      
+        # The gcs corpus data which could be associated in train data. The data path
+        # format is gs:///. A newline delimited jsonl/ndjson file. * For search-tuning
+        # model, each line should have the _id, title and text. Example: `"_id": "doc1",
+        # title: "relevant doc", "text": "relevant text"`
+        # Corresponds to the JSON property `corpusDataPath`
+        # @return [String]
+        attr_accessor :corpus_data_path
+      
+        # The gcs query data which could be associated in train data. The data path
+        # format is gs:///. A newline delimited jsonl/ndjson file. * For search-tuning
+        # model, each line should have the _id and text. Example: `"_id": "query1", "
+        # text": "example query"`
+        # Corresponds to the JSON property `queryDataPath`
+        # @return [String]
+        attr_accessor :query_data_path
+      
+        # Gcs test data. Same format as train_data_path. If not provided, a random 80/20
+        # train/test split will be performed on train_data_path.
+        # Corresponds to the JSON property `testDataPath`
+        # @return [String]
+        attr_accessor :test_data_path
+      
+        # Gcs training data path whose format should be gs:///. The file should be in
+        # tsv format. Each line should have the doc_id and query_id and score (number). *
+        # For search-tuning model, it should have the query-id corpus-id score as tsv
+        # file header. The score should be a number in [0, inf+). The larger the number
+        # is, the more relevant the pair is. Example: query-id\tcorpus-id\tscore query1\
+        # tdoc1\t1
+        # Corresponds to the JSON property `trainDataPath`
+        # @return [String]
+        attr_accessor :train_data_path
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @corpus_data_path = args[:corpus_data_path] if args.key?(:corpus_data_path)
+          @query_data_path = args[:query_data_path] if args.key?(:query_data_path)
+          @test_data_path = args[:test_data_path] if args.key?(:test_data_path)
+          @train_data_path = args[:train_data_path] if args.key?(:train_data_path)
+        end
+      end
+      
+      # Response of the TrainCustomModelRequest. This message is returned by the
+      # google.longrunning.Operations.response field.
+      class GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse
+        include Google::Apis::Core::Hashable
+      
+        # Configuration of destination for Import related errors.
+        # Corresponds to the JSON property `errorConfig`
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportErrorConfig]
+        attr_accessor :error_config
+      
+        # A sample of errors encountered while processing the data.
+        # Corresponds to the JSON property `errorSamples`
+        # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleRpcStatus>]
+        attr_accessor :error_samples
+      
+        # The trained model status. Possible values are: * **bad-data**: The training
+        # data quality is bad. * **no-improvement**: Tuning didn't improve performance.
+        # Won't deploy. * **in-progress**: Model training is in progress. * **ready**:
+        # The model is ready for serving.
+        # Corresponds to the JSON property `modelStatus`
+        # @return [String]
+        attr_accessor :model_status
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @error_config = args[:error_config] if args.key?(:error_config)
+          @error_samples = args[:error_samples] if args.key?(:error_samples)
+          @model_status = args[:model_status] if args.key?(:model_status)
+        end
+      end
+      
       # A transaction represents the entire purchase transaction.
       class GoogleCloudDiscoveryengineV1alphaTransactionInfo
         include Google::Apis::Core::Hashable

data/lib/google/apis/discoveryengine_v1alpha/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module DiscoveryengineV1alpha
       # Version of the google-apis-discoveryengine_v1alpha gem
-      GEM_VERSION = "0.29.0"
+      GEM_VERSION = "0.30.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20231130"
+      REVISION = "20231209"
     end
   end
 end

data/lib/google/apis/discoveryengine_v1alpha/representations.rb

@@ -406,6 +406,42 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -712,6 +748,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -814,12 +856,42 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaSiteSearchEngine
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -856,6 +928,30 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaTransactionInfo
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1351,6 +1447,7 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           property :conversation, as: 'conversation', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation::Representation
       
+          property :filter, as: 'filter'
           property :name, as: 'name'
           property :query, as: 'query', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTextInput, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTextInput::Representation
       
@@ -1653,6 +1750,58 @@ module Google
         end
       end
       
+      class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :create_time, as: 'createTime'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :file_data_source, as: 'fileDataSource', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource::Representation
+      
+          property :website_data_source, as: 'websiteDataSource', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource::Representation
+      
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :bigquery_source, as: 'bigquerySource', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBigQuerySource, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBigQuerySource::Representation
+      
+          property :gcs_source, as: 'gcsSource', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGcsSource, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGcsSource::Representation
+      
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :estimator_uri_patterns, as: 'estimatorUriPatterns', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern::Representation
+      
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :exact_match, as: 'exactMatch'
+          property :exclusive, as: 'exclusive'
+          property :provided_uri_pattern, as: 'providedUriPattern'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :data_size_bytes, :numeric_string => true, as: 'dataSizeBytes'
+          property :document_count, :numeric_string => true, as: 'documentCount'
+        end
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2164,12 +2313,21 @@ module Google
           property :ignore_non_summary_seeking_query, as: 'ignoreNonSummarySeekingQuery'
           property :include_citations, as: 'includeCitations'
           property :language_code, as: 'languageCode'
+          property :model_prompt_spec, as: 'modelPromptSpec', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec::Representation
+      
           property :model_spec, as: 'modelSpec', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec::Representation
       
           property :summary_result_count, as: 'summaryResultCount'
         end
       end
       
+      class GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :preamble, as: 'preamble'
+        end
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2335,6 +2493,42 @@ module Google
       
           collection :summary_skipped_reasons, as: 'summarySkippedReasons'
           property :summary_text, as: 'summaryText'
+          property :summary_with_metadata, as: 'summaryWithMetadata', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata::Representation
+      
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :end_index, :numeric_string => true, as: 'endIndex'
+          collection :sources, as: 'sources', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource::Representation
+      
+          property :start_index, :numeric_string => true, as: 'startIndex'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :citations, as: 'citations', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation::Representation
+      
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :reference_index, :numeric_string => true, as: 'referenceIndex'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :document, as: 'document'
+          property :title, as: 'title'
+          property :uri, as: 'uri'
         end
       end
       
@@ -2346,6 +2540,17 @@ module Google
         end
       end
       
+      class GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :citation_metadata, as: 'citationMetadata', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata::Representation
+      
+          collection :references, as: 'references', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference::Representation
+      
+          property :summary, as: 'summary'
+        end
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaSiteSearchEngine
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2401,6 +2606,46 @@ module Google
         end
       end
       
+      class GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :create_time, as: 'createTime'
+          property :update_time, as: 'updateTime'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :error_config, as: 'errorConfig', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportErrorConfig, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportErrorConfig::Representation
+      
+          property :gcs_training_input, as: 'gcsTrainingInput', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput::Representation
+      
+          property :model_type, as: 'modelType'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :corpus_data_path, as: 'corpusDataPath'
+          property :query_data_path, as: 'queryDataPath'
+          property :test_data_path, as: 'testDataPath'
+          property :train_data_path, as: 'trainDataPath'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :error_config, as: 'errorConfig', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportErrorConfig, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportErrorConfig::Representation
+      
+          collection :error_samples, as: 'errorSamples', class: Google::Apis::DiscoveryengineV1alpha::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleRpcStatus::Representation
+      
+          property :model_status, as: 'modelStatus'
+        end
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaTransactionInfo
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/discoveryengine_v1alpha/service.rb

@@ -190,6 +190,40 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Estimates the data size to be used by a customer.
+        # @param [String] location
+        #   Required. Full resource name of the Location, such as `projects/`project`/
+        #   locations/`location``.
+        # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest] google_cloud_discoveryengine_v1alpha_estimate_data_size_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def estimate_project_location_data_size(location, google_cloud_discoveryengine_v1alpha_estimate_data_size_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1alpha/{+location}:estimateDataSize', options)
+          command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest::Representation
+          command.request_object = google_cloud_discoveryengine_v1alpha_estimate_data_size_request_object
+          command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
+          command.params['location'] = location unless location.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Gets the latest state of a long-running operation. Clients can use this method
         # to poll the operation result at intervals as recommended by the API service.
         # @param [String] name
@@ -562,6 +596,41 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Trains a custom model.
+        # @param [String] data_store
+        #   Required. The resource name of the Data Store, such as `projects/*/locations/
+        #   global/collections/default_collection/dataStores/default_data_store`. This
+        #   field is used to identify the data store where to train the models.
+        # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest] google_cloud_discoveryengine_v1alpha_train_custom_model_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def train_project_location_collection_data_store_custom_model(data_store, google_cloud_discoveryengine_v1alpha_train_custom_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1alpha/{+dataStore}:trainCustomModel', options)
+          command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest::Representation
+          command.request_object = google_cloud_discoveryengine_v1alpha_train_custom_model_request_object
+          command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
+          command.params['dataStore'] = data_store unless data_store.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Creates a Document.
         # @param [String] parent
         #   Required. The parent resource name, such as `projects/`project`/locations/`

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-discoveryengine_v1alpha
 version: !ruby/object:Gem::Version
-  version: 0.29.0
+  version: 0.30.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-10 00:00:00.000000000 Z
+date: 2023-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.29.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.30.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha
 post_install_message: 
 rdoc_options: []