google-apis-discoveryengine_v1alpha 0.54.0 → 0.55.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8507,6 +8507,11 @@ module Google
8507
8507
  # @return [Fixnum]
8508
8508
  attr_accessor :indexed_record_count
8509
8509
 
8510
+ # Represents the progress of a sync run.
8511
+ # Corresponds to the JSON property `progress`
8512
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress]
8513
+ attr_accessor :progress
8514
+
8510
8515
  # The number of requests sent to 3p API.
8511
8516
  # Corresponds to the JSON property `sourceApiRequestCount`
8512
8517
  # @return [Fixnum]
@@ -8545,6 +8550,7 @@ module Google
8545
8550
  @errors = args[:errors] if args.key?(:errors)
8546
8551
  @extracted_record_count = args[:extracted_record_count] if args.key?(:extracted_record_count)
8547
8552
  @indexed_record_count = args[:indexed_record_count] if args.key?(:indexed_record_count)
8553
+ @progress = args[:progress] if args.key?(:progress)
8548
8554
  @source_api_request_count = args[:source_api_request_count] if args.key?(:source_api_request_count)
8549
8555
  @state = args[:state] if args.key?(:state)
8550
8556
  @state_update_time = args[:state_update_time] if args.key?(:state_update_time)
@@ -8553,6 +8559,38 @@ module Google
8553
8559
  end
8554
8560
  end
8555
8561
 
8562
+ # Represents the progress of a sync run.
8563
+ class GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress
8564
+ include Google::Apis::Core::Hashable
8565
+
8566
+ # The current progress.
8567
+ # Corresponds to the JSON property `currentCount`
8568
+ # @return [Fixnum]
8569
+ attr_accessor :current_count
8570
+
8571
+ # Derived. The percentile of the progress.current_count / total_count. The value
8572
+ # is between [0, 1.0] inclusive.
8573
+ # Corresponds to the JSON property `percentile`
8574
+ # @return [Float]
8575
+ attr_accessor :percentile
8576
+
8577
+ # The total.
8578
+ # Corresponds to the JSON property `totalCount`
8579
+ # @return [Fixnum]
8580
+ attr_accessor :total_count
8581
+
8582
+ def initialize(**args)
8583
+ update!(**args)
8584
+ end
8585
+
8586
+ # Update properties of this object
8587
+ def update!(**args)
8588
+ @current_count = args[:current_count] if args.key?(:current_count)
8589
+ @percentile = args[:percentile] if args.key?(:percentile)
8590
+ @total_count = args[:total_count] if args.key?(:total_count)
8591
+ end
8592
+ end
8593
+
8556
8594
  # Defines a conditioned behavior to employ during serving. Must be attached to a
8557
8595
  # ServingConfig to be considered at serving time. Permitted actions dependent on
8558
8596
  # `SolutionType`.
@@ -9458,6 +9496,13 @@ module Google
9458
9496
  # @return [Array<String>]
9459
9497
  attr_accessor :blocking_reasons
9460
9498
 
9499
+ # Output only. The type of connector. Each source can only map to one type. For
9500
+ # example, salesforce, confluence and jira have THIRD_PARTY connector type. It
9501
+ # is notmutable once set by system.
9502
+ # Corresponds to the JSON property `connectorType`
9503
+ # @return [String]
9504
+ attr_accessor :connector_type
9505
+
9461
9506
  # Output only. Timestamp the DataConnector was created at.
9462
9507
  # Corresponds to the JSON property `createTime`
9463
9508
  # @return [String]
@@ -9577,6 +9622,11 @@ module Google
9577
9622
  # @return [String]
9578
9623
  attr_accessor :private_connectivity_project_id
9579
9624
 
9625
+ # Output only. real-time sync state
9626
+ # Corresponds to the JSON property `realtimeState`
9627
+ # @return [String]
9628
+ attr_accessor :realtime_state
9629
+
9580
9630
  # Required. The refresh interval for data sync. If duration is set to 0, the
9581
9631
  # data will be synced in real time. The streaming feature is not supported yet.
9582
9632
  # The minimum is 30 minutes and maximum is 7 days.
@@ -9620,6 +9670,7 @@ module Google
9620
9670
  @auto_run_disabled = args[:auto_run_disabled] if args.key?(:auto_run_disabled)
9621
9671
  @bap_config = args[:bap_config] if args.key?(:bap_config)
9622
9672
  @blocking_reasons = args[:blocking_reasons] if args.key?(:blocking_reasons)
9673
+ @connector_type = args[:connector_type] if args.key?(:connector_type)
9623
9674
  @create_time = args[:create_time] if args.key?(:create_time)
9624
9675
  @data_source = args[:data_source] if args.key?(:data_source)
9625
9676
  @destination_configs = args[:destination_configs] if args.key?(:destination_configs)
@@ -9634,6 +9685,7 @@ module Google
9634
9685
  @next_sync_time = args[:next_sync_time] if args.key?(:next_sync_time)
9635
9686
  @params = args[:params] if args.key?(:params)
9636
9687
  @private_connectivity_project_id = args[:private_connectivity_project_id] if args.key?(:private_connectivity_project_id)
9688
+ @realtime_state = args[:realtime_state] if args.key?(:realtime_state)
9637
9689
  @refresh_interval = args[:refresh_interval] if args.key?(:refresh_interval)
9638
9690
  @state = args[:state] if args.key?(:state)
9639
9691
  @static_ip_addresses = args[:static_ip_addresses] if args.key?(:static_ip_addresses)
@@ -9949,11 +10001,21 @@ module Google
9949
10001
  class GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries
9950
10002
  include Google::Apis::Core::Hashable
9951
10003
 
10004
+ # The historical crawl rate timeseries data, used for monitoring.
10005
+ # Corresponds to the JSON property `autoRefreshCrawlErrorRate`
10006
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries]
10007
+ attr_accessor :auto_refresh_crawl_error_rate
10008
+
9952
10009
  # The historical crawl rate timeseries data, used for monitoring.
9953
10010
  # Corresponds to the JSON property `autoRefreshCrawlRate`
9954
10011
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries]
9955
10012
  attr_accessor :auto_refresh_crawl_rate
9956
10013
 
10014
+ # The historical crawl rate timeseries data, used for monitoring.
10015
+ # Corresponds to the JSON property `userTriggeredCrawlErrorRate`
10016
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries]
10017
+ attr_accessor :user_triggered_crawl_error_rate
10018
+
9957
10019
  # The historical crawl rate timeseries data, used for monitoring.
9958
10020
  # Corresponds to the JSON property `userTriggeredCrawlRate`
9959
10021
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries]
@@ -9965,7 +10027,9 @@ module Google
9965
10027
 
9966
10028
  # Update properties of this object
9967
10029
  def update!(**args)
10030
+ @auto_refresh_crawl_error_rate = args[:auto_refresh_crawl_error_rate] if args.key?(:auto_refresh_crawl_error_rate)
9968
10031
  @auto_refresh_crawl_rate = args[:auto_refresh_crawl_rate] if args.key?(:auto_refresh_crawl_rate)
10032
+ @user_triggered_crawl_error_rate = args[:user_triggered_crawl_error_rate] if args.key?(:user_triggered_crawl_error_rate)
9969
10033
  @user_triggered_crawl_rate = args[:user_triggered_crawl_rate] if args.key?(:user_triggered_crawl_rate)
9970
10034
  end
9971
10035
  end
@@ -11958,549 +12022,6 @@ module Google
11958
12022
  end
11959
12023
  end
11960
12024
 
11961
- # Top-level message sent by the client for the `GenerateGroundedContent` method.
11962
- class GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest
11963
- include Google::Apis::Core::Hashable
11964
-
11965
- # Content of the current conversation with the model. For single-turn queries,
11966
- # this is a single instance. For multi-turn queries, this is a repeated field
11967
- # that contains conversation history + latest request.
11968
- # Corresponds to the JSON property `contents`
11969
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent>]
11970
- attr_accessor :contents
11971
-
11972
- # Content generation specification.
11973
- # Corresponds to the JSON property `generationSpec`
11974
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec]
11975
- attr_accessor :generation_spec
11976
-
11977
- # Grounding specification.
11978
- # Corresponds to the JSON property `groundingSpec`
11979
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSpec]
11980
- attr_accessor :grounding_spec
11981
-
11982
- # Base structured datatype containing multi-part content of a message.
11983
- # Corresponds to the JSON property `systemInstruction`
11984
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent]
11985
- attr_accessor :system_instruction
11986
-
11987
- # The user labels applied to a resource must meet the following requirements: *
11988
- # Each resource can have multiple labels, up to a maximum of 64. * Each label
11989
- # must be a key-value pair. * Keys have a minimum length of 1 character and a
11990
- # maximum length of 63 characters and cannot be empty. Values can be empty and
11991
- # have a maximum length of 63 characters. * Keys and values can contain only
11992
- # lowercase letters, numeric characters, underscores, and dashes. All characters
11993
- # must use UTF-8 encoding, and international characters are allowed. * The key
11994
- # portion of a label must be unique. However, you can use the same key with
11995
- # multiple resources. * Keys must start with a lowercase letter or international
11996
- # character. See [Google Cloud Document](https://cloud.google.com/resource-
11997
- # manager/docs/creating-managing-labels#requirements) for more details.
11998
- # Corresponds to the JSON property `userLabels`
11999
- # @return [Hash<String,String>]
12000
- attr_accessor :user_labels
12001
-
12002
- def initialize(**args)
12003
- update!(**args)
12004
- end
12005
-
12006
- # Update properties of this object
12007
- def update!(**args)
12008
- @contents = args[:contents] if args.key?(:contents)
12009
- @generation_spec = args[:generation_spec] if args.key?(:generation_spec)
12010
- @grounding_spec = args[:grounding_spec] if args.key?(:grounding_spec)
12011
- @system_instruction = args[:system_instruction] if args.key?(:system_instruction)
12012
- @user_labels = args[:user_labels] if args.key?(:user_labels)
12013
- end
12014
- end
12015
-
12016
- # Describes the options to customize dynamic retrieval.
12017
- class GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfiguration
12018
- include Google::Apis::Core::Hashable
12019
-
12020
- # Describes the predictor settings for dynamic retrieval.
12021
- # Corresponds to the JSON property `predictor`
12022
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor]
12023
- attr_accessor :predictor
12024
-
12025
- def initialize(**args)
12026
- update!(**args)
12027
- end
12028
-
12029
- # Update properties of this object
12030
- def update!(**args)
12031
- @predictor = args[:predictor] if args.key?(:predictor)
12032
- end
12033
- end
12034
-
12035
- # Describes the predictor settings for dynamic retrieval.
12036
- class GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor
12037
- include Google::Apis::Core::Hashable
12038
-
12039
- # The value of the threshold. If the predictor will predict a value smaller than
12040
- # this, it would suppress grounding in the source.
12041
- # Corresponds to the JSON property `threshold`
12042
- # @return [Float]
12043
- attr_accessor :threshold
12044
-
12045
- # The version of the predictor to be used in dynamic retrieval.
12046
- # Corresponds to the JSON property `version`
12047
- # @return [String]
12048
- attr_accessor :version
12049
-
12050
- def initialize(**args)
12051
- update!(**args)
12052
- end
12053
-
12054
- # Update properties of this object
12055
- def update!(**args)
12056
- @threshold = args[:threshold] if args.key?(:threshold)
12057
- @version = args[:version] if args.key?(:version)
12058
- end
12059
- end
12060
-
12061
- # Content generation specification.
12062
- class GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGenerationSpec
12063
- include Google::Apis::Core::Hashable
12064
-
12065
- # If specified, custom value for frequency penalty will be used.
12066
- # Corresponds to the JSON property `frequencyPenalty`
12067
- # @return [Float]
12068
- attr_accessor :frequency_penalty
12069
-
12070
- # Language code for content. Use language tags defined by [BCP47](https://www.
12071
- # rfc-editor.org/rfc/bcp/bcp47.txt).
12072
- # Corresponds to the JSON property `languageCode`
12073
- # @return [String]
12074
- attr_accessor :language_code
12075
-
12076
- # If specified, custom value for max output tokens will be used.
12077
- # Corresponds to the JSON property `maxOutputTokens`
12078
- # @return [Fixnum]
12079
- attr_accessor :max_output_tokens
12080
-
12081
- # Specifies which Vertex model id to use for generation.
12082
- # Corresponds to the JSON property `modelId`
12083
- # @return [String]
12084
- attr_accessor :model_id
12085
-
12086
- # If specified, custom value for presence penalty will be used.
12087
- # Corresponds to the JSON property `presencePenalty`
12088
- # @return [Float]
12089
- attr_accessor :presence_penalty
12090
-
12091
- # If specified, custom value for the seed will be used.
12092
- # Corresponds to the JSON property `seed`
12093
- # @return [Fixnum]
12094
- attr_accessor :seed
12095
-
12096
- # If specified, custom value for the temperature will be used.
12097
- # Corresponds to the JSON property `temperature`
12098
- # @return [Float]
12099
- attr_accessor :temperature
12100
-
12101
- # If specified, custom value for top-k sampling will be used.
12102
- # Corresponds to the JSON property `topK`
12103
- # @return [Fixnum]
12104
- attr_accessor :top_k
12105
-
12106
- # If specified, custom value for nucleus sampling will be used.
12107
- # Corresponds to the JSON property `topP`
12108
- # @return [Float]
12109
- attr_accessor :top_p
12110
-
12111
- def initialize(**args)
12112
- update!(**args)
12113
- end
12114
-
12115
- # Update properties of this object
12116
- def update!(**args)
12117
- @frequency_penalty = args[:frequency_penalty] if args.key?(:frequency_penalty)
12118
- @language_code = args[:language_code] if args.key?(:language_code)
12119
- @max_output_tokens = args[:max_output_tokens] if args.key?(:max_output_tokens)
12120
- @model_id = args[:model_id] if args.key?(:model_id)
12121
- @presence_penalty = args[:presence_penalty] if args.key?(:presence_penalty)
12122
- @seed = args[:seed] if args.key?(:seed)
12123
- @temperature = args[:temperature] if args.key?(:temperature)
12124
- @top_k = args[:top_k] if args.key?(:top_k)
12125
- @top_p = args[:top_p] if args.key?(:top_p)
12126
- end
12127
- end
12128
-
12129
- # Grounding source.
12130
- class GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSource
12131
- include Google::Apis::Core::Hashable
12132
-
12133
- # Google Search config parameters.
12134
- # Corresponds to the JSON property `googleSearchSource`
12135
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource]
12136
- attr_accessor :google_search_source
12137
-
12138
- # Message to be used for grounding based on inline content.
12139
- # Corresponds to the JSON property `inlineSource`
12140
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceInlineSource]
12141
- attr_accessor :inline_source
12142
-
12143
- # Message to be used for grounding with Vertex AI Search.
12144
- # Corresponds to the JSON property `searchSource`
12145
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceSearchSource]
12146
- attr_accessor :search_source
12147
-
12148
- def initialize(**args)
12149
- update!(**args)
12150
- end
12151
-
12152
- # Update properties of this object
12153
- def update!(**args)
12154
- @google_search_source = args[:google_search_source] if args.key?(:google_search_source)
12155
- @inline_source = args[:inline_source] if args.key?(:inline_source)
12156
- @search_source = args[:search_source] if args.key?(:search_source)
12157
- end
12158
- end
12159
-
12160
- # Google Search config parameters.
12161
- class GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource
12162
- include Google::Apis::Core::Hashable
12163
-
12164
- # Describes the options to customize dynamic retrieval.
12165
- # Corresponds to the JSON property `dynamicRetrievalConfig`
12166
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestDynamicRetrievalConfiguration]
12167
- attr_accessor :dynamic_retrieval_config
12168
-
12169
- def initialize(**args)
12170
- update!(**args)
12171
- end
12172
-
12173
- # Update properties of this object
12174
- def update!(**args)
12175
- @dynamic_retrieval_config = args[:dynamic_retrieval_config] if args.key?(:dynamic_retrieval_config)
12176
- end
12177
- end
12178
-
12179
- # Message to be used for grounding based on inline content.
12180
- class GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceInlineSource
12181
- include Google::Apis::Core::Hashable
12182
-
12183
- # Attributes associated with the content. Common attributes include `source` (
12184
- # indicating where the content was sourced from) and `author` (indicating the
12185
- # author of the content).
12186
- # Corresponds to the JSON property `attributes`
12187
- # @return [Hash<String,String>]
12188
- attr_accessor :attributes
12189
-
12190
- # List of facts to be used for grounding.
12191
- # Corresponds to the JSON property `groundingFacts`
12192
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGroundingFact>]
12193
- attr_accessor :grounding_facts
12194
-
12195
- def initialize(**args)
12196
- update!(**args)
12197
- end
12198
-
12199
- # Update properties of this object
12200
- def update!(**args)
12201
- @attributes = args[:attributes] if args.key?(:attributes)
12202
- @grounding_facts = args[:grounding_facts] if args.key?(:grounding_facts)
12203
- end
12204
- end
12205
-
12206
- # Message to be used for grounding with Vertex AI Search.
12207
- class GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSourceSearchSource
12208
- include Google::Apis::Core::Hashable
12209
-
12210
- # Filter expression to be applied to the search. The syntax is the same as
12211
- # SearchRequest.filter.
12212
- # Corresponds to the JSON property `filter`
12213
- # @return [String]
12214
- attr_accessor :filter
12215
-
12216
- # Number of search results to return. The default value is 10. The maximumm
12217
- # allowed value is 10.
12218
- # Corresponds to the JSON property `maxResultCount`
12219
- # @return [Fixnum]
12220
- attr_accessor :max_result_count
12221
-
12222
- # If set, safe search is enabled in Vertex AI Search requests.
12223
- # Corresponds to the JSON property `safeSearch`
12224
- # @return [Boolean]
12225
- attr_accessor :safe_search
12226
- alias_method :safe_search?, :safe_search
12227
-
12228
- # The resource name of the Engine to use. Format: `projects/`project`/locations/`
12229
- # location`/collections/`collection_id`/engines/`engine_id`/servingConfigs/`
12230
- # serving_config_id``
12231
- # Corresponds to the JSON property `servingConfig`
12232
- # @return [String]
12233
- attr_accessor :serving_config
12234
-
12235
- def initialize(**args)
12236
- update!(**args)
12237
- end
12238
-
12239
- # Update properties of this object
12240
- def update!(**args)
12241
- @filter = args[:filter] if args.key?(:filter)
12242
- @max_result_count = args[:max_result_count] if args.key?(:max_result_count)
12243
- @safe_search = args[:safe_search] if args.key?(:safe_search)
12244
- @serving_config = args[:serving_config] if args.key?(:serving_config)
12245
- end
12246
- end
12247
-
12248
- # Grounding specification.
12249
- class GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSpec
12250
- include Google::Apis::Core::Hashable
12251
-
12252
- # Grounding sources.
12253
- # Corresponds to the JSON property `groundingSources`
12254
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequestGroundingSource>]
12255
- attr_accessor :grounding_sources
12256
-
12257
- def initialize(**args)
12258
- update!(**args)
12259
- end
12260
-
12261
- # Update properties of this object
12262
- def update!(**args)
12263
- @grounding_sources = args[:grounding_sources] if args.key?(:grounding_sources)
12264
- end
12265
- end
12266
-
12267
- # Response for the `GenerateGroundedContent` method.
12268
- class GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponse
12269
- include Google::Apis::Core::Hashable
12270
-
12271
- # Generated candidates.
12272
- # Corresponds to the JSON property `candidates`
12273
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidate>]
12274
- attr_accessor :candidates
12275
-
12276
- def initialize(**args)
12277
- update!(**args)
12278
- end
12279
-
12280
- # Update properties of this object
12281
- def update!(**args)
12282
- @candidates = args[:candidates] if args.key?(:candidates)
12283
- end
12284
- end
12285
-
12286
- # A response candidate generated from the model.
12287
- class GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidate
12288
- include Google::Apis::Core::Hashable
12289
-
12290
- # Base structured datatype containing multi-part content of a message.
12291
- # Corresponds to the JSON property `content`
12292
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent]
12293
- attr_accessor :content
12294
-
12295
- # Citation for the generated content.
12296
- # Corresponds to the JSON property `groundingMetadata`
12297
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata]
12298
- attr_accessor :grounding_metadata
12299
-
12300
- # The overall grounding score for the candidate, in the range of [0, 1].
12301
- # Corresponds to the JSON property `groundingScore`
12302
- # @return [Float]
12303
- attr_accessor :grounding_score
12304
-
12305
- # Index of the candidate.
12306
- # Corresponds to the JSON property `index`
12307
- # @return [Fixnum]
12308
- attr_accessor :index
12309
-
12310
- def initialize(**args)
12311
- update!(**args)
12312
- end
12313
-
12314
- # Update properties of this object
12315
- def update!(**args)
12316
- @content = args[:content] if args.key?(:content)
12317
- @grounding_metadata = args[:grounding_metadata] if args.key?(:grounding_metadata)
12318
- @grounding_score = args[:grounding_score] if args.key?(:grounding_score)
12319
- @index = args[:index] if args.key?(:index)
12320
- end
12321
- end
12322
-
12323
- # Citation for the generated content.
12324
- class GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata
12325
- include Google::Apis::Core::Hashable
12326
-
12327
- # GroundingSupport across all claims in the answer candidate. An support to a
12328
- # fact indicates that the claim is supported by the fact.
12329
- # Corresponds to the JSON property `groundingSupport`
12330
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport>]
12331
- attr_accessor :grounding_support
12332
-
12333
- # Retrieval metadata to provide an understanding in the retrieval steps
12334
- # performed by the model. There can be multiple such messages which can
12335
- # correspond to different parts of the retrieval. This is a mechanism used to
12336
- # ensure transparency to our users.
12337
- # Corresponds to the JSON property `retrievalMetadata`
12338
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata>]
12339
- attr_accessor :retrieval_metadata
12340
-
12341
- # Google search entry point.
12342
- # Corresponds to the JSON property `searchEntryPoint`
12343
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint]
12344
- attr_accessor :search_entry_point
12345
-
12346
- # List of chunks to be attributed across all claims in the candidate. These are
12347
- # derived from the grounding sources supplied in the request.
12348
- # Corresponds to the JSON property `supportChunks`
12349
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFactChunk>]
12350
- attr_accessor :support_chunks
12351
-
12352
- # Web search queries for the following-up web search.
12353
- # Corresponds to the JSON property `webSearchQueries`
12354
- # @return [Array<String>]
12355
- attr_accessor :web_search_queries
12356
-
12357
- def initialize(**args)
12358
- update!(**args)
12359
- end
12360
-
12361
- # Update properties of this object
12362
- def update!(**args)
12363
- @grounding_support = args[:grounding_support] if args.key?(:grounding_support)
12364
- @retrieval_metadata = args[:retrieval_metadata] if args.key?(:retrieval_metadata)
12365
- @search_entry_point = args[:search_entry_point] if args.key?(:search_entry_point)
12366
- @support_chunks = args[:support_chunks] if args.key?(:support_chunks)
12367
- @web_search_queries = args[:web_search_queries] if args.key?(:web_search_queries)
12368
- end
12369
- end
12370
-
12371
- # Describes the metadata about dynamic retrieval.
12372
- class GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata
12373
- include Google::Apis::Core::Hashable
12374
-
12375
- # Describes the metadata about the dynamic retrieval predictor.
12376
- # Corresponds to the JSON property `predictorMetadata`
12377
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata]
12378
- attr_accessor :predictor_metadata
12379
-
12380
- def initialize(**args)
12381
- update!(**args)
12382
- end
12383
-
12384
- # Update properties of this object
12385
- def update!(**args)
12386
- @predictor_metadata = args[:predictor_metadata] if args.key?(:predictor_metadata)
12387
- end
12388
- end
12389
-
12390
- # Describes the metadata about the dynamic retrieval predictor.
12391
- class GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata
12392
- include Google::Apis::Core::Hashable
12393
-
12394
- # The value of the predictor. This should be between [0, 1] where a value of 0
12395
- # means that the query would not benefit from grounding, while a value of 1.0
12396
- # means that the query would benefit the most. In between values allow to
12397
- # differentiate between different usefulness scores for grounding.
12398
- # Corresponds to the JSON property `prediction`
12399
- # @return [Float]
12400
- attr_accessor :prediction
12401
-
12402
- # The version of the predictor which was used in dynamic retrieval.
12403
- # Corresponds to the JSON property `version`
12404
- # @return [String]
12405
- attr_accessor :version
12406
-
12407
- def initialize(**args)
12408
- update!(**args)
12409
- end
12410
-
12411
- # Update properties of this object
12412
- def update!(**args)
12413
- @prediction = args[:prediction] if args.key?(:prediction)
12414
- @version = args[:version] if args.key?(:version)
12415
- end
12416
- end
12417
-
12418
- # Grounding info for a claim in the candidate and its support.
12419
- class GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport
12420
- include Google::Apis::Core::Hashable
12421
-
12422
- # Text for the claim in the candidate. Always provided when a support is found.
12423
- # Corresponds to the JSON property `claimText`
12424
- # @return [String]
12425
- attr_accessor :claim_text
12426
-
12427
- # A list of indices (into 'support_chunks') specifying the citations associated
12428
- # with the claim. For instance [1,3,4] means that support_chunks[1],
12429
- # support_chunks[3], support_chunks[4] are the chunks attributed to the claim.
12430
- # Corresponds to the JSON property `supportChunkIndices`
12431
- # @return [Array<Fixnum>]
12432
- attr_accessor :support_chunk_indices
12433
-
12434
- # A score in the range of [0, 1] describing how grounded is a specific claim in
12435
- # the support chunks indicated. Higher value means that the claim is better
12436
- # supported by the chunks.
12437
- # Corresponds to the JSON property `supportScore`
12438
- # @return [Float]
12439
- attr_accessor :support_score
12440
-
12441
- def initialize(**args)
12442
- update!(**args)
12443
- end
12444
-
12445
- # Update properties of this object
12446
- def update!(**args)
12447
- @claim_text = args[:claim_text] if args.key?(:claim_text)
12448
- @support_chunk_indices = args[:support_chunk_indices] if args.key?(:support_chunk_indices)
12449
- @support_score = args[:support_score] if args.key?(:support_score)
12450
- end
12451
- end
12452
-
12453
- # Describes the metadata associated with a retrieval step.
12454
- class GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata
12455
- include Google::Apis::Core::Hashable
12456
-
12457
- # Describes the metadata about dynamic retrieval.
12458
- # Corresponds to the JSON property `dynamicRetrievalMetadata`
12459
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata]
12460
- attr_accessor :dynamic_retrieval_metadata
12461
-
12462
- # Describes the source to which the metadata is referring to.
12463
- # Corresponds to the JSON property `source`
12464
- # @return [String]
12465
- attr_accessor :source
12466
-
12467
- def initialize(**args)
12468
- update!(**args)
12469
- end
12470
-
12471
- # Update properties of this object
12472
- def update!(**args)
12473
- @dynamic_retrieval_metadata = args[:dynamic_retrieval_metadata] if args.key?(:dynamic_retrieval_metadata)
12474
- @source = args[:source] if args.key?(:source)
12475
- end
12476
- end
12477
-
12478
- # Google search entry point.
12479
- class GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint
12480
- include Google::Apis::Core::Hashable
12481
-
12482
- # Web content snippet that can be embedded in a web page or an app webview.
12483
- # Corresponds to the JSON property `renderedContent`
12484
- # @return [String]
12485
- attr_accessor :rendered_content
12486
-
12487
- # Base64 encoded JSON representing array of tuple.
12488
- # Corresponds to the JSON property `sdkBlob`
12489
- # NOTE: Values are automatically base64 encoded/decoded in the client library.
12490
- # @return [String]
12491
- attr_accessor :sdk_blob
12492
-
12493
- def initialize(**args)
12494
- update!(**args)
12495
- end
12496
-
12497
- # Update properties of this object
12498
- def update!(**args)
12499
- @rendered_content = args[:rendered_content] if args.key?(:rendered_content)
12500
- @sdk_blob = args[:sdk_blob] if args.key?(:sdk_blob)
12501
- end
12502
- end
12503
-
12504
12025
  # Request for GetSession method.
12505
12026
  class GoogleCloudDiscoveryengineV1alphaGetSessionRequest
12506
12027
  include Google::Apis::Core::Hashable
@@ -12551,51 +12072,6 @@ module Google
12551
12072
  end
12552
12073
  end
12553
12074
 
12554
- # Base structured datatype containing multi-part content of a message.
12555
- class GoogleCloudDiscoveryengineV1alphaGroundedGenerationContent
12556
- include Google::Apis::Core::Hashable
12557
-
12558
- # Ordered `Parts` that constitute a single message.
12559
- # Corresponds to the JSON property `parts`
12560
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGroundedGenerationContentPart>]
12561
- attr_accessor :parts
12562
-
12563
- # Producer of the content. Must be either `user` or `model`. Intended to be used
12564
- # for multi-turn conversations. Otherwise, it can be left unset.
12565
- # Corresponds to the JSON property `role`
12566
- # @return [String]
12567
- attr_accessor :role
12568
-
12569
- def initialize(**args)
12570
- update!(**args)
12571
- end
12572
-
12573
- # Update properties of this object
12574
- def update!(**args)
12575
- @parts = args[:parts] if args.key?(:parts)
12576
- @role = args[:role] if args.key?(:role)
12577
- end
12578
- end
12579
-
12580
- # Single part of content.
12581
- class GoogleCloudDiscoveryengineV1alphaGroundedGenerationContentPart
12582
- include Google::Apis::Core::Hashable
12583
-
12584
- # Inline text.
12585
- # Corresponds to the JSON property `text`
12586
- # @return [String]
12587
- attr_accessor :text
12588
-
12589
- def initialize(**args)
12590
- update!(**args)
12591
- end
12592
-
12593
- # Update properties of this object
12594
- def update!(**args)
12595
- @text = args[:text] if args.key?(:text)
12596
- end
12597
- end
12598
-
12599
12075
  # Grounding Fact.
12600
12076
  class GoogleCloudDiscoveryengineV1alphaGroundingFact
12601
12077
  include Google::Apis::Core::Hashable
@@ -15367,7 +14843,7 @@ module Google
15367
14843
  alias_method :ignore_record_details_in_response?, :ignore_record_details_in_response
15368
14844
 
15369
14845
  # The identifier of the model to use. It is one of: * `semantic-ranker-512@
15370
- # latest`: Semantic ranking model with maxiumn input token size 512. It is set
14846
+ # latest`: Semantic ranking model with maximum input token size 512. It is set
15371
14847
  # to `semantic-ranker-512@latest` by default if unspecified.
15372
14848
  # Corresponds to the JSON property `model`
15373
14849
  # @return [String]
@@ -16684,10 +16160,10 @@ module Google
16684
16160
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec]
16685
16161
  attr_accessor :custom_fine_tuning_spec
16686
16162
 
16687
- # Specs defining DataStores to filter on in a search call and configurations for
16688
- # those data stores. This is only considered for Engines with multiple data
16689
- # stores. For engines with a single data store, the specs directly under
16690
- # SearchRequest should be used.
16163
+ # Specifications that define the specific [DataStore]s to be searched, along
16164
+ # with configurations for those data stores. This is only considered for Engines
16165
+ # with multiple data stores. For engines with a single data store, the specs
16166
+ # directly under SearchRequest should be used.
16691
16167
  # Corresponds to the JSON property `dataStoreSpecs`
16692
16168
  # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec>]
16693
16169
  attr_accessor :data_store_specs
@@ -18218,6 +17694,11 @@ module Google
18218
17694
  class GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo
18219
17695
  include Google::Apis::Core::Hashable
18220
17696
 
17697
+ # The classified intents from the input query.
17698
+ # Corresponds to the JSON property `classifiedIntents`
17699
+ # @return [Array<String>]
17700
+ attr_accessor :classified_intents
17701
+
18221
17702
  # The filters that were extracted from the input query.
18222
17703
  # Corresponds to the JSON property `extractedFilters`
18223
17704
  # @return [String]
@@ -18246,6 +17727,7 @@ module Google
18246
17727
 
18247
17728
  # Update properties of this object
18248
17729
  def update!(**args)
17730
+ @classified_intents = args[:classified_intents] if args.key?(:classified_intents)
18249
17731
  @extracted_filters = args[:extracted_filters] if args.key?(:extracted_filters)
18250
17732
  @rewritten_query = args[:rewritten_query] if args.key?(:rewritten_query)
18251
17733
  @sql_request = args[:sql_request] if args.key?(:sql_request)
@@ -20802,6 +20284,11 @@ module Google
20802
20284
  attr_accessor :enable_web_app
20803
20285
  alias_method :enable_web_app?, :enable_web_app
20804
20286
 
20287
+ # Optional. The workforce identity pool provider used to access the widget.
20288
+ # Corresponds to the JSON property `workforceIdentityPoolProvider`
20289
+ # @return [String]
20290
+ attr_accessor :workforce_identity_pool_provider
20291
+
20805
20292
  def initialize(**args)
20806
20293
  update!(**args)
20807
20294
  end
@@ -20811,6 +20298,7 @@ module Google
20811
20298
  @allow_public_access = args[:allow_public_access] if args.key?(:allow_public_access)
20812
20299
  @allowlisted_domains = args[:allowlisted_domains] if args.key?(:allowlisted_domains)
20813
20300
  @enable_web_app = args[:enable_web_app] if args.key?(:enable_web_app)
20301
+ @workforce_identity_pool_provider = args[:workforce_identity_pool_provider] if args.key?(:workforce_identity_pool_provider)
20814
20302
  end
20815
20303
  end
20816
20304
 
@@ -21290,6 +20778,11 @@ module Google
21290
20778
  attr_accessor :ignore_non_answer_seeking_query
21291
20779
  alias_method :ignore_non_answer_seeking_query?, :ignore_non_answer_seeking_query
21292
20780
 
20781
+ # Optional. Source of image returned in the answer.
20782
+ # Corresponds to the JSON property `imageSource`
20783
+ # @return [String]
20784
+ attr_accessor :image_source
20785
+
21293
20786
  # Language code for Summary. Use language tags defined by [BCP47](https://www.
21294
20787
  # rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
21295
20788
  # Corresponds to the JSON property `languageCode`
@@ -21328,6 +20821,7 @@ module Google
21328
20821
  @ignore_adversarial_query = args[:ignore_adversarial_query] if args.key?(:ignore_adversarial_query)
21329
20822
  @ignore_low_relevant_content = args[:ignore_low_relevant_content] if args.key?(:ignore_low_relevant_content)
21330
20823
  @ignore_non_answer_seeking_query = args[:ignore_non_answer_seeking_query] if args.key?(:ignore_non_answer_seeking_query)
20824
+ @image_source = args[:image_source] if args.key?(:image_source)
21331
20825
  @language_code = args[:language_code] if args.key?(:language_code)
21332
20826
  @max_rephrase_steps = args[:max_rephrase_steps] if args.key?(:max_rephrase_steps)
21333
20827
  @model_prompt_preamble = args[:model_prompt_preamble] if args.key?(:model_prompt_preamble)
@@ -22321,11 +21815,21 @@ module Google
22321
21815
  class GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries
22322
21816
  include Google::Apis::Core::Hashable
22323
21817
 
21818
+ # The historical crawl rate timeseries data, used for monitoring.
21819
+ # Corresponds to the JSON property `autoRefreshCrawlErrorRate`
21820
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries]
21821
+ attr_accessor :auto_refresh_crawl_error_rate
21822
+
22324
21823
  # The historical crawl rate timeseries data, used for monitoring.
22325
21824
  # Corresponds to the JSON property `autoRefreshCrawlRate`
22326
21825
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries]
22327
21826
  attr_accessor :auto_refresh_crawl_rate
22328
21827
 
21828
+ # The historical crawl rate timeseries data, used for monitoring.
21829
+ # Corresponds to the JSON property `userTriggeredCrawlErrorRate`
21830
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries]
21831
+ attr_accessor :user_triggered_crawl_error_rate
21832
+
22329
21833
  # The historical crawl rate timeseries data, used for monitoring.
22330
21834
  # Corresponds to the JSON property `userTriggeredCrawlRate`
22331
21835
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries]
@@ -22337,7 +21841,9 @@ module Google
22337
21841
 
22338
21842
  # Update properties of this object
22339
21843
  def update!(**args)
21844
+ @auto_refresh_crawl_error_rate = args[:auto_refresh_crawl_error_rate] if args.key?(:auto_refresh_crawl_error_rate)
22340
21845
  @auto_refresh_crawl_rate = args[:auto_refresh_crawl_rate] if args.key?(:auto_refresh_crawl_rate)
21846
+ @user_triggered_crawl_error_rate = args[:user_triggered_crawl_error_rate] if args.key?(:user_triggered_crawl_error_rate)
22341
21847
  @user_triggered_crawl_rate = args[:user_triggered_crawl_rate] if args.key?(:user_triggered_crawl_rate)
22342
21848
  end
22343
21849
  end
@@ -24254,10 +23760,10 @@ module Google
24254
23760
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec]
24255
23761
  attr_accessor :content_search_spec
24256
23762
 
24257
- # Specs defining DataStores to filter on in a search call and configurations for
24258
- # those data stores. This is only considered for Engines with multiple data
24259
- # stores. For engines with a single data store, the specs directly under
24260
- # SearchRequest should be used.
23763
+ # Specifications that define the specific [DataStore]s to be searched, along
23764
+ # with configurations for those data stores. This is only considered for Engines
23765
+ # with multiple data stores. For engines with a single data store, the specs
23766
+ # directly under SearchRequest should be used.
24261
23767
  # Corresponds to the JSON property `dataStoreSpecs`
24262
23768
  # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec>]
24263
23769
  attr_accessor :data_store_specs