google-apis-discoveryengine_v1beta 0.73.0 → 0.75.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.
@@ -867,6 +867,28 @@ module Google
867
867
  end
868
868
  end
869
869
 
870
+ # Discovery Engine Assistant resource.
871
+ class GoogleCloudDiscoveryengineV1Assistant
872
+ include Google::Apis::Core::Hashable
873
+
874
+ # Immutable. Resource name of the assistant. Format: `projects/`project`/
875
+ # locations/`location`/collections/`collection`/engines/`engine`/assistants/`
876
+ # assistant`` It must be a UTF-8 encoded string with a length limit of 1024
877
+ # characters.
878
+ # Corresponds to the JSON property `name`
879
+ # @return [String]
880
+ attr_accessor :name
881
+
882
+ def initialize(**args)
883
+ update!(**args)
884
+ end
885
+
886
+ # Update properties of this object
887
+ def update!(**args)
888
+ @name = args[:name] if args.key?(:name)
889
+ end
890
+ end
891
+
870
892
  # Metadata related to the progress of the SiteSearchEngineService.
871
893
  # BatchCreateTargetSites operation. This will be returned by the google.
872
894
  # longrunning.Operation.metadata field.
@@ -989,14 +1011,14 @@ module Google
989
1011
  attr_accessor :is_default
990
1012
  alias_method :is_default?, :is_default
991
1013
 
992
- # KMS key resource name which will be used to encrypt resources `projects/`
993
- # project`/locations/`location`/keyRings/`keyRing`/cryptoKeys/`keyId``.
1014
+ # Required. KMS key resource name which will be used to encrypt resources `
1015
+ # projects/`project`/locations/`location`/keyRings/`keyRing`/cryptoKeys/`keyId``.
994
1016
  # Corresponds to the JSON property `kmsKey`
995
1017
  # @return [String]
996
1018
  attr_accessor :kms_key
997
1019
 
998
- # KMS key version resource name which will be used to encrypt resources `/
999
- # cryptoKeyVersions/`keyVersion``.
1020
+ # Output only. KMS key version resource name which will be used to encrypt
1021
+ # resources `/cryptoKeyVersions/`keyVersion``.
1000
1022
  # Corresponds to the JSON property `kmsKeyVersion`
1001
1023
  # @return [String]
1002
1024
  attr_accessor :kms_key_version
@@ -2194,6 +2216,13 @@ module Google
2194
2216
  class GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig
2195
2217
  include Google::Apis::Core::Hashable
2196
2218
 
2219
+ # Optional. If true, the processed document will be made available for the
2220
+ # GetProcessedDocument API.
2221
+ # Corresponds to the JSON property `enableGetProcessedDocument`
2222
+ # @return [Boolean]
2223
+ attr_accessor :enable_get_processed_document
2224
+ alias_method :enable_get_processed_document?, :enable_get_processed_document
2225
+
2197
2226
  # Optional. If true, the LLM based annotation is added to the image during
2198
2227
  # parsing.
2199
2228
  # Corresponds to the JSON property `enableImageAnnotation`
@@ -2235,6 +2264,7 @@ module Google
2235
2264
 
2236
2265
  # Update properties of this object
2237
2266
  def update!(**args)
2267
+ @enable_get_processed_document = args[:enable_get_processed_document] if args.key?(:enable_get_processed_document)
2238
2268
  @enable_image_annotation = args[:enable_image_annotation] if args.key?(:enable_image_annotation)
2239
2269
  @enable_table_annotation = args[:enable_table_annotation] if args.key?(:enable_table_annotation)
2240
2270
  @exclude_html_classes = args[:exclude_html_classes] if args.key?(:exclude_html_classes)
@@ -2364,7 +2394,8 @@ module Google
2364
2394
  # Supported keys: * `*`: all features, if it's present, all other feature state
2365
2395
  # settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-
2366
2396
  # gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-
2367
- # org-chart` * `bi-directional-audio` * `feedback` * `session-sharing`
2397
+ # org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `
2398
+ # personalization-memory` - Enables personalization based on user preferences.
2368
2399
  # Corresponds to the JSON property `features`
2369
2400
  # @return [Hash<String,String>]
2370
2401
  attr_accessor :features
@@ -5608,14 +5639,14 @@ module Google
5608
5639
  attr_accessor :is_default
5609
5640
  alias_method :is_default?, :is_default
5610
5641
 
5611
- # KMS key resource name which will be used to encrypt resources `projects/`
5612
- # project`/locations/`location`/keyRings/`keyRing`/cryptoKeys/`keyId``.
5642
+ # Required. KMS key resource name which will be used to encrypt resources `
5643
+ # projects/`project`/locations/`location`/keyRings/`keyRing`/cryptoKeys/`keyId``.
5613
5644
  # Corresponds to the JSON property `kmsKey`
5614
5645
  # @return [String]
5615
5646
  attr_accessor :kms_key
5616
5647
 
5617
- # KMS key version resource name which will be used to encrypt resources `/
5618
- # cryptoKeyVersions/`keyVersion``.
5648
+ # Output only. KMS key version resource name which will be used to encrypt
5649
+ # resources `/cryptoKeyVersions/`keyVersion``.
5619
5650
  # Corresponds to the JSON property `kmsKeyVersion`
5620
5651
  # @return [String]
5621
5652
  attr_accessor :kms_key_version
@@ -7738,6 +7769,13 @@ module Google
7738
7769
  class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig
7739
7770
  include Google::Apis::Core::Hashable
7740
7771
 
7772
+ # Optional. If true, the processed document will be made available for the
7773
+ # GetProcessedDocument API.
7774
+ # Corresponds to the JSON property `enableGetProcessedDocument`
7775
+ # @return [Boolean]
7776
+ attr_accessor :enable_get_processed_document
7777
+ alias_method :enable_get_processed_document?, :enable_get_processed_document
7778
+
7741
7779
  # Optional. If true, the LLM based annotation is added to the image during
7742
7780
  # parsing.
7743
7781
  # Corresponds to the JSON property `enableImageAnnotation`
@@ -7779,6 +7817,7 @@ module Google
7779
7817
 
7780
7818
  # Update properties of this object
7781
7819
  def update!(**args)
7820
+ @enable_get_processed_document = args[:enable_get_processed_document] if args.key?(:enable_get_processed_document)
7782
7821
  @enable_image_annotation = args[:enable_image_annotation] if args.key?(:enable_image_annotation)
7783
7822
  @enable_table_annotation = args[:enable_table_annotation] if args.key?(:enable_table_annotation)
7784
7823
  @exclude_html_classes = args[:exclude_html_classes] if args.key?(:exclude_html_classes)
@@ -7908,7 +7947,8 @@ module Google
7908
7947
  # Supported keys: * `*`: all features, if it's present, all other feature state
7909
7948
  # settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-
7910
7949
  # gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-
7911
- # org-chart` * `bi-directional-audio` * `feedback` * `session-sharing`
7950
+ # org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `
7951
+ # personalization-memory` - Enables personalization based on user preferences.
7912
7952
  # Corresponds to the JSON property `features`
7913
7953
  # @return [Hash<String,String>]
7914
7954
  attr_accessor :features
@@ -9341,9 +9381,12 @@ module Google
9341
9381
  class GoogleCloudDiscoveryengineV1alphaListSessionsRequest
9342
9382
  include Google::Apis::Core::Hashable
9343
9383
 
9344
- # A filter to apply on the list results. The supported features are:
9345
- # user_pseudo_id, state, starred. Examples: "user_pseudo_id = some_id" "starred =
9346
- # true"
9384
+ # A comma-separated list of fields to filter by, in EBNF grammar. The supported
9385
+ # fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `
9386
+ # is_pinned` * `labels` * `create_time` * `update_time` Examples: "
9387
+ # user_pseudo_id = some_id" "display_name = \"some_name\"" "starred = true" "
9388
+ # is_pinned=true AND (NOT labels:hidden)" "create_time > \"1970-01-01T12:00:00Z\"
9389
+ # "
9347
9390
  # Corresponds to the JSON property `filter`
9348
9391
  # @return [String]
9349
9392
  attr_accessor :filter
@@ -10602,21 +10645,17 @@ module Google
10602
10645
 
10603
10646
  # The session resource name. Optional. Session allows users to do multi-turn /
10604
10647
  # search API calls or coordination between /search API calls and /answer API
10605
- # calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the
10606
- # auto-session mode (see below). 2. Call /search API with the session ID
10607
- # generated in the first call. Here, the previous search query gets considered
10608
- # in query standing. I.e., if the first query is "How did Alphabet do in 2022?"
10609
- # and the current query is "How about 2023?", the current query will be
10610
- # interpreted as "How did Alphabet do in 2023?". Example #2 (coordination
10611
- # between /search API calls and /answer API calls): 1. Call /search API with the
10612
- # auto-session mode (see below). 2. Call /answer API with the session ID
10613
- # generated in the first call. Here, the answer generation happens in the
10614
- # context of the search results from the first search call. Auto-session mode:
10615
- # when `projects/.../sessions/-` is used, a new session gets automatically
10616
- # created. Otherwise, users can use the create-session API to create a session
10617
- # manually. Multi-turn Search feature is currently at private GA stage. Please
10618
- # use v1alpha or v1beta version instead before we launch this feature to public
10619
- # GA. Or ask for allowlisting through Google Support team.
10648
+ # calls. Example #1 (multi-turn /search API calls): Call /search API with the
10649
+ # session ID generated in the first call. Here, the previous search query gets
10650
+ # considered in query standing. I.e., if the first query is "How did Alphabet do
10651
+ # in 2022?" and the current query is "How about 2023?", the current query will
10652
+ # be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination
10653
+ # between /search API calls and /answer API calls): Call /answer API with the
10654
+ # session ID generated in the first call. Here, the answer generation happens in
10655
+ # the context of the search results from the first search call. Multi-turn
10656
+ # Search feature is currently at private GA stage. Please use v1alpha or v1beta
10657
+ # version instead before we launch this feature to public GA. Or ask for
10658
+ # allowlisting through Google Support team.
10620
10659
  # Corresponds to the JSON property `session`
10621
10660
  # @return [String]
10622
10661
  attr_accessor :session
@@ -14797,6 +14836,436 @@ module Google
14797
14836
  end
14798
14837
  end
14799
14838
 
14839
+ # AssistAnswer resource, main part of AssistResponse.
14840
+ class GoogleCloudDiscoveryengineV1betaAssistAnswer
14841
+ include Google::Apis::Core::Hashable
14842
+
14843
+ # Reasons for not answering the assist call.
14844
+ # Corresponds to the JSON property `assistSkippedReasons`
14845
+ # @return [Array<String>]
14846
+ attr_accessor :assist_skipped_reasons
14847
+
14848
+ # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/`
14849
+ # project`/locations/`location`/collections/`collection`/engines/`engine`/
14850
+ # sessions/`session`/assistAnswers/`assist_answer`` This field must be a UTF-8
14851
+ # encoded string with a length limit of 1024 characters.
14852
+ # Corresponds to the JSON property `name`
14853
+ # @return [String]
14854
+ attr_accessor :name
14855
+
14856
+ # Replies of the assistant.
14857
+ # Corresponds to the JSON property `replies`
14858
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistAnswerReply>]
14859
+ attr_accessor :replies
14860
+
14861
+ # State of the answer generation.
14862
+ # Corresponds to the JSON property `state`
14863
+ # @return [String]
14864
+ attr_accessor :state
14865
+
14866
+ def initialize(**args)
14867
+ update!(**args)
14868
+ end
14869
+
14870
+ # Update properties of this object
14871
+ def update!(**args)
14872
+ @assist_skipped_reasons = args[:assist_skipped_reasons] if args.key?(:assist_skipped_reasons)
14873
+ @name = args[:name] if args.key?(:name)
14874
+ @replies = args[:replies] if args.key?(:replies)
14875
+ @state = args[:state] if args.key?(:state)
14876
+ end
14877
+ end
14878
+
14879
+ # One part of the multi-part response of the assist call.
14880
+ class GoogleCloudDiscoveryengineV1betaAssistAnswerReply
14881
+ include Google::Apis::Core::Hashable
14882
+
14883
+ # A piece of content and possibly its grounding information. Not all content
14884
+ # needs grounding. Phrases like "Of course, I will gladly search it for you." do
14885
+ # not need grounding.
14886
+ # Corresponds to the JSON property `groundedContent`
14887
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistantGroundedContent]
14888
+ attr_accessor :grounded_content
14889
+
14890
+ def initialize(**args)
14891
+ update!(**args)
14892
+ end
14893
+
14894
+ # Update properties of this object
14895
+ def update!(**args)
14896
+ @grounded_content = args[:grounded_content] if args.key?(:grounded_content)
14897
+ end
14898
+ end
14899
+
14900
+ # User metadata of the request.
14901
+ class GoogleCloudDiscoveryengineV1betaAssistUserMetadata
14902
+ include Google::Apis::Core::Hashable
14903
+
14904
+ # Optional. Preferred language to be used for answering if language detection
14905
+ # fails. Also used as the language of error messages created by actions,
14906
+ # regardless of language detection results.
14907
+ # Corresponds to the JSON property `preferredLanguageCode`
14908
+ # @return [String]
14909
+ attr_accessor :preferred_language_code
14910
+
14911
+ # Optional. IANA time zone, e.g. Europe/Budapest.
14912
+ # Corresponds to the JSON property `timeZone`
14913
+ # @return [String]
14914
+ attr_accessor :time_zone
14915
+
14916
+ def initialize(**args)
14917
+ update!(**args)
14918
+ end
14919
+
14920
+ # Update properties of this object
14921
+ def update!(**args)
14922
+ @preferred_language_code = args[:preferred_language_code] if args.key?(:preferred_language_code)
14923
+ @time_zone = args[:time_zone] if args.key?(:time_zone)
14924
+ end
14925
+ end
14926
+
14927
+ # Discovery Engine Assistant resource.
14928
+ class GoogleCloudDiscoveryengineV1betaAssistant
14929
+ include Google::Apis::Core::Hashable
14930
+
14931
+ # Immutable. Resource name of the assistant. Format: `projects/`project`/
14932
+ # locations/`location`/collections/`collection`/engines/`engine`/assistants/`
14933
+ # assistant`` It must be a UTF-8 encoded string with a length limit of 1024
14934
+ # characters.
14935
+ # Corresponds to the JSON property `name`
14936
+ # @return [String]
14937
+ attr_accessor :name
14938
+
14939
+ def initialize(**args)
14940
+ update!(**args)
14941
+ end
14942
+
14943
+ # Update properties of this object
14944
+ def update!(**args)
14945
+ @name = args[:name] if args.key?(:name)
14946
+ end
14947
+ end
14948
+
14949
+ # Multi-modal content.
14950
+ class GoogleCloudDiscoveryengineV1betaAssistantContent
14951
+ include Google::Apis::Core::Hashable
14952
+
14953
+ # Result of executing ExecutableCode.
14954
+ # Corresponds to the JSON property `codeExecutionResult`
14955
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistantContentCodeExecutionResult]
14956
+ attr_accessor :code_execution_result
14957
+
14958
+ # Code generated by the model that is meant to be executed by the model.
14959
+ # Corresponds to the JSON property `executableCode`
14960
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistantContentExecutableCode]
14961
+ attr_accessor :executable_code
14962
+
14963
+ # A file, e.g., an audio summary.
14964
+ # Corresponds to the JSON property `file`
14965
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistantContentFile]
14966
+ attr_accessor :file
14967
+
14968
+ # Inline blob.
14969
+ # Corresponds to the JSON property `inlineData`
14970
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistantContentBlob]
14971
+ attr_accessor :inline_data
14972
+
14973
+ # The producer of the content. Can be "model" or "user".
14974
+ # Corresponds to the JSON property `role`
14975
+ # @return [String]
14976
+ attr_accessor :role
14977
+
14978
+ # Inline text.
14979
+ # Corresponds to the JSON property `text`
14980
+ # @return [String]
14981
+ attr_accessor :text
14982
+
14983
+ # Optional. Indicates if the part is thought from the model.
14984
+ # Corresponds to the JSON property `thought`
14985
+ # @return [Boolean]
14986
+ attr_accessor :thought
14987
+ alias_method :thought?, :thought
14988
+
14989
+ def initialize(**args)
14990
+ update!(**args)
14991
+ end
14992
+
14993
+ # Update properties of this object
14994
+ def update!(**args)
14995
+ @code_execution_result = args[:code_execution_result] if args.key?(:code_execution_result)
14996
+ @executable_code = args[:executable_code] if args.key?(:executable_code)
14997
+ @file = args[:file] if args.key?(:file)
14998
+ @inline_data = args[:inline_data] if args.key?(:inline_data)
14999
+ @role = args[:role] if args.key?(:role)
15000
+ @text = args[:text] if args.key?(:text)
15001
+ @thought = args[:thought] if args.key?(:thought)
15002
+ end
15003
+ end
15004
+
15005
+ # Inline blob.
15006
+ class GoogleCloudDiscoveryengineV1betaAssistantContentBlob
15007
+ include Google::Apis::Core::Hashable
15008
+
15009
+ # Required. Raw bytes.
15010
+ # Corresponds to the JSON property `data`
15011
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
15012
+ # @return [String]
15013
+ attr_accessor :data
15014
+
15015
+ # Required. The media type (MIME type) of the generated data.
15016
+ # Corresponds to the JSON property `mimeType`
15017
+ # @return [String]
15018
+ attr_accessor :mime_type
15019
+
15020
+ def initialize(**args)
15021
+ update!(**args)
15022
+ end
15023
+
15024
+ # Update properties of this object
15025
+ def update!(**args)
15026
+ @data = args[:data] if args.key?(:data)
15027
+ @mime_type = args[:mime_type] if args.key?(:mime_type)
15028
+ end
15029
+ end
15030
+
15031
+ # Result of executing ExecutableCode.
15032
+ class GoogleCloudDiscoveryengineV1betaAssistantContentCodeExecutionResult
15033
+ include Google::Apis::Core::Hashable
15034
+
15035
+ # Required. Outcome of the code execution.
15036
+ # Corresponds to the JSON property `outcome`
15037
+ # @return [String]
15038
+ attr_accessor :outcome
15039
+
15040
+ # Optional. Contains stdout when code execution is successful, stderr or other
15041
+ # description otherwise.
15042
+ # Corresponds to the JSON property `output`
15043
+ # @return [String]
15044
+ attr_accessor :output
15045
+
15046
+ def initialize(**args)
15047
+ update!(**args)
15048
+ end
15049
+
15050
+ # Update properties of this object
15051
+ def update!(**args)
15052
+ @outcome = args[:outcome] if args.key?(:outcome)
15053
+ @output = args[:output] if args.key?(:output)
15054
+ end
15055
+ end
15056
+
15057
+ # Code generated by the model that is meant to be executed by the model.
15058
+ class GoogleCloudDiscoveryengineV1betaAssistantContentExecutableCode
15059
+ include Google::Apis::Core::Hashable
15060
+
15061
+ # Required. The code content. Currently only supports Python.
15062
+ # Corresponds to the JSON property `code`
15063
+ # @return [String]
15064
+ attr_accessor :code
15065
+
15066
+ def initialize(**args)
15067
+ update!(**args)
15068
+ end
15069
+
15070
+ # Update properties of this object
15071
+ def update!(**args)
15072
+ @code = args[:code] if args.key?(:code)
15073
+ end
15074
+ end
15075
+
15076
+ # A file, e.g., an audio summary.
15077
+ class GoogleCloudDiscoveryengineV1betaAssistantContentFile
15078
+ include Google::Apis::Core::Hashable
15079
+
15080
+ # Required. The file ID.
15081
+ # Corresponds to the JSON property `fileId`
15082
+ # @return [String]
15083
+ attr_accessor :file_id
15084
+
15085
+ # Required. The media type (MIME type) of the file.
15086
+ # Corresponds to the JSON property `mimeType`
15087
+ # @return [String]
15088
+ attr_accessor :mime_type
15089
+
15090
+ def initialize(**args)
15091
+ update!(**args)
15092
+ end
15093
+
15094
+ # Update properties of this object
15095
+ def update!(**args)
15096
+ @file_id = args[:file_id] if args.key?(:file_id)
15097
+ @mime_type = args[:mime_type] if args.key?(:mime_type)
15098
+ end
15099
+ end
15100
+
15101
+ # A piece of content and possibly its grounding information. Not all content
15102
+ # needs grounding. Phrases like "Of course, I will gladly search it for you." do
15103
+ # not need grounding.
15104
+ class GoogleCloudDiscoveryengineV1betaAssistantGroundedContent
15105
+ include Google::Apis::Core::Hashable
15106
+
15107
+ # Multi-modal content.
15108
+ # Corresponds to the JSON property `content`
15109
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistantContent]
15110
+ attr_accessor :content
15111
+
15112
+ # Grounding details for text sources.
15113
+ # Corresponds to the JSON property `textGroundingMetadata`
15114
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadata]
15115
+ attr_accessor :text_grounding_metadata
15116
+
15117
+ def initialize(**args)
15118
+ update!(**args)
15119
+ end
15120
+
15121
+ # Update properties of this object
15122
+ def update!(**args)
15123
+ @content = args[:content] if args.key?(:content)
15124
+ @text_grounding_metadata = args[:text_grounding_metadata] if args.key?(:text_grounding_metadata)
15125
+ end
15126
+ end
15127
+
15128
+ # Grounding details for text sources.
15129
+ class GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadata
15130
+ include Google::Apis::Core::Hashable
15131
+
15132
+ # References for the grounded text.
15133
+ # Corresponds to the JSON property `references`
15134
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataReference>]
15135
+ attr_accessor :references
15136
+
15137
+ # Grounding information for parts of the text.
15138
+ # Corresponds to the JSON property `segments`
15139
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataSegment>]
15140
+ attr_accessor :segments
15141
+
15142
+ def initialize(**args)
15143
+ update!(**args)
15144
+ end
15145
+
15146
+ # Update properties of this object
15147
+ def update!(**args)
15148
+ @references = args[:references] if args.key?(:references)
15149
+ @segments = args[:segments] if args.key?(:segments)
15150
+ end
15151
+ end
15152
+
15153
+ # Referenced content and related document metadata.
15154
+ class GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataReference
15155
+ include Google::Apis::Core::Hashable
15156
+
15157
+ # Referenced text content.
15158
+ # Corresponds to the JSON property `content`
15159
+ # @return [String]
15160
+ attr_accessor :content
15161
+
15162
+ # Document metadata.
15163
+ # Corresponds to the JSON property `documentMetadata`
15164
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata]
15165
+ attr_accessor :document_metadata
15166
+
15167
+ def initialize(**args)
15168
+ update!(**args)
15169
+ end
15170
+
15171
+ # Update properties of this object
15172
+ def update!(**args)
15173
+ @content = args[:content] if args.key?(:content)
15174
+ @document_metadata = args[:document_metadata] if args.key?(:document_metadata)
15175
+ end
15176
+ end
15177
+
15178
+ # Document metadata.
15179
+ class GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata
15180
+ include Google::Apis::Core::Hashable
15181
+
15182
+ # Document resource name.
15183
+ # Corresponds to the JSON property `document`
15184
+ # @return [String]
15185
+ attr_accessor :document
15186
+
15187
+ # Domain name from the document URI. Note that the `uri` field may contain a URL
15188
+ # that redirects to the actual website, in which case this will contain the
15189
+ # domain name of the target site.
15190
+ # Corresponds to the JSON property `domain`
15191
+ # @return [String]
15192
+ attr_accessor :domain
15193
+
15194
+ # Page identifier.
15195
+ # Corresponds to the JSON property `pageIdentifier`
15196
+ # @return [String]
15197
+ attr_accessor :page_identifier
15198
+
15199
+ # Title.
15200
+ # Corresponds to the JSON property `title`
15201
+ # @return [String]
15202
+ attr_accessor :title
15203
+
15204
+ # URI for the document. It may contain a URL that redirects to the actual
15205
+ # website.
15206
+ # Corresponds to the JSON property `uri`
15207
+ # @return [String]
15208
+ attr_accessor :uri
15209
+
15210
+ def initialize(**args)
15211
+ update!(**args)
15212
+ end
15213
+
15214
+ # Update properties of this object
15215
+ def update!(**args)
15216
+ @document = args[:document] if args.key?(:document)
15217
+ @domain = args[:domain] if args.key?(:domain)
15218
+ @page_identifier = args[:page_identifier] if args.key?(:page_identifier)
15219
+ @title = args[:title] if args.key?(:title)
15220
+ @uri = args[:uri] if args.key?(:uri)
15221
+ end
15222
+ end
15223
+
15224
+ # Grounding information for a segment of the text.
15225
+ class GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataSegment
15226
+ include Google::Apis::Core::Hashable
15227
+
15228
+ # End of the segment, exclusive.
15229
+ # Corresponds to the JSON property `endIndex`
15230
+ # @return [Fixnum]
15231
+ attr_accessor :end_index
15232
+
15233
+ # Score for the segment.
15234
+ # Corresponds to the JSON property `groundingScore`
15235
+ # @return [Float]
15236
+ attr_accessor :grounding_score
15237
+
15238
+ # References for the segment.
15239
+ # Corresponds to the JSON property `referenceIndices`
15240
+ # @return [Array<Fixnum>]
15241
+ attr_accessor :reference_indices
15242
+
15243
+ # Zero-based index indicating the start of the segment, measured in bytes of a
15244
+ # UTF-8 string (i.e. characters encoded on multiple bytes have a length of more
15245
+ # than one).
15246
+ # Corresponds to the JSON property `startIndex`
15247
+ # @return [Fixnum]
15248
+ attr_accessor :start_index
15249
+
15250
+ # The text segment itself.
15251
+ # Corresponds to the JSON property `text`
15252
+ # @return [String]
15253
+ attr_accessor :text
15254
+
15255
+ def initialize(**args)
15256
+ update!(**args)
15257
+ end
15258
+
15259
+ # Update properties of this object
15260
+ def update!(**args)
15261
+ @end_index = args[:end_index] if args.key?(:end_index)
15262
+ @grounding_score = args[:grounding_score] if args.key?(:grounding_score)
15263
+ @reference_indices = args[:reference_indices] if args.key?(:reference_indices)
15264
+ @start_index = args[:start_index] if args.key?(:start_index)
15265
+ @text = args[:text] if args.key?(:text)
15266
+ end
15267
+ end
15268
+
14800
15269
  # Metadata related to the progress of the SiteSearchEngineService.
14801
15270
  # BatchCreateTargetSites operation. This will be returned by the google.
14802
15271
  # longrunning.Operation.metadata field.
@@ -15815,14 +16284,14 @@ module Google
15815
16284
  attr_accessor :is_default
15816
16285
  alias_method :is_default?, :is_default
15817
16286
 
15818
- # KMS key resource name which will be used to encrypt resources `projects/`
15819
- # project`/locations/`location`/keyRings/`keyRing`/cryptoKeys/`keyId``.
16287
+ # Required. KMS key resource name which will be used to encrypt resources `
16288
+ # projects/`project`/locations/`location`/keyRings/`keyRing`/cryptoKeys/`keyId``.
15820
16289
  # Corresponds to the JSON property `kmsKey`
15821
16290
  # @return [String]
15822
16291
  attr_accessor :kms_key
15823
16292
 
15824
- # KMS key version resource name which will be used to encrypt resources `/
15825
- # cryptoKeyVersions/`keyVersion``.
16293
+ # Output only. KMS key version resource name which will be used to encrypt
16294
+ # resources `/cryptoKeyVersions/`keyVersion``.
15826
16295
  # Corresponds to the JSON property `kmsKeyVersion`
15827
16296
  # @return [String]
15828
16297
  attr_accessor :kms_key_version
@@ -17883,6 +18352,13 @@ module Google
17883
18352
  class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig
17884
18353
  include Google::Apis::Core::Hashable
17885
18354
 
18355
+ # Optional. If true, the processed document will be made available for the
18356
+ # GetProcessedDocument API.
18357
+ # Corresponds to the JSON property `enableGetProcessedDocument`
18358
+ # @return [Boolean]
18359
+ attr_accessor :enable_get_processed_document
18360
+ alias_method :enable_get_processed_document?, :enable_get_processed_document
18361
+
17886
18362
  # Optional. If true, the LLM based annotation is added to the image during
17887
18363
  # parsing.
17888
18364
  # Corresponds to the JSON property `enableImageAnnotation`
@@ -17924,6 +18400,7 @@ module Google
17924
18400
 
17925
18401
  # Update properties of this object
17926
18402
  def update!(**args)
18403
+ @enable_get_processed_document = args[:enable_get_processed_document] if args.key?(:enable_get_processed_document)
17927
18404
  @enable_image_annotation = args[:enable_image_annotation] if args.key?(:enable_image_annotation)
17928
18405
  @enable_table_annotation = args[:enable_table_annotation] if args.key?(:enable_table_annotation)
17929
18406
  @exclude_html_classes = args[:exclude_html_classes] if args.key?(:exclude_html_classes)
@@ -18104,7 +18581,8 @@ module Google
18104
18581
  # Supported keys: * `*`: all features, if it's present, all other feature state
18105
18582
  # settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-
18106
18583
  # gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-
18107
- # org-chart` * `bi-directional-audio` * `feedback` * `session-sharing`
18584
+ # org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `
18585
+ # personalization-memory` - Enables personalization based on user preferences.
18108
18586
  # Corresponds to the JSON property `features`
18109
18587
  # @return [Hash<String,String>]
18110
18588
  attr_accessor :features
@@ -19271,7 +19749,7 @@ module Google
19271
19749
  # GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an
19272
19750
  # INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema
19273
19751
  # must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. *
19274
- # SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.
19752
+ # SpannerSource. * CloudSqlSource. * BigtableSource.
19275
19753
  # Corresponds to the JSON property `idField`
19276
19754
  # @return [String]
19277
19755
  attr_accessor :id_field
@@ -20793,6 +21271,11 @@ module Google
20793
21271
  # @return [String]
20794
21272
  attr_accessor :data_use_terms_version
20795
21273
 
21274
+ # Parameters for Agentspace.
21275
+ # Corresponds to the JSON property `saasParams`
21276
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaProvisionProjectRequestSaasParams]
21277
+ attr_accessor :saas_params
21278
+
20796
21279
  def initialize(**args)
20797
21280
  update!(**args)
20798
21281
  end
@@ -20801,6 +21284,28 @@ module Google
20801
21284
  def update!(**args)
20802
21285
  @accept_data_use_terms = args[:accept_data_use_terms] if args.key?(:accept_data_use_terms)
20803
21286
  @data_use_terms_version = args[:data_use_terms_version] if args.key?(:data_use_terms_version)
21287
+ @saas_params = args[:saas_params] if args.key?(:saas_params)
21288
+ end
21289
+ end
21290
+
21291
+ # Parameters for Agentspace.
21292
+ class GoogleCloudDiscoveryengineV1betaProvisionProjectRequestSaasParams
21293
+ include Google::Apis::Core::Hashable
21294
+
21295
+ # Optional. Set to `true` to specify that caller has read and would like to give
21296
+ # consent to the [Terms for Agent Space quality of service].
21297
+ # Corresponds to the JSON property `acceptBizQos`
21298
+ # @return [Boolean]
21299
+ attr_accessor :accept_biz_qos
21300
+ alias_method :accept_biz_qos?, :accept_biz_qos
21301
+
21302
+ def initialize(**args)
21303
+ update!(**args)
21304
+ end
21305
+
21306
+ # Update properties of this object
21307
+ def update!(**args)
21308
+ @accept_biz_qos = args[:accept_biz_qos] if args.key?(:accept_biz_qos)
20804
21309
  end
20805
21310
  end
20806
21311
 
@@ -21278,7 +21783,7 @@ module Google
21278
21783
  # @return [String]
21279
21784
  attr_accessor :query
21280
21785
 
21281
- # Required. A list of records to rank. At most 200 records to rank.
21786
+ # Required. A list of records to rank.
21282
21787
  # Corresponds to the JSON property `records`
21283
21788
  # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRankingRecord>]
21284
21789
  attr_accessor :records
@@ -22390,21 +22895,17 @@ module Google
22390
22895
 
22391
22896
  # The session resource name. Optional. Session allows users to do multi-turn /
22392
22897
  # search API calls or coordination between /search API calls and /answer API
22393
- # calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the
22394
- # auto-session mode (see below). 2. Call /search API with the session ID
22395
- # generated in the first call. Here, the previous search query gets considered
22396
- # in query standing. I.e., if the first query is "How did Alphabet do in 2022?"
22397
- # and the current query is "How about 2023?", the current query will be
22398
- # interpreted as "How did Alphabet do in 2023?". Example #2 (coordination
22399
- # between /search API calls and /answer API calls): 1. Call /search API with the
22400
- # auto-session mode (see below). 2. Call /answer API with the session ID
22401
- # generated in the first call. Here, the answer generation happens in the
22402
- # context of the search results from the first search call. Auto-session mode:
22403
- # when `projects/.../sessions/-` is used, a new session gets automatically
22404
- # created. Otherwise, users can use the create-session API to create a session
22405
- # manually. Multi-turn Search feature is currently at private GA stage. Please
22406
- # use v1alpha or v1beta version instead before we launch this feature to public
22407
- # GA. Or ask for allowlisting through Google Support team.
22898
+ # calls. Example #1 (multi-turn /search API calls): Call /search API with the
22899
+ # session ID generated in the first call. Here, the previous search query gets
22900
+ # considered in query standing. I.e., if the first query is "How did Alphabet do
22901
+ # in 2022?" and the current query is "How about 2023?", the current query will
22902
+ # be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination
22903
+ # between /search API calls and /answer API calls): Call /answer API with the
22904
+ # session ID generated in the first call. Here, the answer generation happens in
22905
+ # the context of the search results from the first search call. Multi-turn
22906
+ # Search feature is currently at private GA stage. Please use v1alpha or v1beta
22907
+ # version instead before we launch this feature to public GA. Or ask for
22908
+ # allowlisting through Google Support team.
22408
22909
  # Corresponds to the JSON property `session`
22409
22910
  # @return [String]
22410
22911
  attr_accessor :session
@@ -25059,6 +25560,242 @@ module Google
25059
25560
  end
25060
25561
  end
25061
25562
 
25563
+ # Request for the AssistantService.StreamAssist method.
25564
+ class GoogleCloudDiscoveryengineV1betaStreamAssistRequest
25565
+ include Google::Apis::Core::Hashable
25566
+
25567
+ # Assistant generation specification for the request. This allows to override
25568
+ # the default generation configuration at the engine level.
25569
+ # Corresponds to the JSON property `generationSpec`
25570
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaStreamAssistRequestGenerationSpec]
25571
+ attr_accessor :generation_spec
25572
+
25573
+ # Defines a user inputed query.
25574
+ # Corresponds to the JSON property `query`
25575
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaQuery]
25576
+ attr_accessor :query
25577
+
25578
+ # Optional. The session to use for the request. If specified, the assistant has
25579
+ # access to the session history, and the query and the answer are stored there.
25580
+ # If `-` is specified as the session ID, or it is left empty, then a new session
25581
+ # is created with an automatically generated ID. Format: `projects/`project`/
25582
+ # locations/`location`/collections/`collection`/engines/`engine`/sessions/`
25583
+ # session``
25584
+ # Corresponds to the JSON property `session`
25585
+ # @return [String]
25586
+ attr_accessor :session
25587
+
25588
+ # Specification of tools that are used to serve the request.
25589
+ # Corresponds to the JSON property `toolsSpec`
25590
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpec]
25591
+ attr_accessor :tools_spec
25592
+
25593
+ # User metadata of the request.
25594
+ # Corresponds to the JSON property `userMetadata`
25595
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistUserMetadata]
25596
+ attr_accessor :user_metadata
25597
+
25598
+ def initialize(**args)
25599
+ update!(**args)
25600
+ end
25601
+
25602
+ # Update properties of this object
25603
+ def update!(**args)
25604
+ @generation_spec = args[:generation_spec] if args.key?(:generation_spec)
25605
+ @query = args[:query] if args.key?(:query)
25606
+ @session = args[:session] if args.key?(:session)
25607
+ @tools_spec = args[:tools_spec] if args.key?(:tools_spec)
25608
+ @user_metadata = args[:user_metadata] if args.key?(:user_metadata)
25609
+ end
25610
+ end
25611
+
25612
+ # Assistant generation specification for the request. This allows to override
25613
+ # the default generation configuration at the engine level.
25614
+ class GoogleCloudDiscoveryengineV1betaStreamAssistRequestGenerationSpec
25615
+ include Google::Apis::Core::Hashable
25616
+
25617
+ # Optional. The Vertex AI model_id used for the generative model. If not set,
25618
+ # the default Assistant model will be used.
25619
+ # Corresponds to the JSON property `modelId`
25620
+ # @return [String]
25621
+ attr_accessor :model_id
25622
+
25623
+ def initialize(**args)
25624
+ update!(**args)
25625
+ end
25626
+
25627
+ # Update properties of this object
25628
+ def update!(**args)
25629
+ @model_id = args[:model_id] if args.key?(:model_id)
25630
+ end
25631
+ end
25632
+
25633
+ # Specification of tools that are used to serve the request.
25634
+ class GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpec
25635
+ include Google::Apis::Core::Hashable
25636
+
25637
+ # Specification of the image generation tool.
25638
+ # Corresponds to the JSON property `imageGenerationSpec`
25639
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecImageGenerationSpec]
25640
+ attr_accessor :image_generation_spec
25641
+
25642
+ # Specification of the Vertex AI Search tool.
25643
+ # Corresponds to the JSON property `vertexAiSearchSpec`
25644
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecVertexAiSearchSpec]
25645
+ attr_accessor :vertex_ai_search_spec
25646
+
25647
+ # Specification of the video generation tool.
25648
+ # Corresponds to the JSON property `videoGenerationSpec`
25649
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecVideoGenerationSpec]
25650
+ attr_accessor :video_generation_spec
25651
+
25652
+ # Specification of the web grounding tool.
25653
+ # Corresponds to the JSON property `webGroundingSpec`
25654
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecWebGroundingSpec]
25655
+ attr_accessor :web_grounding_spec
25656
+
25657
+ def initialize(**args)
25658
+ update!(**args)
25659
+ end
25660
+
25661
+ # Update properties of this object
25662
+ def update!(**args)
25663
+ @image_generation_spec = args[:image_generation_spec] if args.key?(:image_generation_spec)
25664
+ @vertex_ai_search_spec = args[:vertex_ai_search_spec] if args.key?(:vertex_ai_search_spec)
25665
+ @video_generation_spec = args[:video_generation_spec] if args.key?(:video_generation_spec)
25666
+ @web_grounding_spec = args[:web_grounding_spec] if args.key?(:web_grounding_spec)
25667
+ end
25668
+ end
25669
+
25670
+ # Specification of the image generation tool.
25671
+ class GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecImageGenerationSpec
25672
+ include Google::Apis::Core::Hashable
25673
+
25674
+ def initialize(**args)
25675
+ update!(**args)
25676
+ end
25677
+
25678
+ # Update properties of this object
25679
+ def update!(**args)
25680
+ end
25681
+ end
25682
+
25683
+ # Specification of the Vertex AI Search tool.
25684
+ class GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecVertexAiSearchSpec
25685
+ include Google::Apis::Core::Hashable
25686
+
25687
+ # Optional. Specs defining DataStores to filter on in a search call and
25688
+ # configurations for those data stores. This is only considered for Engines with
25689
+ # multiple data stores.
25690
+ # Corresponds to the JSON property `dataStoreSpecs`
25691
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec>]
25692
+ attr_accessor :data_store_specs
25693
+
25694
+ # Optional. The filter syntax consists of an expression language for
25695
+ # constructing a predicate from one or more fields of the documents being
25696
+ # filtered. Filter expression is case-sensitive. If this field is unrecognizable,
25697
+ # an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by
25698
+ # mapping the LHS filter key to a key property defined in the Vertex AI Search
25699
+ # backend -- this mapping is defined by the customer in their schema. For
25700
+ # example a media customer might have a field 'name' in their schema. In this
25701
+ # case the filter would look like this: filter --> name:'ANY("king kong")' For
25702
+ # more information about filtering including syntax and filter operators, see [
25703
+ # Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-
25704
+ # metadata)
25705
+ # Corresponds to the JSON property `filter`
25706
+ # @return [String]
25707
+ attr_accessor :filter
25708
+
25709
+ def initialize(**args)
25710
+ update!(**args)
25711
+ end
25712
+
25713
+ # Update properties of this object
25714
+ def update!(**args)
25715
+ @data_store_specs = args[:data_store_specs] if args.key?(:data_store_specs)
25716
+ @filter = args[:filter] if args.key?(:filter)
25717
+ end
25718
+ end
25719
+
25720
+ # Specification of the video generation tool.
25721
+ class GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecVideoGenerationSpec
25722
+ include Google::Apis::Core::Hashable
25723
+
25724
+ def initialize(**args)
25725
+ update!(**args)
25726
+ end
25727
+
25728
+ # Update properties of this object
25729
+ def update!(**args)
25730
+ end
25731
+ end
25732
+
25733
+ # Specification of the web grounding tool.
25734
+ class GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecWebGroundingSpec
25735
+ include Google::Apis::Core::Hashable
25736
+
25737
+ def initialize(**args)
25738
+ update!(**args)
25739
+ end
25740
+
25741
+ # Update properties of this object
25742
+ def update!(**args)
25743
+ end
25744
+ end
25745
+
25746
+ # Response for the AssistantService.StreamAssist method.
25747
+ class GoogleCloudDiscoveryengineV1betaStreamAssistResponse
25748
+ include Google::Apis::Core::Hashable
25749
+
25750
+ # AssistAnswer resource, main part of AssistResponse.
25751
+ # Corresponds to the JSON property `answer`
25752
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistAnswer]
25753
+ attr_accessor :answer
25754
+
25755
+ # A global unique ID that identifies the current pair of request and stream of
25756
+ # responses. Used for feedback and support.
25757
+ # Corresponds to the JSON property `assistToken`
25758
+ # @return [String]
25759
+ attr_accessor :assist_token
25760
+
25761
+ # Information about the session.
25762
+ # Corresponds to the JSON property `sessionInfo`
25763
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaStreamAssistResponseSessionInfo]
25764
+ attr_accessor :session_info
25765
+
25766
+ def initialize(**args)
25767
+ update!(**args)
25768
+ end
25769
+
25770
+ # Update properties of this object
25771
+ def update!(**args)
25772
+ @answer = args[:answer] if args.key?(:answer)
25773
+ @assist_token = args[:assist_token] if args.key?(:assist_token)
25774
+ @session_info = args[:session_info] if args.key?(:session_info)
25775
+ end
25776
+ end
25777
+
25778
+ # Information about the session.
25779
+ class GoogleCloudDiscoveryengineV1betaStreamAssistResponseSessionInfo
25780
+ include Google::Apis::Core::Hashable
25781
+
25782
+ # Name of the newly generated or continued session. Format: `projects/`project`/
25783
+ # locations/`location`/collections/`collection`/engines/`engine`/sessions/`
25784
+ # session``.
25785
+ # Corresponds to the JSON property `session`
25786
+ # @return [String]
25787
+ attr_accessor :session
25788
+
25789
+ def initialize(**args)
25790
+ update!(**args)
25791
+ end
25792
+
25793
+ # Update properties of this object
25794
+ def update!(**args)
25795
+ @session = args[:session] if args.key?(:session)
25796
+ end
25797
+ end
25798
+
25062
25799
  # Suggestion deny list entry identifying the phrase to block from suggestions
25063
25800
  # and the applied operation for the phrase.
25064
25801
  class GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry