google-apis-discoveryengine_v1alpha 0.19.0 → 0.21.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2771655dc924e116f60fe6915e797d93b5e1d9af86bd1191e9c88a8146b18144
4
- data.tar.gz: 2583373c9ae454e1c13050f593cb27cd623890e314bff89dedfe2a302f854f2a
3
+ metadata.gz: 1d83f6143023b0103165c9f92dd11536614f64fc9e03381e382dd9e0ce0dd8aa
4
+ data.tar.gz: a819bb70236be5504b446a4e6bfc550549e341cd69b48946b3de2a2fc8e89bd6
5
5
  SHA512:
6
- metadata.gz: 924cb236b0bc385e298a8bed1cc284c9566eaf06b518e5d5eb7e0a900bba266f9526626f26bf3d903fd32a7dd7060d59b1946342e068a21fea23623bf7747e77
7
- data.tar.gz: f7cdc5a55ebe84fb401645e82c1cd6b644033d7b82b01e6d10e46b7e851863b687bf3d44652f3d800ecebbb0f3f8cff06ee868353a4fcaa76839a9b34c1d41e4
6
+ metadata.gz: fe78f3e396644098b6d3390f0cc8171c65d3a4ee50806828b90b7f78c75c8bb6c629e2817ab64d8a3eb534514a4e40375d92c92df527d479d8cc4bfd1d8884bf
7
+ data.tar.gz: ca9e3fce00239cdc0755d120eb8cecfd8c3106b0fbb76f4c1fb3be204c761914b929e261f94e06f49f3ce5e133493f0b73f5940db1443e2209bff44d6611af05
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-discoveryengine_v1alpha
2
2
 
3
+ ### v0.21.0 (2023-09-24)
4
+
5
+ * Regenerated from discovery document revision 20230914
6
+
7
+ ### v0.20.0 (2023-09-10)
8
+
9
+ * Regenerated from discovery document revision 20230905
10
+
3
11
  ### v0.19.0 (2023-08-20)
4
12
 
5
13
  * Regenerated from discovery document revision 20230817
@@ -829,9 +829,9 @@ module Google
829
829
  # The unique document field paths that serve as the source of this suggestion if
830
830
  # it was generated from completable fields. This field is only populated for the
831
831
  # document-completable model.
832
- # Corresponds to the JSON property `completableFieldPath`
832
+ # Corresponds to the JSON property `completableFieldPaths`
833
833
  # @return [Array<String>]
834
- attr_accessor :completable_field_path
834
+ attr_accessor :completable_field_paths
835
835
 
836
836
  # The suggestion for the query.
837
837
  # Corresponds to the JSON property `suggestion`
@@ -844,7 +844,7 @@ module Google
844
844
 
845
845
  # Update properties of this object
846
846
  def update!(**args)
847
- @completable_field_path = args[:completable_field_path] if args.key?(:completable_field_path)
847
+ @completable_field_paths = args[:completable_field_paths] if args.key?(:completable_field_paths)
848
848
  @suggestion = args[:suggestion] if args.key?(:suggestion)
849
849
  end
850
850
  end
@@ -1022,6 +1022,11 @@ module Google
1022
1022
  # @return [String]
1023
1023
  attr_accessor :serving_config
1024
1024
 
1025
+ # A specification for configuring a summary returned in a search response.
1026
+ # Corresponds to the JSON property `summarySpec`
1027
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec]
1028
+ attr_accessor :summary_spec
1029
+
1025
1030
  # The user labels applied to a resource must meet the following requirements: *
1026
1031
  # Each resource can have multiple labels, up to a maximum of 64. * Each label
1027
1032
  # must be a key-value pair. * Keys have a minimum length of 1 character and a
@@ -1048,6 +1053,7 @@ module Google
1048
1053
  @query = args[:query] if args.key?(:query)
1049
1054
  @safe_search = args[:safe_search] if args.key?(:safe_search)
1050
1055
  @serving_config = args[:serving_config] if args.key?(:serving_config)
1056
+ @summary_spec = args[:summary_spec] if args.key?(:summary_spec)
1051
1057
  @user_labels = args[:user_labels] if args.key?(:user_labels)
1052
1058
  end
1053
1059
  end
@@ -2947,13 +2953,6 @@ module Google
2947
2953
  # @return [Fixnum]
2948
2954
  attr_accessor :num_previous_segments
2949
2955
 
2950
- # Specifies whether to return the confidence score from the extractive segments
2951
- # in each search result. The default value is `false`.
2952
- # Corresponds to the JSON property `returnExtractiveSegmentScore`
2953
- # @return [Boolean]
2954
- attr_accessor :return_extractive_segment_score
2955
- alias_method :return_extractive_segment_score?, :return_extractive_segment_score
2956
-
2957
2956
  def initialize(**args)
2958
2957
  update!(**args)
2959
2958
  end
@@ -2964,7 +2963,6 @@ module Google
2964
2963
  @max_extractive_segment_count = args[:max_extractive_segment_count] if args.key?(:max_extractive_segment_count)
2965
2964
  @num_next_segments = args[:num_next_segments] if args.key?(:num_next_segments)
2966
2965
  @num_previous_segments = args[:num_previous_segments] if args.key?(:num_previous_segments)
2967
- @return_extractive_segment_score = args[:return_extractive_segment_score] if args.key?(:return_extractive_segment_score)
2968
2966
  end
2969
2967
  end
2970
2968
 
@@ -3049,7 +3047,8 @@ module Google
3049
3047
  attr_accessor :include_citations
3050
3048
  alias_method :include_citations?, :include_citations
3051
3049
 
3052
- # Language code for Summary. Use language tags defined by BCP47.
3050
+ # Language code for Summary. Use language tags defined by [BCP47](https://www.
3051
+ # rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
3053
3052
  # Corresponds to the JSON property `languageCode`
3054
3053
  # @return [String]
3055
3054
  attr_accessor :language_code
@@ -3605,6 +3604,11 @@ module Google
3605
3604
  class GoogleCloudDiscoveryengineV1alphaSearchResponseSummary
3606
3605
  include Google::Apis::Core::Hashable
3607
3606
 
3607
+ # Safety Attribute categories and their associated confidence scores.
3608
+ # Corresponds to the JSON property `safetyAttributes`
3609
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes]
3610
+ attr_accessor :safety_attributes
3611
+
3608
3612
  # Additional summary-skipped reasons. This provides the reason for ignored cases.
3609
3613
  # If nothing is skipped, this field is not set.
3610
3614
  # Corresponds to the JSON property `summarySkippedReasons`
@@ -3622,11 +3626,39 @@ module Google
3622
3626
 
3623
3627
  # Update properties of this object
3624
3628
  def update!(**args)
3629
+ @safety_attributes = args[:safety_attributes] if args.key?(:safety_attributes)
3625
3630
  @summary_skipped_reasons = args[:summary_skipped_reasons] if args.key?(:summary_skipped_reasons)
3626
3631
  @summary_text = args[:summary_text] if args.key?(:summary_text)
3627
3632
  end
3628
3633
  end
3629
3634
 
3635
+ # Safety Attribute categories and their associated confidence scores.
3636
+ class GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes
3637
+ include Google::Apis::Core::Hashable
3638
+
3639
+ # The display names of Safety Attribute categories associated with the generated
3640
+ # content. Order matches the Scores.
3641
+ # Corresponds to the JSON property `categories`
3642
+ # @return [Array<String>]
3643
+ attr_accessor :categories
3644
+
3645
+ # The confidence scores of the each category, higher value means higher
3646
+ # confidence. Order matches the Categories.
3647
+ # Corresponds to the JSON property `scores`
3648
+ # @return [Array<Float>]
3649
+ attr_accessor :scores
3650
+
3651
+ def initialize(**args)
3652
+ update!(**args)
3653
+ end
3654
+
3655
+ # Update properties of this object
3656
+ def update!(**args)
3657
+ @categories = args[:categories] if args.key?(:categories)
3658
+ @scores = args[:scores] if args.key?(:scores)
3659
+ end
3660
+ end
3661
+
3630
3662
  # Verification information for target sites in advanced site search.
3631
3663
  class GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo
3632
3664
  include Google::Apis::Core::Hashable
@@ -3753,19 +3785,12 @@ module Google
3753
3785
  class GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure
3754
3786
  include Google::Apis::Core::Hashable
3755
3787
 
3756
- # This number is an estimation on how much total quota this project needs to
3757
- # successfully complete indexing.
3758
- # Corresponds to the JSON property `totalRequiredQuota`
3759
- # @return [Fixnum]
3760
- attr_accessor :total_required_quota
3761
-
3762
3788
  def initialize(**args)
3763
3789
  update!(**args)
3764
3790
  end
3765
3791
 
3766
3792
  # Update properties of this object
3767
3793
  def update!(**args)
3768
- @total_required_quota = args[:total_required_quota] if args.key?(:total_required_quota)
3769
3794
  end
3770
3795
  end
3771
3796
 
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DiscoveryengineV1alpha
18
18
  # Version of the google-apis-discoveryengine_v1alpha gem
19
- GEM_VERSION = "0.19.0"
19
+ GEM_VERSION = "0.21.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.12.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20230817"
25
+ REVISION = "20230914"
26
26
  end
27
27
  end
28
28
  end
@@ -574,6 +574,12 @@ module Google
574
574
  include Google::Apis::Core::JsonObjectSupport
575
575
  end
576
576
 
577
+ class GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes
578
+ class Representation < Google::Apis::Core::JsonRepresentation; end
579
+
580
+ include Google::Apis::Core::JsonObjectSupport
581
+ end
582
+
577
583
  class GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo
578
584
  class Representation < Google::Apis::Core::JsonRepresentation; end
579
585
 
@@ -1003,7 +1009,7 @@ module Google
1003
1009
  class GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion
1004
1010
  # @private
1005
1011
  class Representation < Google::Apis::Core::JsonRepresentation
1006
- collection :completable_field_path, as: 'completableFieldPath'
1012
+ collection :completable_field_paths, as: 'completableFieldPaths'
1007
1013
  property :suggestion, as: 'suggestion'
1008
1014
  end
1009
1015
  end
@@ -1058,6 +1064,8 @@ module Google
1058
1064
 
1059
1065
  property :safe_search, as: 'safeSearch'
1060
1066
  property :serving_config, as: 'servingConfig'
1067
+ property :summary_spec, as: 'summarySpec', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec::Representation
1068
+
1061
1069
  hash :user_labels, as: 'userLabels'
1062
1070
  end
1063
1071
  end
@@ -1536,7 +1544,6 @@ module Google
1536
1544
  property :max_extractive_segment_count, as: 'maxExtractiveSegmentCount'
1537
1545
  property :num_next_segments, as: 'numNextSegments'
1538
1546
  property :num_previous_segments, as: 'numPreviousSegments'
1539
- property :return_extractive_segment_score, as: 'returnExtractiveSegmentScore'
1540
1547
  end
1541
1548
  end
1542
1549
 
@@ -1704,11 +1711,21 @@ module Google
1704
1711
  class GoogleCloudDiscoveryengineV1alphaSearchResponseSummary
1705
1712
  # @private
1706
1713
  class Representation < Google::Apis::Core::JsonRepresentation
1714
+ property :safety_attributes, as: 'safetyAttributes', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes::Representation
1715
+
1707
1716
  collection :summary_skipped_reasons, as: 'summarySkippedReasons'
1708
1717
  property :summary_text, as: 'summaryText'
1709
1718
  end
1710
1719
  end
1711
1720
 
1721
+ class GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes
1722
+ # @private
1723
+ class Representation < Google::Apis::Core::JsonRepresentation
1724
+ collection :categories, as: 'categories'
1725
+ collection :scores, as: 'scores'
1726
+ end
1727
+ end
1728
+
1712
1729
  class GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo
1713
1730
  # @private
1714
1731
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1745,7 +1762,6 @@ module Google
1745
1762
  class GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure
1746
1763
  # @private
1747
1764
  class Representation < Google::Apis::Core::JsonRepresentation
1748
- property :total_required_quota, :numeric_string => true, as: 'totalRequiredQuota'
1749
1765
  end
1750
1766
  end
1751
1767
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-discoveryengine_v1alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.19.0
4
+ version: 0.21.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-08-20 00:00:00.000000000 Z
11
+ date: 2023-09-24 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.19.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.21.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha
63
63
  post_install_message:
64
64
  rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  - !ruby/object:Gem::Version
76
76
  version: '0'
77
77
  requirements: []
78
- rubygems_version: 3.4.2
78
+ rubygems_version: 3.4.19
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Discovery Engine API V1alpha