google-apis-discoveryengine_v1 0.46.0 → 0.48.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 076ee6df140b5bbf50a4d194abeafa0b25b2a2958a5655d2a72f0a7380b16818
4
- data.tar.gz: 0f53cb78e0fc1ed54cfac7fa8b116c999c8d94fdd44c306b0d8eee13382b9cc3
3
+ metadata.gz: ee49b1bf268d9daf09a17cec0b4236b127f53410f403a1adf083bb939e5122c5
4
+ data.tar.gz: c4f0cc1595392f2f7dd6f6b35bfae3462562a7ca33c2d615159d7bc873bfc472
5
5
  SHA512:
6
- metadata.gz: 7f42aa32e9f072556520106a0ac8a1a73fe62deadca7bdadbfc5c5af3f1ecaf695e1426bf9c1f71da4a56539f0d1f4f5d67bdbaa580bd76689c24937ba68b6cf
7
- data.tar.gz: 653b7dfd1b8e11a5d9eb5e7d8b526daccb4d77358457b0042cb93a014ca9577f34d794dfe1e7a008db7f61e44714dbeb2b6b88e9b3033aa2ffed6bc1fcd3ebdf
6
+ metadata.gz: c49af7964e53800f856bf43a8b728478bf4b595ea67a78aed604523ea70b9b8cc1f17b2be9597b1646149ebefa9b4ee0cc1c8170dc67b34440965dacd251a190
7
+ data.tar.gz: d313c9577233d234012ac0ea7f3ebf4d5aad25b0b0270e8600961e5d9376392087e43593cf2df2587a13007b6dbed16a0a9fa9afda1d2d2a85c42acfdb9e4bde
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-discoveryengine_v1
2
2
 
3
+ ### v0.48.0 (2025-08-24)
4
+
5
+ * Regenerated from discovery document revision 20250816
6
+
7
+ ### v0.47.0 (2025-08-10)
8
+
9
+ * Regenerated from discovery document revision 20250803
10
+
3
11
  ### v0.46.0 (2025-08-03)
4
12
 
5
13
  * Regenerated from discovery document revision 20250728
@@ -3676,6 +3676,28 @@ module Google
3676
3676
  class GoogleCloudDiscoveryengineV1Assistant
3677
3677
  include Google::Apis::Core::Hashable
3678
3678
 
3679
+ # Customer-defined policy for the assistant.
3680
+ # Corresponds to the JSON property `customerPolicy`
3681
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AssistantCustomerPolicy]
3682
+ attr_accessor :customer_policy
3683
+
3684
+ # Optional. Note: not implemented yet. Use enabled_actions instead. The enabled
3685
+ # tools on this assistant. The keys are connector name, for example "projects/`
3686
+ # projectId`/locations/`locationId`/collections/`collectionId`/dataconnector The
3687
+ # values consist of admin enabled tools towards the connector instance. Admin
3688
+ # can selectively enable multiple tools on any of the connector instances that
3689
+ # they created in the project. For example `"jira1ConnectorName": [(toolId1, "
3690
+ # createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3,
3691
+ # "sendEmail"),..] `
3692
+ # Corresponds to the JSON property `enabledTools`
3693
+ # @return [Hash<String,Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AssistantToolList>]
3694
+ attr_accessor :enabled_tools
3695
+
3696
+ # Configuration for the generation of the assistant response.
3697
+ # Corresponds to the JSON property `generationConfig`
3698
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AssistantGenerationConfig]
3699
+ attr_accessor :generation_config
3700
+
3679
3701
  # Immutable. Resource name of the assistant. Format: `projects/`project`/
3680
3702
  # locations/`location`/collections/`collection`/engines/`engine`/assistants/`
3681
3703
  # assistant`` It must be a UTF-8 encoded string with a length limit of 1024
@@ -3684,13 +3706,22 @@ module Google
3684
3706
  # @return [String]
3685
3707
  attr_accessor :name
3686
3708
 
3709
+ # Optional. The type of web grounding to use.
3710
+ # Corresponds to the JSON property `webGroundingType`
3711
+ # @return [String]
3712
+ attr_accessor :web_grounding_type
3713
+
3687
3714
  def initialize(**args)
3688
3715
  update!(**args)
3689
3716
  end
3690
3717
 
3691
3718
  # Update properties of this object
3692
3719
  def update!(**args)
3720
+ @customer_policy = args[:customer_policy] if args.key?(:customer_policy)
3721
+ @enabled_tools = args[:enabled_tools] if args.key?(:enabled_tools)
3722
+ @generation_config = args[:generation_config] if args.key?(:generation_config)
3693
3723
  @name = args[:name] if args.key?(:name)
3724
+ @web_grounding_type = args[:web_grounding_type] if args.key?(:web_grounding_type)
3694
3725
  end
3695
3726
  end
3696
3727
 
@@ -3846,6 +3877,107 @@ module Google
3846
3877
  end
3847
3878
  end
3848
3879
 
3880
+ # Customer-defined policy for the assistant.
3881
+ class GoogleCloudDiscoveryengineV1AssistantCustomerPolicy
3882
+ include Google::Apis::Core::Hashable
3883
+
3884
+ # Optional. List of banned phrases.
3885
+ # Corresponds to the JSON property `bannedPhrases`
3886
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase>]
3887
+ attr_accessor :banned_phrases
3888
+
3889
+ def initialize(**args)
3890
+ update!(**args)
3891
+ end
3892
+
3893
+ # Update properties of this object
3894
+ def update!(**args)
3895
+ @banned_phrases = args[:banned_phrases] if args.key?(:banned_phrases)
3896
+ end
3897
+ end
3898
+
3899
+ # Definition of a customer-defined banned phrase. A banned phrase is not allowed
3900
+ # to appear in the user query or the LLM response, or else the answer will be
3901
+ # refused.
3902
+ class GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase
3903
+ include Google::Apis::Core::Hashable
3904
+
3905
+ # Optional. If true, diacritical marks (e.g., accents, umlauts) are ignored when
3906
+ # matching banned phrases. For example, "cafe" would match "café".
3907
+ # Corresponds to the JSON property `ignoreDiacritics`
3908
+ # @return [Boolean]
3909
+ attr_accessor :ignore_diacritics
3910
+ alias_method :ignore_diacritics?, :ignore_diacritics
3911
+
3912
+ # Optional. Match type for the banned phrase.
3913
+ # Corresponds to the JSON property `matchType`
3914
+ # @return [String]
3915
+ attr_accessor :match_type
3916
+
3917
+ # Required. The raw string content to be banned.
3918
+ # Corresponds to the JSON property `phrase`
3919
+ # @return [String]
3920
+ attr_accessor :phrase
3921
+
3922
+ def initialize(**args)
3923
+ update!(**args)
3924
+ end
3925
+
3926
+ # Update properties of this object
3927
+ def update!(**args)
3928
+ @ignore_diacritics = args[:ignore_diacritics] if args.key?(:ignore_diacritics)
3929
+ @match_type = args[:match_type] if args.key?(:match_type)
3930
+ @phrase = args[:phrase] if args.key?(:phrase)
3931
+ end
3932
+ end
3933
+
3934
+ # Configuration for the generation of the assistant response.
3935
+ class GoogleCloudDiscoveryengineV1AssistantGenerationConfig
3936
+ include Google::Apis::Core::Hashable
3937
+
3938
+ # The default language to use for the generation of the assistant response. Use
3939
+ # an ISO 639-1 language code such as `en`. If not specified, the language will
3940
+ # be automatically detected.
3941
+ # Corresponds to the JSON property `defaultLanguage`
3942
+ # @return [String]
3943
+ attr_accessor :default_language
3944
+
3945
+ # System instruction, also known as the prompt preamble for LLM calls.
3946
+ # Corresponds to the JSON property `systemInstruction`
3947
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction]
3948
+ attr_accessor :system_instruction
3949
+
3950
+ def initialize(**args)
3951
+ update!(**args)
3952
+ end
3953
+
3954
+ # Update properties of this object
3955
+ def update!(**args)
3956
+ @default_language = args[:default_language] if args.key?(:default_language)
3957
+ @system_instruction = args[:system_instruction] if args.key?(:system_instruction)
3958
+ end
3959
+ end
3960
+
3961
+ # System instruction, also known as the prompt preamble for LLM calls.
3962
+ class GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction
3963
+ include Google::Apis::Core::Hashable
3964
+
3965
+ # Optional. Additional system instruction that will be added to the default
3966
+ # system instruction.
3967
+ # Corresponds to the JSON property `additionalSystemInstruction`
3968
+ # @return [String]
3969
+ attr_accessor :additional_system_instruction
3970
+
3971
+ def initialize(**args)
3972
+ update!(**args)
3973
+ end
3974
+
3975
+ # Update properties of this object
3976
+ def update!(**args)
3977
+ @additional_system_instruction = args[:additional_system_instruction] if args.key?(:additional_system_instruction)
3978
+ end
3979
+ end
3980
+
3849
3981
  # A piece of content and possibly its grounding information. Not all content
3850
3982
  # needs grounding. Phrases like "Of course, I will gladly search it for you." do
3851
3983
  # not need grounding.
@@ -4014,6 +4146,52 @@ module Google
4014
4146
  end
4015
4147
  end
4016
4148
 
4149
+ # Information to identify a tool.
4150
+ class GoogleCloudDiscoveryengineV1AssistantToolInfo
4151
+ include Google::Apis::Core::Hashable
4152
+
4153
+ # The display name of the tool.
4154
+ # Corresponds to the JSON property `toolDisplayName`
4155
+ # @return [String]
4156
+ attr_accessor :tool_display_name
4157
+
4158
+ # The name of the tool as defined by DataConnectorService.QueryAvailableActions.
4159
+ # Note: it's using `action` in the DataConnectorService apis, but they are the
4160
+ # same as the `tool` here.
4161
+ # Corresponds to the JSON property `toolName`
4162
+ # @return [String]
4163
+ attr_accessor :tool_name
4164
+
4165
+ def initialize(**args)
4166
+ update!(**args)
4167
+ end
4168
+
4169
+ # Update properties of this object
4170
+ def update!(**args)
4171
+ @tool_display_name = args[:tool_display_name] if args.key?(:tool_display_name)
4172
+ @tool_name = args[:tool_name] if args.key?(:tool_name)
4173
+ end
4174
+ end
4175
+
4176
+ # The enabled tools on a connector
4177
+ class GoogleCloudDiscoveryengineV1AssistantToolList
4178
+ include Google::Apis::Core::Hashable
4179
+
4180
+ # The list of tools with corresponding tool information.
4181
+ # Corresponds to the JSON property `toolInfo`
4182
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AssistantToolInfo>]
4183
+ attr_accessor :tool_info
4184
+
4185
+ def initialize(**args)
4186
+ update!(**args)
4187
+ end
4188
+
4189
+ # Update properties of this object
4190
+ def update!(**args)
4191
+ @tool_info = args[:tool_info] if args.key?(:tool_info)
4192
+ end
4193
+ end
4194
+
4017
4195
  # Metadata related to the progress of the SiteSearchEngineService.
4018
4196
  # BatchCreateTargetSites operation. This will be returned by the google.
4019
4197
  # longrunning.Operation.metadata field.
@@ -4885,6 +5063,12 @@ module Google
4885
5063
  class GoogleCloudDiscoveryengineV1ChunkDocumentMetadata
4886
5064
  include Google::Apis::Core::Hashable
4887
5065
 
5066
+ # The mime type of the document. https://www.iana.org/assignments/media-types/
5067
+ # media-types.xhtml.
5068
+ # Corresponds to the JSON property `mimeType`
5069
+ # @return [String]
5070
+ attr_accessor :mime_type
5071
+
4888
5072
  # Data representation. The structured JSON data for the document. It should
4889
5073
  # conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
4890
5074
  # Corresponds to the JSON property `structData`
@@ -4907,6 +5091,7 @@ module Google
4907
5091
 
4908
5092
  # Update properties of this object
4909
5093
  def update!(**args)
5094
+ @mime_type = args[:mime_type] if args.key?(:mime_type)
4910
5095
  @struct_data = args[:struct_data] if args.key?(:struct_data)
4911
5096
  @title = args[:title] if args.key?(:title)
4912
5097
  @uri = args[:uri] if args.key?(:uri)
@@ -10498,6 +10683,65 @@ module Google
10498
10683
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec]
10499
10684
  attr_accessor :query_expansion_spec
10500
10685
 
10686
+ # Optional. The ranking expression controls the customized ranking on retrieval
10687
+ # documents. This overrides ServingConfig.ranking_expression. The syntax and
10688
+ # supported features depend on the `ranking_expression_backend` value. If `
10689
+ # ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`
10690
+ # . If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`,
10691
+ # it should be a single function or multiple functions that are joined by "+". *
10692
+ # ranking_expression = function, ` " + ", function `; Supported functions: *
10693
+ # double * relevance_score * double * dotProduct(embedding_field_path) Function
10694
+ # variables: * `relevance_score`: pre-defined keywords, used for measure
10695
+ # relevance between query and document. * `embedding_field_path`: the document
10696
+ # embedding field used with query embedding vector. * `dotProduct`: embedding
10697
+ # function between `embedding_field_path` and query embedding vector. Example
10698
+ # ranking expression: If document has an embedding field doc_embedding, the
10699
+ # ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(
10700
+ # doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`,
10701
+ # the following expression types (and combinations of those chained using + or *
10702
+ # operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)`
10703
+ # * `rr(signal, double > 0)` -- reciprocal rank transformation with second
10704
+ # argument being a denominator constant. * `is_nan(signal)` -- returns 0 if
10705
+ # signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if
10706
+ # signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few
10707
+ # examples of ranking formulas that use the supported ranking expression types: -
10708
+ # `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` --
10709
+ # mostly rank by the logarithm of `keyword_similarity_score` with slight `
10710
+ # semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(
10711
+ # semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` --
10712
+ # rank by the exponent of `semantic_similarity_score` filling the value with 0
10713
+ # if it's NaN, also add constant 0.3 adjustment to the final score if `
10714
+ # semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) +
10715
+ # 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
10716
+ # of `keyword_similarity_score` with slight adjustment of reciprocal rank of `
10717
+ # semantic_smilarity_score`. The following signals are supported: * `
10718
+ # semantic_similarity_score`: semantic similarity adjustment that is calculated
10719
+ # using the embeddings generated by a proprietary Google model. This score
10720
+ # determines how semantically similar a search query is to a document. * `
10721
+ # keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (
10722
+ # BM25) ranking function. This score is calculated using a probabilistic model
10723
+ # to estimate the probability that a document is relevant to a given query. * `
10724
+ # relevance_score`: semantic relevance adjustment that uses a proprietary Google
10725
+ # model to determine the meaning and intent behind a user's query in context
10726
+ # with the content in the documents. * `pctr_rank`: predicted conversion rate
10727
+ # adjustment as a rank use predicted Click-through rate (pCTR) to gauge the
10728
+ # relevance and attractiveness of a search result from a user's perspective. A
10729
+ # higher pCTR suggests that the result is more likely to satisfy the user's
10730
+ # query and intent, making it a valuable signal for ranking. * `freshness_rank`:
10731
+ # freshness adjustment as a rank * `document_age`: The time in hours elapsed
10732
+ # since the document was last updated, a floating-point number (e.g., 0.25 means
10733
+ # 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses
10734
+ # proprietary Google model to determine the keyword-based overlap between the
10735
+ # query and the document. * `base_rank`: the default rank of the result
10736
+ # Corresponds to the JSON property `rankingExpression`
10737
+ # @return [String]
10738
+ attr_accessor :ranking_expression
10739
+
10740
+ # Optional. The backend to use for the ranking expression evaluation.
10741
+ # Corresponds to the JSON property `rankingExpressionBackend`
10742
+ # @return [String]
10743
+ attr_accessor :ranking_expression_backend
10744
+
10501
10745
  # The specification for returning the document relevance score.
10502
10746
  # Corresponds to the JSON property `relevanceScoreSpec`
10503
10747
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec]
@@ -10607,6 +10851,8 @@ module Google
10607
10851
  @params = args[:params] if args.key?(:params)
10608
10852
  @query = args[:query] if args.key?(:query)
10609
10853
  @query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
10854
+ @ranking_expression = args[:ranking_expression] if args.key?(:ranking_expression)
10855
+ @ranking_expression_backend = args[:ranking_expression_backend] if args.key?(:ranking_expression_backend)
10610
10856
  @relevance_score_spec = args[:relevance_score_spec] if args.key?(:relevance_score_spec)
10611
10857
  @relevance_threshold = args[:relevance_threshold] if args.key?(:relevance_threshold)
10612
10858
  @safe_search = args[:safe_search] if args.key?(:safe_search)
@@ -11129,6 +11375,8 @@ module Google
11129
11375
 
11130
11376
  # Required. Full resource name of DataStore, such as `projects/`project`/
11131
11377
  # locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
11378
+ # The path must include the project number, project id is not supported for this
11379
+ # field.
11132
11380
  # Corresponds to the JSON property `dataStore`
11133
11381
  # @return [String]
11134
11382
  attr_accessor :data_store
@@ -11679,6 +11927,11 @@ module Google
11679
11927
  # @return [Hash<String,Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DoubleList>]
11680
11928
  attr_accessor :model_scores
11681
11929
 
11930
+ # A set of ranking signals.
11931
+ # Corresponds to the JSON property `rankSignals`
11932
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals]
11933
+ attr_accessor :rank_signals
11934
+
11682
11935
  def initialize(**args)
11683
11936
  update!(**args)
11684
11937
  end
@@ -11689,6 +11942,99 @@ module Google
11689
11942
  @document = args[:document] if args.key?(:document)
11690
11943
  @id = args[:id] if args.key?(:id)
11691
11944
  @model_scores = args[:model_scores] if args.key?(:model_scores)
11945
+ @rank_signals = args[:rank_signals] if args.key?(:rank_signals)
11946
+ end
11947
+ end
11948
+
11949
+ # A set of ranking signals.
11950
+ class GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals
11951
+ include Google::Apis::Core::Hashable
11952
+
11953
+ # Optional. Combined custom boosts for a doc.
11954
+ # Corresponds to the JSON property `boostingFactor`
11955
+ # @return [Float]
11956
+ attr_accessor :boosting_factor
11957
+
11958
+ # Optional. A list of custom clearbox signals.
11959
+ # Corresponds to the JSON property `customSignals`
11960
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignalsCustomSignal>]
11961
+ attr_accessor :custom_signals
11962
+
11963
+ # Optional. The default rank of the result.
11964
+ # Corresponds to the JSON property `defaultRank`
11965
+ # @return [Float]
11966
+ attr_accessor :default_rank
11967
+
11968
+ # Optional. Age of the document in hours.
11969
+ # Corresponds to the JSON property `documentAge`
11970
+ # @return [Float]
11971
+ attr_accessor :document_age
11972
+
11973
+ # Optional. Keyword matching adjustment.
11974
+ # Corresponds to the JSON property `keywordSimilarityScore`
11975
+ # @return [Float]
11976
+ attr_accessor :keyword_similarity_score
11977
+
11978
+ # Optional. Predicted conversion rate adjustment as a rank.
11979
+ # Corresponds to the JSON property `pctrRank`
11980
+ # @return [Float]
11981
+ attr_accessor :pctr_rank
11982
+
11983
+ # Optional. Semantic relevance adjustment.
11984
+ # Corresponds to the JSON property `relevanceScore`
11985
+ # @return [Float]
11986
+ attr_accessor :relevance_score
11987
+
11988
+ # Optional. Semantic similarity adjustment.
11989
+ # Corresponds to the JSON property `semanticSimilarityScore`
11990
+ # @return [Float]
11991
+ attr_accessor :semantic_similarity_score
11992
+
11993
+ # Optional. Topicality adjustment as a rank.
11994
+ # Corresponds to the JSON property `topicalityRank`
11995
+ # @return [Float]
11996
+ attr_accessor :topicality_rank
11997
+
11998
+ def initialize(**args)
11999
+ update!(**args)
12000
+ end
12001
+
12002
+ # Update properties of this object
12003
+ def update!(**args)
12004
+ @boosting_factor = args[:boosting_factor] if args.key?(:boosting_factor)
12005
+ @custom_signals = args[:custom_signals] if args.key?(:custom_signals)
12006
+ @default_rank = args[:default_rank] if args.key?(:default_rank)
12007
+ @document_age = args[:document_age] if args.key?(:document_age)
12008
+ @keyword_similarity_score = args[:keyword_similarity_score] if args.key?(:keyword_similarity_score)
12009
+ @pctr_rank = args[:pctr_rank] if args.key?(:pctr_rank)
12010
+ @relevance_score = args[:relevance_score] if args.key?(:relevance_score)
12011
+ @semantic_similarity_score = args[:semantic_similarity_score] if args.key?(:semantic_similarity_score)
12012
+ @topicality_rank = args[:topicality_rank] if args.key?(:topicality_rank)
12013
+ end
12014
+ end
12015
+
12016
+ # Custom clearbox signal represented by name and value pair.
12017
+ class GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignalsCustomSignal
12018
+ include Google::Apis::Core::Hashable
12019
+
12020
+ # Optional. Name of the signal.
12021
+ # Corresponds to the JSON property `name`
12022
+ # @return [String]
12023
+ attr_accessor :name
12024
+
12025
+ # Optional. Float value representing the ranking signal (e.g. 1.25 for BM25).
12026
+ # Corresponds to the JSON property `value`
12027
+ # @return [Float]
12028
+ attr_accessor :value
12029
+
12030
+ def initialize(**args)
12031
+ update!(**args)
12032
+ end
12033
+
12034
+ # Update properties of this object
12035
+ def update!(**args)
12036
+ @name = args[:name] if args.key?(:name)
12037
+ @value = args[:value] if args.key?(:value)
11692
12038
  end
11693
12039
  end
11694
12040
 
@@ -13624,6 +13970,13 @@ module Google
13624
13970
  # @return [String]
13625
13971
  attr_accessor :service_name
13626
13972
 
13973
+ # Optional. Whether to use static secrets for the connector. If true, the
13974
+ # secrets provided in the action_params will be ignored.
13975
+ # Corresponds to the JSON property `useStaticSecrets`
13976
+ # @return [Boolean]
13977
+ attr_accessor :use_static_secrets
13978
+ alias_method :use_static_secrets?, :use_static_secrets
13979
+
13627
13980
  def initialize(**args)
13628
13981
  update!(**args)
13629
13982
  end
@@ -13633,6 +13986,7 @@ module Google
13633
13986
  @action_params = args[:action_params] if args.key?(:action_params)
13634
13987
  @is_action_configured = args[:is_action_configured] if args.key?(:is_action_configured)
13635
13988
  @service_name = args[:service_name] if args.key?(:service_name)
13989
+ @use_static_secrets = args[:use_static_secrets] if args.key?(:use_static_secrets)
13636
13990
  end
13637
13991
  end
13638
13992
 
@@ -15623,6 +15977,14 @@ module Google
15623
15977
  # @return [Array<Google::Apis::DiscoveryengineV1::GoogleRpcStatus>]
15624
15978
  attr_accessor :errors
15625
15979
 
15980
+ # Optional. If the connector is a hybrid connector, determines whether ingestion
15981
+ # is enabled and appropriate resources are provisioned during connector creation.
15982
+ # If the connector is not a hybrid connector, this field is ignored.
15983
+ # Corresponds to the JSON property `hybridIngestionDisabled`
15984
+ # @return [Boolean]
15985
+ attr_accessor :hybrid_ingestion_disabled
15986
+ alias_method :hybrid_ingestion_disabled?, :hybrid_ingestion_disabled
15987
+
15626
15988
  # The refresh interval to sync the Access Control List information for the
15627
15989
  # documents ingested by this connector. If not set, the access control list will
15628
15990
  # be refreshed at the default interval of 30 minutes. The identity refresh
@@ -15802,6 +16164,7 @@ module Google
15802
16164
  @end_user_config = args[:end_user_config] if args.key?(:end_user_config)
15803
16165
  @entities = args[:entities] if args.key?(:entities)
15804
16166
  @errors = args[:errors] if args.key?(:errors)
16167
+ @hybrid_ingestion_disabled = args[:hybrid_ingestion_disabled] if args.key?(:hybrid_ingestion_disabled)
15805
16168
  @identity_refresh_interval = args[:identity_refresh_interval] if args.key?(:identity_refresh_interval)
15806
16169
  @identity_schedule_config = args[:identity_schedule_config] if args.key?(:identity_schedule_config)
15807
16170
  @incremental_refresh_interval = args[:incremental_refresh_interval] if args.key?(:incremental_refresh_interval)
@@ -18409,8 +18772,8 @@ module Google
18409
18772
 
18410
18773
  # A comma-separated list of fields to order by, sorted in ascending order. Use "
18411
18774
  # desc" after a field name for descending. Supported fields: * `update_time` * `
18412
- # create_time` * `session_name` * `is_pinned` Example: * "update_time desc" * "
18413
- # create_time" * "is_pinned desc,update_time desc": list sessions by is_pinned
18775
+ # create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `
18776
+ # create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned
18414
18777
  # first, then by update_time.
18415
18778
  # Corresponds to the JSON property `orderBy`
18416
18779
  # @return [String]
@@ -20311,6 +20674,8 @@ module Google
20311
20674
 
20312
20675
  # Required. Full resource name of DataStore, such as `projects/`project`/
20313
20676
  # locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
20677
+ # The path must include the project number, project id is not supported for this
20678
+ # field.
20314
20679
  # Corresponds to the JSON property `dataStore`
20315
20680
  # @return [String]
20316
20681
  attr_accessor :data_store
@@ -25680,6 +26045,8 @@ module Google
25680
26045
 
25681
26046
  # Required. Full resource name of DataStore, such as `projects/`project`/
25682
26047
  # locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
26048
+ # The path must include the project number, project id is not supported for this
26049
+ # field.
25683
26050
  # Corresponds to the JSON property `dataStore`
25684
26051
  # @return [String]
25685
26052
  attr_accessor :data_store
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DiscoveryengineV1
18
18
  # Version of the google-apis-discoveryengine_v1 gem
19
- GEM_VERSION = "0.46.0"
19
+ GEM_VERSION = "0.48.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.18.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20250728"
25
+ REVISION = "20250816"
26
26
  end
27
27
  end
28
28
  end
@@ -604,6 +604,30 @@ module Google
604
604
  include Google::Apis::Core::JsonObjectSupport
605
605
  end
606
606
 
607
+ class GoogleCloudDiscoveryengineV1AssistantCustomerPolicy
608
+ class Representation < Google::Apis::Core::JsonRepresentation; end
609
+
610
+ include Google::Apis::Core::JsonObjectSupport
611
+ end
612
+
613
+ class GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase
614
+ class Representation < Google::Apis::Core::JsonRepresentation; end
615
+
616
+ include Google::Apis::Core::JsonObjectSupport
617
+ end
618
+
619
+ class GoogleCloudDiscoveryengineV1AssistantGenerationConfig
620
+ class Representation < Google::Apis::Core::JsonRepresentation; end
621
+
622
+ include Google::Apis::Core::JsonObjectSupport
623
+ end
624
+
625
+ class GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction
626
+ class Representation < Google::Apis::Core::JsonRepresentation; end
627
+
628
+ include Google::Apis::Core::JsonObjectSupport
629
+ end
630
+
607
631
  class GoogleCloudDiscoveryengineV1AssistantGroundedContent
608
632
  class Representation < Google::Apis::Core::JsonRepresentation; end
609
633
 
@@ -634,6 +658,18 @@ module Google
634
658
  include Google::Apis::Core::JsonObjectSupport
635
659
  end
636
660
 
661
+ class GoogleCloudDiscoveryengineV1AssistantToolInfo
662
+ class Representation < Google::Apis::Core::JsonRepresentation; end
663
+
664
+ include Google::Apis::Core::JsonObjectSupport
665
+ end
666
+
667
+ class GoogleCloudDiscoveryengineV1AssistantToolList
668
+ class Representation < Google::Apis::Core::JsonRepresentation; end
669
+
670
+ include Google::Apis::Core::JsonObjectSupport
671
+ end
672
+
637
673
  class GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata
638
674
  class Representation < Google::Apis::Core::JsonRepresentation; end
639
675
 
@@ -1876,6 +1912,18 @@ module Google
1876
1912
  include Google::Apis::Core::JsonObjectSupport
1877
1913
  end
1878
1914
 
1915
+ class GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals
1916
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1917
+
1918
+ include Google::Apis::Core::JsonObjectSupport
1919
+ end
1920
+
1921
+ class GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignalsCustomSignal
1922
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1923
+
1924
+ include Google::Apis::Core::JsonObjectSupport
1925
+ end
1926
+
1879
1927
  class GoogleCloudDiscoveryengineV1SearchResponseSessionInfo
1880
1928
  class Representation < Google::Apis::Core::JsonRepresentation; end
1881
1929
 
@@ -5256,7 +5304,14 @@ module Google
5256
5304
  class GoogleCloudDiscoveryengineV1Assistant
5257
5305
  # @private
5258
5306
  class Representation < Google::Apis::Core::JsonRepresentation
5307
+ property :customer_policy, as: 'customerPolicy', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AssistantCustomerPolicy, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AssistantCustomerPolicy::Representation
5308
+
5309
+ hash :enabled_tools, as: 'enabledTools', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AssistantToolList, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AssistantToolList::Representation
5310
+
5311
+ property :generation_config, as: 'generationConfig', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AssistantGenerationConfig, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AssistantGenerationConfig::Representation
5312
+
5259
5313
  property :name, as: 'name'
5314
+ property :web_grounding_type, as: 'webGroundingType'
5260
5315
  end
5261
5316
  end
5262
5317
 
@@ -5308,6 +5363,39 @@ module Google
5308
5363
  end
5309
5364
  end
5310
5365
 
5366
+ class GoogleCloudDiscoveryengineV1AssistantCustomerPolicy
5367
+ # @private
5368
+ class Representation < Google::Apis::Core::JsonRepresentation
5369
+ collection :banned_phrases, as: 'bannedPhrases', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase::Representation
5370
+
5371
+ end
5372
+ end
5373
+
5374
+ class GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase
5375
+ # @private
5376
+ class Representation < Google::Apis::Core::JsonRepresentation
5377
+ property :ignore_diacritics, as: 'ignoreDiacritics'
5378
+ property :match_type, as: 'matchType'
5379
+ property :phrase, as: 'phrase'
5380
+ end
5381
+ end
5382
+
5383
+ class GoogleCloudDiscoveryengineV1AssistantGenerationConfig
5384
+ # @private
5385
+ class Representation < Google::Apis::Core::JsonRepresentation
5386
+ property :default_language, as: 'defaultLanguage'
5387
+ property :system_instruction, as: 'systemInstruction', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction::Representation
5388
+
5389
+ end
5390
+ end
5391
+
5392
+ class GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction
5393
+ # @private
5394
+ class Representation < Google::Apis::Core::JsonRepresentation
5395
+ property :additional_system_instruction, as: 'additionalSystemInstruction'
5396
+ end
5397
+ end
5398
+
5311
5399
  class GoogleCloudDiscoveryengineV1AssistantGroundedContent
5312
5400
  # @private
5313
5401
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -5359,6 +5447,22 @@ module Google
5359
5447
  end
5360
5448
  end
5361
5449
 
5450
+ class GoogleCloudDiscoveryengineV1AssistantToolInfo
5451
+ # @private
5452
+ class Representation < Google::Apis::Core::JsonRepresentation
5453
+ property :tool_display_name, as: 'toolDisplayName'
5454
+ property :tool_name, as: 'toolName'
5455
+ end
5456
+ end
5457
+
5458
+ class GoogleCloudDiscoveryengineV1AssistantToolList
5459
+ # @private
5460
+ class Representation < Google::Apis::Core::JsonRepresentation
5461
+ collection :tool_info, as: 'toolInfo', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AssistantToolInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AssistantToolInfo::Representation
5462
+
5463
+ end
5464
+ end
5465
+
5362
5466
  class GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata
5363
5467
  # @private
5364
5468
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -5603,6 +5707,7 @@ module Google
5603
5707
  class GoogleCloudDiscoveryengineV1ChunkDocumentMetadata
5604
5708
  # @private
5605
5709
  class Representation < Google::Apis::Core::JsonRepresentation
5710
+ property :mime_type, as: 'mimeType'
5606
5711
  hash :struct_data, as: 'structData'
5607
5712
  property :title, as: 'title'
5608
5713
  property :uri, as: 'uri'
@@ -7151,6 +7256,8 @@ module Google
7151
7256
  property :query, as: 'query'
7152
7257
  property :query_expansion_spec, as: 'queryExpansionSpec', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec::Representation
7153
7258
 
7259
+ property :ranking_expression, as: 'rankingExpression'
7260
+ property :ranking_expression_backend, as: 'rankingExpressionBackend'
7154
7261
  property :relevance_score_spec, as: 'relevanceScoreSpec', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec::Representation
7155
7262
 
7156
7263
  property :relevance_threshold, as: 'relevanceThreshold'
@@ -7429,6 +7536,32 @@ module Google
7429
7536
  property :id, as: 'id'
7430
7537
  hash :model_scores, as: 'modelScores', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DoubleList, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DoubleList::Representation
7431
7538
 
7539
+ property :rank_signals, as: 'rankSignals', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals::Representation
7540
+
7541
+ end
7542
+ end
7543
+
7544
+ class GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals
7545
+ # @private
7546
+ class Representation < Google::Apis::Core::JsonRepresentation
7547
+ property :boosting_factor, as: 'boostingFactor'
7548
+ collection :custom_signals, as: 'customSignals', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignalsCustomSignal, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignalsCustomSignal::Representation
7549
+
7550
+ property :default_rank, as: 'defaultRank'
7551
+ property :document_age, as: 'documentAge'
7552
+ property :keyword_similarity_score, as: 'keywordSimilarityScore'
7553
+ property :pctr_rank, as: 'pctrRank'
7554
+ property :relevance_score, as: 'relevanceScore'
7555
+ property :semantic_similarity_score, as: 'semanticSimilarityScore'
7556
+ property :topicality_rank, as: 'topicalityRank'
7557
+ end
7558
+ end
7559
+
7560
+ class GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignalsCustomSignal
7561
+ # @private
7562
+ class Representation < Google::Apis::Core::JsonRepresentation
7563
+ property :name, as: 'name'
7564
+ property :value, as: 'value'
7432
7565
  end
7433
7566
  end
7434
7567
 
@@ -7927,6 +8060,7 @@ module Google
7927
8060
  hash :action_params, as: 'actionParams'
7928
8061
  property :is_action_configured, as: 'isActionConfigured'
7929
8062
  property :service_name, as: 'serviceName'
8063
+ property :use_static_secrets, as: 'useStaticSecrets'
7930
8064
  end
7931
8065
  end
7932
8066
 
@@ -8494,6 +8628,7 @@ module Google
8494
8628
 
8495
8629
  collection :errors, as: 'errors', class: Google::Apis::DiscoveryengineV1::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1::GoogleRpcStatus::Representation
8496
8630
 
8631
+ property :hybrid_ingestion_disabled, as: 'hybridIngestionDisabled'
8497
8632
  property :identity_refresh_interval, as: 'identityRefreshInterval'
8498
8633
  property :identity_schedule_config, as: 'identityScheduleConfig', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig::Representation
8499
8634
 
@@ -2515,8 +2515,8 @@ module Google
2515
2515
  # @param [String] order_by
2516
2516
  # A comma-separated list of fields to order by, sorted in ascending order. Use "
2517
2517
  # desc" after a field name for descending. Supported fields: * `update_time` * `
2518
- # create_time` * `session_name` * `is_pinned` Example: * "update_time desc" * "
2519
- # create_time" * "is_pinned desc,update_time desc": list sessions by is_pinned
2518
+ # create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `
2519
+ # create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned
2520
2520
  # first, then by update_time.
2521
2521
  # @param [Fixnum] page_size
2522
2522
  # Maximum number of results to return. If unspecified, defaults to 50. Max
@@ -4734,8 +4734,8 @@ module Google
4734
4734
  # @param [String] order_by
4735
4735
  # A comma-separated list of fields to order by, sorted in ascending order. Use "
4736
4736
  # desc" after a field name for descending. Supported fields: * `update_time` * `
4737
- # create_time` * `session_name` * `is_pinned` Example: * "update_time desc" * "
4738
- # create_time" * "is_pinned desc,update_time desc": list sessions by is_pinned
4737
+ # create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `
4738
+ # create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned
4739
4739
  # first, then by update_time.
4740
4740
  # @param [Fixnum] page_size
4741
4741
  # Maximum number of results to return. If unspecified, defaults to 50. Max
@@ -6878,8 +6878,8 @@ module Google
6878
6878
  # @param [String] order_by
6879
6879
  # A comma-separated list of fields to order by, sorted in ascending order. Use "
6880
6880
  # desc" after a field name for descending. Supported fields: * `update_time` * `
6881
- # create_time` * `session_name` * `is_pinned` Example: * "update_time desc" * "
6882
- # create_time" * "is_pinned desc,update_time desc": list sessions by is_pinned
6881
+ # create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `
6882
+ # create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned
6883
6883
  # first, then by update_time.
6884
6884
  # @param [Fixnum] page_size
6885
6885
  # Maximum number of results to return. If unspecified, defaults to 50. Max
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-discoveryengine_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.46.0
4
+ version: 0.48.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
@@ -57,7 +57,7 @@ licenses:
57
57
  metadata:
58
58
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
59
59
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1/CHANGELOG.md
60
- documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1/v0.46.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1/v0.48.0
61
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1
62
62
  rdoc_options: []
63
63
  require_paths: