google-apis-discoveryengine_v1 0.14.0 → 0.15.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -474,6 +474,7 @@ module Google
474
474
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec]
475
475
  attr_accessor :answer_generation_spec
476
476
 
477
+ # Deprecated: This field is deprecated. Streaming Answer API will be supported.
477
478
  # Asynchronous mode control. If enabled, the response will be returned with
478
479
  # answer/session resource name without final answer. The API users need to do
479
480
  # the polling to get the latest status of answer/session by calling
@@ -584,6 +585,19 @@ module Google
584
585
  attr_accessor :ignore_adversarial_query
585
586
  alias_method :ignore_adversarial_query?, :ignore_adversarial_query
586
587
 
588
+ # Optional. Specifies whether to filter out jail-breaking queries. The default
589
+ # value is `false`. Google employs search-query classification to detect jail-
590
+ # breaking queries. No summary is returned if the search query is classified as
591
+ # a jail-breaking query. A user might add instructions to the query to change
592
+ # the tone, style, language, content of the answer, or ask the model to act as a
593
+ # different entity, e.g. "Reply in the tone of a competing company's CEO". If
594
+ # this field is set to `true`, we skip generating summaries for jail-breaking
595
+ # queries and return fallback messages instead.
596
+ # Corresponds to the JSON property `ignoreJailBreakingQuery`
597
+ # @return [Boolean]
598
+ attr_accessor :ignore_jail_breaking_query
599
+ alias_method :ignore_jail_breaking_query?, :ignore_jail_breaking_query
600
+
587
601
  # Specifies whether to filter out queries that have low relevance. If this field
588
602
  # is set to `false`, all search results are used regardless of relevance to
589
603
  # generate answers. If set to `true` or unset, the behavior will be determined
@@ -629,6 +643,7 @@ module Google
629
643
  def update!(**args)
630
644
  @answer_language_code = args[:answer_language_code] if args.key?(:answer_language_code)
631
645
  @ignore_adversarial_query = args[:ignore_adversarial_query] if args.key?(:ignore_adversarial_query)
646
+ @ignore_jail_breaking_query = args[:ignore_jail_breaking_query] if args.key?(:ignore_jail_breaking_query)
632
647
  @ignore_low_relevant_content = args[:ignore_low_relevant_content] if args.key?(:ignore_low_relevant_content)
633
648
  @ignore_non_answer_seeking_query = args[:ignore_non_answer_seeking_query] if args.key?(:ignore_non_answer_seeking_query)
634
649
  @include_citations = args[:include_citations] if args.key?(:include_citations)
@@ -939,6 +954,12 @@ module Google
939
954
  # @return [String]
940
955
  attr_accessor :content
941
956
 
957
+ # Document metadata contains the information of the document of the current
958
+ # chunk.
959
+ # Corresponds to the JSON property `documentMetadata`
960
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata]
961
+ attr_accessor :document_metadata
962
+
942
963
  def initialize(**args)
943
964
  update!(**args)
944
965
  end
@@ -947,6 +968,33 @@ module Google
947
968
  def update!(**args)
948
969
  @chunk = args[:chunk] if args.key?(:chunk)
949
970
  @content = args[:content] if args.key?(:content)
971
+ @document_metadata = args[:document_metadata] if args.key?(:document_metadata)
972
+ end
973
+ end
974
+
975
+ # Document metadata contains the information of the document of the current
976
+ # chunk.
977
+ class GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata
978
+ include Google::Apis::Core::Hashable
979
+
980
+ # Title of the document.
981
+ # Corresponds to the JSON property `title`
982
+ # @return [String]
983
+ attr_accessor :title
984
+
985
+ # Uri of the document.
986
+ # Corresponds to the JSON property `uri`
987
+ # @return [String]
988
+ attr_accessor :uri
989
+
990
+ def initialize(**args)
991
+ update!(**args)
992
+ end
993
+
994
+ # Update properties of this object
995
+ def update!(**args)
996
+ @title = args[:title] if args.key?(:title)
997
+ @uri = args[:uri] if args.key?(:uri)
950
998
  end
951
999
  end
952
1000
 
@@ -1473,7 +1521,7 @@ module Google
1473
1521
  attr_accessor :snippet_info
1474
1522
 
1475
1523
  # Data representation. The structured JSON data for the document. It's populated
1476
- # from the struct data from the Document , or the Chunk in search result .
1524
+ # from the struct data from the Document, or the Chunk in search result. .
1477
1525
  # Corresponds to the JSON property `structData`
1478
1526
  # @return [Hash<String,Object>]
1479
1527
  attr_accessor :struct_data
@@ -1688,10 +1736,10 @@ module Google
1688
1736
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue]
1689
1737
  attr_accessor :matcher_value
1690
1738
 
1691
- # The status of the document.
1692
- # Corresponds to the JSON property `status`
1739
+ # The state of the document.
1740
+ # Corresponds to the JSON property `state`
1693
1741
  # @return [String]
1694
- attr_accessor :status
1742
+ attr_accessor :state
1695
1743
 
1696
1744
  def initialize(**args)
1697
1745
  update!(**args)
@@ -1702,7 +1750,7 @@ module Google
1702
1750
  @data_ingestion_source = args[:data_ingestion_source] if args.key?(:data_ingestion_source)
1703
1751
  @last_refreshed_time = args[:last_refreshed_time] if args.key?(:last_refreshed_time)
1704
1752
  @matcher_value = args[:matcher_value] if args.key?(:matcher_value)
1705
- @status = args[:status] if args.key?(:status)
1753
+ @state = args[:state] if args.key?(:state)
1706
1754
  end
1707
1755
  end
1708
1756
 
@@ -2915,10 +2963,10 @@ module Google
2915
2963
  attr_accessor :safe_search
2916
2964
  alias_method :safe_search?, :safe_search
2917
2965
 
2918
- # The resource name of the Serving Config to use. Format: `projects/`
2919
- # project_number`/locations/`location_id`/collections/`collection`/dataStores/`
2920
- # data_store_id`/servingConfigs/`serving_config_id`` If this is not set, the
2921
- # default serving config will be used.
2966
+ # The resource name of the Serving Config to use. Format: `projects/`project`/
2967
+ # locations/`location`/collections/`collection`/dataStores/`data_store_id`/
2968
+ # servingConfigs/`serving_config_id`` If this is not set, the default serving
2969
+ # config will be used.
2922
2970
  # Corresponds to the JSON property `servingConfig`
2923
2971
  # @return [String]
2924
2972
  attr_accessor :serving_config
@@ -3190,9 +3238,9 @@ module Google
3190
3238
  attr_accessor :model_version
3191
3239
 
3192
3240
  # Required. The fully qualified resource name of the model. Format: `projects/`
3193
- # project_number`/locations/`location`/collections/`collection`/dataStores/`
3194
- # data_store`/customTuningModels/`custom_tuning_model`` model must be an alpha-
3195
- # numerical string with limit of 40 characters.
3241
+ # project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
3242
+ # customTuningModels/`custom_tuning_model``. Model must be an alpha-numerical
3243
+ # string with limit of 40 characters.
3196
3244
  # Corresponds to the JSON property `name`
3197
3245
  # @return [String]
3198
3246
  attr_accessor :name
@@ -3265,6 +3313,11 @@ module Google
3265
3313
  # @return [String]
3266
3314
  attr_accessor :name
3267
3315
 
3316
+ # Stores information regarding the serving configurations at DataStore level.
3317
+ # Corresponds to the JSON property `servingConfigDataStore`
3318
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfigDataStore]
3319
+ attr_accessor :serving_config_data_store
3320
+
3268
3321
  # The solutions that the data store enrolls. Available solutions for each
3269
3322
  # industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `
3270
3323
  # SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is
@@ -3296,6 +3349,7 @@ module Google
3296
3349
  @document_processing_config = args[:document_processing_config] if args.key?(:document_processing_config)
3297
3350
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
3298
3351
  @name = args[:name] if args.key?(:name)
3352
+ @serving_config_data_store = args[:serving_config_data_store] if args.key?(:serving_config_data_store)
3299
3353
  @solution_types = args[:solution_types] if args.key?(:solution_types)
3300
3354
  @starting_schema = args[:starting_schema] if args.key?(:starting_schema)
3301
3355
  @workspace_config = args[:workspace_config] if args.key?(:workspace_config)
@@ -3488,6 +3542,11 @@ module Google
3488
3542
  # @return [String]
3489
3543
  attr_accessor :id
3490
3544
 
3545
+ # Index status of the document.
3546
+ # Corresponds to the JSON property `indexStatus`
3547
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DocumentIndexStatus]
3548
+ attr_accessor :index_status
3549
+
3491
3550
  # Output only. The last time the document was indexed. If this field is set, the
3492
3551
  # document could be returned in search results. This field is OUTPUT_ONLY. If
3493
3552
  # this field is not populated, it means the document has never been indexed.
@@ -3536,6 +3595,7 @@ module Google
3536
3595
  @content = args[:content] if args.key?(:content)
3537
3596
  @derived_struct_data = args[:derived_struct_data] if args.key?(:derived_struct_data)
3538
3597
  @id = args[:id] if args.key?(:id)
3598
+ @index_status = args[:index_status] if args.key?(:index_status)
3539
3599
  @index_time = args[:index_time] if args.key?(:index_time)
3540
3600
  @json_data = args[:json_data] if args.key?(:json_data)
3541
3601
  @name = args[:name] if args.key?(:name)
@@ -3589,6 +3649,33 @@ module Google
3589
3649
  end
3590
3650
  end
3591
3651
 
3652
+ # Index status of the document.
3653
+ class GoogleCloudDiscoveryengineV1DocumentIndexStatus
3654
+ include Google::Apis::Core::Hashable
3655
+
3656
+ # A sample of errors encountered while indexing the document. If this field is
3657
+ # populated, the document is not indexed due to errors.
3658
+ # Corresponds to the JSON property `errorSamples`
3659
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleRpcStatus>]
3660
+ attr_accessor :error_samples
3661
+
3662
+ # The time when the document was indexed. If this field is populated, it means
3663
+ # the document has been indexed.
3664
+ # Corresponds to the JSON property `indexTime`
3665
+ # @return [String]
3666
+ attr_accessor :index_time
3667
+
3668
+ def initialize(**args)
3669
+ update!(**args)
3670
+ end
3671
+
3672
+ # Update properties of this object
3673
+ def update!(**args)
3674
+ @error_samples = args[:error_samples] if args.key?(:error_samples)
3675
+ @index_time = args[:index_time] if args.key?(:index_time)
3676
+ end
3677
+ end
3678
+
3592
3679
  # Detailed document information associated with a user event.
3593
3680
  class GoogleCloudDiscoveryengineV1DocumentInfo
3594
3681
  include Google::Apis::Core::Hashable
@@ -3604,8 +3691,8 @@ module Google
3604
3691
  attr_accessor :joined
3605
3692
  alias_method :joined?, :joined
3606
3693
 
3607
- # The Document resource full name, of the form: `projects/`project_id`/locations/
3608
- # `location`/collections/`collection_id`/dataStores/`data_store_id`/branches/`
3694
+ # The Document resource full name, of the form: `projects/`project`/locations/`
3695
+ # location`/collections/`collection_id`/dataStores/`data_store_id`/branches/`
3609
3696
  # branch_id`/documents/`document_id``
3610
3697
  # Corresponds to the JSON property `name`
3611
3698
  # @return [String]
@@ -3674,8 +3761,9 @@ module Google
3674
3761
  # parsing are supported. * `docx`: Override parsing config for DOCX files, only
3675
3762
  # digital parsing and layout parsing are supported. * `pptx`: Override parsing
3676
3763
  # config for PPTX files, only digital parsing and layout parsing are supported. *
3677
- # `xlsx`: Override parsing config for XLSX files, only digital parsing and
3678
- # layout parsing are supported.
3764
+ # `xlsm`: Override parsing config for XLSM files, only digital parsing and
3765
+ # layout parsing are supported. * `xlsx`: Override parsing config for XLSX files,
3766
+ # only digital parsing and layout parsing are supported.
3679
3767
  # Corresponds to the JSON property `parsingConfigOverrides`
3680
3768
  # @return [Hash<String,Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig>]
3681
3769
  attr_accessor :parsing_config_overrides
@@ -3929,9 +4017,9 @@ module Google
3929
4017
 
3930
4018
  # Immutable. The fully qualified resource name of the engine. This field must be
3931
4019
  # a UTF-8 encoded string with a length limit of 1024 characters. Format: `
3932
- # projects/`project_number`/locations/`location`/collections/`collection`/
3933
- # engines/`engine`` engine should be 1-63 characters, and valid characters are /
3934
- # a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
4020
+ # projects/`project`/locations/`location`/collections/`collection`/engines/`
4021
+ # engine`` engine should be 1-63 characters, and valid characters are /a-z0-9*/.
4022
+ # Otherwise, an INVALID_ARGUMENT error is returned.
3935
4023
  # Corresponds to the JSON property `name`
3936
4024
  # @return [String]
3937
4025
  attr_accessor :name
@@ -5337,9 +5425,9 @@ module Google
5337
5425
  # @return [String]
5338
5426
  attr_accessor :create_time
5339
5427
 
5340
- # Output only. Full resource name of the project, for example `projects/`
5341
- # project_number``. Note that when making requests, project number and project
5342
- # id are both acceptable, but the server will always respond in project number.
5428
+ # Output only. Full resource name of the project, for example `projects/`project`
5429
+ # `. Note that when making requests, project number and project id are both
5430
+ # acceptable, but the server will always respond in project number.
5343
5431
  # Corresponds to the JSON property `name`
5344
5432
  # @return [String]
5345
5433
  attr_accessor :name
@@ -6115,6 +6203,13 @@ module Google
6115
6203
  class GoogleCloudDiscoveryengineV1RecrawlUrisRequest
6116
6204
  include Google::Apis::Core::Hashable
6117
6205
 
6206
+ # Optional. Full resource name of the SiteCredential, such as `projects/*/
6207
+ # locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`.
6208
+ # Only set to crawl private URIs.
6209
+ # Corresponds to the JSON property `siteCredential`
6210
+ # @return [String]
6211
+ attr_accessor :site_credential
6212
+
6118
6213
  # Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an
6119
6214
  # INVALID_ARGUMENT error is thrown. Each URI should match at least one
6120
6215
  # TargetSite in `site_search_engine`.
@@ -6128,6 +6223,7 @@ module Google
6128
6223
 
6129
6224
  # Update properties of this object
6130
6225
  def update!(**args)
6226
+ @site_credential = args[:site_credential] if args.key?(:site_credential)
6131
6227
  @uris = args[:uris] if args.key?(:uris)
6132
6228
  end
6133
6229
  end
@@ -6518,6 +6614,13 @@ module Google
6518
6614
  # @return [Float]
6519
6615
  attr_accessor :boost
6520
6616
 
6617
+ # Specification for custom ranking based on customer specified attribute value.
6618
+ # It provides more controls for customized ranking than the simple (condition,
6619
+ # boost) combination above.
6620
+ # Corresponds to the JSON property `boostControlSpec`
6621
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec]
6622
+ attr_accessor :boost_control_spec
6623
+
6521
6624
  # An expression which specifies a boost condition. The syntax and supported
6522
6625
  # fields are the same as a filter expression. See SearchRequest.filter for
6523
6626
  # detail syntax and limitations. Examples: * To boost documents with document ID
@@ -6534,10 +6637,88 @@ module Google
6534
6637
  # Update properties of this object
6535
6638
  def update!(**args)
6536
6639
  @boost = args[:boost] if args.key?(:boost)
6640
+ @boost_control_spec = args[:boost_control_spec] if args.key?(:boost_control_spec)
6537
6641
  @condition = args[:condition] if args.key?(:condition)
6538
6642
  end
6539
6643
  end
6540
6644
 
6645
+ # Specification for custom ranking based on customer specified attribute value.
6646
+ # It provides more controls for customized ranking than the simple (condition,
6647
+ # boost) combination above.
6648
+ class GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec
6649
+ include Google::Apis::Core::Hashable
6650
+
6651
+ # The attribute type to be used to determine the boost amount. The attribute
6652
+ # value can be derived from the field value of the specified field_name. In the
6653
+ # case of numerical it is straightforward i.e. attribute_value =
6654
+ # numerical_field_value. In the case of freshness however, attribute_value = (
6655
+ # time.now() - datetime_field_value).
6656
+ # Corresponds to the JSON property `attributeType`
6657
+ # @return [String]
6658
+ attr_accessor :attribute_type
6659
+
6660
+ # The control points used to define the curve. The monotonic function (defined
6661
+ # through the interpolation_type above) passes through the control points listed
6662
+ # here.
6663
+ # Corresponds to the JSON property `controlPoints`
6664
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint>]
6665
+ attr_accessor :control_points
6666
+
6667
+ # The name of the field whose value will be used to determine the boost amount.
6668
+ # Corresponds to the JSON property `fieldName`
6669
+ # @return [String]
6670
+ attr_accessor :field_name
6671
+
6672
+ # The interpolation type to be applied to connect the control points listed
6673
+ # below.
6674
+ # Corresponds to the JSON property `interpolationType`
6675
+ # @return [String]
6676
+ attr_accessor :interpolation_type
6677
+
6678
+ def initialize(**args)
6679
+ update!(**args)
6680
+ end
6681
+
6682
+ # Update properties of this object
6683
+ def update!(**args)
6684
+ @attribute_type = args[:attribute_type] if args.key?(:attribute_type)
6685
+ @control_points = args[:control_points] if args.key?(:control_points)
6686
+ @field_name = args[:field_name] if args.key?(:field_name)
6687
+ @interpolation_type = args[:interpolation_type] if args.key?(:interpolation_type)
6688
+ end
6689
+ end
6690
+
6691
+ # The control points used to define the curve. The curve defined through these
6692
+ # control points can only be monotonically increasing or decreasing(constant
6693
+ # values are acceptable).
6694
+ class GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint
6695
+ include Google::Apis::Core::Hashable
6696
+
6697
+ # Can be one of: 1. The numerical field value. 2. The duration spec for
6698
+ # freshness: The value must be formatted as an XSD `dayTimeDuration` value (a
6699
+ # restricted subset of an ISO 8601 duration value). The pattern for this is: `
6700
+ # nDnM]`.
6701
+ # Corresponds to the JSON property `attributeValue`
6702
+ # @return [String]
6703
+ attr_accessor :attribute_value
6704
+
6705
+ # The value between -1 to 1 by which to boost the score if the attribute_value
6706
+ # evaluates to the value specified above.
6707
+ # Corresponds to the JSON property `boostAmount`
6708
+ # @return [Float]
6709
+ attr_accessor :boost_amount
6710
+
6711
+ def initialize(**args)
6712
+ update!(**args)
6713
+ end
6714
+
6715
+ # Update properties of this object
6716
+ def update!(**args)
6717
+ @attribute_value = args[:attribute_value] if args.key?(:attribute_value)
6718
+ @boost_amount = args[:boost_amount] if args.key?(:boost_amount)
6719
+ end
6720
+ end
6721
+
6541
6722
  # A specification for configuring the behavior of content search.
6542
6723
  class GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec
6543
6724
  include Google::Apis::Core::Hashable
@@ -6728,6 +6909,19 @@ module Google
6728
6909
  attr_accessor :ignore_adversarial_query
6729
6910
  alias_method :ignore_adversarial_query?, :ignore_adversarial_query
6730
6911
 
6912
+ # Optional. Specifies whether to filter out jail-breaking queries. The default
6913
+ # value is `false`. Google employs search-query classification to detect jail-
6914
+ # breaking queries. No summary is returned if the search query is classified as
6915
+ # a jail-breaking query. A user might add instructions to the query to change
6916
+ # the tone, style, language, content of the answer, or ask the model to act as a
6917
+ # different entity, e.g. "Reply in the tone of a competing company's CEO". If
6918
+ # this field is set to `true`, we skip generating summaries for jail-breaking
6919
+ # queries and return fallback messages instead.
6920
+ # Corresponds to the JSON property `ignoreJailBreakingQuery`
6921
+ # @return [Boolean]
6922
+ attr_accessor :ignore_jail_breaking_query
6923
+ alias_method :ignore_jail_breaking_query?, :ignore_jail_breaking_query
6924
+
6731
6925
  # Specifies whether to filter out queries that have low relevance. The default
6732
6926
  # value is `false`. If this field is set to `false`, all search results are used
6733
6927
  # regardless of relevance to generate answers. If set to `true`, only queries
@@ -6807,6 +7001,7 @@ module Google
6807
7001
  # Update properties of this object
6808
7002
  def update!(**args)
6809
7003
  @ignore_adversarial_query = args[:ignore_adversarial_query] if args.key?(:ignore_adversarial_query)
7004
+ @ignore_jail_breaking_query = args[:ignore_jail_breaking_query] if args.key?(:ignore_jail_breaking_query)
6810
7005
  @ignore_low_relevant_content = args[:ignore_low_relevant_content] if args.key?(:ignore_low_relevant_content)
6811
7006
  @ignore_non_summary_seeking_query = args[:ignore_non_summary_seeking_query] if args.key?(:ignore_non_summary_seeking_query)
6812
7007
  @include_citations = args[:include_citations] if args.key?(:include_citations)
@@ -7632,6 +7827,26 @@ module Google
7632
7827
  end
7633
7828
  end
7634
7829
 
7830
+ # Stores information regarding the serving configurations at DataStore level.
7831
+ class GoogleCloudDiscoveryengineV1ServingConfigDataStore
7832
+ include Google::Apis::Core::Hashable
7833
+
7834
+ # If set true, the DataStore will not be available for serving search requests.
7835
+ # Corresponds to the JSON property `disabledForServing`
7836
+ # @return [Boolean]
7837
+ attr_accessor :disabled_for_serving
7838
+ alias_method :disabled_for_serving?, :disabled_for_serving
7839
+
7840
+ def initialize(**args)
7841
+ update!(**args)
7842
+ end
7843
+
7844
+ # Update properties of this object
7845
+ def update!(**args)
7846
+ @disabled_for_serving = args[:disabled_for_serving] if args.key?(:disabled_for_serving)
7847
+ end
7848
+ end
7849
+
7635
7850
  # External session proto definition.
7636
7851
  class GoogleCloudDiscoveryengineV1Session
7637
7852
  include Google::Apis::Core::Hashable
@@ -9051,7 +9266,7 @@ module Google
9051
9266
  attr_accessor :snippet_info
9052
9267
 
9053
9268
  # Data representation. The structured JSON data for the document. It's populated
9054
- # from the struct data from the Document , or the Chunk in search result .
9269
+ # from the struct data from the Document, or the Chunk in search result. .
9055
9270
  # Corresponds to the JSON property `structData`
9056
9271
  # @return [Hash<String,Object>]
9057
9272
  attr_accessor :struct_data
@@ -9653,9 +9868,9 @@ module Google
9653
9868
  attr_accessor :model_version
9654
9869
 
9655
9870
  # Required. The fully qualified resource name of the model. Format: `projects/`
9656
- # project_number`/locations/`location`/collections/`collection`/dataStores/`
9657
- # data_store`/customTuningModels/`custom_tuning_model`` model must be an alpha-
9658
- # numerical string with limit of 40 characters.
9871
+ # project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
9872
+ # customTuningModels/`custom_tuning_model``. Model must be an alpha-numerical
9873
+ # string with limit of 40 characters.
9659
9874
  # Corresponds to the JSON property `name`
9660
9875
  # @return [String]
9661
9876
  attr_accessor :name
@@ -9749,6 +9964,16 @@ module Google
9749
9964
  # @return [String]
9750
9965
  attr_accessor :name
9751
9966
 
9967
+ # Configuration for Natural Language Query Understanding.
9968
+ # Corresponds to the JSON property `naturalLanguageQueryUnderstandingConfig`
9969
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig]
9970
+ attr_accessor :natural_language_query_understanding_config
9971
+
9972
+ # Stores information regarding the serving configurations at DataStore level.
9973
+ # Corresponds to the JSON property `servingConfigDataStore`
9974
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaServingConfigDataStore]
9975
+ attr_accessor :serving_config_data_store
9976
+
9752
9977
  # The solutions that the data store enrolls. Available solutions for each
9753
9978
  # industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `
9754
9979
  # SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is
@@ -9783,6 +10008,8 @@ module Google
9783
10008
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
9784
10009
  @language_info = args[:language_info] if args.key?(:language_info)
9785
10010
  @name = args[:name] if args.key?(:name)
10011
+ @natural_language_query_understanding_config = args[:natural_language_query_understanding_config] if args.key?(:natural_language_query_understanding_config)
10012
+ @serving_config_data_store = args[:serving_config_data_store] if args.key?(:serving_config_data_store)
9786
10013
  @solution_types = args[:solution_types] if args.key?(:solution_types)
9787
10014
  @starting_schema = args[:starting_schema] if args.key?(:starting_schema)
9788
10015
  @workspace_config = args[:workspace_config] if args.key?(:workspace_config)
@@ -9968,8 +10195,9 @@ module Google
9968
10195
  # parsing are supported. * `docx`: Override parsing config for DOCX files, only
9969
10196
  # digital parsing and layout parsing are supported. * `pptx`: Override parsing
9970
10197
  # config for PPTX files, only digital parsing and layout parsing are supported. *
9971
- # `xlsx`: Override parsing config for XLSX files, only digital parsing and
9972
- # layout parsing are supported.
10198
+ # `xlsm`: Override parsing config for XLSM files, only digital parsing and
10199
+ # layout parsing are supported. * `xlsx`: Override parsing config for XLSX files,
10200
+ # only digital parsing and layout parsing are supported.
9973
10201
  # Corresponds to the JSON property `parsingConfigOverrides`
9974
10202
  # @return [Hash<String,Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig>]
9975
10203
  attr_accessor :parsing_config_overrides
@@ -10215,9 +10443,9 @@ module Google
10215
10443
 
10216
10444
  # Immutable. The fully qualified resource name of the engine. This field must be
10217
10445
  # a UTF-8 encoded string with a length limit of 1024 characters. Format: `
10218
- # projects/`project_number`/locations/`location`/collections/`collection`/
10219
- # engines/`engine`` engine should be 1-63 characters, and valid characters are /
10220
- # a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
10446
+ # projects/`project`/locations/`location`/collections/`collection`/engines/`
10447
+ # engine`` engine should be 1-63 characters, and valid characters are /a-z0-9*/.
10448
+ # Otherwise, an INVALID_ARGUMENT error is returned.
10221
10449
  # Corresponds to the JSON property `name`
10222
10450
  # @return [String]
10223
10451
  attr_accessor :name
@@ -11385,6 +11613,26 @@ module Google
11385
11613
  end
11386
11614
  end
11387
11615
 
11616
+ # Configuration for Natural Language Query Understanding.
11617
+ class GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig
11618
+ include Google::Apis::Core::Hashable
11619
+
11620
+ # Mode of Natural Language Query Understanding. If this field is unset, the
11621
+ # behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.
11622
+ # Corresponds to the JSON property `mode`
11623
+ # @return [String]
11624
+ attr_accessor :mode
11625
+
11626
+ def initialize(**args)
11627
+ update!(**args)
11628
+ end
11629
+
11630
+ # Update properties of this object
11631
+ def update!(**args)
11632
+ @mode = args[:mode] if args.key?(:mode)
11633
+ end
11634
+ end
11635
+
11388
11636
  # Metadata and configurations for a Google Cloud project in the service.
11389
11637
  class GoogleCloudDiscoveryengineV1alphaProject
11390
11638
  include Google::Apis::Core::Hashable
@@ -11394,9 +11642,9 @@ module Google
11394
11642
  # @return [String]
11395
11643
  attr_accessor :create_time
11396
11644
 
11397
- # Output only. Full resource name of the project, for example `projects/`
11398
- # project_number``. Note that when making requests, project number and project
11399
- # id are both acceptable, but the server will always respond in project number.
11645
+ # Output only. Full resource name of the project, for example `projects/`project`
11646
+ # `. Note that when making requests, project number and project id are both
11647
+ # acceptable, but the server will always respond in project number.
11400
11648
  # Corresponds to the JSON property `name`
11401
11649
  # @return [String]
11402
11650
  attr_accessor :name
@@ -12656,6 +12904,19 @@ module Google
12656
12904
  attr_accessor :ignore_adversarial_query
12657
12905
  alias_method :ignore_adversarial_query?, :ignore_adversarial_query
12658
12906
 
12907
+ # Optional. Specifies whether to filter out jail-breaking queries. The default
12908
+ # value is `false`. Google employs search-query classification to detect jail-
12909
+ # breaking queries. No summary is returned if the search query is classified as
12910
+ # a jail-breaking query. A user might add instructions to the query to change
12911
+ # the tone, style, language, content of the answer, or ask the model to act as a
12912
+ # different entity, e.g. "Reply in the tone of a competing company's CEO". If
12913
+ # this field is set to `true`, we skip generating summaries for jail-breaking
12914
+ # queries and return fallback messages instead.
12915
+ # Corresponds to the JSON property `ignoreJailBreakingQuery`
12916
+ # @return [Boolean]
12917
+ attr_accessor :ignore_jail_breaking_query
12918
+ alias_method :ignore_jail_breaking_query?, :ignore_jail_breaking_query
12919
+
12659
12920
  # Specifies whether to filter out queries that have low relevance. The default
12660
12921
  # value is `false`. If this field is set to `false`, all search results are used
12661
12922
  # regardless of relevance to generate answers. If set to `true`, only queries
@@ -12735,6 +12996,7 @@ module Google
12735
12996
  # Update properties of this object
12736
12997
  def update!(**args)
12737
12998
  @ignore_adversarial_query = args[:ignore_adversarial_query] if args.key?(:ignore_adversarial_query)
12999
+ @ignore_jail_breaking_query = args[:ignore_jail_breaking_query] if args.key?(:ignore_jail_breaking_query)
12738
13000
  @ignore_low_relevant_content = args[:ignore_low_relevant_content] if args.key?(:ignore_low_relevant_content)
12739
13001
  @ignore_non_summary_seeking_query = args[:ignore_non_summary_seeking_query] if args.key?(:ignore_non_summary_seeking_query)
12740
13002
  @include_citations = args[:include_citations] if args.key?(:include_citations)
@@ -13168,6 +13430,26 @@ module Google
13168
13430
  end
13169
13431
  end
13170
13432
 
13433
+ # Stores information regarding the serving configurations at DataStore level.
13434
+ class GoogleCloudDiscoveryengineV1alphaServingConfigDataStore
13435
+ include Google::Apis::Core::Hashable
13436
+
13437
+ # If set true, the DataStore will not be available for serving search requests.
13438
+ # Corresponds to the JSON property `disabledForServing`
13439
+ # @return [Boolean]
13440
+ attr_accessor :disabled_for_serving
13441
+ alias_method :disabled_for_serving?, :disabled_for_serving
13442
+
13443
+ def initialize(**args)
13444
+ update!(**args)
13445
+ end
13446
+
13447
+ # Update properties of this object
13448
+ def update!(**args)
13449
+ @disabled_for_serving = args[:disabled_for_serving] if args.key?(:disabled_for_serving)
13450
+ end
13451
+ end
13452
+
13171
13453
  # External session proto definition.
13172
13454
  class GoogleCloudDiscoveryengineV1alphaSession
13173
13455
  include Google::Apis::Core::Hashable
@@ -13514,8 +13796,8 @@ module Google
13514
13796
  include Google::Apis::Core::Hashable
13515
13797
 
13516
13798
  # Required. The resource name of the engine that this tune applies to. Format: `
13517
- # projects/`project_number`/locations/`location_id`/collections/`collection_id`/
13518
- # engines/`engine_id``
13799
+ # projects/`project`/locations/`location`/collections/`collection_id`/engines/`
13800
+ # engine_id``
13519
13801
  # Corresponds to the JSON property `engine`
13520
13802
  # @return [String]
13521
13803
  attr_accessor :engine
@@ -14130,9 +14412,9 @@ module Google
14130
14412
  attr_accessor :model_version
14131
14413
 
14132
14414
  # Required. The fully qualified resource name of the model. Format: `projects/`
14133
- # project_number`/locations/`location`/collections/`collection`/dataStores/`
14134
- # data_store`/customTuningModels/`custom_tuning_model`` model must be an alpha-
14135
- # numerical string with limit of 40 characters.
14415
+ # project`/locations/`location`/collections/`collection`/dataStores/`data_store`/
14416
+ # customTuningModels/`custom_tuning_model``. Model must be an alpha-numerical
14417
+ # string with limit of 40 characters.
14136
14418
  # Corresponds to the JSON property `name`
14137
14419
  # @return [String]
14138
14420
  attr_accessor :name
@@ -14210,6 +14492,16 @@ module Google
14210
14492
  # @return [String]
14211
14493
  attr_accessor :name
14212
14494
 
14495
+ # Configuration for Natural Language Query Understanding.
14496
+ # Corresponds to the JSON property `naturalLanguageQueryUnderstandingConfig`
14497
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig]
14498
+ attr_accessor :natural_language_query_understanding_config
14499
+
14500
+ # Stores information regarding the serving configurations at DataStore level.
14501
+ # Corresponds to the JSON property `servingConfigDataStore`
14502
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaServingConfigDataStore]
14503
+ attr_accessor :serving_config_data_store
14504
+
14213
14505
  # The solutions that the data store enrolls. Available solutions for each
14214
14506
  # industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `
14215
14507
  # SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is
@@ -14242,6 +14534,8 @@ module Google
14242
14534
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
14243
14535
  @language_info = args[:language_info] if args.key?(:language_info)
14244
14536
  @name = args[:name] if args.key?(:name)
14537
+ @natural_language_query_understanding_config = args[:natural_language_query_understanding_config] if args.key?(:natural_language_query_understanding_config)
14538
+ @serving_config_data_store = args[:serving_config_data_store] if args.key?(:serving_config_data_store)
14245
14539
  @solution_types = args[:solution_types] if args.key?(:solution_types)
14246
14540
  @starting_schema = args[:starting_schema] if args.key?(:starting_schema)
14247
14541
  @workspace_config = args[:workspace_config] if args.key?(:workspace_config)
@@ -14427,8 +14721,9 @@ module Google
14427
14721
  # parsing are supported. * `docx`: Override parsing config for DOCX files, only
14428
14722
  # digital parsing and layout parsing are supported. * `pptx`: Override parsing
14429
14723
  # config for PPTX files, only digital parsing and layout parsing are supported. *
14430
- # `xlsx`: Override parsing config for XLSX files, only digital parsing and
14431
- # layout parsing are supported.
14724
+ # `xlsm`: Override parsing config for XLSM files, only digital parsing and
14725
+ # layout parsing are supported. * `xlsx`: Override parsing config for XLSX files,
14726
+ # only digital parsing and layout parsing are supported.
14432
14727
  # Corresponds to the JSON property `parsingConfigOverrides`
14433
14728
  # @return [Hash<String,Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig>]
14434
14729
  attr_accessor :parsing_config_overrides
@@ -14669,9 +14964,9 @@ module Google
14669
14964
 
14670
14965
  # Immutable. The fully qualified resource name of the engine. This field must be
14671
14966
  # a UTF-8 encoded string with a length limit of 1024 characters. Format: `
14672
- # projects/`project_number`/locations/`location`/collections/`collection`/
14673
- # engines/`engine`` engine should be 1-63 characters, and valid characters are /
14674
- # a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
14967
+ # projects/`project`/locations/`location`/collections/`collection`/engines/`
14968
+ # engine`` engine should be 1-63 characters, and valid characters are /a-z0-9*/.
14969
+ # Otherwise, an INVALID_ARGUMENT error is returned.
14675
14970
  # Corresponds to the JSON property `name`
14676
14971
  # @return [String]
14677
14972
  attr_accessor :name
@@ -15440,6 +15735,26 @@ module Google
15440
15735
  end
15441
15736
  end
15442
15737
 
15738
+ # Configuration for Natural Language Query Understanding.
15739
+ class GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig
15740
+ include Google::Apis::Core::Hashable
15741
+
15742
+ # Mode of Natural Language Query Understanding. If this field is unset, the
15743
+ # behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.
15744
+ # Corresponds to the JSON property `mode`
15745
+ # @return [String]
15746
+ attr_accessor :mode
15747
+
15748
+ def initialize(**args)
15749
+ update!(**args)
15750
+ end
15751
+
15752
+ # Update properties of this object
15753
+ def update!(**args)
15754
+ @mode = args[:mode] if args.key?(:mode)
15755
+ end
15756
+ end
15757
+
15443
15758
  # Metadata and configurations for a Google Cloud project in the service.
15444
15759
  class GoogleCloudDiscoveryengineV1betaProject
15445
15760
  include Google::Apis::Core::Hashable
@@ -15449,9 +15764,9 @@ module Google
15449
15764
  # @return [String]
15450
15765
  attr_accessor :create_time
15451
15766
 
15452
- # Output only. Full resource name of the project, for example `projects/`
15453
- # project_number``. Note that when making requests, project number and project
15454
- # id are both acceptable, but the server will always respond in project number.
15767
+ # Output only. Full resource name of the project, for example `projects/`project`
15768
+ # `. Note that when making requests, project number and project id are both
15769
+ # acceptable, but the server will always respond in project number.
15455
15770
  # Corresponds to the JSON property `name`
15456
15771
  # @return [String]
15457
15772
  attr_accessor :name
@@ -16424,6 +16739,19 @@ module Google
16424
16739
  attr_accessor :ignore_adversarial_query
16425
16740
  alias_method :ignore_adversarial_query?, :ignore_adversarial_query
16426
16741
 
16742
+ # Optional. Specifies whether to filter out jail-breaking queries. The default
16743
+ # value is `false`. Google employs search-query classification to detect jail-
16744
+ # breaking queries. No summary is returned if the search query is classified as
16745
+ # a jail-breaking query. A user might add instructions to the query to change
16746
+ # the tone, style, language, content of the answer, or ask the model to act as a
16747
+ # different entity, e.g. "Reply in the tone of a competing company's CEO". If
16748
+ # this field is set to `true`, we skip generating summaries for jail-breaking
16749
+ # queries and return fallback messages instead.
16750
+ # Corresponds to the JSON property `ignoreJailBreakingQuery`
16751
+ # @return [Boolean]
16752
+ attr_accessor :ignore_jail_breaking_query
16753
+ alias_method :ignore_jail_breaking_query?, :ignore_jail_breaking_query
16754
+
16427
16755
  # Specifies whether to filter out queries that have low relevance. The default
16428
16756
  # value is `false`. If this field is set to `false`, all search results are used
16429
16757
  # regardless of relevance to generate answers. If set to `true`, only queries
@@ -16503,6 +16831,7 @@ module Google
16503
16831
  # Update properties of this object
16504
16832
  def update!(**args)
16505
16833
  @ignore_adversarial_query = args[:ignore_adversarial_query] if args.key?(:ignore_adversarial_query)
16834
+ @ignore_jail_breaking_query = args[:ignore_jail_breaking_query] if args.key?(:ignore_jail_breaking_query)
16506
16835
  @ignore_low_relevant_content = args[:ignore_low_relevant_content] if args.key?(:ignore_low_relevant_content)
16507
16836
  @ignore_non_summary_seeking_query = args[:ignore_non_summary_seeking_query] if args.key?(:ignore_non_summary_seeking_query)
16508
16837
  @include_citations = args[:include_citations] if args.key?(:include_citations)
@@ -16936,6 +17265,26 @@ module Google
16936
17265
  end
16937
17266
  end
16938
17267
 
17268
+ # Stores information regarding the serving configurations at DataStore level.
17269
+ class GoogleCloudDiscoveryengineV1betaServingConfigDataStore
17270
+ include Google::Apis::Core::Hashable
17271
+
17272
+ # If set true, the DataStore will not be available for serving search requests.
17273
+ # Corresponds to the JSON property `disabledForServing`
17274
+ # @return [Boolean]
17275
+ attr_accessor :disabled_for_serving
17276
+ alias_method :disabled_for_serving?, :disabled_for_serving
17277
+
17278
+ def initialize(**args)
17279
+ update!(**args)
17280
+ end
17281
+
17282
+ # Update properties of this object
17283
+ def update!(**args)
17284
+ @disabled_for_serving = args[:disabled_for_serving] if args.key?(:disabled_for_serving)
17285
+ end
17286
+ end
17287
+
16939
17288
  # Verification information for target sites in advanced site search.
16940
17289
  class GoogleCloudDiscoveryengineV1betaSiteVerificationInfo
16941
17290
  include Google::Apis::Core::Hashable
@@ -17165,8 +17514,8 @@ module Google
17165
17514
  include Google::Apis::Core::Hashable
17166
17515
 
17167
17516
  # Required. The resource name of the engine that this tune applies to. Format: `
17168
- # projects/`project_number`/locations/`location_id`/collections/`collection_id`/
17169
- # engines/`engine_id``
17517
+ # projects/`project`/locations/`location`/collections/`collection_id`/engines/`
17518
+ # engine_id``
17170
17519
  # Corresponds to the JSON property `engine`
17171
17520
  # @return [String]
17172
17521
  attr_accessor :engine