@google-cloud/discoveryengine 1.1.0 → 1.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.
- package/CHANGELOG.md +14 -0
- package/README.md +39 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +190 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/completion_service.proto +134 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/conversation.proto +138 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +306 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +98 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto +307 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +121 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +318 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/engine.proto +370 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/engine_service.proto +336 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +343 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +159 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto +227 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +312 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/schema_service.proto +260 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +874 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +152 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +475 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/user_event_service.proto +154 -0
- package/build/protos/protos.d.ts +16365 -7
- package/build/protos/protos.js +42499 -1945
- package/build/protos/protos.json +4455 -5
- package/build/src/index.d.ts +3 -1
- package/build/src/index.js +4 -1
- package/build/src/v1alpha/completion_service_client.d.ts +645 -0
- package/build/src/v1alpha/completion_service_client.js +901 -0
- package/build/src/v1alpha/completion_service_client_config.json +43 -0
- package/build/src/v1alpha/conversational_search_service_client.d.ts +1040 -0
- package/build/src/v1alpha/conversational_search_service_client.js +1333 -0
- package/build/src/v1alpha/conversational_search_service_client_config.json +68 -0
- package/build/src/v1alpha/data_store_service_client.d.ts +1060 -0
- package/build/src/v1alpha/data_store_service_client.js +1431 -0
- package/build/src/v1alpha/data_store_service_client_config.json +46 -0
- package/build/src/v1alpha/document_service_client.d.ts +1257 -0
- package/build/src/v1alpha/document_service_client.js +1555 -0
- package/build/src/v1alpha/document_service_client_config.json +82 -0
- package/build/src/v1alpha/engine_service_client.d.ts +1079 -0
- package/build/src/v1alpha/engine_service_client.js +1481 -0
- package/build/src/v1alpha/engine_service_client_config.json +58 -0
- package/build/src/v1alpha/index.d.ts +10 -0
- package/build/src/v1alpha/index.js +41 -0
- package/build/src/v1alpha/recommendation_service_client.d.ts +858 -0
- package/build/src/v1alpha/recommendation_service_client.js +1100 -0
- package/build/src/v1alpha/recommendation_service_client_config.json +43 -0
- package/build/src/v1alpha/schema_service_client.d.ts +977 -0
- package/build/src/v1alpha/schema_service_client.js +1385 -0
- package/build/src/v1alpha/schema_service_client_config.json +63 -0
- package/build/src/v1alpha/search_service_client.d.ts +1394 -0
- package/build/src/v1alpha/search_service_client.js +1640 -0
- package/build/src/v1alpha/search_service_client_config.json +43 -0
- package/build/src/v1alpha/site_search_engine_service_client.d.ts +821 -0
- package/build/src/v1alpha/site_search_engine_service_client.js +1249 -0
- package/build/src/v1alpha/site_search_engine_service_client_config.json +30 -0
- package/build/src/v1alpha/user_event_service_client.d.ts +895 -0
- package/build/src/v1alpha/user_event_service_client.js +1232 -0
- package/build/src/v1alpha/user_event_service_client_config.json +67 -0
- package/package.json +5 -5
package/CHANGELOG.md
CHANGED
@@ -1,5 +1,19 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## [1.3.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v1.2.0...discoveryengine-v1.3.0) (2023-11-16)
|
4
|
+
|
5
|
+
|
6
|
+
### Features
|
7
|
+
|
8
|
+
* [discoveryengine] add data store and engine services ([#4810](https://github.com/googleapis/google-cloud-node/issues/4810)) ([7e95257](https://github.com/googleapis/google-cloud-node/commit/7e95257cb371509efce1e5b83a730cb1a1db4492))
|
9
|
+
|
10
|
+
## [1.2.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v1.1.0...discoveryengine-v1.2.0) (2023-10-18)
|
11
|
+
|
12
|
+
|
13
|
+
### Features
|
14
|
+
|
15
|
+
* [discoveryengine] add v1alpha public library for discoveryengine ([#4735](https://github.com/googleapis/google-cloud-node/issues/4735)) ([969c8b4](https://github.com/googleapis/google-cloud-node/commit/969c8b400612e9036de647e36b2c76398a3d4db6))
|
16
|
+
|
3
17
|
## [1.1.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v1.0.0...discoveryengine-v1.1.0) (2023-09-06)
|
4
18
|
|
5
19
|
|
package/README.md
CHANGED
@@ -148,6 +148,45 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
|
|
148
148
|
| User_event_service.collect_user_event | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/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/v1/user_event_service.collect_user_event.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
149
149
|
| User_event_service.import_user_events | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/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/v1/user_event_service.import_user_events.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
150
150
|
| User_event_service.write_user_event | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/user_event_service.write_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/v1/user_event_service.write_user_event.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
151
|
+
| 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) |
|
152
|
+
| Conversational_search_service.converse_conversation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/conversational_search_service.converse_conversation.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/conversational_search_service.converse_conversation.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
153
|
+
| Conversational_search_service.create_conversation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/conversational_search_service.create_conversation.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/conversational_search_service.create_conversation.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
154
|
+
| Conversational_search_service.delete_conversation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/conversational_search_service.delete_conversation.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/conversational_search_service.delete_conversation.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
155
|
+
| Conversational_search_service.get_conversation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/conversational_search_service.get_conversation.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/conversational_search_service.get_conversation.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
156
|
+
| Conversational_search_service.list_conversations | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/conversational_search_service.list_conversations.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/conversational_search_service.list_conversations.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
157
|
+
| Conversational_search_service.update_conversation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/conversational_search_service.update_conversation.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/conversational_search_service.update_conversation.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
158
|
+
| Data_store_service.create_data_store | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.create_data_store.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/data_store_service.create_data_store.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
159
|
+
| Data_store_service.delete_data_store | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.delete_data_store.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/data_store_service.delete_data_store.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
160
|
+
| Data_store_service.get_data_store | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.get_data_store.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/data_store_service.get_data_store.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
161
|
+
| Data_store_service.list_data_stores | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.list_data_stores.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/data_store_service.list_data_stores.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
162
|
+
| Data_store_service.update_data_store | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/data_store_service.update_data_store.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/data_store_service.update_data_store.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
163
|
+
| Document_service.create_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.create_document.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/document_service.create_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
164
|
+
| Document_service.delete_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.delete_document.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/document_service.delete_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
165
|
+
| Document_service.get_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.get_document.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/document_service.get_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
166
|
+
| Document_service.import_documents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.import_documents.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/document_service.import_documents.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
167
|
+
| Document_service.list_documents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.list_documents.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/document_service.list_documents.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
168
|
+
| Document_service.purge_documents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.purge_documents.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/document_service.purge_documents.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
169
|
+
| Document_service.update_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.update_document.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/document_service.update_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
170
|
+
| Engine_service.create_engine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.create_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/engine_service.create_engine.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
171
|
+
| Engine_service.delete_engine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.delete_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/engine_service.delete_engine.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
172
|
+
| Engine_service.get_engine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.get_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/engine_service.get_engine.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
173
|
+
| Engine_service.list_engines | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.list_engines.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/engine_service.list_engines.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
174
|
+
| Engine_service.pause_engine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.pause_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/engine_service.pause_engine.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
175
|
+
| Engine_service.resume_engine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.resume_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/engine_service.resume_engine.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
176
|
+
| Engine_service.tune_engine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.tune_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/engine_service.tune_engine.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
177
|
+
| Engine_service.update_engine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.update_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/engine_service.update_engine.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
178
|
+
| Recommendation_service.recommend | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/recommendation_service.recommend.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/recommendation_service.recommend.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
179
|
+
| Schema_service.create_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/schema_service.create_schema.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/schema_service.create_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
180
|
+
| Schema_service.delete_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/schema_service.delete_schema.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/schema_service.delete_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
181
|
+
| Schema_service.get_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/schema_service.get_schema.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/schema_service.get_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
182
|
+
| Schema_service.list_schemas | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/schema_service.list_schemas.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/schema_service.list_schemas.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
183
|
+
| Schema_service.update_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/schema_service.update_schema.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/schema_service.update_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
184
|
+
| Search_service.search | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/search_service.search.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/search_service.search.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
185
|
+
| 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) |
|
186
|
+
| 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) |
|
187
|
+
| 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) |
|
188
|
+
| User_event_service.purge_user_events | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/user_event_service.purge_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.purge_user_events.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
189
|
+
| User_event_service.write_user_event | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/user_event_service.write_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.write_user_event.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
151
190
|
| Completion_service.complete_query | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/completion_service.complete_query.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
152
191
|
| Conversational_search_service.converse_conversation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/conversational_search_service.converse_conversation.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/v1beta/conversational_search_service.converse_conversation.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
153
192
|
| Conversational_search_service.create_conversation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/conversational_search_service.create_conversation.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/v1beta/conversational_search_service.create_conversation.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
@@ -0,0 +1,190 @@
|
|
1
|
+
// Copyright 2022 Google LLC
|
2
|
+
//
|
3
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
// you may not use this file except in compliance with the License.
|
5
|
+
// You may obtain a copy of the License at
|
6
|
+
//
|
7
|
+
// http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
//
|
9
|
+
// Unless required by applicable law or agreed to in writing, software
|
10
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
// See the License for the specific language governing permissions and
|
13
|
+
// limitations under the License.
|
14
|
+
|
15
|
+
syntax = "proto3";
|
16
|
+
|
17
|
+
package google.cloud.discoveryengine.v1alpha;
|
18
|
+
|
19
|
+
import "google/api/resource.proto";
|
20
|
+
|
21
|
+
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
|
22
|
+
option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
|
23
|
+
option java_multiple_files = true;
|
24
|
+
option java_outer_classname = "CommonProto";
|
25
|
+
option java_package = "com.google.cloud.discoveryengine.v1alpha";
|
26
|
+
option objc_class_prefix = "DISCOVERYENGINE";
|
27
|
+
option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
|
28
|
+
option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
|
29
|
+
option (google.api.resource_definition) = {
|
30
|
+
type: "discoveryengine.googleapis.com/Branch"
|
31
|
+
pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}"
|
32
|
+
pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}"
|
33
|
+
};
|
34
|
+
option (google.api.resource_definition) = {
|
35
|
+
type: "discoveryengine.googleapis.com/Collection"
|
36
|
+
pattern: "projects/{project}/locations/{location}/collections/{collection}"
|
37
|
+
};
|
38
|
+
option (google.api.resource_definition) = {
|
39
|
+
type: "discoveryengine.googleapis.com/ServingConfig"
|
40
|
+
pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}"
|
41
|
+
pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}"
|
42
|
+
pattern: "projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}"
|
43
|
+
};
|
44
|
+
option (google.api.resource_definition) = {
|
45
|
+
type: "discoveryengine.googleapis.com/SiteSearchEngine"
|
46
|
+
pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine"
|
47
|
+
pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine"
|
48
|
+
};
|
49
|
+
|
50
|
+
// The industry vertical associated with the
|
51
|
+
// [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
|
52
|
+
enum IndustryVertical {
|
53
|
+
// Value used when unset.
|
54
|
+
INDUSTRY_VERTICAL_UNSPECIFIED = 0;
|
55
|
+
|
56
|
+
// The generic vertical for documents that are not specific to any industry
|
57
|
+
// vertical.
|
58
|
+
GENERIC = 1;
|
59
|
+
|
60
|
+
// The media industry vertical.
|
61
|
+
MEDIA = 2;
|
62
|
+
}
|
63
|
+
|
64
|
+
// The type of solution.
|
65
|
+
enum SolutionType {
|
66
|
+
// Default value.
|
67
|
+
SOLUTION_TYPE_UNSPECIFIED = 0;
|
68
|
+
|
69
|
+
// Used for Recommendations AI.
|
70
|
+
SOLUTION_TYPE_RECOMMENDATION = 1;
|
71
|
+
|
72
|
+
// Used for Discovery Search.
|
73
|
+
SOLUTION_TYPE_SEARCH = 2;
|
74
|
+
|
75
|
+
// Used for use cases related to the Generative AI agent.
|
76
|
+
SOLUTION_TYPE_CHAT = 3;
|
77
|
+
}
|
78
|
+
|
79
|
+
// Tiers of search features. Different tiers might have different
|
80
|
+
// pricing. To learn more, please check the pricing documentation.
|
81
|
+
enum SearchTier {
|
82
|
+
// Default value when the enum is unspecified. This is invalid to use.
|
83
|
+
SEARCH_TIER_UNSPECIFIED = 0;
|
84
|
+
|
85
|
+
// Standard tier.
|
86
|
+
SEARCH_TIER_STANDARD = 1;
|
87
|
+
|
88
|
+
// Enterprise tier.
|
89
|
+
SEARCH_TIER_ENTERPRISE = 2;
|
90
|
+
}
|
91
|
+
|
92
|
+
// Add-on that provides additional functionality for search.
|
93
|
+
enum SearchAddOn {
|
94
|
+
// Default value when the enum is unspecified. This is invalid to use.
|
95
|
+
SEARCH_ADD_ON_UNSPECIFIED = 0;
|
96
|
+
|
97
|
+
// Large language model add-on.
|
98
|
+
SEARCH_ADD_ON_LLM = 1;
|
99
|
+
}
|
100
|
+
|
101
|
+
// A floating point interval.
|
102
|
+
message Interval {
|
103
|
+
// The lower bound of the interval. If neither of the min fields are
|
104
|
+
// set, then the lower bound is negative infinity.
|
105
|
+
//
|
106
|
+
// This field must be not larger than max.
|
107
|
+
// Otherwise, an `INVALID_ARGUMENT` error is returned.
|
108
|
+
oneof min {
|
109
|
+
// Inclusive lower bound.
|
110
|
+
double minimum = 1;
|
111
|
+
|
112
|
+
// Exclusive lower bound.
|
113
|
+
double exclusive_minimum = 2;
|
114
|
+
}
|
115
|
+
|
116
|
+
// The upper bound of the interval. If neither of the max fields are
|
117
|
+
// set, then the upper bound is positive infinity.
|
118
|
+
//
|
119
|
+
// This field must be not smaller than min.
|
120
|
+
// Otherwise, an `INVALID_ARGUMENT` error is returned.
|
121
|
+
oneof max {
|
122
|
+
// Inclusive upper bound.
|
123
|
+
double maximum = 3;
|
124
|
+
|
125
|
+
// Exclusive upper bound.
|
126
|
+
double exclusive_maximum = 4;
|
127
|
+
}
|
128
|
+
}
|
129
|
+
|
130
|
+
// A custom attribute that is not explicitly modeled in a resource, e.g.
|
131
|
+
// [UserEvent][google.cloud.discoveryengine.v1alpha.UserEvent].
|
132
|
+
message CustomAttribute {
|
133
|
+
// The textual values of this custom attribute. For example, `["yellow",
|
134
|
+
// "green"]` when the key is "color".
|
135
|
+
//
|
136
|
+
// Empty string is not allowed. Otherwise, an `INVALID_ARGUMENT` error is
|
137
|
+
// returned.
|
138
|
+
//
|
139
|
+
// Exactly one of
|
140
|
+
// [CustomAttribute.text][google.cloud.discoveryengine.v1alpha.CustomAttribute.text]
|
141
|
+
// or
|
142
|
+
// [CustomAttribute.numbers][google.cloud.discoveryengine.v1alpha.CustomAttribute.numbers]
|
143
|
+
// should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
144
|
+
repeated string text = 1;
|
145
|
+
|
146
|
+
// The numerical values of this custom attribute. For example, `[2.3, 15.4]`
|
147
|
+
// when the key is "lengths_cm".
|
148
|
+
//
|
149
|
+
// Exactly one of
|
150
|
+
// [CustomAttribute.text][google.cloud.discoveryengine.v1alpha.CustomAttribute.text]
|
151
|
+
// or
|
152
|
+
// [CustomAttribute.numbers][google.cloud.discoveryengine.v1alpha.CustomAttribute.numbers]
|
153
|
+
// should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
154
|
+
repeated double numbers = 2;
|
155
|
+
}
|
156
|
+
|
157
|
+
// Information of an end user.
|
158
|
+
message UserInfo {
|
159
|
+
// Highly recommended for logged-in users. Unique identifier for logged-in
|
160
|
+
// user, such as a user name. Don't set for anonymous users.
|
161
|
+
//
|
162
|
+
// Always use a hashed value for this ID.
|
163
|
+
//
|
164
|
+
// Don't set the field to the same fixed ID for different users. This mixes
|
165
|
+
// the event history of those users together, which results in degraded
|
166
|
+
// model quality.
|
167
|
+
//
|
168
|
+
// The field must be a UTF-8 encoded string with a length limit of 128
|
169
|
+
// characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
170
|
+
string user_id = 1;
|
171
|
+
|
172
|
+
// User agent as included in the HTTP header.
|
173
|
+
//
|
174
|
+
// The field must be a UTF-8 encoded string with a length limit of 1,000
|
175
|
+
// characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
176
|
+
//
|
177
|
+
// This should not be set when using the client side event reporting with
|
178
|
+
// GTM or JavaScript tag in
|
179
|
+
// [UserEventService.CollectUserEvent][google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent]
|
180
|
+
// or if
|
181
|
+
// [UserEvent.direct_user_request][google.cloud.discoveryengine.v1alpha.UserEvent.direct_user_request]
|
182
|
+
// is set.
|
183
|
+
string user_agent = 2;
|
184
|
+
}
|
185
|
+
|
186
|
+
// Double list.
|
187
|
+
message DoubleList {
|
188
|
+
// Double values.
|
189
|
+
repeated double values = 1;
|
190
|
+
}
|
@@ -0,0 +1,134 @@
|
|
1
|
+
// Copyright 2022 Google LLC
|
2
|
+
//
|
3
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
// you may not use this file except in compliance with the License.
|
5
|
+
// You may obtain a copy of the License at
|
6
|
+
//
|
7
|
+
// http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
//
|
9
|
+
// Unless required by applicable law or agreed to in writing, software
|
10
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
// See the License for the specific language governing permissions and
|
13
|
+
// limitations under the License.
|
14
|
+
|
15
|
+
syntax = "proto3";
|
16
|
+
|
17
|
+
package google.cloud.discoveryengine.v1alpha;
|
18
|
+
|
19
|
+
import "google/api/annotations.proto";
|
20
|
+
import "google/api/client.proto";
|
21
|
+
import "google/api/field_behavior.proto";
|
22
|
+
import "google/api/resource.proto";
|
23
|
+
|
24
|
+
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
|
25
|
+
option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
|
26
|
+
option java_multiple_files = true;
|
27
|
+
option java_outer_classname = "CompletionServiceProto";
|
28
|
+
option java_package = "com.google.cloud.discoveryengine.v1alpha";
|
29
|
+
option objc_class_prefix = "DISCOVERYENGINE";
|
30
|
+
option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
|
31
|
+
option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
|
32
|
+
|
33
|
+
// Service for Auto-Completion.
|
34
|
+
service CompletionService {
|
35
|
+
option (google.api.default_host) = "discoveryengine.googleapis.com";
|
36
|
+
option (google.api.oauth_scopes) =
|
37
|
+
"https://www.googleapis.com/auth/cloud-platform";
|
38
|
+
|
39
|
+
// Completes the specified user input with keyword suggestions.
|
40
|
+
rpc CompleteQuery(CompleteQueryRequest) returns (CompleteQueryResponse) {
|
41
|
+
option (google.api.http) = {
|
42
|
+
get: "/v1alpha/{data_store=projects/*/locations/*/dataStores/*}:completeQuery"
|
43
|
+
additional_bindings {
|
44
|
+
get: "/v1alpha/{data_store=projects/*/locations/*/collections/*/dataStores/*}:completeQuery"
|
45
|
+
}
|
46
|
+
};
|
47
|
+
}
|
48
|
+
}
|
49
|
+
|
50
|
+
// Request message for
|
51
|
+
// [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery]
|
52
|
+
// method.
|
53
|
+
message CompleteQueryRequest {
|
54
|
+
// Required. The parent data store resource name for which the completion is
|
55
|
+
// performed, such as
|
56
|
+
// `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
|
57
|
+
string data_store = 1 [
|
58
|
+
(google.api.field_behavior) = REQUIRED,
|
59
|
+
(google.api.resource_reference) = {
|
60
|
+
type: "discoveryengine.googleapis.com/DataStore"
|
61
|
+
}
|
62
|
+
];
|
63
|
+
|
64
|
+
// Required. The typeahead input used to fetch suggestions. Maximum length is
|
65
|
+
// 128 characters.
|
66
|
+
string query = 2 [(google.api.field_behavior) = REQUIRED];
|
67
|
+
|
68
|
+
// Selects data model of query suggestions for serving. Currently supported
|
69
|
+
// values:
|
70
|
+
//
|
71
|
+
// * `document` - Using suggestions generated from user-imported documents.
|
72
|
+
// * `search-history` - Using suggestions generated from the past history of
|
73
|
+
// [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search]
|
74
|
+
// API calls. Do not use it when there is no traffic for Search API.
|
75
|
+
// * `user-event` - Using suggestions generated from user-imported search
|
76
|
+
// events.
|
77
|
+
// * `document-completable` - Using suggestions taken directly from
|
78
|
+
// user-imported document fields marked as completable.
|
79
|
+
//
|
80
|
+
// Default values:
|
81
|
+
//
|
82
|
+
// * `document` is the default model for regular dataStores.
|
83
|
+
// * `search-history` is the default model for site search dataStores.
|
84
|
+
string query_model = 3;
|
85
|
+
|
86
|
+
// A unique identifier for tracking visitors. For example, this could be
|
87
|
+
// implemented with an HTTP cookie, which should be able to uniquely identify
|
88
|
+
// a visitor on a single device. This unique identifier should not change if
|
89
|
+
// the visitor logs in or out of the website.
|
90
|
+
//
|
91
|
+
// This field should NOT have a fixed value such as `unknown_visitor`.
|
92
|
+
//
|
93
|
+
// This should be the same identifier as
|
94
|
+
// [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id]
|
95
|
+
// and
|
96
|
+
// [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1alpha.SearchRequest.user_pseudo_id].
|
97
|
+
//
|
98
|
+
// The field must be a UTF-8 encoded string with a length limit of 128
|
99
|
+
// characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
100
|
+
string user_pseudo_id = 4;
|
101
|
+
|
102
|
+
// Indicates if tail suggestions should be returned if there are no
|
103
|
+
// suggestions that match the full query. Even if set to true, if there are
|
104
|
+
// suggestions that match the full query, those are returned and no
|
105
|
+
// tail suggestions are returned.
|
106
|
+
bool include_tail_suggestions = 5;
|
107
|
+
}
|
108
|
+
|
109
|
+
// Response message for
|
110
|
+
// [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery]
|
111
|
+
// method.
|
112
|
+
message CompleteQueryResponse {
|
113
|
+
// Suggestions as search queries.
|
114
|
+
message QuerySuggestion {
|
115
|
+
// The suggestion for the query.
|
116
|
+
string suggestion = 1;
|
117
|
+
|
118
|
+
// The unique document field paths that serve as the source of this
|
119
|
+
// suggestion if it was generated from completable fields.
|
120
|
+
//
|
121
|
+
// This field is only populated for the document-completable model.
|
122
|
+
repeated string completable_field_paths = 2;
|
123
|
+
}
|
124
|
+
|
125
|
+
// Results of the matched query suggestions. The result list is ordered and
|
126
|
+
// the first result is a top suggestion.
|
127
|
+
repeated QuerySuggestion query_suggestions = 1;
|
128
|
+
|
129
|
+
// True if the returned suggestions are all tail suggestions.
|
130
|
+
//
|
131
|
+
// For tail matching to be triggered, include_tail_suggestions in the request
|
132
|
+
// must be true and there must be no suggestions that match the full query.
|
133
|
+
bool tail_match_triggered = 2;
|
134
|
+
}
|
@@ -0,0 +1,138 @@
|
|
1
|
+
// Copyright 2022 Google LLC
|
2
|
+
//
|
3
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
// you may not use this file except in compliance with the License.
|
5
|
+
// You may obtain a copy of the License at
|
6
|
+
//
|
7
|
+
// http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
//
|
9
|
+
// Unless required by applicable law or agreed to in writing, software
|
10
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
// See the License for the specific language governing permissions and
|
13
|
+
// limitations under the License.
|
14
|
+
|
15
|
+
syntax = "proto3";
|
16
|
+
|
17
|
+
package google.cloud.discoveryengine.v1alpha;
|
18
|
+
|
19
|
+
import "google/api/field_behavior.proto";
|
20
|
+
import "google/api/resource.proto";
|
21
|
+
import "google/cloud/discoveryengine/v1alpha/search_service.proto";
|
22
|
+
import "google/protobuf/timestamp.proto";
|
23
|
+
|
24
|
+
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
|
25
|
+
option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
|
26
|
+
option java_multiple_files = true;
|
27
|
+
option java_outer_classname = "ConversationProto";
|
28
|
+
option java_package = "com.google.cloud.discoveryengine.v1alpha";
|
29
|
+
option objc_class_prefix = "DISCOVERYENGINE";
|
30
|
+
option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
|
31
|
+
option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
|
32
|
+
|
33
|
+
// External conversation proto definition.
|
34
|
+
message Conversation {
|
35
|
+
option (google.api.resource) = {
|
36
|
+
type: "discoveryengine.googleapis.com/Conversation"
|
37
|
+
pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}"
|
38
|
+
pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}"
|
39
|
+
};
|
40
|
+
|
41
|
+
// Enumeration of the state of the conversation.
|
42
|
+
enum State {
|
43
|
+
// Unknown.
|
44
|
+
STATE_UNSPECIFIED = 0;
|
45
|
+
|
46
|
+
// Conversation is currently open.
|
47
|
+
IN_PROGRESS = 1;
|
48
|
+
|
49
|
+
// Conversation has been completed.
|
50
|
+
COMPLETED = 2;
|
51
|
+
}
|
52
|
+
|
53
|
+
// Immutable. Fully qualified name
|
54
|
+
// `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*`
|
55
|
+
string name = 1 [(google.api.field_behavior) = IMMUTABLE];
|
56
|
+
|
57
|
+
// The state of the Conversation.
|
58
|
+
State state = 2;
|
59
|
+
|
60
|
+
// A unique identifier for tracking users.
|
61
|
+
string user_pseudo_id = 3;
|
62
|
+
|
63
|
+
// Conversation messages.
|
64
|
+
repeated ConversationMessage messages = 4;
|
65
|
+
|
66
|
+
// Output only. The time the conversation started.
|
67
|
+
google.protobuf.Timestamp start_time = 5
|
68
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
69
|
+
|
70
|
+
// Output only. The time the conversation finished.
|
71
|
+
google.protobuf.Timestamp end_time = 6
|
72
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
73
|
+
}
|
74
|
+
|
75
|
+
// Defines a reply message to user.
|
76
|
+
message Reply {
|
77
|
+
// Defines reference in reply.
|
78
|
+
message Reference {
|
79
|
+
option deprecated = true;
|
80
|
+
|
81
|
+
// URI link reference.
|
82
|
+
string uri = 1;
|
83
|
+
|
84
|
+
// Anchor text.
|
85
|
+
string anchor_text = 2;
|
86
|
+
|
87
|
+
// Anchor text start index.
|
88
|
+
int32 start = 3;
|
89
|
+
|
90
|
+
// Anchor text end index.
|
91
|
+
int32 end = 4;
|
92
|
+
}
|
93
|
+
|
94
|
+
// DEPRECATED: use `summary` instead.
|
95
|
+
// Text reply.
|
96
|
+
string reply = 1 [deprecated = true];
|
97
|
+
|
98
|
+
// References in the reply.
|
99
|
+
repeated Reference references = 2 [deprecated = true];
|
100
|
+
|
101
|
+
// Summary based on search results.
|
102
|
+
SearchResponse.Summary summary = 3;
|
103
|
+
}
|
104
|
+
|
105
|
+
// Defines context of the conversation
|
106
|
+
message ConversationContext {
|
107
|
+
// The current list of documents the user is seeing.
|
108
|
+
// It contains the document resource references.
|
109
|
+
repeated string context_documents = 1;
|
110
|
+
|
111
|
+
// The current active document the user opened.
|
112
|
+
// It contains the document resource reference.
|
113
|
+
string active_document = 2;
|
114
|
+
}
|
115
|
+
|
116
|
+
// Defines text input.
|
117
|
+
message TextInput {
|
118
|
+
// Text input.
|
119
|
+
string input = 1;
|
120
|
+
|
121
|
+
// Conversation context of the input.
|
122
|
+
ConversationContext context = 2;
|
123
|
+
}
|
124
|
+
|
125
|
+
// Defines a conversation message.
|
126
|
+
message ConversationMessage {
|
127
|
+
oneof message {
|
128
|
+
// User text input.
|
129
|
+
TextInput user_input = 1;
|
130
|
+
|
131
|
+
// Search reply.
|
132
|
+
Reply reply = 2;
|
133
|
+
}
|
134
|
+
|
135
|
+
// Output only. Message creation timestamp.
|
136
|
+
google.protobuf.Timestamp create_time = 3
|
137
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
138
|
+
}
|