google-apis-discoveryengine_v1beta 0.72.0 → 0.74.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.
@@ -2194,6 +2194,13 @@ module Google
2194
2194
  class GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig
2195
2195
  include Google::Apis::Core::Hashable
2196
2196
 
2197
+ # Optional. If true, the processed document will be made available for the
2198
+ # GetProcessedDocument API.
2199
+ # Corresponds to the JSON property `enableGetProcessedDocument`
2200
+ # @return [Boolean]
2201
+ attr_accessor :enable_get_processed_document
2202
+ alias_method :enable_get_processed_document?, :enable_get_processed_document
2203
+
2197
2204
  # Optional. If true, the LLM based annotation is added to the image during
2198
2205
  # parsing.
2199
2206
  # Corresponds to the JSON property `enableImageAnnotation`
@@ -2235,6 +2242,7 @@ module Google
2235
2242
 
2236
2243
  # Update properties of this object
2237
2244
  def update!(**args)
2245
+ @enable_get_processed_document = args[:enable_get_processed_document] if args.key?(:enable_get_processed_document)
2238
2246
  @enable_image_annotation = args[:enable_image_annotation] if args.key?(:enable_image_annotation)
2239
2247
  @enable_table_annotation = args[:enable_table_annotation] if args.key?(:enable_table_annotation)
2240
2248
  @exclude_html_classes = args[:exclude_html_classes] if args.key?(:exclude_html_classes)
@@ -2364,7 +2372,8 @@ module Google
2364
2372
  # Supported keys: * `*`: all features, if it's present, all other feature state
2365
2373
  # settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-
2366
2374
  # gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-
2367
- # org-chart` * `bi-directional-audio` * `feedback` * `session-sharing`
2375
+ # org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `
2376
+ # personalization-memory` - Enables personalization based on user preferences.
2368
2377
  # Corresponds to the JSON property `features`
2369
2378
  # @return [Hash<String,String>]
2370
2379
  attr_accessor :features
@@ -6862,6 +6871,11 @@ module Google
6862
6871
  # @return [String]
6863
6872
  attr_accessor :realtime_sync_secret
6864
6873
 
6874
+ # Streaming error details.
6875
+ # Corresponds to the JSON property `streamingError`
6876
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError]
6877
+ attr_accessor :streaming_error
6878
+
6865
6879
  # Optional. Webhook url for the connector to specify additional params for
6866
6880
  # realtime sync.
6867
6881
  # Corresponds to the JSON property `webhookUri`
@@ -6875,10 +6889,41 @@ module Google
6875
6889
  # Update properties of this object
6876
6890
  def update!(**args)
6877
6891
  @realtime_sync_secret = args[:realtime_sync_secret] if args.key?(:realtime_sync_secret)
6892
+ @streaming_error = args[:streaming_error] if args.key?(:streaming_error)
6878
6893
  @webhook_uri = args[:webhook_uri] if args.key?(:webhook_uri)
6879
6894
  end
6880
6895
  end
6881
6896
 
6897
+ # Streaming error details.
6898
+ class GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfigStreamingError
6899
+ include Google::Apis::Core::Hashable
6900
+
6901
+ # The `Status` type defines a logical error model that is suitable for different
6902
+ # programming environments, including REST APIs and RPC APIs. It is used by [
6903
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
6904
+ # data: error code, error message, and error details. You can find out more
6905
+ # about this error model and how to work with it in the [API Design Guide](https:
6906
+ # //cloud.google.com/apis/design/errors).
6907
+ # Corresponds to the JSON property `error`
6908
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus]
6909
+ attr_accessor :error
6910
+
6911
+ # Optional. Streaming error.
6912
+ # Corresponds to the JSON property `streamingErrorReason`
6913
+ # @return [String]
6914
+ attr_accessor :streaming_error_reason
6915
+
6916
+ def initialize(**args)
6917
+ update!(**args)
6918
+ end
6919
+
6920
+ # Update properties of this object
6921
+ def update!(**args)
6922
+ @error = args[:error] if args.key?(:error)
6923
+ @streaming_error_reason = args[:streaming_error_reason] if args.key?(:streaming_error_reason)
6924
+ end
6925
+ end
6926
+
6882
6927
  # Represents an entity in the data source. For example, the `Account` object in
6883
6928
  # Salesforce.
6884
6929
  class GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity
@@ -7702,6 +7747,13 @@ module Google
7702
7747
  class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig
7703
7748
  include Google::Apis::Core::Hashable
7704
7749
 
7750
+ # Optional. If true, the processed document will be made available for the
7751
+ # GetProcessedDocument API.
7752
+ # Corresponds to the JSON property `enableGetProcessedDocument`
7753
+ # @return [Boolean]
7754
+ attr_accessor :enable_get_processed_document
7755
+ alias_method :enable_get_processed_document?, :enable_get_processed_document
7756
+
7705
7757
  # Optional. If true, the LLM based annotation is added to the image during
7706
7758
  # parsing.
7707
7759
  # Corresponds to the JSON property `enableImageAnnotation`
@@ -7743,6 +7795,7 @@ module Google
7743
7795
 
7744
7796
  # Update properties of this object
7745
7797
  def update!(**args)
7798
+ @enable_get_processed_document = args[:enable_get_processed_document] if args.key?(:enable_get_processed_document)
7746
7799
  @enable_image_annotation = args[:enable_image_annotation] if args.key?(:enable_image_annotation)
7747
7800
  @enable_table_annotation = args[:enable_table_annotation] if args.key?(:enable_table_annotation)
7748
7801
  @exclude_html_classes = args[:exclude_html_classes] if args.key?(:exclude_html_classes)
@@ -7872,7 +7925,8 @@ module Google
7872
7925
  # Supported keys: * `*`: all features, if it's present, all other feature state
7873
7926
  # settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-
7874
7927
  # gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-
7875
- # org-chart` * `bi-directional-audio` * `feedback` * `session-sharing`
7928
+ # org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `
7929
+ # personalization-memory` - Enables personalization based on user preferences.
7876
7930
  # Corresponds to the JSON property `features`
7877
7931
  # @return [Hash<String,String>]
7878
7932
  attr_accessor :features
@@ -9306,7 +9360,8 @@ module Google
9306
9360
  include Google::Apis::Core::Hashable
9307
9361
 
9308
9362
  # A filter to apply on the list results. The supported features are:
9309
- # user_pseudo_id, state. Example: "user_pseudo_id = some_id"
9363
+ # user_pseudo_id, state, starred. Examples: "user_pseudo_id = some_id" "starred =
9364
+ # true"
9310
9365
  # Corresponds to the JSON property `filter`
9311
9366
  # @return [String]
9312
9367
  attr_accessor :filter
@@ -10507,10 +10562,11 @@ module Google
10507
10562
  # relevance and attractiveness of a search result from a user's perspective. A
10508
10563
  # higher pCTR suggests that the result is more likely to satisfy the user's
10509
10564
  # query and intent, making it a valuable signal for ranking. * `freshness_rank`:
10510
- # freshness adjustment as a rank * `topicality_rank`: topicality adjustment as a
10511
- # rank. Uses proprietary Google model to determine the keyword-based overlap
10512
- # between the query and the document. * `base_rank`: the default rank of the
10513
- # result
10565
+ # freshness adjustment as a rank * `document_age`: The time in hours elapsed
10566
+ # since the document was last updated, a floating-point number (e.g., 0.25 means
10567
+ # 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses
10568
+ # proprietary Google model to determine the keyword-based overlap between the
10569
+ # query and the document. * `base_rank`: the default rank of the result
10514
10570
  # Corresponds to the JSON property `rankingExpression`
10515
10571
  # @return [String]
10516
10572
  attr_accessor :ranking_expression
@@ -10564,21 +10620,17 @@ module Google
10564
10620
 
10565
10621
  # The session resource name. Optional. Session allows users to do multi-turn /
10566
10622
  # search API calls or coordination between /search API calls and /answer API
10567
- # calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the
10568
- # auto-session mode (see below). 2. Call /search API with the session ID
10569
- # generated in the first call. Here, the previous search query gets considered
10570
- # in query standing. I.e., if the first query is "How did Alphabet do in 2022?"
10571
- # and the current query is "How about 2023?", the current query will be
10572
- # interpreted as "How did Alphabet do in 2023?". Example #2 (coordination
10573
- # between /search API calls and /answer API calls): 1. Call /search API with the
10574
- # auto-session mode (see below). 2. Call /answer API with the session ID
10575
- # generated in the first call. Here, the answer generation happens in the
10576
- # context of the search results from the first search call. Auto-session mode:
10577
- # when `projects/.../sessions/-` is used, a new session gets automatically
10578
- # created. Otherwise, users can use the create-session API to create a session
10579
- # manually. Multi-turn Search feature is currently at private GA stage. Please
10580
- # use v1alpha or v1beta version instead before we launch this feature to public
10581
- # GA. Or ask for allowlisting through Google Support team.
10623
+ # calls. Example #1 (multi-turn /search API calls): Call /search API with the
10624
+ # session ID generated in the first call. Here, the previous search query gets
10625
+ # considered in query standing. I.e., if the first query is "How did Alphabet do
10626
+ # in 2022?" and the current query is "How about 2023?", the current query will
10627
+ # be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination
10628
+ # between /search API calls and /answer API calls): Call /answer API with the
10629
+ # session ID generated in the first call. Here, the answer generation happens in
10630
+ # the context of the search results from the first search call. Multi-turn
10631
+ # Search feature is currently at private GA stage. Please use v1alpha or v1beta
10632
+ # version instead before we launch this feature to public GA. Or ask for
10633
+ # allowlisting through Google Support team.
10582
10634
  # Corresponds to the JSON property `session`
10583
10635
  # @return [String]
10584
10636
  attr_accessor :session
@@ -14759,6 +14811,405 @@ module Google
14759
14811
  end
14760
14812
  end
14761
14813
 
14814
+ # AssistAnswer resource, main part of AssistResponse.
14815
+ class GoogleCloudDiscoveryengineV1betaAssistAnswer
14816
+ include Google::Apis::Core::Hashable
14817
+
14818
+ # Reasons for not answering the assist call.
14819
+ # Corresponds to the JSON property `assistSkippedReasons`
14820
+ # @return [Array<String>]
14821
+ attr_accessor :assist_skipped_reasons
14822
+
14823
+ # Replies of the assistant.
14824
+ # Corresponds to the JSON property `replies`
14825
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistAnswerReply>]
14826
+ attr_accessor :replies
14827
+
14828
+ # State of the answer generation.
14829
+ # Corresponds to the JSON property `state`
14830
+ # @return [String]
14831
+ attr_accessor :state
14832
+
14833
+ def initialize(**args)
14834
+ update!(**args)
14835
+ end
14836
+
14837
+ # Update properties of this object
14838
+ def update!(**args)
14839
+ @assist_skipped_reasons = args[:assist_skipped_reasons] if args.key?(:assist_skipped_reasons)
14840
+ @replies = args[:replies] if args.key?(:replies)
14841
+ @state = args[:state] if args.key?(:state)
14842
+ end
14843
+ end
14844
+
14845
+ # One part of the multi-part response of the assist call.
14846
+ class GoogleCloudDiscoveryengineV1betaAssistAnswerReply
14847
+ include Google::Apis::Core::Hashable
14848
+
14849
+ # A piece of content and possibly its grounding information. Not all content
14850
+ # needs grounding. Phrases like "Of course, I will gladly search it for you." do
14851
+ # not need grounding.
14852
+ # Corresponds to the JSON property `groundedContent`
14853
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistantGroundedContent]
14854
+ attr_accessor :grounded_content
14855
+
14856
+ def initialize(**args)
14857
+ update!(**args)
14858
+ end
14859
+
14860
+ # Update properties of this object
14861
+ def update!(**args)
14862
+ @grounded_content = args[:grounded_content] if args.key?(:grounded_content)
14863
+ end
14864
+ end
14865
+
14866
+ # User metadata of the request.
14867
+ class GoogleCloudDiscoveryengineV1betaAssistUserMetadata
14868
+ include Google::Apis::Core::Hashable
14869
+
14870
+ # Optional. Preferred language to be used for answering if language detection
14871
+ # fails. Also used as the language of error messages created by actions,
14872
+ # regardless of language detection results.
14873
+ # Corresponds to the JSON property `preferredLanguageCode`
14874
+ # @return [String]
14875
+ attr_accessor :preferred_language_code
14876
+
14877
+ # Optional. IANA time zone, e.g. Europe/Budapest.
14878
+ # Corresponds to the JSON property `timeZone`
14879
+ # @return [String]
14880
+ attr_accessor :time_zone
14881
+
14882
+ def initialize(**args)
14883
+ update!(**args)
14884
+ end
14885
+
14886
+ # Update properties of this object
14887
+ def update!(**args)
14888
+ @preferred_language_code = args[:preferred_language_code] if args.key?(:preferred_language_code)
14889
+ @time_zone = args[:time_zone] if args.key?(:time_zone)
14890
+ end
14891
+ end
14892
+
14893
+ # Multi-modal content.
14894
+ class GoogleCloudDiscoveryengineV1betaAssistantContent
14895
+ include Google::Apis::Core::Hashable
14896
+
14897
+ # Result of executing ExecutableCode.
14898
+ # Corresponds to the JSON property `codeExecutionResult`
14899
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistantContentCodeExecutionResult]
14900
+ attr_accessor :code_execution_result
14901
+
14902
+ # Code generated by the model that is meant to be executed by the model.
14903
+ # Corresponds to the JSON property `executableCode`
14904
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistantContentExecutableCode]
14905
+ attr_accessor :executable_code
14906
+
14907
+ # A file, e.g., an audio summary.
14908
+ # Corresponds to the JSON property `file`
14909
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistantContentFile]
14910
+ attr_accessor :file
14911
+
14912
+ # Inline blob.
14913
+ # Corresponds to the JSON property `inlineData`
14914
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistantContentBlob]
14915
+ attr_accessor :inline_data
14916
+
14917
+ # The producer of the content. Can be "model" or "user".
14918
+ # Corresponds to the JSON property `role`
14919
+ # @return [String]
14920
+ attr_accessor :role
14921
+
14922
+ # Inline text.
14923
+ # Corresponds to the JSON property `text`
14924
+ # @return [String]
14925
+ attr_accessor :text
14926
+
14927
+ # Optional. Indicates if the part is thought from the model.
14928
+ # Corresponds to the JSON property `thought`
14929
+ # @return [Boolean]
14930
+ attr_accessor :thought
14931
+ alias_method :thought?, :thought
14932
+
14933
+ def initialize(**args)
14934
+ update!(**args)
14935
+ end
14936
+
14937
+ # Update properties of this object
14938
+ def update!(**args)
14939
+ @code_execution_result = args[:code_execution_result] if args.key?(:code_execution_result)
14940
+ @executable_code = args[:executable_code] if args.key?(:executable_code)
14941
+ @file = args[:file] if args.key?(:file)
14942
+ @inline_data = args[:inline_data] if args.key?(:inline_data)
14943
+ @role = args[:role] if args.key?(:role)
14944
+ @text = args[:text] if args.key?(:text)
14945
+ @thought = args[:thought] if args.key?(:thought)
14946
+ end
14947
+ end
14948
+
14949
+ # Inline blob.
14950
+ class GoogleCloudDiscoveryengineV1betaAssistantContentBlob
14951
+ include Google::Apis::Core::Hashable
14952
+
14953
+ # Required. Raw bytes.
14954
+ # Corresponds to the JSON property `data`
14955
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
14956
+ # @return [String]
14957
+ attr_accessor :data
14958
+
14959
+ # Required. The media type (MIME type) of the generated data.
14960
+ # Corresponds to the JSON property `mimeType`
14961
+ # @return [String]
14962
+ attr_accessor :mime_type
14963
+
14964
+ def initialize(**args)
14965
+ update!(**args)
14966
+ end
14967
+
14968
+ # Update properties of this object
14969
+ def update!(**args)
14970
+ @data = args[:data] if args.key?(:data)
14971
+ @mime_type = args[:mime_type] if args.key?(:mime_type)
14972
+ end
14973
+ end
14974
+
14975
+ # Result of executing ExecutableCode.
14976
+ class GoogleCloudDiscoveryengineV1betaAssistantContentCodeExecutionResult
14977
+ include Google::Apis::Core::Hashable
14978
+
14979
+ # Required. Outcome of the code execution.
14980
+ # Corresponds to the JSON property `outcome`
14981
+ # @return [String]
14982
+ attr_accessor :outcome
14983
+
14984
+ # Optional. Contains stdout when code execution is successful, stderr or other
14985
+ # description otherwise.
14986
+ # Corresponds to the JSON property `output`
14987
+ # @return [String]
14988
+ attr_accessor :output
14989
+
14990
+ def initialize(**args)
14991
+ update!(**args)
14992
+ end
14993
+
14994
+ # Update properties of this object
14995
+ def update!(**args)
14996
+ @outcome = args[:outcome] if args.key?(:outcome)
14997
+ @output = args[:output] if args.key?(:output)
14998
+ end
14999
+ end
15000
+
15001
+ # Code generated by the model that is meant to be executed by the model.
15002
+ class GoogleCloudDiscoveryengineV1betaAssistantContentExecutableCode
15003
+ include Google::Apis::Core::Hashable
15004
+
15005
+ # Required. The code content. Currently only supports Python.
15006
+ # Corresponds to the JSON property `code`
15007
+ # @return [String]
15008
+ attr_accessor :code
15009
+
15010
+ def initialize(**args)
15011
+ update!(**args)
15012
+ end
15013
+
15014
+ # Update properties of this object
15015
+ def update!(**args)
15016
+ @code = args[:code] if args.key?(:code)
15017
+ end
15018
+ end
15019
+
15020
+ # A file, e.g., an audio summary.
15021
+ class GoogleCloudDiscoveryengineV1betaAssistantContentFile
15022
+ include Google::Apis::Core::Hashable
15023
+
15024
+ # Required. The file ID.
15025
+ # Corresponds to the JSON property `fileId`
15026
+ # @return [String]
15027
+ attr_accessor :file_id
15028
+
15029
+ # Required. The media type (MIME type) of the file.
15030
+ # Corresponds to the JSON property `mimeType`
15031
+ # @return [String]
15032
+ attr_accessor :mime_type
15033
+
15034
+ def initialize(**args)
15035
+ update!(**args)
15036
+ end
15037
+
15038
+ # Update properties of this object
15039
+ def update!(**args)
15040
+ @file_id = args[:file_id] if args.key?(:file_id)
15041
+ @mime_type = args[:mime_type] if args.key?(:mime_type)
15042
+ end
15043
+ end
15044
+
15045
+ # A piece of content and possibly its grounding information. Not all content
15046
+ # needs grounding. Phrases like "Of course, I will gladly search it for you." do
15047
+ # not need grounding.
15048
+ class GoogleCloudDiscoveryengineV1betaAssistantGroundedContent
15049
+ include Google::Apis::Core::Hashable
15050
+
15051
+ # Multi-modal content.
15052
+ # Corresponds to the JSON property `content`
15053
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistantContent]
15054
+ attr_accessor :content
15055
+
15056
+ # Grounding details for text sources.
15057
+ # Corresponds to the JSON property `textGroundingMetadata`
15058
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadata]
15059
+ attr_accessor :text_grounding_metadata
15060
+
15061
+ def initialize(**args)
15062
+ update!(**args)
15063
+ end
15064
+
15065
+ # Update properties of this object
15066
+ def update!(**args)
15067
+ @content = args[:content] if args.key?(:content)
15068
+ @text_grounding_metadata = args[:text_grounding_metadata] if args.key?(:text_grounding_metadata)
15069
+ end
15070
+ end
15071
+
15072
+ # Grounding details for text sources.
15073
+ class GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadata
15074
+ include Google::Apis::Core::Hashable
15075
+
15076
+ # References for the grounded text.
15077
+ # Corresponds to the JSON property `references`
15078
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataReference>]
15079
+ attr_accessor :references
15080
+
15081
+ # Grounding information for parts of the text.
15082
+ # Corresponds to the JSON property `segments`
15083
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataSegment>]
15084
+ attr_accessor :segments
15085
+
15086
+ def initialize(**args)
15087
+ update!(**args)
15088
+ end
15089
+
15090
+ # Update properties of this object
15091
+ def update!(**args)
15092
+ @references = args[:references] if args.key?(:references)
15093
+ @segments = args[:segments] if args.key?(:segments)
15094
+ end
15095
+ end
15096
+
15097
+ # Referenced content and related document metadata.
15098
+ class GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataReference
15099
+ include Google::Apis::Core::Hashable
15100
+
15101
+ # Referenced text content.
15102
+ # Corresponds to the JSON property `content`
15103
+ # @return [String]
15104
+ attr_accessor :content
15105
+
15106
+ # Document metadata.
15107
+ # Corresponds to the JSON property `documentMetadata`
15108
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata]
15109
+ attr_accessor :document_metadata
15110
+
15111
+ def initialize(**args)
15112
+ update!(**args)
15113
+ end
15114
+
15115
+ # Update properties of this object
15116
+ def update!(**args)
15117
+ @content = args[:content] if args.key?(:content)
15118
+ @document_metadata = args[:document_metadata] if args.key?(:document_metadata)
15119
+ end
15120
+ end
15121
+
15122
+ # Document metadata.
15123
+ class GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata
15124
+ include Google::Apis::Core::Hashable
15125
+
15126
+ # Document resource name.
15127
+ # Corresponds to the JSON property `document`
15128
+ # @return [String]
15129
+ attr_accessor :document
15130
+
15131
+ # Domain name from the document URI. Note that the `uri` field may contain a URL
15132
+ # that redirects to the actual website, in which case this will contain the
15133
+ # domain name of the target site.
15134
+ # Corresponds to the JSON property `domain`
15135
+ # @return [String]
15136
+ attr_accessor :domain
15137
+
15138
+ # Page identifier.
15139
+ # Corresponds to the JSON property `pageIdentifier`
15140
+ # @return [String]
15141
+ attr_accessor :page_identifier
15142
+
15143
+ # Title.
15144
+ # Corresponds to the JSON property `title`
15145
+ # @return [String]
15146
+ attr_accessor :title
15147
+
15148
+ # URI for the document. It may contain a URL that redirects to the actual
15149
+ # website.
15150
+ # Corresponds to the JSON property `uri`
15151
+ # @return [String]
15152
+ attr_accessor :uri
15153
+
15154
+ def initialize(**args)
15155
+ update!(**args)
15156
+ end
15157
+
15158
+ # Update properties of this object
15159
+ def update!(**args)
15160
+ @document = args[:document] if args.key?(:document)
15161
+ @domain = args[:domain] if args.key?(:domain)
15162
+ @page_identifier = args[:page_identifier] if args.key?(:page_identifier)
15163
+ @title = args[:title] if args.key?(:title)
15164
+ @uri = args[:uri] if args.key?(:uri)
15165
+ end
15166
+ end
15167
+
15168
+ # Grounding information for a segment of the text.
15169
+ class GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataSegment
15170
+ include Google::Apis::Core::Hashable
15171
+
15172
+ # End of the segment, exclusive.
15173
+ # Corresponds to the JSON property `endIndex`
15174
+ # @return [Fixnum]
15175
+ attr_accessor :end_index
15176
+
15177
+ # Score for the segment.
15178
+ # Corresponds to the JSON property `groundingScore`
15179
+ # @return [Float]
15180
+ attr_accessor :grounding_score
15181
+
15182
+ # References for the segment.
15183
+ # Corresponds to the JSON property `referenceIndices`
15184
+ # @return [Array<Fixnum>]
15185
+ attr_accessor :reference_indices
15186
+
15187
+ # Zero-based index indicating the start of the segment, measured in bytes of a
15188
+ # UTF-8 string (i.e. characters encoded on multiple bytes have a length of more
15189
+ # than one).
15190
+ # Corresponds to the JSON property `startIndex`
15191
+ # @return [Fixnum]
15192
+ attr_accessor :start_index
15193
+
15194
+ # The text segment itself.
15195
+ # Corresponds to the JSON property `text`
15196
+ # @return [String]
15197
+ attr_accessor :text
15198
+
15199
+ def initialize(**args)
15200
+ update!(**args)
15201
+ end
15202
+
15203
+ # Update properties of this object
15204
+ def update!(**args)
15205
+ @end_index = args[:end_index] if args.key?(:end_index)
15206
+ @grounding_score = args[:grounding_score] if args.key?(:grounding_score)
15207
+ @reference_indices = args[:reference_indices] if args.key?(:reference_indices)
15208
+ @start_index = args[:start_index] if args.key?(:start_index)
15209
+ @text = args[:text] if args.key?(:text)
15210
+ end
15211
+ end
15212
+
14762
15213
  # Metadata related to the progress of the SiteSearchEngineService.
14763
15214
  # BatchCreateTargetSites operation. This will be returned by the google.
14764
15215
  # longrunning.Operation.metadata field.
@@ -17845,6 +18296,13 @@ module Google
17845
18296
  class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig
17846
18297
  include Google::Apis::Core::Hashable
17847
18298
 
18299
+ # Optional. If true, the processed document will be made available for the
18300
+ # GetProcessedDocument API.
18301
+ # Corresponds to the JSON property `enableGetProcessedDocument`
18302
+ # @return [Boolean]
18303
+ attr_accessor :enable_get_processed_document
18304
+ alias_method :enable_get_processed_document?, :enable_get_processed_document
18305
+
17848
18306
  # Optional. If true, the LLM based annotation is added to the image during
17849
18307
  # parsing.
17850
18308
  # Corresponds to the JSON property `enableImageAnnotation`
@@ -17886,6 +18344,7 @@ module Google
17886
18344
 
17887
18345
  # Update properties of this object
17888
18346
  def update!(**args)
18347
+ @enable_get_processed_document = args[:enable_get_processed_document] if args.key?(:enable_get_processed_document)
17889
18348
  @enable_image_annotation = args[:enable_image_annotation] if args.key?(:enable_image_annotation)
17890
18349
  @enable_table_annotation = args[:enable_table_annotation] if args.key?(:enable_table_annotation)
17891
18350
  @exclude_html_classes = args[:exclude_html_classes] if args.key?(:exclude_html_classes)
@@ -18066,7 +18525,8 @@ module Google
18066
18525
  # Supported keys: * `*`: all features, if it's present, all other feature state
18067
18526
  # settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-
18068
18527
  # gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-
18069
- # org-chart` * `bi-directional-audio` * `feedback` * `session-sharing`
18528
+ # org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `
18529
+ # personalization-memory` - Enables personalization based on user preferences.
18070
18530
  # Corresponds to the JSON property `features`
18071
18531
  # @return [Hash<String,String>]
18072
18532
  attr_accessor :features
@@ -19233,7 +19693,7 @@ module Google
19233
19693
  # GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an
19234
19694
  # INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema
19235
19695
  # must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. *
19236
- # SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.
19696
+ # SpannerSource. * CloudSqlSource. * BigtableSource.
19237
19697
  # Corresponds to the JSON property `idField`
19238
19698
  # @return [String]
19239
19699
  attr_accessor :id_field
@@ -22294,10 +22754,11 @@ module Google
22294
22754
  # relevance and attractiveness of a search result from a user's perspective. A
22295
22755
  # higher pCTR suggests that the result is more likely to satisfy the user's
22296
22756
  # query and intent, making it a valuable signal for ranking. * `freshness_rank`:
22297
- # freshness adjustment as a rank * `topicality_rank`: topicality adjustment as a
22298
- # rank. Uses proprietary Google model to determine the keyword-based overlap
22299
- # between the query and the document. * `base_rank`: the default rank of the
22300
- # result
22757
+ # freshness adjustment as a rank * `document_age`: The time in hours elapsed
22758
+ # since the document was last updated, a floating-point number (e.g., 0.25 means
22759
+ # 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses
22760
+ # proprietary Google model to determine the keyword-based overlap between the
22761
+ # query and the document. * `base_rank`: the default rank of the result
22301
22762
  # Corresponds to the JSON property `rankingExpression`
22302
22763
  # @return [String]
22303
22764
  attr_accessor :ranking_expression
@@ -22351,21 +22812,17 @@ module Google
22351
22812
 
22352
22813
  # The session resource name. Optional. Session allows users to do multi-turn /
22353
22814
  # search API calls or coordination between /search API calls and /answer API
22354
- # calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the
22355
- # auto-session mode (see below). 2. Call /search API with the session ID
22356
- # generated in the first call. Here, the previous search query gets considered
22357
- # in query standing. I.e., if the first query is "How did Alphabet do in 2022?"
22358
- # and the current query is "How about 2023?", the current query will be
22359
- # interpreted as "How did Alphabet do in 2023?". Example #2 (coordination
22360
- # between /search API calls and /answer API calls): 1. Call /search API with the
22361
- # auto-session mode (see below). 2. Call /answer API with the session ID
22362
- # generated in the first call. Here, the answer generation happens in the
22363
- # context of the search results from the first search call. Auto-session mode:
22364
- # when `projects/.../sessions/-` is used, a new session gets automatically
22365
- # created. Otherwise, users can use the create-session API to create a session
22366
- # manually. Multi-turn Search feature is currently at private GA stage. Please
22367
- # use v1alpha or v1beta version instead before we launch this feature to public
22368
- # GA. Or ask for allowlisting through Google Support team.
22815
+ # calls. Example #1 (multi-turn /search API calls): Call /search API with the
22816
+ # session ID generated in the first call. Here, the previous search query gets
22817
+ # considered in query standing. I.e., if the first query is "How did Alphabet do
22818
+ # in 2022?" and the current query is "How about 2023?", the current query will
22819
+ # be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination
22820
+ # between /search API calls and /answer API calls): Call /answer API with the
22821
+ # session ID generated in the first call. Here, the answer generation happens in
22822
+ # the context of the search results from the first search call. Multi-turn
22823
+ # Search feature is currently at private GA stage. Please use v1alpha or v1beta
22824
+ # version instead before we launch this feature to public GA. Or ask for
22825
+ # allowlisting through Google Support team.
22369
22826
  # Corresponds to the JSON property `session`
22370
22827
  # @return [String]
22371
22828
  attr_accessor :session
@@ -25020,6 +25477,266 @@ module Google
25020
25477
  end
25021
25478
  end
25022
25479
 
25480
+ # Request for the AssistantService.StreamAssist method.
25481
+ class GoogleCloudDiscoveryengineV1betaStreamAssistRequest
25482
+ include Google::Apis::Core::Hashable
25483
+
25484
+ # Assistant generation specification for the request. This allows to override
25485
+ # the default generation configuration at the engine level.
25486
+ # Corresponds to the JSON property `generationSpec`
25487
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaStreamAssistRequestGenerationSpec]
25488
+ attr_accessor :generation_spec
25489
+
25490
+ # Defines a user inputed query.
25491
+ # Corresponds to the JSON property `query`
25492
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaQuery]
25493
+ attr_accessor :query
25494
+
25495
+ # Optional. The session to use for the request. If specified, the assistant has
25496
+ # access to the session history, and the query and the answer are stored there.
25497
+ # If `-` is specified as the session ID, or it is left empty, then a new session
25498
+ # is created with an automatically generated ID. Format: `projects/`project`/
25499
+ # locations/`location`/collections/`collection`/engines/`engine`/sessions/`
25500
+ # session``
25501
+ # Corresponds to the JSON property `session`
25502
+ # @return [String]
25503
+ attr_accessor :session
25504
+
25505
+ # Specification of tools that are used to serve the request.
25506
+ # Corresponds to the JSON property `toolsSpec`
25507
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpec]
25508
+ attr_accessor :tools_spec
25509
+
25510
+ # User metadata of the request.
25511
+ # Corresponds to the JSON property `userMetadata`
25512
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistUserMetadata]
25513
+ attr_accessor :user_metadata
25514
+
25515
+ def initialize(**args)
25516
+ update!(**args)
25517
+ end
25518
+
25519
+ # Update properties of this object
25520
+ def update!(**args)
25521
+ @generation_spec = args[:generation_spec] if args.key?(:generation_spec)
25522
+ @query = args[:query] if args.key?(:query)
25523
+ @session = args[:session] if args.key?(:session)
25524
+ @tools_spec = args[:tools_spec] if args.key?(:tools_spec)
25525
+ @user_metadata = args[:user_metadata] if args.key?(:user_metadata)
25526
+ end
25527
+ end
25528
+
25529
+ # Assistant generation specification for the request. This allows to override
25530
+ # the default generation configuration at the engine level.
25531
+ class GoogleCloudDiscoveryengineV1betaStreamAssistRequestGenerationSpec
25532
+ include Google::Apis::Core::Hashable
25533
+
25534
+ # Optional. The Vertex AI model_id used for the generative model. If not set,
25535
+ # the default Assistant model will be used.
25536
+ # Corresponds to the JSON property `modelId`
25537
+ # @return [String]
25538
+ attr_accessor :model_id
25539
+
25540
+ def initialize(**args)
25541
+ update!(**args)
25542
+ end
25543
+
25544
+ # Update properties of this object
25545
+ def update!(**args)
25546
+ @model_id = args[:model_id] if args.key?(:model_id)
25547
+ end
25548
+ end
25549
+
25550
+ # Specification of tools that are used to serve the request.
25551
+ class GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpec
25552
+ include Google::Apis::Core::Hashable
25553
+
25554
+ # Specification of the image generation tool.
25555
+ # Corresponds to the JSON property `imageGenerationSpec`
25556
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecImageGenerationSpec]
25557
+ attr_accessor :image_generation_spec
25558
+
25559
+ # Optional. The name of the tool registry to use. Format: `projects/`project`/
25560
+ # locations/`location`/toolRegistries/`tool_registry``
25561
+ # Corresponds to the JSON property `toolRegistry`
25562
+ # @return [String]
25563
+ attr_accessor :tool_registry
25564
+
25565
+ # Specification of the Vertex AI Search tool.
25566
+ # Corresponds to the JSON property `vertexAiSearchSpec`
25567
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecVertexAiSearchSpec]
25568
+ attr_accessor :vertex_ai_search_spec
25569
+
25570
+ # Specification of the video generation tool.
25571
+ # Corresponds to the JSON property `videoGenerationSpec`
25572
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecVideoGenerationSpec]
25573
+ attr_accessor :video_generation_spec
25574
+
25575
+ # Specification of the web grounding tool.
25576
+ # Corresponds to the JSON property `webGroundingSpec`
25577
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecWebGroundingSpec]
25578
+ attr_accessor :web_grounding_spec
25579
+
25580
+ def initialize(**args)
25581
+ update!(**args)
25582
+ end
25583
+
25584
+ # Update properties of this object
25585
+ def update!(**args)
25586
+ @image_generation_spec = args[:image_generation_spec] if args.key?(:image_generation_spec)
25587
+ @tool_registry = args[:tool_registry] if args.key?(:tool_registry)
25588
+ @vertex_ai_search_spec = args[:vertex_ai_search_spec] if args.key?(:vertex_ai_search_spec)
25589
+ @video_generation_spec = args[:video_generation_spec] if args.key?(:video_generation_spec)
25590
+ @web_grounding_spec = args[:web_grounding_spec] if args.key?(:web_grounding_spec)
25591
+ end
25592
+ end
25593
+
25594
+ # Specification of the image generation tool.
25595
+ class GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecImageGenerationSpec
25596
+ include Google::Apis::Core::Hashable
25597
+
25598
+ def initialize(**args)
25599
+ update!(**args)
25600
+ end
25601
+
25602
+ # Update properties of this object
25603
+ def update!(**args)
25604
+ end
25605
+ end
25606
+
25607
+ # Specification of the Vertex AI Search tool.
25608
+ class GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecVertexAiSearchSpec
25609
+ include Google::Apis::Core::Hashable
25610
+
25611
+ # Optional. Specs defining DataStores to filter on in a search call and
25612
+ # configurations for those data stores. This is only considered for Engines with
25613
+ # multiple data stores.
25614
+ # Corresponds to the JSON property `dataStoreSpecs`
25615
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec>]
25616
+ attr_accessor :data_store_specs
25617
+
25618
+ # Optional. Deprecated. Please refrain from using this field. Whether the Vertex
25619
+ # AI Search tool is disabled. Default value is false, the tool is enabled by
25620
+ # default.
25621
+ # Corresponds to the JSON property `disabled`
25622
+ # @return [Boolean]
25623
+ attr_accessor :disabled
25624
+ alias_method :disabled?, :disabled
25625
+
25626
+ # Optional. The filter syntax consists of an expression language for
25627
+ # constructing a predicate from one or more fields of the documents being
25628
+ # filtered. Filter expression is case-sensitive. If this field is unrecognizable,
25629
+ # an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by
25630
+ # mapping the LHS filter key to a key property defined in the Vertex AI Search
25631
+ # backend -- this mapping is defined by the customer in their schema. For
25632
+ # example a media customer might have a field 'name' in their schema. In this
25633
+ # case the filter would look like this: filter --> name:'ANY("king kong")' For
25634
+ # more information about filtering including syntax and filter operators, see [
25635
+ # Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-
25636
+ # metadata)
25637
+ # Corresponds to the JSON property `filter`
25638
+ # @return [String]
25639
+ attr_accessor :filter
25640
+
25641
+ def initialize(**args)
25642
+ update!(**args)
25643
+ end
25644
+
25645
+ # Update properties of this object
25646
+ def update!(**args)
25647
+ @data_store_specs = args[:data_store_specs] if args.key?(:data_store_specs)
25648
+ @disabled = args[:disabled] if args.key?(:disabled)
25649
+ @filter = args[:filter] if args.key?(:filter)
25650
+ end
25651
+ end
25652
+
25653
+ # Specification of the video generation tool.
25654
+ class GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecVideoGenerationSpec
25655
+ include Google::Apis::Core::Hashable
25656
+
25657
+ def initialize(**args)
25658
+ update!(**args)
25659
+ end
25660
+
25661
+ # Update properties of this object
25662
+ def update!(**args)
25663
+ end
25664
+ end
25665
+
25666
+ # Specification of the web grounding tool.
25667
+ class GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecWebGroundingSpec
25668
+ include Google::Apis::Core::Hashable
25669
+
25670
+ # Optional. Deprecated. Please refrain from using this field. Whether the web
25671
+ # grounding tool is enabled.
25672
+ # Corresponds to the JSON property `enabled`
25673
+ # @return [Boolean]
25674
+ attr_accessor :enabled
25675
+ alias_method :enabled?, :enabled
25676
+
25677
+ def initialize(**args)
25678
+ update!(**args)
25679
+ end
25680
+
25681
+ # Update properties of this object
25682
+ def update!(**args)
25683
+ @enabled = args[:enabled] if args.key?(:enabled)
25684
+ end
25685
+ end
25686
+
25687
+ # Response for the AssistantService.StreamAssist method.
25688
+ class GoogleCloudDiscoveryengineV1betaStreamAssistResponse
25689
+ include Google::Apis::Core::Hashable
25690
+
25691
+ # AssistAnswer resource, main part of AssistResponse.
25692
+ # Corresponds to the JSON property `answer`
25693
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAssistAnswer]
25694
+ attr_accessor :answer
25695
+
25696
+ # A global unique ID that identifies the current pair of request and stream of
25697
+ # responses. Used for feedback and support.
25698
+ # Corresponds to the JSON property `assistToken`
25699
+ # @return [String]
25700
+ attr_accessor :assist_token
25701
+
25702
+ # Information about the session.
25703
+ # Corresponds to the JSON property `sessionInfo`
25704
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaStreamAssistResponseSessionInfo]
25705
+ attr_accessor :session_info
25706
+
25707
+ def initialize(**args)
25708
+ update!(**args)
25709
+ end
25710
+
25711
+ # Update properties of this object
25712
+ def update!(**args)
25713
+ @answer = args[:answer] if args.key?(:answer)
25714
+ @assist_token = args[:assist_token] if args.key?(:assist_token)
25715
+ @session_info = args[:session_info] if args.key?(:session_info)
25716
+ end
25717
+ end
25718
+
25719
+ # Information about the session.
25720
+ class GoogleCloudDiscoveryengineV1betaStreamAssistResponseSessionInfo
25721
+ include Google::Apis::Core::Hashable
25722
+
25723
+ # Name of the newly generated or continued session. Format: `projects/`project`/
25724
+ # locations/`location`/collections/`collection`/engines/`engine`/sessions/`
25725
+ # session``.
25726
+ # Corresponds to the JSON property `session`
25727
+ # @return [String]
25728
+ attr_accessor :session
25729
+
25730
+ def initialize(**args)
25731
+ update!(**args)
25732
+ end
25733
+
25734
+ # Update properties of this object
25735
+ def update!(**args)
25736
+ @session = args[:session] if args.key?(:session)
25737
+ end
25738
+ end
25739
+
25023
25740
  # Suggestion deny list entry identifying the phrase to block from suggestions
25024
25741
  # and the applied operation for the phrase.
25025
25742
  class GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry