google-cloud-discovery_engine-v1 2.2.0 → 2.3.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.
Files changed (87) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +4 -4
  3. data/README.md +4 -4
  4. data/lib/google/cloud/discovery_engine/v1/cmek_config_service/client.rb +803 -0
  5. data/lib/google/cloud/discovery_engine/v1/cmek_config_service/credentials.rb +47 -0
  6. data/lib/google/cloud/discovery_engine/v1/cmek_config_service/operations.rb +813 -0
  7. data/lib/google/cloud/discovery_engine/v1/cmek_config_service/paths.rb +135 -0
  8. data/lib/google/cloud/discovery_engine/v1/cmek_config_service/rest/client.rb +749 -0
  9. data/lib/google/cloud/discovery_engine/v1/cmek_config_service/rest/operations.rb +1148 -0
  10. data/lib/google/cloud/discovery_engine/v1/cmek_config_service/rest/service_stub.rb +341 -0
  11. data/lib/google/cloud/discovery_engine/v1/cmek_config_service/rest.rb +53 -0
  12. data/lib/google/cloud/discovery_engine/v1/cmek_config_service.rb +56 -0
  13. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/operations.rb +8 -0
  14. data/lib/google/cloud/discovery_engine/v1/control_service/paths.rb +53 -0
  15. data/lib/google/cloud/discovery_engine/v1/data_store_service/client.rb +11 -1
  16. data/lib/google/cloud/discovery_engine/v1/data_store_service/paths.rb +104 -0
  17. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/client.rb +11 -1
  18. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/operations.rb +8 -0
  19. data/lib/google/cloud/discovery_engine/v1/document_service/rest/operations.rb +8 -0
  20. data/lib/google/cloud/discovery_engine/v1/engine_service/rest/operations.rb +8 -0
  21. data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/client.rb +1160 -0
  22. data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/credentials.rb +47 -0
  23. data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/operations.rb +813 -0
  24. data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/paths.rb +154 -0
  25. data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/rest/client.rb +1085 -0
  26. data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/rest/operations.rb +1148 -0
  27. data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/rest/service_stub.rb +511 -0
  28. data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/rest.rb +53 -0
  29. data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service.rb +56 -0
  30. data/lib/google/cloud/discovery_engine/v1/project_service/rest/operations.rb +8 -0
  31. data/lib/google/cloud/discovery_engine/v1/rest.rb +4 -1
  32. data/lib/google/cloud/discovery_engine/v1/schema_service/rest/operations.rb +8 -0
  33. data/lib/google/cloud/discovery_engine/v1/search_tuning_service/rest/operations.rb +8 -0
  34. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/operations.rb +8 -0
  35. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/operations.rb +8 -0
  36. data/lib/google/cloud/discovery_engine/v1/user_license_service/client.rb +630 -0
  37. data/lib/google/cloud/discovery_engine/v1/user_license_service/credentials.rb +47 -0
  38. data/lib/google/cloud/discovery_engine/v1/user_license_service/operations.rb +813 -0
  39. data/lib/google/cloud/discovery_engine/v1/user_license_service/paths.rb +71 -0
  40. data/lib/google/cloud/discovery_engine/v1/user_license_service/rest/client.rb +590 -0
  41. data/lib/google/cloud/discovery_engine/v1/user_license_service/rest/operations.rb +1148 -0
  42. data/lib/google/cloud/discovery_engine/v1/user_license_service/rest/service_stub.rb +204 -0
  43. data/lib/google/cloud/discovery_engine/v1/user_license_service/rest.rb +53 -0
  44. data/lib/google/cloud/discovery_engine/v1/user_license_service.rb +56 -0
  45. data/lib/google/cloud/discovery_engine/v1/version.rb +1 -1
  46. data/lib/google/cloud/discovery_engine/v1.rb +5 -2
  47. data/lib/google/cloud/discoveryengine/v1/answer_pb.rb +1 -1
  48. data/lib/google/cloud/discoveryengine/v1/chunk_pb.rb +4 -1
  49. data/lib/google/cloud/discoveryengine/v1/cmek_config_service_pb.rb +61 -0
  50. data/lib/google/cloud/discoveryengine/v1/cmek_config_service_services_pb.rb +55 -0
  51. data/lib/google/cloud/discoveryengine/v1/common_pb.rb +3 -1
  52. data/lib/google/cloud/discoveryengine/v1/conversational_search_service_pb.rb +1 -1
  53. data/lib/google/cloud/discoveryengine/v1/data_store_pb.rb +4 -1
  54. data/lib/google/cloud/discoveryengine/v1/data_store_service_pb.rb +1 -1
  55. data/lib/google/cloud/discoveryengine/v1/document_pb.rb +5 -1
  56. data/lib/google/cloud/discoveryengine/v1/document_processing_config_pb.rb +1 -1
  57. data/lib/google/cloud/discoveryengine/v1/engine_pb.rb +7 -1
  58. data/lib/google/cloud/discoveryengine/v1/grounded_generation_service_pb.rb +1 -1
  59. data/lib/google/cloud/discoveryengine/v1/grounding_pb.rb +1 -1
  60. data/lib/google/cloud/discoveryengine/v1/identity_mapping_store_pb.rb +48 -0
  61. data/lib/google/cloud/discoveryengine/v1/identity_mapping_store_service_pb.rb +68 -0
  62. data/lib/google/cloud/discoveryengine/v1/identity_mapping_store_service_services_pb.rb +58 -0
  63. data/lib/google/cloud/discoveryengine/v1/search_service_pb.rb +1 -1
  64. data/lib/google/cloud/discoveryengine/v1/site_search_engine_pb.rb +1 -1
  65. data/lib/google/cloud/discoveryengine/v1/user_license_pb.rb +48 -0
  66. data/lib/google/cloud/discoveryengine/v1/user_license_service_pb.rb +61 -0
  67. data/lib/google/cloud/discoveryengine/v1/user_license_service_services_pb.rb +48 -0
  68. data/proto_docs/google/cloud/discoveryengine/v1/answer.rb +17 -0
  69. data/proto_docs/google/cloud/discoveryengine/v1/chunk.rb +54 -0
  70. data/proto_docs/google/cloud/discoveryengine/v1/cmek_config_service.rb +222 -0
  71. data/proto_docs/google/cloud/discoveryengine/v1/common.rb +55 -0
  72. data/proto_docs/google/cloud/discoveryengine/v1/control.rb +1 -3
  73. data/proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb +3 -0
  74. data/proto_docs/google/cloud/discoveryengine/v1/data_store.rb +43 -1
  75. data/proto_docs/google/cloud/discoveryengine/v1/data_store_service.rb +12 -0
  76. data/proto_docs/google/cloud/discoveryengine/v1/document.rb +99 -4
  77. data/proto_docs/google/cloud/discoveryengine/v1/document_processing_config.rb +23 -0
  78. data/proto_docs/google/cloud/discoveryengine/v1/engine.rb +141 -5
  79. data/proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb +8 -0
  80. data/proto_docs/google/cloud/discoveryengine/v1/grounding.rb +9 -0
  81. data/proto_docs/google/cloud/discoveryengine/v1/identity_mapping_store.rb +81 -0
  82. data/proto_docs/google/cloud/discoveryengine/v1/identity_mapping_store_service.rb +279 -0
  83. data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb +6 -0
  84. data/proto_docs/google/cloud/discoveryengine/v1/site_search_engine.rb +6 -0
  85. data/proto_docs/google/cloud/discoveryengine/v1/user_license.rb +85 -0
  86. data/proto_docs/google/cloud/discoveryengine/v1/user_license_service.rb +153 -0
  87. metadata +42 -2
@@ -121,6 +121,56 @@ module Google
121
121
  extend ::Google::Protobuf::MessageExts::ClassMethods
122
122
  end
123
123
 
124
+ # Principal identifier of a user or a group.
125
+ # @!attribute [rw] user_id
126
+ # @return [::String]
127
+ # User identifier.
128
+ # For Google Workspace user account, user_id should be the google workspace
129
+ # user email.
130
+ # For non-google identity provider user account, user_id is the mapped user
131
+ # identifier configured during the workforcepool config.
132
+ #
133
+ # Note: The following fields are mutually exclusive: `user_id`, `group_id`, `external_entity_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
134
+ # @!attribute [rw] group_id
135
+ # @return [::String]
136
+ # Group identifier.
137
+ # For Google Workspace user account, group_id should be the google
138
+ # workspace group email.
139
+ # For non-google identity provider user account, group_id is the mapped
140
+ # group identifier configured during the workforcepool config.
141
+ #
142
+ # Note: The following fields are mutually exclusive: `group_id`, `user_id`, `external_entity_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
143
+ # @!attribute [rw] external_entity_id
144
+ # @return [::String]
145
+ # For 3P application identities which are not present in the customer
146
+ # identity provider.
147
+ #
148
+ # Note: The following fields are mutually exclusive: `external_entity_id`, `user_id`, `group_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
149
+ class Principal
150
+ include ::Google::Protobuf::MessageExts
151
+ extend ::Google::Protobuf::MessageExts::ClassMethods
152
+ end
153
+
154
+ # Config to data store for `HEALTHCARE_FHIR` vertical.
155
+ # @!attribute [rw] enable_configurable_schema
156
+ # @return [::Boolean]
157
+ # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical.
158
+ #
159
+ # If set to `true`, the predefined healthcare fhir schema can be extended
160
+ # for more customized searching and filtering.
161
+ # @!attribute [rw] enable_static_indexing_for_batch_ingestion
162
+ # @return [::Boolean]
163
+ # Whether to enable static indexing for `HEALTHCARE_FHIR` batch
164
+ # ingestion.
165
+ #
166
+ # If set to `true`, the batch ingestion will be processed in a static
167
+ # indexing mode which is slower but more capable of handling larger
168
+ # volume.
169
+ class HealthcareFhirConfig
170
+ include ::Google::Protobuf::MessageExts
171
+ extend ::Google::Protobuf::MessageExts::ClassMethods
172
+ end
173
+
124
174
  # Promotion proto includes uri and other helping information to display the
125
175
  # promotion.
126
176
  # @!attribute [rw] title
@@ -131,6 +181,11 @@ module Google
131
181
  # @return [::String]
132
182
  # Optional. The URL for the page the user wants to promote. Must be set for
133
183
  # site search. For other verticals, this is optional.
184
+ # @!attribute [rw] document
185
+ # @return [::String]
186
+ # Optional. The {::Google::Cloud::DiscoveryEngine::V1::Document Document} the user
187
+ # wants to promote. For site search, leave unset and only populate uri. Can
188
+ # be set along with uri.
134
189
  # @!attribute [rw] image_uri
135
190
  # @return [::String]
136
191
  # Optional. The promotion thumbnail image url.
@@ -41,7 +41,7 @@ module Google
41
41
  # Optional. Query regex to match the whole search query.
42
42
  # Cannot be set when
43
43
  # {::Google::Cloud::DiscoveryEngine::V1::Condition#query_terms Condition.query_terms}
44
- # is set. This is currently supporting promotion use case.
44
+ # is set. Only supported for Basic Site Search promotion serving controls.
45
45
  class Condition
46
46
  include ::Google::Protobuf::MessageExts
47
47
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -110,8 +110,6 @@ module Google
110
110
  # @return [::Google::Cloud::DiscoveryEngine::V1::Control::PromoteAction]
111
111
  # Promote certain links based on predefined trigger queries.
112
112
  #
113
- # This now only supports basic site search.
114
- #
115
113
  # Note: The following fields are mutually exclusive: `promote_action`, `boost_action`, `filter_action`, `redirect_action`, `synonyms_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
116
114
  # @!attribute [rw] name
117
115
  # @return [::String]
@@ -721,6 +721,9 @@ module Google
721
721
 
722
722
  # Non-answer-seeking query classification type, for no clear intent.
723
723
  NON_ANSWER_SEEKING_QUERY_V2 = 4
724
+
725
+ # User defined query classification type.
726
+ USER_DEFINED_CLASSIFICATION_QUERY = 5
724
727
  end
725
728
  end
726
729
 
@@ -24,7 +24,7 @@ module Google
24
24
  # DataStore captures global settings and configs at the DataStore level.
25
25
  # @!attribute [rw] name
26
26
  # @return [::String]
27
- # Immutable. The full resource name of the data store.
27
+ # Immutable. Identifier. The full resource name of the data store.
28
28
  # Format:
29
29
  # `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
30
30
  #
@@ -64,9 +64,41 @@ module Google
64
64
  # @!attribute [rw] advanced_site_search_config
65
65
  # @return [::Google::Cloud::DiscoveryEngine::V1::AdvancedSiteSearchConfig]
66
66
  # Optional. Configuration for advanced site search.
67
+ # @!attribute [rw] kms_key_name
68
+ # @return [::String]
69
+ # Input only. The KMS key to be used to protect this DataStore at creation
70
+ # time.
71
+ #
72
+ # Must be set for requests that need to comply with CMEK Org Policy
73
+ # protections.
74
+ #
75
+ # If this field is set and processed successfully, the DataStore will be
76
+ # protected by the KMS key, as indicated in the cmek_config field.
77
+ # @!attribute [r] cmek_config
78
+ # @return [::Google::Cloud::DiscoveryEngine::V1::CmekConfig]
79
+ # Output only. CMEK-related information for the DataStore.
67
80
  # @!attribute [r] billing_estimation
68
81
  # @return [::Google::Cloud::DiscoveryEngine::V1::DataStore::BillingEstimation]
69
82
  # Output only. Data size estimation for billing.
83
+ # @!attribute [rw] acl_enabled
84
+ # @return [::Boolean]
85
+ # Immutable. Whether data in the
86
+ # {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore} has ACL information.
87
+ # If set to `true`, the source data must have ACL. ACL will be ingested when
88
+ # data is ingested by
89
+ # {::Google::Cloud::DiscoveryEngine::V1::DocumentService::Client#import_documents DocumentService.ImportDocuments}
90
+ # methods.
91
+ #
92
+ # When ACL is enabled for the
93
+ # {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore},
94
+ # {::Google::Cloud::DiscoveryEngine::V1::Document Document} can't be accessed by
95
+ # calling
96
+ # {::Google::Cloud::DiscoveryEngine::V1::DocumentService::Client#get_document DocumentService.GetDocument}
97
+ # or
98
+ # {::Google::Cloud::DiscoveryEngine::V1::DocumentService::Client#list_documents DocumentService.ListDocuments}.
99
+ #
100
+ # Currently ACL is only supported in `GENERIC` industry vertical with
101
+ # non-`PUBLIC_WEBSITE` content config.
70
102
  # @!attribute [rw] workspace_config
71
103
  # @return [::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig]
72
104
  # Config to store data store type configuration for workspace data. This
@@ -96,6 +128,16 @@ module Google
96
128
  # The provided schema will be validated against certain rules on schema.
97
129
  # Learn more from [this
98
130
  # doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
131
+ # @!attribute [rw] healthcare_fhir_config
132
+ # @return [::Google::Cloud::DiscoveryEngine::V1::HealthcareFhirConfig]
133
+ # Optional. Configuration for `HEALTHCARE_FHIR` vertical.
134
+ # @!attribute [rw] identity_mapping_store
135
+ # @return [::String]
136
+ # Immutable. The fully qualified resource name of the associated
137
+ # {::Google::Cloud::DiscoveryEngine::V1::IdentityMappingStore IdentityMappingStore}.
138
+ # This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or
139
+ # `GSUITE` IdP. Format:
140
+ # `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.
99
141
  class DataStore
100
142
  include ::Google::Protobuf::MessageExts
101
143
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -24,6 +24,18 @@ module Google
24
24
  # Request for
25
25
  # {::Google::Cloud::DiscoveryEngine::V1::DataStoreService::Client#create_data_store DataStoreService.CreateDataStore}
26
26
  # method.
27
+ # @!attribute [rw] cmek_config_name
28
+ # @return [::String]
29
+ # Resource name of the CmekConfig to use for protecting this DataStore.
30
+ #
31
+ # Note: The following fields are mutually exclusive: `cmek_config_name`, `disable_cmek`. If a field in that set is populated, all other fields in the set will automatically be cleared.
32
+ # @!attribute [rw] disable_cmek
33
+ # @return [::Boolean]
34
+ # DataStore without CMEK protections. If a default CmekConfig is set for
35
+ # the project, setting this field will override the default CmekConfig as
36
+ # well.
37
+ #
38
+ # Note: The following fields are mutually exclusive: `disable_cmek`, `cmek_config_name`. If a field in that set is populated, all other fields in the set will automatically be cleared.
27
39
  # @!attribute [rw] parent
28
40
  # @return [::String]
29
41
  # Required. The parent resource name, such as
@@ -56,9 +56,8 @@ module Google
56
56
  # The identifier of the schema located in the same data store.
57
57
  # @!attribute [rw] content
58
58
  # @return [::Google::Cloud::DiscoveryEngine::V1::Document::Content]
59
- # The unstructured data linked to this document. Content must be set if this
60
- # document is under a
61
- # `CONTENT_REQUIRED` data store.
59
+ # The unstructured data linked to this document. Content can only be set
60
+ # and must be set if this document is under a `CONTENT_REQUIRED` data store.
62
61
  # @!attribute [rw] parent_document_id
63
62
  # @return [::String]
64
63
  # The identifier of the parent document. Currently supports at most two level
@@ -70,6 +69,9 @@ module Google
70
69
  # @return [::Google::Protobuf::Struct]
71
70
  # Output only. This field is OUTPUT_ONLY.
72
71
  # It contains derived data that are not in the original input document.
72
+ # @!attribute [rw] acl_info
73
+ # @return [::Google::Cloud::DiscoveryEngine::V1::Document::AclInfo]
74
+ # Access control information for the document.
73
75
  # @!attribute [r] index_time
74
76
  # @return [::Google::Protobuf::Timestamp]
75
77
  # Output only. The last time the document was indexed. If this field is set,
@@ -116,9 +118,23 @@ module Google
116
118
  #
117
119
  # * `application/pdf` (PDF, only native PDFs are supported for now)
118
120
  # * `text/html` (HTML)
121
+ # * `text/plain` (TXT)
122
+ # * `application/xml` or `text/xml` (XML)
123
+ # * `application/json` (JSON)
119
124
  # * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX)
120
125
  # * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX)
121
- # * `text/plain` (TXT)
126
+ # * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`
127
+ # (XLSX)
128
+ # * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM)
129
+ #
130
+ # The following types are supported only if layout parser is enabled in the
131
+ # data store:
132
+ #
133
+ # * `image/bmp` (BMP)
134
+ # * `image/gif` (GIF)
135
+ # * `image/jpeg` (JPEG)
136
+ # * `image/png` (PNG)
137
+ # * `image/tiff` (TIFF)
122
138
  #
123
139
  # See https://www.iana.org/assignments/media-types/media-types.xhtml.
124
140
  class Content
@@ -126,6 +142,85 @@ module Google
126
142
  extend ::Google::Protobuf::MessageExts::ClassMethods
127
143
  end
128
144
 
145
+ # ACL Information of the Document.
146
+ # @!attribute [rw] readers
147
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Document::AclInfo::AccessRestriction>]
148
+ # Readers of the document.
149
+ class AclInfo
150
+ include ::Google::Protobuf::MessageExts
151
+ extend ::Google::Protobuf::MessageExts::ClassMethods
152
+
153
+ # AclRestriction to model complex inheritance restrictions.
154
+ #
155
+ # Example: Modeling a "Both Permit" inheritance, where to access a
156
+ # child document, user needs to have access to parent document.
157
+ #
158
+ # Document Hierarchy - Space_S --> Page_P.
159
+ #
160
+ # Readers:
161
+ # Space_S: group_1, user_1
162
+ # Page_P: group_2, group_3, user_2
163
+ #
164
+ # Space_S ACL Restriction -
165
+ # {
166
+ # "acl_info": {
167
+ # "readers": [
168
+ # {
169
+ # "principals": [
170
+ # {
171
+ # "group_id": "group_1"
172
+ # },
173
+ # {
174
+ # "user_id": "user_1"
175
+ # }
176
+ # ]
177
+ # }
178
+ # ]
179
+ # }
180
+ # }
181
+ #
182
+ # Page_P ACL Restriction.
183
+ # {
184
+ # "acl_info": {
185
+ # "readers": [
186
+ # {
187
+ # "principals": [
188
+ # {
189
+ # "group_id": "group_2"
190
+ # },
191
+ # {
192
+ # "group_id": "group_3"
193
+ # },
194
+ # {
195
+ # "user_id": "user_2"
196
+ # }
197
+ # ],
198
+ # },
199
+ # {
200
+ # "principals": [
201
+ # {
202
+ # "group_id": "group_1"
203
+ # },
204
+ # {
205
+ # "user_id": "user_1"
206
+ # }
207
+ # ],
208
+ # }
209
+ # ]
210
+ # }
211
+ # }
212
+ # @!attribute [rw] principals
213
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Principal>]
214
+ # List of principals.
215
+ # @!attribute [rw] idp_wide
216
+ # @return [::Boolean]
217
+ # All users within the Identity Provider.
218
+ class AccessRestriction
219
+ include ::Google::Protobuf::MessageExts
220
+ extend ::Google::Protobuf::MessageExts::ClassMethods
221
+ end
222
+ end
223
+
129
224
  # Index status of the document.
130
225
  # @!attribute [rw] index_time
131
226
  # @return [::Google::Protobuf::Timestamp]
@@ -132,6 +132,29 @@ module Google
132
132
  end
133
133
 
134
134
  # The layout parsing configurations for documents.
135
+ # @!attribute [rw] enable_table_annotation
136
+ # @return [::Boolean]
137
+ # Optional. If true, the LLM based annotation is added to the table
138
+ # during parsing.
139
+ # @!attribute [rw] enable_image_annotation
140
+ # @return [::Boolean]
141
+ # Optional. If true, the LLM based annotation is added to the image
142
+ # during parsing.
143
+ # @!attribute [rw] structured_content_types
144
+ # @return [::Array<::String>]
145
+ # Optional. Contains the required structure types to extract from the
146
+ # document. Supported values:
147
+ #
148
+ # * `shareholder-structure`
149
+ # @!attribute [rw] exclude_html_elements
150
+ # @return [::Array<::String>]
151
+ # Optional. List of HTML elements to exclude from the parsed content.
152
+ # @!attribute [rw] exclude_html_classes
153
+ # @return [::Array<::String>]
154
+ # Optional. List of HTML classes to exclude from the parsed content.
155
+ # @!attribute [rw] exclude_html_ids
156
+ # @return [::Array<::String>]
157
+ # Optional. List of HTML ids to exclude from the parsed content.
135
158
  class LayoutParsingConfig
136
159
  include ::Google::Protobuf::MessageExts
137
160
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -29,14 +29,25 @@ module Google
29
29
  # {::Google::Cloud::DiscoveryEngine::V1::Engine#solution_type solution_type} is
30
30
  # {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_CHAT SOLUTION_TYPE_CHAT}.
31
31
  #
32
- # Note: The following fields are mutually exclusive: `chat_engine_config`, `search_engine_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
32
+ # Note: The following fields are mutually exclusive: `chat_engine_config`, `search_engine_config`, `media_recommendation_engine_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
33
33
  # @!attribute [rw] search_engine_config
34
34
  # @return [::Google::Cloud::DiscoveryEngine::V1::Engine::SearchEngineConfig]
35
35
  # Configurations for the Search Engine. Only applicable if
36
36
  # {::Google::Cloud::DiscoveryEngine::V1::Engine#solution_type solution_type} is
37
37
  # {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
38
38
  #
39
- # Note: The following fields are mutually exclusive: `search_engine_config`, `chat_engine_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
39
+ # Note: The following fields are mutually exclusive: `search_engine_config`, `chat_engine_config`, `media_recommendation_engine_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
40
+ # @!attribute [rw] media_recommendation_engine_config
41
+ # @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig]
42
+ # Configurations for the Media Engine. Only applicable on the data
43
+ # stores with
44
+ # {::Google::Cloud::DiscoveryEngine::V1::Engine#solution_type solution_type}
45
+ # {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}
46
+ # and
47
+ # {::Google::Cloud::DiscoveryEngine::V1::IndustryVertical::MEDIA IndustryVertical.MEDIA}
48
+ # vertical.
49
+ #
50
+ # Note: The following fields are mutually exclusive: `media_recommendation_engine_config`, `chat_engine_config`, `search_engine_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
40
51
  # @!attribute [r] chat_engine_metadata
41
52
  # @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata]
42
53
  # Output only. Additional information of the Chat Engine. Only applicable
@@ -45,7 +56,7 @@ module Google
45
56
  # {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_CHAT SOLUTION_TYPE_CHAT}.
46
57
  # @!attribute [rw] name
47
58
  # @return [::String]
48
- # Immutable. The fully qualified resource name of the engine.
59
+ # Immutable. Identifier. The fully qualified resource name of the engine.
49
60
  #
50
61
  # This field must be a UTF-8 encoded string with a length limit of 1024
51
62
  # characters.
@@ -66,7 +77,7 @@ module Google
66
77
  # Output only. Timestamp the Recommendation Engine was last updated.
67
78
  # @!attribute [rw] data_store_ids
68
79
  # @return [::Array<::String>]
69
- # The data stores associated with this engine.
80
+ # Optional. The data stores associated with this engine.
70
81
  #
71
82
  # For
72
83
  # {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}
@@ -89,7 +100,7 @@ module Google
89
100
  # Required. The solutions of the engine.
90
101
  # @!attribute [rw] industry_vertical
91
102
  # @return [::Google::Cloud::DiscoveryEngine::V1::IndustryVertical]
92
- # The industry vertical that the engine registers.
103
+ # Optional. The industry vertical that the engine registers.
93
104
  # The restriction of the Engine industry vertical is based on
94
105
  # {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}: Vertical on Engine
95
106
  # has to match vertical of the DataStore linked to the engine.
@@ -123,6 +134,131 @@ module Google
123
134
  extend ::Google::Protobuf::MessageExts::ClassMethods
124
135
  end
125
136
 
137
+ # Additional config specs for a Media Recommendation engine.
138
+ # @!attribute [rw] type
139
+ # @return [::String]
140
+ # Required. The type of engine. e.g., `recommended-for-you`.
141
+ #
142
+ # This field together with
143
+ # {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
144
+ # describe engine metadata to use to control engine training and serving.
145
+ #
146
+ # Currently supported values: `recommended-for-you`, `others-you-may-like`,
147
+ # `more-like-this`, `most-popular-items`.
148
+ # @!attribute [rw] optimization_objective
149
+ # @return [::String]
150
+ # The optimization objective. e.g., `cvr`.
151
+ #
152
+ # This field together with
153
+ # {::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig#type optimization_objective}
154
+ # describe engine metadata to use to control engine training and serving.
155
+ #
156
+ # Currently supported
157
+ # values: `ctr`, `cvr`.
158
+ #
159
+ # If not specified, we choose default based on engine type.
160
+ # Default depends on type of recommendation:
161
+ #
162
+ # `recommended-for-you` => `ctr`
163
+ #
164
+ # `others-you-may-like` => `ctr`
165
+ # @!attribute [rw] optimization_objective_config
166
+ # @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
167
+ # Name and value of the custom threshold for cvr optimization_objective.
168
+ # For target_field `watch-time`, target_field_value must be an integer
169
+ # value indicating the media progress time in seconds between (0, 86400]
170
+ # (excludes 0, includes 86400) (e.g., 90).
171
+ # For target_field `watch-percentage`, the target_field_value must be a
172
+ # valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
173
+ # 0.5).
174
+ # @!attribute [rw] training_state
175
+ # @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::TrainingState]
176
+ # The training state that the engine is in (e.g.
177
+ # `TRAINING` or `PAUSED`).
178
+ #
179
+ # Since part of the cost of running the service
180
+ # is frequency of training - this can be used to determine when to train
181
+ # engine in order to control cost. If not specified: the default value for
182
+ # `CreateEngine` method is `TRAINING`. The default value for
183
+ # `UpdateEngine` method is to keep the state the same as before.
184
+ # @!attribute [rw] engine_features_config
185
+ # @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
186
+ # Optional. Additional engine features config.
187
+ class MediaRecommendationEngineConfig
188
+ include ::Google::Protobuf::MessageExts
189
+ extend ::Google::Protobuf::MessageExts::ClassMethods
190
+
191
+ # Custom threshold for `cvr` optimization_objective.
192
+ # @!attribute [rw] target_field
193
+ # @return [::String]
194
+ # Required. The name of the field to target. Currently supported
195
+ # values: `watch-percentage`, `watch-time`.
196
+ # @!attribute [rw] target_field_value_float
197
+ # @return [::Float]
198
+ # Required. The threshold to be applied to the target (e.g., 0.5).
199
+ class OptimizationObjectiveConfig
200
+ include ::Google::Protobuf::MessageExts
201
+ extend ::Google::Protobuf::MessageExts::ClassMethods
202
+ end
203
+
204
+ # More feature configs of the selected engine type.
205
+ # @!attribute [rw] recommended_for_you_config
206
+ # @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
207
+ # Recommended for you engine feature config.
208
+ #
209
+ # Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
210
+ # @!attribute [rw] most_popular_config
211
+ # @return [::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
212
+ # Most popular engine feature config.
213
+ #
214
+ # Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
215
+ class EngineFeaturesConfig
216
+ include ::Google::Protobuf::MessageExts
217
+ extend ::Google::Protobuf::MessageExts::ClassMethods
218
+ end
219
+
220
+ # Additional feature configurations for creating a `recommended-for-you`
221
+ # engine.
222
+ # @!attribute [rw] context_event_type
223
+ # @return [::String]
224
+ # The type of event with which the engine is queried at prediction time.
225
+ # If set to `generic`, only `view-item`, `media-play`,and
226
+ # `media-complete` will be used as `context-event` in engine training. If
227
+ # set to `view-home-page`, `view-home-page` will also be used as
228
+ # `context-events` in addition to `view-item`, `media-play`, and
229
+ # `media-complete`. Currently supported for the `recommended-for-you`
230
+ # engine. Currently supported values: `view-home-page`, `generic`.
231
+ class RecommendedForYouFeatureConfig
232
+ include ::Google::Protobuf::MessageExts
233
+ extend ::Google::Protobuf::MessageExts::ClassMethods
234
+ end
235
+
236
+ # Feature configurations that are required for creating a Most Popular
237
+ # engine.
238
+ # @!attribute [rw] time_window_days
239
+ # @return [::Integer]
240
+ # The time window of which the engine is queried at training and
241
+ # prediction time. Positive integers only. The value translates to the
242
+ # last X days of events. Currently required for the `most-popular-items`
243
+ # engine.
244
+ class MostPopularFeatureConfig
245
+ include ::Google::Protobuf::MessageExts
246
+ extend ::Google::Protobuf::MessageExts::ClassMethods
247
+ end
248
+
249
+ # The training state of the engine.
250
+ module TrainingState
251
+ # Unspecified training state.
252
+ TRAINING_STATE_UNSPECIFIED = 0
253
+
254
+ # The engine training is paused.
255
+ PAUSED = 1
256
+
257
+ # The engine is training.
258
+ TRAINING = 2
259
+ end
260
+ end
261
+
126
262
  # Configurations for a Chat Engine.
127
263
  # @!attribute [rw] agent_creation_config
128
264
  # @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
@@ -476,6 +476,9 @@ module Google
476
476
  # will lead to fewer but very strong citations, while choosing a lower
477
477
  # threshold may lead to more but somewhat weaker citations. If unset, the
478
478
  # threshold will default to 0.6.
479
+ # @!attribute [rw] enable_claim_level_score
480
+ # @return [::Boolean]
481
+ # The control flag that enables claim-level grounding score in the response.
479
482
  class CheckGroundingSpec
480
483
  include ::Google::Protobuf::MessageExts
481
484
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -601,6 +604,11 @@ module Google
601
604
  # the claim and therefore
602
605
  # {::Google::Cloud::DiscoveryEngine::V1::CheckGroundingResponse::Claim#citation_indices citation_indices}
603
606
  # should not be returned.
607
+ # @!attribute [rw] score
608
+ # @return [::Float]
609
+ # Confidence score for the claim in the answer candidate, in the range of
610
+ # [0, 1]. This is set only when
611
+ # `CheckGroundingRequest.grounding_spec.enable_claim_level_score` is true.
604
612
  class Claim
605
613
  include ::Google::Protobuf::MessageExts
606
614
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -60,6 +60,15 @@ module Google
60
60
  # @!attribute [rw] source_metadata
61
61
  # @return [::Google::Protobuf::Map{::String => ::String}]
62
62
  # More fine-grained information for the source reference.
63
+ # @!attribute [rw] uri
64
+ # @return [::String]
65
+ # The URI of the source.
66
+ # @!attribute [rw] title
67
+ # @return [::String]
68
+ # The title of the source.
69
+ # @!attribute [rw] domain
70
+ # @return [::String]
71
+ # The domain of the source.
63
72
  class FactChunk
64
73
  include ::Google::Protobuf::MessageExts
65
74
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -0,0 +1,81 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 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 V1
24
+ # Identity Mapping Store which contains Identity Mapping Entries.
25
+ # @!attribute [rw] name
26
+ # @return [::String]
27
+ # Immutable. The full resource name of the identity mapping store.
28
+ # Format:
29
+ # `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.
30
+ # This field must be a UTF-8 encoded string with a length limit of 1024
31
+ # characters.
32
+ # @!attribute [rw] kms_key_name
33
+ # @return [::String]
34
+ # Input only. The KMS key to be used to protect this Identity Mapping Store
35
+ # at creation time.
36
+ #
37
+ # Must be set for requests that need to comply with CMEK Org Policy
38
+ # protections.
39
+ #
40
+ # If this field is set and processed successfully, the Identity Mapping Store
41
+ # will be protected by the KMS key, as indicated in the cmek_config field.
42
+ # @!attribute [r] cmek_config
43
+ # @return [::Google::Cloud::DiscoveryEngine::V1::CmekConfig]
44
+ # Output only. CMEK-related information for the Identity Mapping Store.
45
+ class IdentityMappingStore
46
+ include ::Google::Protobuf::MessageExts
47
+ extend ::Google::Protobuf::MessageExts::ClassMethods
48
+ end
49
+
50
+ # Identity Mapping Entry that maps an external identity to an internal
51
+ # identity.
52
+ # @!attribute [rw] user_id
53
+ # @return [::String]
54
+ # User identifier.
55
+ # For Google Workspace user account, user_id should be the google workspace
56
+ # user email.
57
+ # For non-google identity provider, user_id is the mapped user identifier
58
+ # configured during the workforcepool config.
59
+ #
60
+ # Note: The following fields are mutually exclusive: `user_id`, `group_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
61
+ # @!attribute [rw] group_id
62
+ # @return [::String]
63
+ # Group identifier.
64
+ # For Google Workspace user account, group_id should be the google
65
+ # workspace group email.
66
+ # For non-google identity provider, group_id is the mapped group identifier
67
+ # configured during the workforcepool config.
68
+ #
69
+ # Note: The following fields are mutually exclusive: `group_id`, `user_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
70
+ # @!attribute [rw] external_identity
71
+ # @return [::String]
72
+ # Required. Identity outside the customer identity provider.
73
+ # The length limit of external identity will be of 100 characters.
74
+ class IdentityMappingEntry
75
+ include ::Google::Protobuf::MessageExts
76
+ extend ::Google::Protobuf::MessageExts::ClassMethods
77
+ end
78
+ end
79
+ end
80
+ end
81
+ end