@google-cloud/discoveryengine 0.6.0 → 0.8.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 +24 -0
- package/README.md +38 -22
- package/build/protos/google/cloud/discoveryengine/v1/common.proto +100 -0
- package/build/protos/google/cloud/discoveryengine/v1/completion_service.proto +116 -0
- package/build/protos/google/cloud/discoveryengine/v1/document.proto +118 -0
- package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +313 -0
- package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +334 -0
- package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +86 -0
- package/build/protos/google/cloud/discoveryengine/v1/schema.proto +58 -0
- package/build/protos/google/cloud/discoveryengine/v1/schema_service.proto +256 -0
- package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +289 -0
- package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +458 -0
- package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +133 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +2 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +4 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +65 -7
- package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +75 -4
- package/build/protos/protos.d.ts +6704 -0
- package/build/protos/protos.js +16332 -5
- package/build/protos/protos.json +1830 -12
- package/build/src/index.d.ts +18 -19
- package/build/src/index.js +9 -9
- package/build/src/v1/completion_service_client.d.ts +455 -0
- package/build/src/v1/completion_service_client.js +659 -0
- package/build/src/v1/completion_service_client_config.json +43 -0
- package/build/src/v1/document_service_client.d.ts +995 -0
- package/build/src/v1/document_service_client.js +1191 -0
- package/build/src/v1/document_service_client_config.json +82 -0
- package/build/src/v1/index.d.ts +5 -0
- package/build/src/v1/index.js +31 -0
- package/build/src/v1/schema_service_client.d.ts +795 -0
- package/build/src/v1/schema_service_client.js +1129 -0
- package/build/src/v1/schema_service_client_config.json +63 -0
- package/build/src/v1/search_service_client.d.ts +857 -0
- package/build/src/v1/search_service_client.js +1073 -0
- package/build/src/v1/search_service_client_config.json +43 -0
- package/build/src/v1/user_event_service_client.d.ts +638 -0
- package/build/src/v1/user_event_service_client.js +933 -0
- package/build/src/v1/user_event_service_client_config.json +62 -0
- package/build/src/v1beta/completion_service_client.d.ts +2 -0
- package/build/src/v1beta/document_service_client.d.ts +52 -0
- package/build/src/v1beta/document_service_client.js +6 -0
- package/build/src/v1beta/schema_service_client.js +6 -0
- package/build/src/v1beta/search_service_client.d.ts +78 -12
- package/build/src/v1beta/search_service_client.js +52 -8
- package/build/src/v1beta/user_event_service_client.d.ts +3 -3
- package/build/src/v1beta/user_event_service_client.js +6 -0
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
@@ -1,5 +1,29 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## [0.8.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v0.7.0...discoveryengine-v0.8.0) (2023-06-28)
|
4
|
+
|
5
|
+
|
6
|
+
### Features
|
7
|
+
|
8
|
+
* [discoveryengine] support extractive content in search ([#4355](https://github.com/googleapis/google-cloud-node/issues/4355)) ([5958cfa](https://github.com/googleapis/google-cloud-node/commit/5958cfa56bd5280301f446a8863d6461ea86493e))
|
9
|
+
|
10
|
+
## [0.7.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v0.6.0...discoveryengine-v0.7.0) (2023-06-14)
|
11
|
+
|
12
|
+
|
13
|
+
### ⚠ BREAKING CHANGES
|
14
|
+
|
15
|
+
* use v1 as the default version ([#4333](https://github.com/googleapis/google-cloud-node/issues/4333))
|
16
|
+
* [discoveryengine] remove the summarization feature from v1 version ([#4273](https://github.com/googleapis/google-cloud-node/issues/4273))
|
17
|
+
|
18
|
+
### Features
|
19
|
+
|
20
|
+
* Use v1 as the default version ([#4333](https://github.com/googleapis/google-cloud-node/issues/4333)) ([1415f5f](https://github.com/googleapis/google-cloud-node/commit/1415f5f0cdbd284fb11427fe1053048e278e7546))
|
21
|
+
|
22
|
+
|
23
|
+
### Bug Fixes
|
24
|
+
|
25
|
+
* [discoveryengine] remove the summarization feature from v1 version ([#4273](https://github.com/googleapis/google-cloud-node/issues/4273)) ([0b9c928](https://github.com/googleapis/google-cloud-node/commit/0b9c928a45e5de78dd13894dc537b351f90a9d56))
|
26
|
+
|
3
27
|
## [0.6.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v0.5.0...discoveryengine-v0.6.0) (2023-05-04)
|
4
28
|
|
5
29
|
|
package/README.md
CHANGED
@@ -2,7 +2,7 @@
|
|
2
2
|
[//]: # "To regenerate it, use `python -m synthtool`."
|
3
3
|
<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
|
4
4
|
|
5
|
-
# [Discovery Engine API: Node.js Client](https://github.com/googleapis/google-cloud-node)
|
5
|
+
# [Discovery Engine API: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-discoveryengine)
|
6
6
|
|
7
7
|
[](https://cloud.google.com/terms/launch-stages)
|
8
8
|
[](https://www.npmjs.org/package/@google-cloud/discoveryengine)
|
@@ -121,30 +121,46 @@ callListDocuments();
|
|
121
121
|
|
122
122
|
## Samples
|
123
123
|
|
124
|
-
Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample.
|
124
|
+
Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-discoveryengine/samples) directory. Each sample's `README.md` has instructions for running its sample.
|
125
125
|
|
126
126
|
| Sample | Source Code | Try it |
|
127
127
|
| --------------------------- | --------------------------------- | ------ |
|
128
|
-
| Completion_service.complete_query | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/
|
129
|
-
| Document_service.create_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/
|
130
|
-
| Document_service.delete_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/
|
131
|
-
| Document_service.get_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/
|
132
|
-
| Document_service.import_documents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/
|
133
|
-
| Document_service.list_documents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/
|
134
|
-
| Document_service.purge_documents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/
|
135
|
-
| Document_service.update_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/
|
136
|
-
|
|
137
|
-
| Schema_service.
|
138
|
-
| Schema_service.
|
139
|
-
| Schema_service.
|
140
|
-
| Schema_service.
|
141
|
-
|
|
142
|
-
|
|
143
|
-
| User_event_service.
|
144
|
-
| User_event_service.
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
128
|
+
| Completion_service.complete_query | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/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/v1/completion_service.complete_query.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
129
|
+
| Document_service.create_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/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/v1/document_service.create_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
130
|
+
| Document_service.delete_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/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/v1/document_service.delete_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
131
|
+
| Document_service.get_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/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/v1/document_service.get_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
132
|
+
| Document_service.import_documents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/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/v1/document_service.import_documents.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
133
|
+
| Document_service.list_documents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/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/v1/document_service.list_documents.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
134
|
+
| Document_service.purge_documents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/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/v1/document_service.purge_documents.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
135
|
+
| Document_service.update_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/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/v1/document_service.update_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
136
|
+
| Schema_service.create_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/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/v1/schema_service.create_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
137
|
+
| Schema_service.delete_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/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/v1/schema_service.delete_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
138
|
+
| Schema_service.get_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/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/v1/schema_service.get_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
139
|
+
| Schema_service.list_schemas | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/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/v1/schema_service.list_schemas.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
140
|
+
| Schema_service.update_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/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/v1/schema_service.update_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
141
|
+
| Search_service.search | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1/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/v1/search_service.search.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
142
|
+
| 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) |
|
143
|
+
| 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) |
|
144
|
+
| 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) |
|
145
|
+
| 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) |
|
146
|
+
| Document_service.create_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/document_service.create_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
147
|
+
| Document_service.delete_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/document_service.delete_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
148
|
+
| Document_service.get_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/document_service.get_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
149
|
+
| Document_service.import_documents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/document_service.import_documents.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
150
|
+
| Document_service.list_documents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/document_service.list_documents.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
151
|
+
| Document_service.purge_documents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/document_service.purge_documents.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
152
|
+
| Document_service.update_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/document_service.update_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
153
|
+
| Recommendation_service.recommend | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/recommendation_service.recommend.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
154
|
+
| Schema_service.create_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/schema_service.create_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
155
|
+
| Schema_service.delete_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/schema_service.delete_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
156
|
+
| Schema_service.get_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/schema_service.get_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
157
|
+
| Schema_service.list_schemas | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/schema_service.list_schemas.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
158
|
+
| Schema_service.update_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/schema_service.update_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
159
|
+
| Search_service.search | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/search_service.search.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
160
|
+
| User_event_service.collect_user_event | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/user_event_service.collect_user_event.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
161
|
+
| User_event_service.import_user_events | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/user_event_service.import_user_events.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
162
|
+
| User_event_service.write_user_event | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/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/v1beta/user_event_service.write_user_event.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
163
|
+
| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/quickstart.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/quickstart.js,packages/google-cloud-discoveryengine/samples/README.md) |
|
148
164
|
|
149
165
|
|
150
166
|
|
@@ -0,0 +1,100 @@
|
|
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.v1;
|
18
|
+
|
19
|
+
import "google/api/resource.proto";
|
20
|
+
|
21
|
+
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1";
|
22
|
+
option go_package = "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb";
|
23
|
+
option java_multiple_files = true;
|
24
|
+
option java_outer_classname = "CommonProto";
|
25
|
+
option java_package = "com.google.cloud.discoveryengine.v1";
|
26
|
+
option objc_class_prefix = "DISCOVERYENGINE";
|
27
|
+
option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1";
|
28
|
+
option ruby_package = "Google::Cloud::DiscoveryEngine::V1";
|
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/DataStore"
|
36
|
+
pattern: "projects/{project}/locations/{location}/dataStores/{data_store}"
|
37
|
+
pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}"
|
38
|
+
};
|
39
|
+
option (google.api.resource_definition) = {
|
40
|
+
type: "discoveryengine.googleapis.com/ServingConfig"
|
41
|
+
pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}"
|
42
|
+
pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}"
|
43
|
+
};
|
44
|
+
|
45
|
+
// A custom attribute that is not explicitly modeled in a resource, e.g.
|
46
|
+
// [UserEvent][google.cloud.discoveryengine.v1.UserEvent].
|
47
|
+
message CustomAttribute {
|
48
|
+
// The textual values of this custom attribute. For example, `["yellow",
|
49
|
+
// "green"]` when the key is "color".
|
50
|
+
//
|
51
|
+
// Empty string is not allowed. Otherwise, an `INVALID_ARGUMENT` error is
|
52
|
+
// returned.
|
53
|
+
//
|
54
|
+
// Exactly one of
|
55
|
+
// [CustomAttribute.text][google.cloud.discoveryengine.v1.CustomAttribute.text]
|
56
|
+
// or
|
57
|
+
// [CustomAttribute.numbers][google.cloud.discoveryengine.v1.CustomAttribute.numbers]
|
58
|
+
// should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
59
|
+
repeated string text = 1;
|
60
|
+
|
61
|
+
// The numerical values of this custom attribute. For example, `[2.3, 15.4]`
|
62
|
+
// when the key is "lengths_cm".
|
63
|
+
//
|
64
|
+
// Exactly one of
|
65
|
+
// [CustomAttribute.text][google.cloud.discoveryengine.v1.CustomAttribute.text]
|
66
|
+
// or
|
67
|
+
// [CustomAttribute.numbers][google.cloud.discoveryengine.v1.CustomAttribute.numbers]
|
68
|
+
// should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
69
|
+
repeated double numbers = 2;
|
70
|
+
}
|
71
|
+
|
72
|
+
// Information of an end user.
|
73
|
+
message UserInfo {
|
74
|
+
// Highly recommended for logged-in users. Unique identifier for logged-in
|
75
|
+
// user, such as a user name. Don't set for anonymous users.
|
76
|
+
//
|
77
|
+
// Always use a hashed value for this ID.
|
78
|
+
//
|
79
|
+
// Don't set the field to the same fixed ID for different users. This mixes
|
80
|
+
// the event history of those users together, which results in degraded
|
81
|
+
// model quality.
|
82
|
+
//
|
83
|
+
// The field must be a UTF-8 encoded string with a length limit of 128
|
84
|
+
// characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
85
|
+
string user_id = 1;
|
86
|
+
|
87
|
+
// User agent as included in the HTTP header. Required for getting
|
88
|
+
// [SearchResponse.sponsored_results][].
|
89
|
+
//
|
90
|
+
// The field must be a UTF-8 encoded string with a length limit of 1,000
|
91
|
+
// characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
92
|
+
//
|
93
|
+
// This should not be set when using the client side event reporting with
|
94
|
+
// GTM or JavaScript tag in
|
95
|
+
// [UserEventService.CollectUserEvent][google.cloud.discoveryengine.v1.UserEventService.CollectUserEvent]
|
96
|
+
// or if
|
97
|
+
// [UserEvent.direct_user_request][google.cloud.discoveryengine.v1.UserEvent.direct_user_request]
|
98
|
+
// is set.
|
99
|
+
string user_agent = 2;
|
100
|
+
}
|
@@ -0,0 +1,116 @@
|
|
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.v1;
|
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.V1";
|
25
|
+
option go_package = "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb";
|
26
|
+
option java_multiple_files = true;
|
27
|
+
option java_outer_classname = "CompletionServiceProto";
|
28
|
+
option java_package = "com.google.cloud.discoveryengine.v1";
|
29
|
+
option objc_class_prefix = "DISCOVERYENGINE";
|
30
|
+
option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1";
|
31
|
+
option ruby_package = "Google::Cloud::DiscoveryEngine::V1";
|
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: "/v1/{data_store=projects/*/locations/*/dataStores/*}:completeQuery"
|
43
|
+
additional_bindings {
|
44
|
+
get: "/v1/{data_store=projects/*/locations/*/collections/*/dataStores/*}:completeQuery"
|
45
|
+
}
|
46
|
+
};
|
47
|
+
}
|
48
|
+
}
|
49
|
+
|
50
|
+
// Request message for
|
51
|
+
// [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.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.v1.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
|
+
//
|
78
|
+
// Default values:
|
79
|
+
//
|
80
|
+
// * `document` is the default model for regular dataStores.
|
81
|
+
// * `search-history` is the default model for
|
82
|
+
// [IndustryVertical.SITE_SEARCH][google.cloud.discoveryengine.v1.IndustryVertical.SITE_SEARCH]
|
83
|
+
// 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.v1.UserEvent.user_pseudo_id]
|
95
|
+
// and
|
96
|
+
// [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1.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
|
+
|
103
|
+
// Response message for
|
104
|
+
// [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.CompletionService.CompleteQuery]
|
105
|
+
// method.
|
106
|
+
message CompleteQueryResponse {
|
107
|
+
// Suggestions as search queries.
|
108
|
+
message QuerySuggestion {
|
109
|
+
// The suggestion for the query.
|
110
|
+
string suggestion = 1;
|
111
|
+
}
|
112
|
+
|
113
|
+
// Results of the matched query suggestions. The result list is ordered and
|
114
|
+
// the first result is a top suggestion.
|
115
|
+
repeated QuerySuggestion query_suggestions = 1;
|
116
|
+
}
|
@@ -0,0 +1,118 @@
|
|
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.v1;
|
18
|
+
|
19
|
+
import "google/api/field_behavior.proto";
|
20
|
+
import "google/api/resource.proto";
|
21
|
+
import "google/protobuf/struct.proto";
|
22
|
+
|
23
|
+
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1";
|
24
|
+
option go_package = "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb";
|
25
|
+
option java_multiple_files = true;
|
26
|
+
option java_outer_classname = "DocumentProto";
|
27
|
+
option java_package = "com.google.cloud.discoveryengine.v1";
|
28
|
+
option objc_class_prefix = "DISCOVERYENGINE";
|
29
|
+
option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1";
|
30
|
+
option ruby_package = "Google::Cloud::DiscoveryEngine::V1";
|
31
|
+
|
32
|
+
// Document captures all raw metadata information of items to be recommended or
|
33
|
+
// searched.
|
34
|
+
message Document {
|
35
|
+
option (google.api.resource) = {
|
36
|
+
type: "discoveryengine.googleapis.com/Document"
|
37
|
+
pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}"
|
38
|
+
pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}"
|
39
|
+
};
|
40
|
+
|
41
|
+
// Unstructured data linked to this document.
|
42
|
+
message Content {
|
43
|
+
oneof content {
|
44
|
+
// The content represented as a stream of bytes. The maximum length is
|
45
|
+
// 1,000,000 bytes (1 MB / ~0.95 MiB).
|
46
|
+
//
|
47
|
+
// Note: As with all `bytes` fields, this field is represented as pure
|
48
|
+
// binary in Protocol Buffers and base64-encoded string in JSON. For
|
49
|
+
// example, `abc123!?$*&()'-=@~` should be represented as
|
50
|
+
// `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See
|
51
|
+
// https://developers.google.com/protocol-buffers/docs/proto3#json.
|
52
|
+
bytes raw_bytes = 2;
|
53
|
+
|
54
|
+
// The URI of the content. Only Cloud Storage URIs (e.g.
|
55
|
+
// `gs://bucket-name/path/to/file`) are supported. The maximum file size
|
56
|
+
// is 100 MB.
|
57
|
+
string uri = 3;
|
58
|
+
}
|
59
|
+
|
60
|
+
// The MIME type of the content. Supported types:
|
61
|
+
//
|
62
|
+
// * `application/pdf` (PDF)
|
63
|
+
// * `text/html` (HTML)
|
64
|
+
//
|
65
|
+
// See https://www.iana.org/assignments/media-types/media-types.xhtml.
|
66
|
+
string mime_type = 1;
|
67
|
+
}
|
68
|
+
|
69
|
+
// Data representation. One of
|
70
|
+
// [struct_data][google.cloud.discoveryengine.v1.Document.struct_data] or
|
71
|
+
// [json_data][google.cloud.discoveryengine.v1.Document.json_data] should be
|
72
|
+
// provided otherwise an `INVALID_ARGUMENT` error is thrown.
|
73
|
+
oneof data {
|
74
|
+
// The structured JSON data for the document. It should conform to the
|
75
|
+
// registered [Schema.schema][google.cloud.discoveryengine.v1.Schema.schema]
|
76
|
+
// or an `INVALID_ARGUMENT` error is thrown.
|
77
|
+
google.protobuf.Struct struct_data = 4;
|
78
|
+
|
79
|
+
// The JSON string representation of the document. It should conform to the
|
80
|
+
// registered [Schema.schema][google.cloud.discoveryengine.v1.Schema.schema]
|
81
|
+
// or an `INVALID_ARGUMENT` error is thrown.
|
82
|
+
string json_data = 5;
|
83
|
+
}
|
84
|
+
|
85
|
+
// Immutable. The full resource name of the document.
|
86
|
+
// Format:
|
87
|
+
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
|
88
|
+
//
|
89
|
+
// This field must be a UTF-8 encoded string with a length limit of 1024
|
90
|
+
// characters.
|
91
|
+
string name = 1 [(google.api.field_behavior) = IMMUTABLE];
|
92
|
+
|
93
|
+
// Immutable. The identifier of the document.
|
94
|
+
//
|
95
|
+
// Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
|
96
|
+
// standard with a length limit of 63 characters.
|
97
|
+
string id = 2 [(google.api.field_behavior) = IMMUTABLE];
|
98
|
+
|
99
|
+
// The identifier of the schema located in the same data store.
|
100
|
+
string schema_id = 3;
|
101
|
+
|
102
|
+
// The unstructured data linked to this document. Content must be set if this
|
103
|
+
// document is under a
|
104
|
+
// `CONTENT_REQUIRED` data store.
|
105
|
+
Content content = 10;
|
106
|
+
|
107
|
+
// The identifier of the parent document. Currently supports at most two level
|
108
|
+
// document hierarchy.
|
109
|
+
//
|
110
|
+
// Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
|
111
|
+
// standard with a length limit of 63 characters.
|
112
|
+
string parent_document_id = 7;
|
113
|
+
|
114
|
+
// Output only. This field is OUTPUT_ONLY.
|
115
|
+
// It contains derived data that are not in the original input document.
|
116
|
+
google.protobuf.Struct derived_struct_data = 6
|
117
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
118
|
+
}
|