@google-cloud/discoveryengine 1.12.0 → 1.13.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.
- package/CHANGELOG.md +7 -0
- package/README.md +4 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/answer.proto +55 -2
- package/build/protos/google/cloud/discoveryengine/v1alpha/chunk.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/completion.proto +31 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/completion_service.proto +38 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +28 -9
- package/build/protos/google/cloud/discoveryengine/v1alpha/custom_tuning_model.proto +7 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +23 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto +11 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +4 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/document_processing_config.proto +6 -2
- package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +114 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +57 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +5 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +407 -11
- package/build/protos/google/cloud/discoveryengine/v1alpha/serving_config.proto +14 -5
- package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +126 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/user_event_service.proto +3 -0
- package/build/protos/protos.d.ts +3703 -219
- package/build/protos/protos.js +35486 -26672
- package/build/protos/protos.json +844 -46
- package/build/src/v1alpha/completion_service_client.d.ts +91 -0
- package/build/src/v1alpha/completion_service_client.js +90 -0
- package/build/src/v1alpha/completion_service_client_config.json +10 -0
- package/build/src/v1alpha/conversational_search_service_client.d.ts +18 -0
- package/build/src/v1alpha/data_store_service_client.d.ts +12 -3
- package/build/src/v1alpha/data_store_service_client.js +8 -2
- package/build/src/v1alpha/document_service_client.d.ts +4 -0
- package/build/src/v1alpha/document_service_client.js +6 -0
- package/build/src/v1alpha/engine_service_client.js +6 -0
- package/build/src/v1alpha/estimate_billing_service_client.js +6 -0
- package/build/src/v1alpha/evaluation_service_client.js +6 -0
- package/build/src/v1alpha/project_service_client.js +6 -0
- package/build/src/v1alpha/sample_query_service_client.js +6 -0
- package/build/src/v1alpha/schema_service_client.js +6 -0
- package/build/src/v1alpha/search_service_client.d.ts +219 -21
- package/build/src/v1alpha/search_service_client.js +146 -14
- package/build/src/v1alpha/search_tuning_service_client.js +6 -0
- package/build/src/v1alpha/site_search_engine_service_client.d.ts +101 -0
- package/build/src/v1alpha/site_search_engine_service_client.js +70 -0
- package/build/src/v1alpha/site_search_engine_service_client_config.json +8 -0
- package/build/src/v1alpha/user_event_service_client.js +6 -0
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
@@ -1,5 +1,12 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## [1.13.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v1.12.0...discoveryengine-v1.13.0) (2024-08-19)
|
4
|
+
|
5
|
+
|
6
|
+
### Features
|
7
|
+
|
8
|
+
* [discoveryengine] support natural language understanding in search ([#5596](https://github.com/googleapis/google-cloud-node/issues/5596)) ([5cf8d9e](https://github.com/googleapis/google-cloud-node/commit/5cf8d9e6be7c9f95910185062817379a2e29ffdc))
|
9
|
+
|
3
10
|
## [1.12.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v1.11.0...discoveryengine-v1.12.0) (2024-08-09)
|
4
11
|
|
5
12
|
|
package/README.md
CHANGED
@@ -195,7 +195,9 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
|
|
195
195
|
| Chunk_service.get_chunk | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/chunk_service.get_chunk.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/chunk_service.get_chunk.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
196
196
|
| Chunk_service.list_chunks | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/chunk_service.list_chunks.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/chunk_service.list_chunks.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
197
197
|
| Completion_service.complete_query | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.complete_query.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.complete_query.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
198
|
+
| Completion_service.import_completion_suggestions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.import_completion_suggestions.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.import_completion_suggestions.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
198
199
|
| Completion_service.import_suggestion_deny_list_entries | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.import_suggestion_deny_list_entries.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.import_suggestion_deny_list_entries.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
200
|
+
| Completion_service.purge_completion_suggestions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.purge_completion_suggestions.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.purge_completion_suggestions.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
199
201
|
| Completion_service.purge_suggestion_deny_list_entries | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.purge_suggestion_deny_list_entries.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/completion_service.purge_suggestion_deny_list_entries.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
200
202
|
| Control_service.create_control | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/control_service.create_control.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/control_service.create_control.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
201
203
|
| Control_service.delete_control | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/control_service.delete_control.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/control_service.delete_control.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
@@ -280,8 +282,10 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
|
|
280
282
|
| Site_search_engine_service.fetch_domain_verification_status | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.fetch_domain_verification_status.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.fetch_domain_verification_status.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
281
283
|
| Site_search_engine_service.get_site_search_engine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.get_site_search_engine.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.get_site_search_engine.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
282
284
|
| Site_search_engine_service.get_target_site | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.get_target_site.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.get_target_site.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
285
|
+
| Site_search_engine_service.get_uri_pattern_document_data | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.get_uri_pattern_document_data.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.get_uri_pattern_document_data.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
283
286
|
| Site_search_engine_service.list_target_sites | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.list_target_sites.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.list_target_sites.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
284
287
|
| Site_search_engine_service.recrawl_uris | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.recrawl_uris.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.recrawl_uris.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
288
|
+
| Site_search_engine_service.set_uri_pattern_document_data | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.set_uri_pattern_document_data.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.set_uri_pattern_document_data.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
285
289
|
| Site_search_engine_service.update_target_site | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.update_target_site.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.update_target_site.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
286
290
|
| User_event_service.collect_user_event | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/user_event_service.collect_user_event.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/user_event_service.collect_user_event.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
287
291
|
| User_event_service.import_user_events | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/user_event_service.import_user_events.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/user_event_service.import_user_events.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
@@ -69,6 +69,13 @@ message Answer {
|
|
69
69
|
|
70
70
|
// Page identifier.
|
71
71
|
string page_identifier = 2;
|
72
|
+
|
73
|
+
// The relevance of the chunk for a given query. Values range from 0.0
|
74
|
+
// (completely irrelevant) to 1.0 (completely relevant).
|
75
|
+
// This value is for informational purpose only. It may change for
|
76
|
+
// the same query and chunk at any time due to a model retraining or
|
77
|
+
// change in implementation.
|
78
|
+
optional float relevance_score = 3;
|
72
79
|
}
|
73
80
|
|
74
81
|
// Document resource name.
|
@@ -121,13 +128,28 @@ message Answer {
|
|
121
128
|
// Chunk textual content.
|
122
129
|
string content = 2;
|
123
130
|
|
124
|
-
//
|
131
|
+
// The relevance of the chunk for a given query. Values range from 0.0
|
132
|
+
// (completely irrelevant) to 1.0 (completely relevant).
|
133
|
+
// This value is for informational purpose only. It may change for
|
134
|
+
// the same query and chunk at any time due to a model retraining or
|
135
|
+
// change in implementation.
|
125
136
|
optional float relevance_score = 3;
|
126
137
|
|
127
138
|
// Document metadata.
|
128
139
|
DocumentMetadata document_metadata = 4;
|
129
140
|
}
|
130
141
|
|
142
|
+
// Structured search information.
|
143
|
+
message StructuredDocumentInfo {
|
144
|
+
// Document resource name.
|
145
|
+
string document = 1 [(google.api.resource_reference) = {
|
146
|
+
type: "discoveryengine.googleapis.com/Document"
|
147
|
+
}];
|
148
|
+
|
149
|
+
// Structured search data.
|
150
|
+
google.protobuf.Struct struct_data = 2;
|
151
|
+
}
|
152
|
+
|
131
153
|
// Search result content.
|
132
154
|
oneof content {
|
133
155
|
// Unstructured document information.
|
@@ -135,6 +157,9 @@ message Answer {
|
|
135
157
|
|
136
158
|
// Chunk information.
|
137
159
|
ChunkInfo chunk_info = 2;
|
160
|
+
|
161
|
+
// Structured document information.
|
162
|
+
StructuredDocumentInfo structured_document_info = 3;
|
138
163
|
}
|
139
164
|
}
|
140
165
|
|
@@ -168,7 +193,11 @@ message Answer {
|
|
168
193
|
// Chunk textual content.
|
169
194
|
string content = 2;
|
170
195
|
|
171
|
-
//
|
196
|
+
// The relevance of the chunk for a given query. Values range from
|
197
|
+
// 0.0 (completely irrelevant) to 1.0 (completely relevant).
|
198
|
+
// This value is for informational purpose only. It may change for
|
199
|
+
// the same query and chunk at any time due to a model retraining or
|
200
|
+
// change in implementation.
|
172
201
|
optional float relevance_score = 3;
|
173
202
|
}
|
174
203
|
|
@@ -188,6 +217,14 @@ message Answer {
|
|
188
217
|
// If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on,
|
189
218
|
// populate chunk info.
|
190
219
|
repeated ChunkInfo chunk_info = 5;
|
220
|
+
|
221
|
+
// Data representation.
|
222
|
+
// The structured JSON data for the document.
|
223
|
+
// It's populated from the struct data from the Document
|
224
|
+
// , or the Chunk in
|
225
|
+
// search result
|
226
|
+
// .
|
227
|
+
google.protobuf.Struct struct_data = 6;
|
191
228
|
}
|
192
229
|
|
193
230
|
// Search results observed by the search action, it can be snippets info
|
@@ -247,6 +284,9 @@ message Answer {
|
|
247
284
|
|
248
285
|
// Non-answer-seeking query classification type.
|
249
286
|
NON_ANSWER_SEEKING_QUERY = 2;
|
287
|
+
|
288
|
+
// Jail-breaking query classification type.
|
289
|
+
JAIL_BREAKING_QUERY = 3;
|
250
290
|
}
|
251
291
|
|
252
292
|
// Query classification type.
|
@@ -296,6 +336,19 @@ message Answer {
|
|
296
336
|
// Google skips the answer if there is a potential policy violation
|
297
337
|
// detected. This includes content that may be violent or toxic.
|
298
338
|
POTENTIAL_POLICY_VIOLATION = 4;
|
339
|
+
|
340
|
+
// The no relevant content case.
|
341
|
+
//
|
342
|
+
// Google skips the answer if there is no relevant content in the
|
343
|
+
// retrieved search results.
|
344
|
+
NO_RELEVANT_CONTENT = 5;
|
345
|
+
|
346
|
+
// The jail-breaking query ignored case.
|
347
|
+
//
|
348
|
+
// For example, "Reply in the tone of a competing company's CEO".
|
349
|
+
// Google skips the answer if the query is classified as a jail-breaking
|
350
|
+
// query.
|
351
|
+
JAIL_BREAKING_QUERY_IGNORED = 6;
|
299
352
|
}
|
300
353
|
|
301
354
|
// Immutable. Fully qualified name
|
@@ -96,7 +96,7 @@ message Chunk {
|
|
96
96
|
// Content is a string from a document (parsed content).
|
97
97
|
string content = 3;
|
98
98
|
|
99
|
-
//
|
99
|
+
// Output only. Represents the relevance score based on similarity.
|
100
100
|
// Higher score indicates higher chunk relevance.
|
101
101
|
// The score is in range [-1.0, 1.0].
|
102
102
|
// Only populated on [SearchService.SearchResponse][].
|
@@ -50,3 +50,34 @@ message SuggestionDenyListEntry {
|
|
50
50
|
// exact phrase, or block any suggestions containing this phrase.
|
51
51
|
MatchOperator match_operator = 2 [(google.api.field_behavior) = REQUIRED];
|
52
52
|
}
|
53
|
+
|
54
|
+
// Autocomplete suggestions that are imported from Customer.
|
55
|
+
message CompletionSuggestion {
|
56
|
+
// Ranking metrics of this suggestion.
|
57
|
+
oneof ranking_info {
|
58
|
+
// Global score of this suggestion. Control how this suggestion would be
|
59
|
+
// scored / ranked.
|
60
|
+
double global_score = 2;
|
61
|
+
|
62
|
+
// Frequency of this suggestion. Will be used to rank suggestions when score
|
63
|
+
// is not available.
|
64
|
+
int64 frequency = 3;
|
65
|
+
}
|
66
|
+
|
67
|
+
// Required. The suggestion text.
|
68
|
+
string suggestion = 1 [(google.api.field_behavior) = REQUIRED];
|
69
|
+
|
70
|
+
// BCP-47 language code of this suggestion.
|
71
|
+
string language_code = 4;
|
72
|
+
|
73
|
+
// If two suggestions have the same groupId, they will not be
|
74
|
+
// returned together. Instead the one ranked higher will be returned. This can
|
75
|
+
// be used to deduplicate semantically identical suggestions.
|
76
|
+
string group_id = 5;
|
77
|
+
|
78
|
+
// The score of this suggestion within its group.
|
79
|
+
double group_score = 6;
|
80
|
+
|
81
|
+
// Alternative matching phrases for this suggestion.
|
82
|
+
repeated string alternative_phrases = 7;
|
83
|
+
}
|
@@ -86,6 +86,44 @@ service CompletionService {
|
|
86
86
|
metadata_type: "google.cloud.discoveryengine.v1alpha.PurgeSuggestionDenyListEntriesMetadata"
|
87
87
|
};
|
88
88
|
}
|
89
|
+
|
90
|
+
// Imports
|
91
|
+
// [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s
|
92
|
+
// for a DataStore.
|
93
|
+
rpc ImportCompletionSuggestions(ImportCompletionSuggestionsRequest)
|
94
|
+
returns (google.longrunning.Operation) {
|
95
|
+
option (google.api.http) = {
|
96
|
+
post: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/completionSuggestions:import"
|
97
|
+
body: "*"
|
98
|
+
additional_bindings {
|
99
|
+
post: "/v1alpha/{parent=projects/*/locations/*/dataStores/*}/completionSuggestions:import"
|
100
|
+
body: "*"
|
101
|
+
}
|
102
|
+
};
|
103
|
+
option (google.longrunning.operation_info) = {
|
104
|
+
response_type: "google.cloud.discoveryengine.v1alpha.ImportCompletionSuggestionsResponse"
|
105
|
+
metadata_type: "google.cloud.discoveryengine.v1alpha.ImportCompletionSuggestionsMetadata"
|
106
|
+
};
|
107
|
+
}
|
108
|
+
|
109
|
+
// Permanently deletes all
|
110
|
+
// [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s
|
111
|
+
// for a DataStore.
|
112
|
+
rpc PurgeCompletionSuggestions(PurgeCompletionSuggestionsRequest)
|
113
|
+
returns (google.longrunning.Operation) {
|
114
|
+
option (google.api.http) = {
|
115
|
+
post: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/completionSuggestions:purge"
|
116
|
+
body: "*"
|
117
|
+
additional_bindings {
|
118
|
+
post: "/v1alpha/{parent=projects/*/locations/*/dataStores/*}/completionSuggestions:purge"
|
119
|
+
body: "*"
|
120
|
+
}
|
121
|
+
};
|
122
|
+
option (google.longrunning.operation_info) = {
|
123
|
+
response_type: "google.cloud.discoveryengine.v1alpha.PurgeCompletionSuggestionsResponse"
|
124
|
+
metadata_type: "google.cloud.discoveryengine.v1alpha.PurgeCompletionSuggestionsMetadata"
|
125
|
+
};
|
126
|
+
}
|
89
127
|
}
|
90
128
|
|
91
129
|
// Request message for
|
package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto
CHANGED
@@ -589,12 +589,7 @@ message AnswerQueryRequest {
|
|
589
589
|
string order_by = 4;
|
590
590
|
|
591
591
|
// Specifies the search result mode. If unspecified, the
|
592
|
-
// search result mode
|
593
|
-
// [DataStore.DocumentProcessingConfig.chunking_config][]:
|
594
|
-
// * If [DataStore.DocumentProcessingConfig.chunking_config][] is
|
595
|
-
// specified,
|
596
|
-
// it defaults to `CHUNKS`.
|
597
|
-
// * Otherwise, it defaults to `DOCUMENTS`.
|
592
|
+
// search result mode defaults to `DOCUMENTS`.
|
598
593
|
// See [parse and chunk
|
599
594
|
// documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)
|
600
595
|
SearchRequest.ContentSearchSpec.SearchResultMode search_result_mode = 5;
|
@@ -715,6 +710,9 @@ message AnswerQueryRequest {
|
|
715
710
|
|
716
711
|
// Non-answer-seeking query classification type.
|
717
712
|
NON_ANSWER_SEEKING_QUERY = 2;
|
713
|
+
|
714
|
+
// Jail-breaking query classification type.
|
715
|
+
JAIL_BREAKING_QUERY = 3;
|
718
716
|
}
|
719
717
|
|
720
718
|
// Enabled query classification types.
|
@@ -801,6 +799,25 @@ message AnswerQueryRequest {
|
|
801
799
|
// The field must be a UTF-8 encoded string with a length limit of 128
|
802
800
|
// characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
803
801
|
string user_pseudo_id = 12;
|
802
|
+
|
803
|
+
// The user labels applied to a resource must meet the following requirements:
|
804
|
+
//
|
805
|
+
// * Each resource can have multiple labels, up to a maximum of 64.
|
806
|
+
// * Each label must be a key-value pair.
|
807
|
+
// * Keys have a minimum length of 1 character and a maximum length of 63
|
808
|
+
// characters and cannot be empty. Values can be empty and have a maximum
|
809
|
+
// length of 63 characters.
|
810
|
+
// * Keys and values can contain only lowercase letters, numeric characters,
|
811
|
+
// underscores, and dashes. All characters must use UTF-8 encoding, and
|
812
|
+
// international characters are allowed.
|
813
|
+
// * The key portion of a label must be unique. However, you can use the same
|
814
|
+
// key with multiple resources.
|
815
|
+
// * Keys must start with a lowercase letter or international character.
|
816
|
+
//
|
817
|
+
// See [Google Cloud
|
818
|
+
// Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
819
|
+
// for more details.
|
820
|
+
map<string, string> user_labels = 13;
|
804
821
|
}
|
805
822
|
|
806
823
|
// Response message for
|
@@ -808,9 +825,11 @@ message AnswerQueryRequest {
|
|
808
825
|
// method.
|
809
826
|
message AnswerQueryResponse {
|
810
827
|
// Answer resource object.
|
811
|
-
// If
|
812
|
-
//
|
813
|
-
//
|
828
|
+
// If
|
829
|
+
// [AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps][google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps]
|
830
|
+
// is greater than 1, use
|
831
|
+
// [Answer.name][google.cloud.discoveryengine.v1alpha.Answer.name] to fetch
|
832
|
+
// answer information using
|
814
833
|
// [ConversationalSearchService.GetAnswer][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.GetAnswer]
|
815
834
|
// API.
|
816
835
|
Answer answer = 1;
|
@@ -56,6 +56,9 @@ message CustomTuningModel {
|
|
56
56
|
|
57
57
|
// The model training failed.
|
58
58
|
TRAINING_FAILED = 5;
|
59
|
+
|
60
|
+
// The model training finished successfully but metrics did not improve.
|
61
|
+
NO_IMPROVEMENT = 6;
|
59
62
|
}
|
60
63
|
|
61
64
|
// Required. The fully qualified resource name of the model.
|
@@ -80,8 +83,11 @@ message CustomTuningModel {
|
|
80
83
|
ModelState model_state = 4;
|
81
84
|
|
82
85
|
// Timestamp the Model was created at.
|
83
|
-
google.protobuf.Timestamp create_time = 5;
|
86
|
+
google.protobuf.Timestamp create_time = 5 [deprecated = true];
|
84
87
|
|
85
88
|
// Timestamp the model training was initiated.
|
86
89
|
google.protobuf.Timestamp training_start_time = 6;
|
90
|
+
|
91
|
+
// The metrics of the trained model.
|
92
|
+
map<string, double> metrics = 7;
|
87
93
|
}
|
@@ -98,6 +98,9 @@ message DataStore {
|
|
98
98
|
google.protobuf.Timestamp create_time = 4
|
99
99
|
[(google.api.field_behavior) = OUTPUT_ONLY];
|
100
100
|
|
101
|
+
// Language info for DataStore.
|
102
|
+
LanguageInfo language_info = 14;
|
103
|
+
|
101
104
|
// Output only. Data store level identity provider config.
|
102
105
|
IdpConfig idp_config = 21 [(google.api.field_behavior) = OUTPUT_ONLY];
|
103
106
|
|
@@ -140,3 +143,23 @@ message DataStore {
|
|
140
143
|
// doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
|
141
144
|
Schema starting_schema = 28;
|
142
145
|
}
|
146
|
+
|
147
|
+
// Language info for DataStore.
|
148
|
+
message LanguageInfo {
|
149
|
+
// The language code for the DataStore.
|
150
|
+
string language_code = 1;
|
151
|
+
|
152
|
+
// Output only. This is the normalized form of language_code.
|
153
|
+
// E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb`
|
154
|
+
// will have normalized_language_code of `en-GB`.
|
155
|
+
string normalized_language_code = 2
|
156
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
157
|
+
|
158
|
+
// Output only. Language part of normalized_language_code.
|
159
|
+
// E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.
|
160
|
+
string language = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
|
161
|
+
|
162
|
+
// Output only. Region part of normalized_language_code, if present.
|
163
|
+
// E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.
|
164
|
+
string region = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
|
165
|
+
}
|
@@ -189,6 +189,16 @@ message CreateDataStoreRequest {
|
|
189
189
|
// search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will
|
190
190
|
// be ignored.
|
191
191
|
bool create_advanced_site_search = 4;
|
192
|
+
|
193
|
+
// A boolean flag indicating whether to skip the default schema creation for
|
194
|
+
// the data store. Only enable this flag if you are certain that the default
|
195
|
+
// schema is incompatible with your use case.
|
196
|
+
//
|
197
|
+
// If set to true, you must manually create a schema for the data store before
|
198
|
+
// any documents can be ingested.
|
199
|
+
//
|
200
|
+
// This flag cannot be specified if `data_store.starting_schema` is specified.
|
201
|
+
bool skip_default_schema_creation = 7;
|
192
202
|
}
|
193
203
|
|
194
204
|
// Request message for
|
@@ -265,7 +275,7 @@ message ListDataStoresRequest {
|
|
265
275
|
// INVALID_ARGUMENT error is returned.
|
266
276
|
string page_token = 3;
|
267
277
|
|
268
|
-
// Filter by solution type.
|
278
|
+
// Filter by solution type .
|
269
279
|
// For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`
|
270
280
|
string filter = 4;
|
271
281
|
}
|
@@ -55,7 +55,7 @@ message Document {
|
|
55
55
|
|
56
56
|
// The URI of the content. Only Cloud Storage URIs (e.g.
|
57
57
|
// `gs://bucket-name/path/to/file`) are supported. The maximum file size
|
58
|
-
// is 2.5 MB for text-based formats,
|
58
|
+
// is 2.5 MB for text-based formats, 200 MB for other formats.
|
59
59
|
string uri = 3;
|
60
60
|
}
|
61
61
|
|
@@ -135,6 +135,9 @@ message Document {
|
|
135
135
|
message AccessRestriction {
|
136
136
|
// List of principals.
|
137
137
|
repeated Principal principals = 1;
|
138
|
+
|
139
|
+
// All users within the Identity Provider.
|
140
|
+
bool idp_wide = 2;
|
138
141
|
}
|
139
142
|
|
140
143
|
// Readers of the document.
|
@@ -118,8 +118,12 @@ message DocumentProcessingConfig {
|
|
118
118
|
// * `pdf`: Override parsing config for PDF files, either digital parsing, ocr
|
119
119
|
// parsing or layout parsing is supported.
|
120
120
|
// * `html`: Override parsing config for HTML files, only digital parsing and
|
121
|
-
//
|
121
|
+
// layout parsing are supported.
|
122
122
|
// * `docx`: Override parsing config for DOCX files, only digital parsing and
|
123
|
-
//
|
123
|
+
// layout parsing are supported.
|
124
|
+
// * `pptx`: Override parsing config for PPTX files, only digital parsing and
|
125
|
+
// layout parsing are supported.
|
126
|
+
// * `xlsx`: Override parsing config for XLSX files, only digital parsing and
|
127
|
+
// layout parsing are supported.
|
124
128
|
map<string, ParsingConfig> parsing_config_overrides = 5;
|
125
129
|
}
|
@@ -351,7 +351,7 @@ message GetProcessedDocumentRequest {
|
|
351
351
|
// Only available if ChunkingConfig is enabled on the data store.
|
352
352
|
CHUNKED_DOCUMENT = 2;
|
353
353
|
|
354
|
-
// Returns the converted
|
354
|
+
// Returns the converted Image bytes (as JPEG or PNG) if available.
|
355
355
|
PNG_CONVERTED_DOCUMENT = 3;
|
356
356
|
}
|
357
357
|
|
@@ -293,6 +293,12 @@ message FhirStoreSource {
|
|
293
293
|
// limit of 2,000 characters. Can be specified if one wants to have the
|
294
294
|
// FhirStore export to a specific Cloud Storage directory.
|
295
295
|
string gcs_staging_dir = 2;
|
296
|
+
|
297
|
+
// The FHIR resource types to import. The resource types should be a subset of
|
298
|
+
// all [supported FHIR resource
|
299
|
+
// types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification).
|
300
|
+
// Default to all supported FHIR resource types if empty.
|
301
|
+
repeated string resource_types = 3;
|
296
302
|
}
|
297
303
|
|
298
304
|
// Cloud SQL source import data from.
|
@@ -328,6 +334,38 @@ message CloudSqlSource {
|
|
328
334
|
bool offload = 6;
|
329
335
|
}
|
330
336
|
|
337
|
+
// AlloyDB source import data from.
|
338
|
+
message AlloyDbSource {
|
339
|
+
// The project ID that the AlloyDB source is in
|
340
|
+
// with a length limit of 128 characters. If not specified, inherits the
|
341
|
+
// project ID from the parent request.
|
342
|
+
string project_id = 1;
|
343
|
+
|
344
|
+
// Required. The AlloyDB location to copy the data from with a length limit of
|
345
|
+
// 256 characters.
|
346
|
+
string location_id = 2 [(google.api.field_behavior) = REQUIRED];
|
347
|
+
|
348
|
+
// Required. The AlloyDB cluster to copy the data from with a length limit of
|
349
|
+
// 256 characters.
|
350
|
+
string cluster_id = 3 [(google.api.field_behavior) = REQUIRED];
|
351
|
+
|
352
|
+
// Required. The AlloyDB database to copy the data from with a length limit of
|
353
|
+
// 256 characters.
|
354
|
+
string database_id = 4 [(google.api.field_behavior) = REQUIRED];
|
355
|
+
|
356
|
+
// Required. The AlloyDB table to copy the data from with a length limit of
|
357
|
+
// 256 characters.
|
358
|
+
string table_id = 5 [(google.api.field_behavior) = REQUIRED];
|
359
|
+
|
360
|
+
// Intermediate Cloud Storage directory used for the import with a length
|
361
|
+
// limit of 2,000 characters. Can be specified if one wants to have the
|
362
|
+
// AlloyDB export to a specific Cloud Storage directory.
|
363
|
+
//
|
364
|
+
// Ensure that the AlloyDB service account has the necessary Cloud
|
365
|
+
// Storage Admin permissions to access the specified Cloud Storage directory.
|
366
|
+
string gcs_staging_dir = 6;
|
367
|
+
}
|
368
|
+
|
331
369
|
// Firestore source import data from.
|
332
370
|
message FirestoreSource {
|
333
371
|
// The project ID that the Cloud SQL source is in with a length limit of 128
|
@@ -501,6 +539,9 @@ message ImportDocumentsRequest {
|
|
501
539
|
// Firestore input source.
|
502
540
|
FirestoreSource firestore_source = 13;
|
503
541
|
|
542
|
+
// AlloyDB input source.
|
543
|
+
AlloyDbSource alloy_db_source = 14;
|
544
|
+
|
504
545
|
// Cloud Bigtable input source.
|
505
546
|
BigtableSource bigtable_source = 15;
|
506
547
|
}
|
@@ -666,6 +707,79 @@ message ImportSuggestionDenyListEntriesMetadata {
|
|
666
707
|
google.protobuf.Timestamp update_time = 2;
|
667
708
|
}
|
668
709
|
|
710
|
+
// Request message for
|
711
|
+
// [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.ImportCompletionSuggestions]
|
712
|
+
// method.
|
713
|
+
message ImportCompletionSuggestionsRequest {
|
714
|
+
// The inline source for CompletionSuggestions.
|
715
|
+
message InlineSource {
|
716
|
+
// Required. A list of all denylist entries to import. Max of 1000 items.
|
717
|
+
repeated CompletionSuggestion suggestions = 1
|
718
|
+
[(google.api.field_behavior) = REQUIRED];
|
719
|
+
}
|
720
|
+
|
721
|
+
// The source of the autocomplete suggestions.
|
722
|
+
oneof source {
|
723
|
+
// The Inline source for suggestion entries.
|
724
|
+
InlineSource inline_source = 2;
|
725
|
+
|
726
|
+
// Cloud Storage location for the input content.
|
727
|
+
GcsSource gcs_source = 3;
|
728
|
+
|
729
|
+
// BigQuery input source.
|
730
|
+
BigQuerySource bigquery_source = 4;
|
731
|
+
}
|
732
|
+
|
733
|
+
// Required. The parent data store resource name for which to import customer
|
734
|
+
// autocomplete suggestions.
|
735
|
+
//
|
736
|
+
// Follows pattern `projects/*/locations/*/collections/*/dataStores/*`
|
737
|
+
string parent = 1 [
|
738
|
+
(google.api.field_behavior) = REQUIRED,
|
739
|
+
(google.api.resource_reference) = {
|
740
|
+
type: "discoveryengine.googleapis.com/DataStore"
|
741
|
+
}
|
742
|
+
];
|
743
|
+
|
744
|
+
// The desired location of errors incurred during the Import.
|
745
|
+
ImportErrorConfig error_config = 5;
|
746
|
+
}
|
747
|
+
|
748
|
+
// Response of the
|
749
|
+
// [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1alpha.CompletionService.ImportCompletionSuggestions]
|
750
|
+
// method. If the long running operation is done, this message is returned by
|
751
|
+
// the google.longrunning.Operations.response field if the operation is
|
752
|
+
// successful.
|
753
|
+
message ImportCompletionSuggestionsResponse {
|
754
|
+
// A sample of errors encountered while processing the request.
|
755
|
+
repeated google.rpc.Status error_samples = 1;
|
756
|
+
|
757
|
+
// The desired location of errors incurred during the Import.
|
758
|
+
ImportErrorConfig error_config = 2;
|
759
|
+
}
|
760
|
+
|
761
|
+
// Metadata related to the progress of the ImportCompletionSuggestions
|
762
|
+
// operation. This will be returned by the google.longrunning.Operation.metadata
|
763
|
+
// field.
|
764
|
+
message ImportCompletionSuggestionsMetadata {
|
765
|
+
// Operation create time.
|
766
|
+
google.protobuf.Timestamp create_time = 1;
|
767
|
+
|
768
|
+
// Operation last update time. If the operation is done, this is also the
|
769
|
+
// finish time.
|
770
|
+
google.protobuf.Timestamp update_time = 2;
|
771
|
+
|
772
|
+
// Count of
|
773
|
+
// [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s
|
774
|
+
// successfully imported.
|
775
|
+
int64 success_count = 3;
|
776
|
+
|
777
|
+
// Count of
|
778
|
+
// [CompletionSuggestion][google.cloud.discoveryengine.v1alpha.CompletionSuggestion]s
|
779
|
+
// that failed to be imported.
|
780
|
+
int64 failure_count = 4;
|
781
|
+
}
|
782
|
+
|
669
783
|
// Request message for
|
670
784
|
// [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1alpha.SampleQueryService.ImportSampleQueries]
|
671
785
|
// method.
|