google-cloud-discovery_engine-v1beta 0.10.0 → 0.11.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (63) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +742 -0
  3. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/paths.rb +199 -0
  4. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +693 -0
  5. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/service_stub.rb +520 -0
  6. data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +48 -23
  7. data/lib/google/cloud/discovery_engine/v1beta/document_service/paths.rb +21 -0
  8. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb +48 -23
  9. data/lib/google/cloud/discovery_engine/v1beta/engine_service/client.rb +296 -0
  10. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/client.rb +275 -0
  11. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/service_stub.rb +180 -0
  12. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/client.rb +449 -0
  13. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/credentials.rb +47 -0
  14. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/paths.rb +52 -0
  15. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/client.rb +416 -0
  16. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/service_stub.rb +129 -0
  17. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest.rb +52 -0
  18. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service.rb +55 -0
  19. data/lib/google/cloud/discovery_engine/v1beta/rank_service/client.rb +459 -0
  20. data/lib/google/cloud/discovery_engine/v1beta/rank_service/credentials.rb +47 -0
  21. data/lib/google/cloud/discovery_engine/v1beta/rank_service/paths.rb +52 -0
  22. data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest/client.rb +426 -0
  23. data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest/service_stub.rb +129 -0
  24. data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest.rb +52 -0
  25. data/lib/google/cloud/discovery_engine/v1beta/rank_service.rb +55 -0
  26. data/lib/google/cloud/discovery_engine/v1beta/rest.rb +2 -0
  27. data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +11 -6
  28. data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +11 -6
  29. data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
  30. data/lib/google/cloud/discovery_engine/v1beta.rb +2 -0
  31. data/lib/google/cloud/discoveryengine/v1beta/answer_pb.rb +67 -0
  32. data/lib/google/cloud/discoveryengine/v1beta/common_pb.rb +1 -1
  33. data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +32 -1
  34. data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_services_pb.rb +25 -0
  35. data/lib/google/cloud/discoveryengine/v1beta/document_processing_config_pb.rb +1 -1
  36. data/lib/google/cloud/discoveryengine/v1beta/document_service_pb.rb +3 -1
  37. data/lib/google/cloud/discoveryengine/v1beta/engine_service_pb.rb +6 -1
  38. data/lib/google/cloud/discoveryengine/v1beta/engine_service_services_pb.rb +12 -0
  39. data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_pb.rb +52 -0
  40. data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_services_pb.rb +45 -0
  41. data/lib/google/cloud/discoveryengine/v1beta/grounding_pb.rb +46 -0
  42. data/lib/google/cloud/discoveryengine/v1beta/import_config_pb.rb +13 -1
  43. data/lib/google/cloud/discoveryengine/v1beta/rank_service_pb.rb +49 -0
  44. data/lib/google/cloud/discoveryengine/v1beta/rank_service_services_pb.rb +45 -0
  45. data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +7 -1
  46. data/lib/google/cloud/discoveryengine/v1beta/search_tuning_service_pb.rb +1 -1
  47. data/lib/google/cloud/discoveryengine/v1beta/session_pb.rb +50 -0
  48. data/proto_docs/google/cloud/discoveryengine/v1beta/answer.rb +354 -0
  49. data/proto_docs/google/cloud/discoveryengine/v1beta/common.rb +9 -1
  50. data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +475 -0
  51. data/proto_docs/google/cloud/discoveryengine/v1beta/document_processing_config.rb +3 -5
  52. data/proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb +4 -0
  53. data/proto_docs/google/cloud/discoveryengine/v1beta/engine.rb +2 -2
  54. data/proto_docs/google/cloud/discoveryengine/v1beta/engine_service.rb +51 -0
  55. data/proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb +106 -0
  56. data/proto_docs/google/cloud/discoveryengine/v1beta/grounding.rb +76 -0
  57. data/proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb +310 -24
  58. data/proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb +99 -0
  59. data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +154 -22
  60. data/proto_docs/google/cloud/discoveryengine/v1beta/search_tuning_service.rb +16 -1
  61. data/proto_docs/google/cloud/discoveryengine/v1beta/session.rb +85 -0
  62. data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb +1 -1
  63. metadata +28 -2
@@ -0,0 +1,99 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module DiscoveryEngine
23
+ module V1beta
24
+ # Record message for
25
+ # {::Google::Cloud::DiscoveryEngine::V1beta::RankService::Client#rank RankService.Rank}
26
+ # method.
27
+ # @!attribute [rw] id
28
+ # @return [::String]
29
+ # The unique ID to represent the record.
30
+ # @!attribute [rw] title
31
+ # @return [::String]
32
+ # The title of the record. Empty by default.
33
+ # At least one of
34
+ # {::Google::Cloud::DiscoveryEngine::V1beta::RankingRecord#title title} or
35
+ # {::Google::Cloud::DiscoveryEngine::V1beta::RankingRecord#content content} should
36
+ # be set otherwise an INVALID_ARGUMENT error is thrown.
37
+ # @!attribute [rw] content
38
+ # @return [::String]
39
+ # The content of the record. Empty by default.
40
+ # At least one of
41
+ # {::Google::Cloud::DiscoveryEngine::V1beta::RankingRecord#title title} or
42
+ # {::Google::Cloud::DiscoveryEngine::V1beta::RankingRecord#content content} should
43
+ # be set otherwise an INVALID_ARGUMENT error is thrown.
44
+ # @!attribute [rw] score
45
+ # @return [::Float]
46
+ # The score of this record based on the given query and selected model.
47
+ class RankingRecord
48
+ include ::Google::Protobuf::MessageExts
49
+ extend ::Google::Protobuf::MessageExts::ClassMethods
50
+ end
51
+
52
+ # Request message for
53
+ # {::Google::Cloud::DiscoveryEngine::V1beta::RankService::Client#rank RankService.Rank}
54
+ # method.
55
+ # @!attribute [rw] ranking_config
56
+ # @return [::String]
57
+ # Required. The resource name of the rank service config, such as
58
+ # `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`.
59
+ # @!attribute [rw] model
60
+ # @return [::String]
61
+ # The identifier of the model to use. It is one of:
62
+ #
63
+ # * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input
64
+ # token size 512.
65
+ #
66
+ # It is set to `semantic-ranker-512@latest` by default if unspecified.
67
+ # @!attribute [rw] top_n
68
+ # @return [::Integer]
69
+ # The number of results to return. If this is unset or no bigger than zero,
70
+ # returns all results.
71
+ # @!attribute [rw] query
72
+ # @return [::String]
73
+ # The query to use.
74
+ # @!attribute [rw] records
75
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::RankingRecord>]
76
+ # Required. A list of records to rank. At most 200 records to rank.
77
+ # @!attribute [rw] ignore_record_details_in_response
78
+ # @return [::Boolean]
79
+ # If true, the response will contain only record ID and score. By default, it
80
+ # is false, the response will contain record details.
81
+ class RankRequest
82
+ include ::Google::Protobuf::MessageExts
83
+ extend ::Google::Protobuf::MessageExts::ClassMethods
84
+ end
85
+
86
+ # Response message for
87
+ # {::Google::Cloud::DiscoveryEngine::V1beta::RankService::Client#rank RankService.Rank}
88
+ # method.
89
+ # @!attribute [rw] records
90
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::RankingRecord>]
91
+ # A list of records sorted by descending score.
92
+ class RankResponse
93
+ include ::Google::Protobuf::MessageExts
94
+ extend ::Google::Protobuf::MessageExts::ClassMethods
95
+ end
96
+ end
97
+ end
98
+ end
99
+ end
@@ -48,10 +48,14 @@ module Google
48
48
  # @!attribute [rw] page_size
49
49
  # @return [::Integer]
50
50
  # Maximum number of {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s
51
- # to return. If unspecified, defaults to a reasonable value. The maximum
52
- # allowed value is 100. Values above 100 are coerced to 100.
51
+ # to return. The maximum allowed value depends on the data type. Values above
52
+ # the maximum value are coerced to the maximum value.
53
53
  #
54
- # If this field is negative, an `INVALID_ARGUMENT` is returned.
54
+ # * Websites with basic indexing: Default `10`, Maximum `25`.
55
+ # * Websites with advanced indexing: Default `25`, Maximum `50`.
56
+ # * Other: Default `50`, Maximum `100`.
57
+ #
58
+ # If this field is negative, an `INVALID_ARGUMENT` is returned.
55
59
  # @!attribute [rw] page_token
56
60
  # @return [::String]
57
61
  # A page token received from a previous
@@ -188,7 +192,8 @@ module Google
188
192
  #
189
193
  # If
190
194
  # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::EmbeddingSpec::EmbeddingVector#field_path SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}
191
- # is not provided, it will use [ServingConfig.EmbeddingConfig.field_path][].
195
+ # is not provided, it will use
196
+ # {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig#embedding_config ServingConfig.EmbeddingConfig.field_path}.
192
197
  # @!attribute [rw] ranking_expression
193
198
  # @return [::String]
194
199
  # The ranking expression controls the customized ranking on retrieval
@@ -425,23 +430,109 @@ module Google
425
430
  # Strength of the condition boost, which should be in [-1, 1]. Negative
426
431
  # boost means demotion. Default is 0.0.
427
432
  #
428
- # Setting to 1.0 gives the document a big promotion. However, it does not
429
- # necessarily mean that the boosted document will be the top result at
430
- # all times, nor that other documents will be excluded. Results could
431
- # still be shown even when none of them matches the condition. And
432
- # results that are significantly more relevant to the search query can
433
- # still trump your heavily favored but irrelevant documents.
433
+ # Setting to 1.0 gives the document a big promotion. However, it does
434
+ # not necessarily mean that the boosted document will be the top result
435
+ # at all times, nor that other documents will be excluded. Results
436
+ # could still be shown even when none of them matches the condition.
437
+ # And results that are significantly more relevant to the search query
438
+ # can still trump your heavily favored but irrelevant documents.
434
439
  #
435
440
  # Setting to -1.0 gives the document a big demotion. However, results
436
441
  # that are deeply relevant might still be shown. The document will have
437
- # an upstream battle to get a fairly high ranking, but it is not blocked
438
- # out completely.
442
+ # an upstream battle to get a fairly high ranking, but it is not
443
+ # blocked out completely.
439
444
  #
440
445
  # Setting to 0.0 means no boost applied. The boosting condition is
441
- # ignored.
446
+ # ignored. Only one of the (condition, boost) combination or the
447
+ # boost_control_spec below are set. If both are set then the global boost
448
+ # is ignored and the more fine-grained boost_control_spec is applied.
449
+ # @!attribute [rw] boost_control_spec
450
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec]
451
+ # Complex specification for custom ranking based on customer defined
452
+ # attribute value.
442
453
  class ConditionBoostSpec
443
454
  include ::Google::Protobuf::MessageExts
444
455
  extend ::Google::Protobuf::MessageExts::ClassMethods
456
+
457
+ # Specification for custom ranking based on customer specified attribute
458
+ # value. It provides more controls for customized ranking than the simple
459
+ # (condition, boost) combination above.
460
+ # @!attribute [rw] field_name
461
+ # @return [::String]
462
+ # The name of the field whose value will be used to determine the
463
+ # boost amount.
464
+ # @!attribute [rw] attribute_type
465
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec::AttributeType]
466
+ # The attribute type to be used to determine the boost amount. The
467
+ # attribute value can be derived from the field value of the specified
468
+ # field_name. In the case of numerical it is straightforward i.e.
469
+ # attribute_value = numerical_field_value. In the case of freshness
470
+ # however, attribute_value = (time.now() - datetime_field_value).
471
+ # @!attribute [rw] interpolation_type
472
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec::InterpolationType]
473
+ # The interpolation type to be applied to connect the control points
474
+ # listed below.
475
+ # @!attribute [rw] control_points
476
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec::ControlPoint>]
477
+ # The control points used to define the curve. The monotonic function
478
+ # (defined through the interpolation_type above) passes through the
479
+ # control points listed here.
480
+ class BoostControlSpec
481
+ include ::Google::Protobuf::MessageExts
482
+ extend ::Google::Protobuf::MessageExts::ClassMethods
483
+
484
+ # The control points used to define the curve. The curve defined
485
+ # through these control points can only be monotonically increasing
486
+ # or decreasing(constant values are acceptable).
487
+ # @!attribute [rw] attribute_value
488
+ # @return [::String]
489
+ # Can be one of:
490
+ # 1. The numerical field value.
491
+ # 2. The duration spec for freshness:
492
+ # The value must be formatted as an XSD `dayTimeDuration` value (a
493
+ # restricted subset of an ISO 8601 duration value). The pattern for
494
+ # this is: `[nD][T[nH][nM][nS]]`.
495
+ # @!attribute [rw] boost_amount
496
+ # @return [::Float]
497
+ # The value between -1 to 1 by which to boost the score if the
498
+ # attribute_value evaluates to the value specified above.
499
+ class ControlPoint
500
+ include ::Google::Protobuf::MessageExts
501
+ extend ::Google::Protobuf::MessageExts::ClassMethods
502
+ end
503
+
504
+ # The attribute(or function) for which the custom ranking is to be
505
+ # applied.
506
+ module AttributeType
507
+ # Unspecified AttributeType.
508
+ ATTRIBUTE_TYPE_UNSPECIFIED = 0
509
+
510
+ # The value of the numerical field will be used to dynamically update
511
+ # the boost amount. In this case, the attribute_value (the x value)
512
+ # of the control point will be the actual value of the numerical
513
+ # field for which the boost_amount is specified.
514
+ NUMERICAL = 1
515
+
516
+ # For the freshness use case the attribute value will be the duration
517
+ # between the current time and the date in the datetime field
518
+ # specified. The value must be formatted as an XSD `dayTimeDuration`
519
+ # value (a restricted subset of an ISO 8601 duration value). The
520
+ # pattern for this is: `[nD][T[nH][nM][nS]]`.
521
+ # E.g. `5D`, `3DT12H30M`, `T24H`.
522
+ FRESHNESS = 2
523
+ end
524
+
525
+ # The interpolation type to be applied. Default will be linear
526
+ # (Piecewise Linear).
527
+ module InterpolationType
528
+ # Interpolation type is unspecified. In this case, it defaults to
529
+ # Linear.
530
+ INTERPOLATION_TYPE_UNSPECIFIED = 0
531
+
532
+ # Piecewise linear interpolation will be applied.
533
+ LINEAR = 1
534
+ end
535
+ end
445
536
  end
446
537
  end
447
538
 
@@ -611,6 +702,14 @@ module Google
611
702
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::ModelSpec]
612
703
  # If specified, the spec will be used to modify the model specification
613
704
  # provided to the LLM.
705
+ # @!attribute [rw] use_semantic_chunks
706
+ # @return [::Boolean]
707
+ # If true, answer will be generated from most relevant chunks from top
708
+ # search results. This feature will improve summary quality.
709
+ # Note that with this feature enabled, not all top search results
710
+ # will be referenced and included in the reference list, so the citation
711
+ # source index only points to the search results listed in the reference
712
+ # list.
614
713
  class SummarySpec
615
714
  include ::Google::Protobuf::MessageExts
616
715
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -633,11 +732,13 @@ module Google
633
732
  # Supported values are:
634
733
  #
635
734
  # * `stable`: string. Default value when no value is specified. Uses a
636
- # generally available, fine-tuned version of the text-bison@001
637
- # model.
638
- # * `preview`: string. (Public preview) Uses a fine-tuned version of
639
- # the text-bison@002 model. This model works only for summaries in
640
- # English.
735
+ # generally available, fine-tuned model. For more information, see
736
+ # [Answer generation model versions and
737
+ # lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
738
+ # * `preview`: string. (Public preview) Uses a preview model. For more
739
+ # information, see
740
+ # [Answer generation model versions and
741
+ # lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
641
742
  class ModelSpec
642
743
  include ::Google::Protobuf::MessageExts
643
744
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -683,10 +784,9 @@ module Google
683
784
  # @!attribute [rw] return_extractive_segment_score
684
785
  # @return [::Boolean]
685
786
  # Specifies whether to return the confidence score from the extractive
686
- # segments in each search result. The default value is `false`.
687
- #
688
- # Note: this is a priavte preview feature and only works for allowlisted
689
- # users, please reach out to Cloud Support team if you want to use it.
787
+ # segments in each search result. This feature is available only for new
788
+ # or allowlisted data stores. To allowlist your data store,
789
+ # contact your Customer Engineer. The default value is `false`.
690
790
  # @!attribute [rw] num_previous_segments
691
791
  # @return [::Integer]
692
792
  # Specifies whether to also include the adjacent from each selected
@@ -798,6 +898,10 @@ module Google
798
898
  # @!attribute [rw] applied_controls
799
899
  # @return [::Array<::String>]
800
900
  # Controls applied as part of the Control service.
901
+ # @!attribute [rw] geo_search_debug_info
902
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GeoSearchDebugInfo>]
903
+ # Debug information specifically related to forward geocoding issues arising
904
+ # from Geolocation Search.
801
905
  # @!attribute [rw] query_expansion_info
802
906
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::QueryExpansionInfo]
803
907
  # Query expansion information for the returned results.
@@ -971,9 +1075,24 @@ module Google
971
1075
  # @!attribute [rw] uri
972
1076
  # @return [::String]
973
1077
  # Cloud Storage or HTTP uri for the document.
1078
+ # @!attribute [rw] chunk_contents
1079
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference::ChunkContent>]
1080
+ # List of cited chunk contents derived from document content.
974
1081
  class Reference
975
1082
  include ::Google::Protobuf::MessageExts
976
1083
  extend ::Google::Protobuf::MessageExts::ClassMethods
1084
+
1085
+ # Chunk content.
1086
+ # @!attribute [rw] content
1087
+ # @return [::String]
1088
+ # Chunk textual content.
1089
+ # @!attribute [rw] page_identifier
1090
+ # @return [::String]
1091
+ # Page identifier.
1092
+ class ChunkContent
1093
+ include ::Google::Protobuf::MessageExts
1094
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1095
+ end
977
1096
  end
978
1097
 
979
1098
  # Summary with metadata information.
@@ -1030,6 +1149,19 @@ module Google
1030
1149
  end
1031
1150
  end
1032
1151
 
1152
+ # Debug information specifically related to forward geocoding issues arising
1153
+ # from Geolocation Search.
1154
+ # @!attribute [rw] original_address_query
1155
+ # @return [::String]
1156
+ # The address from which forward geocoding ingestion produced issues.
1157
+ # @!attribute [rw] error_message
1158
+ # @return [::String]
1159
+ # The error produced.
1160
+ class GeoSearchDebugInfo
1161
+ include ::Google::Protobuf::MessageExts
1162
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1163
+ end
1164
+
1033
1165
  # Information describing query expansion including whether expansion has
1034
1166
  # occurred.
1035
1167
  # @!attribute [rw] expanded_query
@@ -100,11 +100,26 @@ module Google
100
100
  #
101
101
  # * **bad-data**: The training data quality is bad.
102
102
  # * **no-improvement**: Tuning didn't improve performance. Won't deploy.
103
- # * **in-progress**: Model training is in progress.
103
+ # * **in-progress**: Model training job creation is in progress.
104
+ # * **training**: Model is actively training.
105
+ # * **evaluating**: The model is evaluating trained metrics.
106
+ # * **indexing**: The model trained metrics are indexing.
104
107
  # * **ready**: The model is ready for serving.
108
+ # @!attribute [rw] metrics
109
+ # @return [::Google::Protobuf::Map{::String => ::Float}]
110
+ # The metrics of the trained model.
105
111
  class TrainCustomModelResponse
106
112
  include ::Google::Protobuf::MessageExts
107
113
  extend ::Google::Protobuf::MessageExts::ClassMethods
114
+
115
+ # @!attribute [rw] key
116
+ # @return [::String]
117
+ # @!attribute [rw] value
118
+ # @return [::Float]
119
+ class MetricsEntry
120
+ include ::Google::Protobuf::MessageExts
121
+ extend ::Google::Protobuf::MessageExts::ClassMethods
122
+ end
108
123
  end
109
124
 
110
125
  # Metadata related to the progress of the TrainCustomModel operation. This is
@@ -0,0 +1,85 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module DiscoveryEngine
23
+ module V1beta
24
+ # External session proto definition.
25
+ # @!attribute [rw] name
26
+ # @return [::String]
27
+ # Immutable. Fully qualified name
28
+ # `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
29
+ # @!attribute [rw] state
30
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Session::State]
31
+ # The state of the session.
32
+ # @!attribute [rw] user_pseudo_id
33
+ # @return [::String]
34
+ # A unique identifier for tracking users.
35
+ # @!attribute [rw] turns
36
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Session::Turn>]
37
+ # Turns.
38
+ # @!attribute [r] start_time
39
+ # @return [::Google::Protobuf::Timestamp]
40
+ # Output only. The time the session started.
41
+ # @!attribute [r] end_time
42
+ # @return [::Google::Protobuf::Timestamp]
43
+ # Output only. The time the session finished.
44
+ class Session
45
+ include ::Google::Protobuf::MessageExts
46
+ extend ::Google::Protobuf::MessageExts::ClassMethods
47
+
48
+ # Represents a turn, including a query from the user and a
49
+ # answer from service.
50
+ # @!attribute [rw] query
51
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Query]
52
+ # The user query.
53
+ # @!attribute [rw] answer
54
+ # @return [::String]
55
+ # The resource name of the answer to the user query.
56
+ class Turn
57
+ include ::Google::Protobuf::MessageExts
58
+ extend ::Google::Protobuf::MessageExts::ClassMethods
59
+ end
60
+
61
+ # Enumeration of the state of the session.
62
+ module State
63
+ # State is unspecified.
64
+ STATE_UNSPECIFIED = 0
65
+
66
+ # The session is currently open.
67
+ IN_PROGRESS = 1
68
+ end
69
+ end
70
+
71
+ # Defines a user inputed query.
72
+ # @!attribute [rw] text
73
+ # @return [::String]
74
+ # Plain text.
75
+ # @!attribute [rw] query_id
76
+ # @return [::String]
77
+ # Unique Id for the query.
78
+ class Query
79
+ include ::Google::Protobuf::MessageExts
80
+ extend ::Google::Protobuf::MessageExts::ClassMethods
81
+ end
82
+ end
83
+ end
84
+ end
85
+ end
@@ -255,7 +255,7 @@ module Google
255
255
  # The most specific category associated with a category page.
256
256
  #
257
257
  # To represent full path of category, use '>' sign to separate different
258
- # hierarchies. If '>' is part of the category name, please replace it with
258
+ # hierarchies. If '>' is part of the category name, replace it with
259
259
  # other character(s).
260
260
  #
261
261
  # Category pages include special pages such as sales or promotions. For
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-discovery_engine-v1beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.10.0
4
+ version: 0.11.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: 2024-03-18 00:00:00.000000000 Z
11
+ date: 2024-04-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -122,6 +122,20 @@ files:
122
122
  - lib/google/cloud/discovery_engine/v1beta/engine_service/rest/client.rb
123
123
  - lib/google/cloud/discovery_engine/v1beta/engine_service/rest/operations.rb
124
124
  - lib/google/cloud/discovery_engine/v1beta/engine_service/rest/service_stub.rb
125
+ - lib/google/cloud/discovery_engine/v1beta/grounded_generation_service.rb
126
+ - lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/client.rb
127
+ - lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/credentials.rb
128
+ - lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/paths.rb
129
+ - lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest.rb
130
+ - lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/client.rb
131
+ - lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/service_stub.rb
132
+ - lib/google/cloud/discovery_engine/v1beta/rank_service.rb
133
+ - lib/google/cloud/discovery_engine/v1beta/rank_service/client.rb
134
+ - lib/google/cloud/discovery_engine/v1beta/rank_service/credentials.rb
135
+ - lib/google/cloud/discovery_engine/v1beta/rank_service/paths.rb
136
+ - lib/google/cloud/discovery_engine/v1beta/rank_service/rest.rb
137
+ - lib/google/cloud/discovery_engine/v1beta/rank_service/rest/client.rb
138
+ - lib/google/cloud/discovery_engine/v1beta/rank_service/rest/service_stub.rb
125
139
  - lib/google/cloud/discovery_engine/v1beta/recommendation_service.rb
126
140
  - lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb
127
141
  - lib/google/cloud/discovery_engine/v1beta/recommendation_service/credentials.rb
@@ -181,6 +195,7 @@ files:
181
195
  - lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb
182
196
  - lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/service_stub.rb
183
197
  - lib/google/cloud/discovery_engine/v1beta/version.rb
198
+ - lib/google/cloud/discoveryengine/v1beta/answer_pb.rb
184
199
  - lib/google/cloud/discoveryengine/v1beta/common_pb.rb
185
200
  - lib/google/cloud/discoveryengine/v1beta/completion_pb.rb
186
201
  - lib/google/cloud/discoveryengine/v1beta/completion_service_pb.rb
@@ -198,8 +213,13 @@ files:
198
213
  - lib/google/cloud/discoveryengine/v1beta/engine_pb.rb
199
214
  - lib/google/cloud/discoveryengine/v1beta/engine_service_pb.rb
200
215
  - lib/google/cloud/discoveryengine/v1beta/engine_service_services_pb.rb
216
+ - lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_pb.rb
217
+ - lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_services_pb.rb
218
+ - lib/google/cloud/discoveryengine/v1beta/grounding_pb.rb
201
219
  - lib/google/cloud/discoveryengine/v1beta/import_config_pb.rb
202
220
  - lib/google/cloud/discoveryengine/v1beta/purge_config_pb.rb
221
+ - lib/google/cloud/discoveryengine/v1beta/rank_service_pb.rb
222
+ - lib/google/cloud/discoveryengine/v1beta/rank_service_services_pb.rb
203
223
  - lib/google/cloud/discoveryengine/v1beta/recommendation_service_pb.rb
204
224
  - lib/google/cloud/discoveryengine/v1beta/recommendation_service_services_pb.rb
205
225
  - lib/google/cloud/discoveryengine/v1beta/schema_pb.rb
@@ -212,6 +232,7 @@ files:
212
232
  - lib/google/cloud/discoveryengine/v1beta/serving_config_pb.rb
213
233
  - lib/google/cloud/discoveryengine/v1beta/serving_config_service_pb.rb
214
234
  - lib/google/cloud/discoveryengine/v1beta/serving_config_service_services_pb.rb
235
+ - lib/google/cloud/discoveryengine/v1beta/session_pb.rb
215
236
  - lib/google/cloud/discoveryengine/v1beta/site_search_engine_pb.rb
216
237
  - lib/google/cloud/discoveryengine/v1beta/site_search_engine_service_pb.rb
217
238
  - lib/google/cloud/discoveryengine/v1beta/site_search_engine_service_services_pb.rb
@@ -224,6 +245,7 @@ files:
224
245
  - proto_docs/google/api/httpbody.rb
225
246
  - proto_docs/google/api/launch_stage.rb
226
247
  - proto_docs/google/api/resource.rb
248
+ - proto_docs/google/cloud/discoveryengine/v1beta/answer.rb
227
249
  - proto_docs/google/cloud/discoveryengine/v1beta/common.rb
228
250
  - proto_docs/google/cloud/discoveryengine/v1beta/completion.rb
229
251
  - proto_docs/google/cloud/discoveryengine/v1beta/completion_service.rb
@@ -236,8 +258,11 @@ files:
236
258
  - proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb
237
259
  - proto_docs/google/cloud/discoveryengine/v1beta/engine.rb
238
260
  - proto_docs/google/cloud/discoveryengine/v1beta/engine_service.rb
261
+ - proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb
262
+ - proto_docs/google/cloud/discoveryengine/v1beta/grounding.rb
239
263
  - proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb
240
264
  - proto_docs/google/cloud/discoveryengine/v1beta/purge_config.rb
265
+ - proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb
241
266
  - proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb
242
267
  - proto_docs/google/cloud/discoveryengine/v1beta/schema.rb
243
268
  - proto_docs/google/cloud/discoveryengine/v1beta/schema_service.rb
@@ -245,6 +270,7 @@ files:
245
270
  - proto_docs/google/cloud/discoveryengine/v1beta/search_tuning_service.rb
246
271
  - proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb
247
272
  - proto_docs/google/cloud/discoveryengine/v1beta/serving_config_service.rb
273
+ - proto_docs/google/cloud/discoveryengine/v1beta/session.rb
248
274
  - proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb
249
275
  - proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine_service.rb
250
276
  - proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb