@google-cloud/discoveryengine 0.8.0 → 1.0.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 +17 -0
- package/README.md +6 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +1 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +13 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/conversation.proto +131 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +281 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +2 -4
- package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +2 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +17 -17
- package/build/protos/google/cloud/discoveryengine/v1beta/schema.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +163 -63
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +41 -36
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event_service.proto +2 -2
- package/build/protos/protos.d.ts +6587 -4645
- package/build/protos/protos.js +16668 -12007
- package/build/protos/protos.json +1799 -1285
- package/build/src/v1/completion_service_client.d.ts +6 -7
- package/build/src/v1/document_service_client.d.ts +83 -94
- package/build/src/v1/document_service_client.js +18 -22
- package/build/src/v1/schema_service_client.d.ts +39 -49
- package/build/src/v1/schema_service_client.js +17 -22
- package/build/src/v1/search_service_client.d.ts +31 -34
- package/build/src/v1/search_service_client.js +21 -23
- package/build/src/v1/user_event_service_client.d.ts +6 -10
- package/build/src/v1/user_event_service_client.js +1 -2
- package/build/src/v1beta/completion_service_client.d.ts +104 -8
- package/build/src/v1beta/completion_service_client.js +128 -0
- package/build/src/v1beta/conversational_search_service_client.d.ts +876 -0
- package/build/src/v1beta/conversational_search_service_client.js +1149 -0
- package/build/src/v1beta/conversational_search_service_client_config.json +68 -0
- package/build/src/v1beta/document_service_client.d.ts +182 -97
- package/build/src/v1beta/document_service_client.js +166 -22
- package/build/src/v1beta/index.d.ts +1 -0
- package/build/src/v1beta/index.js +3 -1
- package/build/src/v1beta/recommendation_service_client.d.ts +103 -11
- package/build/src/v1beta/recommendation_service_client.js +128 -0
- package/build/src/v1beta/schema_service_client.d.ts +132 -49
- package/build/src/v1beta/schema_service_client.js +163 -22
- package/build/src/v1beta/search_service_client.d.ts +163 -67
- package/build/src/v1beta/search_service_client.js +175 -45
- package/build/src/v1beta/user_event_service_client.d.ts +101 -12
- package/build/src/v1beta/user_event_service_client.js +147 -2
- package/package.json +8 -11
@@ -0,0 +1,876 @@
|
|
1
|
+
/// <reference types="node" />
|
2
|
+
import type * as gax from 'google-gax';
|
3
|
+
import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax';
|
4
|
+
import { Transform } from 'stream';
|
5
|
+
import * as protos from '../../protos/protos';
|
6
|
+
/**
|
7
|
+
* Service for conversational search.
|
8
|
+
* @class
|
9
|
+
* @memberof v1beta
|
10
|
+
*/
|
11
|
+
export declare class ConversationalSearchServiceClient {
|
12
|
+
private _terminated;
|
13
|
+
private _opts;
|
14
|
+
private _providedCustomServicePath;
|
15
|
+
private _gaxModule;
|
16
|
+
private _gaxGrpc;
|
17
|
+
private _protos;
|
18
|
+
private _defaults;
|
19
|
+
auth: gax.GoogleAuth;
|
20
|
+
descriptors: Descriptors;
|
21
|
+
warn: (code: string, message: string, warnType?: string) => void;
|
22
|
+
innerApiCalls: {
|
23
|
+
[name: string]: Function;
|
24
|
+
};
|
25
|
+
pathTemplates: {
|
26
|
+
[name: string]: gax.PathTemplate;
|
27
|
+
};
|
28
|
+
conversationalSearchServiceStub?: Promise<{
|
29
|
+
[name: string]: Function;
|
30
|
+
}>;
|
31
|
+
/**
|
32
|
+
* Construct an instance of ConversationalSearchServiceClient.
|
33
|
+
*
|
34
|
+
* @param {object} [options] - The configuration object.
|
35
|
+
* The options accepted by the constructor are described in detail
|
36
|
+
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
|
37
|
+
* The common options are:
|
38
|
+
* @param {object} [options.credentials] - Credentials object.
|
39
|
+
* @param {string} [options.credentials.client_email]
|
40
|
+
* @param {string} [options.credentials.private_key]
|
41
|
+
* @param {string} [options.email] - Account email address. Required when
|
42
|
+
* using a .pem or .p12 keyFilename.
|
43
|
+
* @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
|
44
|
+
* .p12 key downloaded from the Google Developers Console. If you provide
|
45
|
+
* a path to a JSON file, the projectId option below is not necessary.
|
46
|
+
* NOTE: .pem and .p12 require you to specify options.email as well.
|
47
|
+
* @param {number} [options.port] - The port on which to connect to
|
48
|
+
* the remote host.
|
49
|
+
* @param {string} [options.projectId] - The project ID from the Google
|
50
|
+
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
|
51
|
+
* the environment variable GCLOUD_PROJECT for your project ID. If your
|
52
|
+
* app is running in an environment which supports
|
53
|
+
* {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
|
54
|
+
* your project ID will be detected automatically.
|
55
|
+
* @param {string} [options.apiEndpoint] - The domain name of the
|
56
|
+
* API remote host.
|
57
|
+
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
|
58
|
+
* Follows the structure of {@link gapicConfig}.
|
59
|
+
* @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
|
60
|
+
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
|
61
|
+
* For more information, please check the
|
62
|
+
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
|
63
|
+
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
|
64
|
+
* need to avoid loading the default gRPC version and want to use the fallback
|
65
|
+
* HTTP implementation. Load only fallback version and pass it to the constructor:
|
66
|
+
* ```
|
67
|
+
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
|
68
|
+
* const client = new ConversationalSearchServiceClient({fallback: 'rest'}, gax);
|
69
|
+
* ```
|
70
|
+
*/
|
71
|
+
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
|
72
|
+
/**
|
73
|
+
* Initialize the client.
|
74
|
+
* Performs asynchronous operations (such as authentication) and prepares the client.
|
75
|
+
* This function will be called automatically when any class method is called for the
|
76
|
+
* first time, but if you need to initialize it before calling an actual method,
|
77
|
+
* feel free to call initialize() directly.
|
78
|
+
*
|
79
|
+
* You can await on this method if you want to make sure the client is initialized.
|
80
|
+
*
|
81
|
+
* @returns {Promise} A promise that resolves to an authenticated service stub.
|
82
|
+
*/
|
83
|
+
initialize(): Promise<{
|
84
|
+
[name: string]: Function;
|
85
|
+
}>;
|
86
|
+
/**
|
87
|
+
* The DNS address for this API service.
|
88
|
+
* @returns {string} The DNS address for this service.
|
89
|
+
*/
|
90
|
+
static get servicePath(): string;
|
91
|
+
/**
|
92
|
+
* The DNS address for this API service - same as servicePath(),
|
93
|
+
* exists for compatibility reasons.
|
94
|
+
* @returns {string} The DNS address for this service.
|
95
|
+
*/
|
96
|
+
static get apiEndpoint(): string;
|
97
|
+
/**
|
98
|
+
* The port for this API service.
|
99
|
+
* @returns {number} The default port for this service.
|
100
|
+
*/
|
101
|
+
static get port(): number;
|
102
|
+
/**
|
103
|
+
* The scopes needed to make gRPC calls for every method defined
|
104
|
+
* in this service.
|
105
|
+
* @returns {string[]} List of default scopes.
|
106
|
+
*/
|
107
|
+
static get scopes(): string[];
|
108
|
+
getProjectId(): Promise<string>;
|
109
|
+
getProjectId(callback: Callback<string, undefined, undefined>): void;
|
110
|
+
/**
|
111
|
+
* Converses a conversation.
|
112
|
+
*
|
113
|
+
* @param {Object} request
|
114
|
+
* The request object that will be sent.
|
115
|
+
* @param {string} request.name
|
116
|
+
* Required. The resource name of the Conversation to get. Format:
|
117
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
|
118
|
+
* Use
|
119
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
|
120
|
+
* to activate auto session mode, which automatically creates a new
|
121
|
+
* conversation inside a ConverseConversation session.
|
122
|
+
* @param {google.cloud.discoveryengine.v1beta.TextInput} request.query
|
123
|
+
* Required. Current user input.
|
124
|
+
* @param {string} request.servingConfig
|
125
|
+
* The resource name of the Serving Config to use. Format:
|
126
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
|
127
|
+
* If this is not set, the default serving config will be used.
|
128
|
+
* @param {google.cloud.discoveryengine.v1beta.Conversation} request.conversation
|
129
|
+
* The conversation to be used by auto session only. The name field will be
|
130
|
+
* ignored as we automatically assign new name for the conversation in auto
|
131
|
+
* session.
|
132
|
+
* @param {boolean} request.safeSearch
|
133
|
+
* Whether to turn on safe search.
|
134
|
+
* @param {object} [options]
|
135
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
136
|
+
* @returns {Promise} - The promise which resolves to an array.
|
137
|
+
* The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1beta.ConverseConversationResponse|ConverseConversationResponse}.
|
138
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
139
|
+
* for more details and examples.
|
140
|
+
* @example <caption>include:samples/generated/v1beta/conversational_search_service.converse_conversation.js</caption>
|
141
|
+
* region_tag:discoveryengine_v1beta_generated_ConversationalSearchService_ConverseConversation_async
|
142
|
+
*/
|
143
|
+
converseConversation(request?: protos.google.cloud.discoveryengine.v1beta.IConverseConversationRequest, options?: CallOptions): Promise<[
|
144
|
+
protos.google.cloud.discoveryengine.v1beta.IConverseConversationResponse,
|
145
|
+
(protos.google.cloud.discoveryengine.v1beta.IConverseConversationRequest | undefined),
|
146
|
+
{} | undefined
|
147
|
+
]>;
|
148
|
+
converseConversation(request: protos.google.cloud.discoveryengine.v1beta.IConverseConversationRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IConverseConversationResponse, protos.google.cloud.discoveryengine.v1beta.IConverseConversationRequest | null | undefined, {} | null | undefined>): void;
|
149
|
+
converseConversation(request: protos.google.cloud.discoveryengine.v1beta.IConverseConversationRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IConverseConversationResponse, protos.google.cloud.discoveryengine.v1beta.IConverseConversationRequest | null | undefined, {} | null | undefined>): void;
|
150
|
+
/**
|
151
|
+
* Creates a Conversation.
|
152
|
+
*
|
153
|
+
* If the {@link protos.google.cloud.discoveryengine.v1beta.Conversation|Conversation} to
|
154
|
+
* create already exists, an ALREADY_EXISTS error is returned.
|
155
|
+
*
|
156
|
+
* @param {Object} request
|
157
|
+
* The request object that will be sent.
|
158
|
+
* @param {string} request.parent
|
159
|
+
* Required. Full resource name of parent data store. Format:
|
160
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
|
161
|
+
* @param {google.cloud.discoveryengine.v1beta.Conversation} request.conversation
|
162
|
+
* Required. The conversation to create.
|
163
|
+
* @param {object} [options]
|
164
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
165
|
+
* @returns {Promise} - The promise which resolves to an array.
|
166
|
+
* The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1beta.Conversation|Conversation}.
|
167
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
168
|
+
* for more details and examples.
|
169
|
+
* @example <caption>include:samples/generated/v1beta/conversational_search_service.create_conversation.js</caption>
|
170
|
+
* region_tag:discoveryengine_v1beta_generated_ConversationalSearchService_CreateConversation_async
|
171
|
+
*/
|
172
|
+
createConversation(request?: protos.google.cloud.discoveryengine.v1beta.ICreateConversationRequest, options?: CallOptions): Promise<[
|
173
|
+
protos.google.cloud.discoveryengine.v1beta.IConversation,
|
174
|
+
(protos.google.cloud.discoveryengine.v1beta.ICreateConversationRequest | undefined),
|
175
|
+
{} | undefined
|
176
|
+
]>;
|
177
|
+
createConversation(request: protos.google.cloud.discoveryengine.v1beta.ICreateConversationRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IConversation, protos.google.cloud.discoveryengine.v1beta.ICreateConversationRequest | null | undefined, {} | null | undefined>): void;
|
178
|
+
createConversation(request: protos.google.cloud.discoveryengine.v1beta.ICreateConversationRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IConversation, protos.google.cloud.discoveryengine.v1beta.ICreateConversationRequest | null | undefined, {} | null | undefined>): void;
|
179
|
+
/**
|
180
|
+
* Deletes a Conversation.
|
181
|
+
*
|
182
|
+
* If the {@link protos.google.cloud.discoveryengine.v1beta.Conversation|Conversation} to
|
183
|
+
* delete does not exist, a NOT_FOUND error is returned.
|
184
|
+
*
|
185
|
+
* @param {Object} request
|
186
|
+
* The request object that will be sent.
|
187
|
+
* @param {string} request.name
|
188
|
+
* Required. The resource name of the Conversation to delete. Format:
|
189
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
|
190
|
+
* @param {object} [options]
|
191
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
192
|
+
* @returns {Promise} - The promise which resolves to an array.
|
193
|
+
* The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
|
194
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
195
|
+
* for more details and examples.
|
196
|
+
* @example <caption>include:samples/generated/v1beta/conversational_search_service.delete_conversation.js</caption>
|
197
|
+
* region_tag:discoveryengine_v1beta_generated_ConversationalSearchService_DeleteConversation_async
|
198
|
+
*/
|
199
|
+
deleteConversation(request?: protos.google.cloud.discoveryengine.v1beta.IDeleteConversationRequest, options?: CallOptions): Promise<[
|
200
|
+
protos.google.protobuf.IEmpty,
|
201
|
+
(protos.google.cloud.discoveryengine.v1beta.IDeleteConversationRequest | undefined),
|
202
|
+
{} | undefined
|
203
|
+
]>;
|
204
|
+
deleteConversation(request: protos.google.cloud.discoveryengine.v1beta.IDeleteConversationRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1beta.IDeleteConversationRequest | null | undefined, {} | null | undefined>): void;
|
205
|
+
deleteConversation(request: protos.google.cloud.discoveryengine.v1beta.IDeleteConversationRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1beta.IDeleteConversationRequest | null | undefined, {} | null | undefined>): void;
|
206
|
+
/**
|
207
|
+
* Updates a Conversation.
|
208
|
+
*
|
209
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.Conversation|Conversation} action
|
210
|
+
* type cannot be changed. If the
|
211
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.Conversation|Conversation} to update
|
212
|
+
* does not exist, a NOT_FOUND error is returned.
|
213
|
+
*
|
214
|
+
* @param {Object} request
|
215
|
+
* The request object that will be sent.
|
216
|
+
* @param {google.cloud.discoveryengine.v1beta.Conversation} request.conversation
|
217
|
+
* Required. The Conversation to update.
|
218
|
+
* @param {google.protobuf.FieldMask} request.updateMask
|
219
|
+
* Indicates which fields in the provided
|
220
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.Conversation|Conversation} to update.
|
221
|
+
* The following are NOT supported:
|
222
|
+
*
|
223
|
+
* * {@link protos.|conversation.name}
|
224
|
+
*
|
225
|
+
* If not set or empty, all supported fields are updated.
|
226
|
+
* @param {object} [options]
|
227
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
228
|
+
* @returns {Promise} - The promise which resolves to an array.
|
229
|
+
* The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1beta.Conversation|Conversation}.
|
230
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
231
|
+
* for more details and examples.
|
232
|
+
* @example <caption>include:samples/generated/v1beta/conversational_search_service.update_conversation.js</caption>
|
233
|
+
* region_tag:discoveryengine_v1beta_generated_ConversationalSearchService_UpdateConversation_async
|
234
|
+
*/
|
235
|
+
updateConversation(request?: protos.google.cloud.discoveryengine.v1beta.IUpdateConversationRequest, options?: CallOptions): Promise<[
|
236
|
+
protos.google.cloud.discoveryengine.v1beta.IConversation,
|
237
|
+
(protos.google.cloud.discoveryengine.v1beta.IUpdateConversationRequest | undefined),
|
238
|
+
{} | undefined
|
239
|
+
]>;
|
240
|
+
updateConversation(request: protos.google.cloud.discoveryengine.v1beta.IUpdateConversationRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IConversation, protos.google.cloud.discoveryengine.v1beta.IUpdateConversationRequest | null | undefined, {} | null | undefined>): void;
|
241
|
+
updateConversation(request: protos.google.cloud.discoveryengine.v1beta.IUpdateConversationRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IConversation, protos.google.cloud.discoveryengine.v1beta.IUpdateConversationRequest | null | undefined, {} | null | undefined>): void;
|
242
|
+
/**
|
243
|
+
* Gets a Conversation.
|
244
|
+
*
|
245
|
+
* @param {Object} request
|
246
|
+
* The request object that will be sent.
|
247
|
+
* @param {string} request.name
|
248
|
+
* Required. The resource name of the Conversation to get. Format:
|
249
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
|
250
|
+
* @param {object} [options]
|
251
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
252
|
+
* @returns {Promise} - The promise which resolves to an array.
|
253
|
+
* The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1beta.Conversation|Conversation}.
|
254
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
255
|
+
* for more details and examples.
|
256
|
+
* @example <caption>include:samples/generated/v1beta/conversational_search_service.get_conversation.js</caption>
|
257
|
+
* region_tag:discoveryengine_v1beta_generated_ConversationalSearchService_GetConversation_async
|
258
|
+
*/
|
259
|
+
getConversation(request?: protos.google.cloud.discoveryengine.v1beta.IGetConversationRequest, options?: CallOptions): Promise<[
|
260
|
+
protos.google.cloud.discoveryengine.v1beta.IConversation,
|
261
|
+
(protos.google.cloud.discoveryengine.v1beta.IGetConversationRequest | undefined),
|
262
|
+
{} | undefined
|
263
|
+
]>;
|
264
|
+
getConversation(request: protos.google.cloud.discoveryengine.v1beta.IGetConversationRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IConversation, protos.google.cloud.discoveryengine.v1beta.IGetConversationRequest | null | undefined, {} | null | undefined>): void;
|
265
|
+
getConversation(request: protos.google.cloud.discoveryengine.v1beta.IGetConversationRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IConversation, protos.google.cloud.discoveryengine.v1beta.IGetConversationRequest | null | undefined, {} | null | undefined>): void;
|
266
|
+
/**
|
267
|
+
* Lists all Conversations by their parent
|
268
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}.
|
269
|
+
*
|
270
|
+
* @param {Object} request
|
271
|
+
* The request object that will be sent.
|
272
|
+
* @param {string} request.parent
|
273
|
+
* Required. The data store resource name. Format:
|
274
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
|
275
|
+
* @param {number} request.pageSize
|
276
|
+
* Maximum number of results to return. If unspecified, defaults
|
277
|
+
* to 50. Max allowed value is 1000.
|
278
|
+
* @param {string} request.pageToken
|
279
|
+
* A page token, received from a previous `ListConversations` call.
|
280
|
+
* Provide this to retrieve the subsequent page.
|
281
|
+
* @param {string} request.filter
|
282
|
+
* A filter to apply on the list results. The supported features are:
|
283
|
+
* user_pseudo_id, state.
|
284
|
+
*
|
285
|
+
* Example:
|
286
|
+
* "user_pseudo_id = some_id"
|
287
|
+
* @param {string} request.orderBy
|
288
|
+
* A comma-separated list of fields to order by, sorted in ascending order.
|
289
|
+
* Use "desc" after a field name for descending.
|
290
|
+
* Supported fields:
|
291
|
+
* * `update_time`
|
292
|
+
* * `create_time`
|
293
|
+
* * `conversation_name`
|
294
|
+
*
|
295
|
+
* Example:
|
296
|
+
* "update_time desc"
|
297
|
+
* "create_time"
|
298
|
+
* @param {object} [options]
|
299
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
300
|
+
* @returns {Promise} - The promise which resolves to an array.
|
301
|
+
* The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1beta.Conversation|Conversation}.
|
302
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
303
|
+
* times as needed and will merge results from all the pages into this array.
|
304
|
+
* Note that it can affect your quota.
|
305
|
+
* We recommend using `listConversationsAsync()`
|
306
|
+
* method described below for async iteration which you can stop as needed.
|
307
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
308
|
+
* for more details and examples.
|
309
|
+
*/
|
310
|
+
listConversations(request?: protos.google.cloud.discoveryengine.v1beta.IListConversationsRequest, options?: CallOptions): Promise<[
|
311
|
+
protos.google.cloud.discoveryengine.v1beta.IConversation[],
|
312
|
+
protos.google.cloud.discoveryengine.v1beta.IListConversationsRequest | null,
|
313
|
+
protos.google.cloud.discoveryengine.v1beta.IListConversationsResponse
|
314
|
+
]>;
|
315
|
+
listConversations(request: protos.google.cloud.discoveryengine.v1beta.IListConversationsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1beta.IListConversationsRequest, protos.google.cloud.discoveryengine.v1beta.IListConversationsResponse | null | undefined, protos.google.cloud.discoveryengine.v1beta.IConversation>): void;
|
316
|
+
listConversations(request: protos.google.cloud.discoveryengine.v1beta.IListConversationsRequest, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1beta.IListConversationsRequest, protos.google.cloud.discoveryengine.v1beta.IListConversationsResponse | null | undefined, protos.google.cloud.discoveryengine.v1beta.IConversation>): void;
|
317
|
+
/**
|
318
|
+
* Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
|
319
|
+
* @param {Object} request
|
320
|
+
* The request object that will be sent.
|
321
|
+
* @param {string} request.parent
|
322
|
+
* Required. The data store resource name. Format:
|
323
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
|
324
|
+
* @param {number} request.pageSize
|
325
|
+
* Maximum number of results to return. If unspecified, defaults
|
326
|
+
* to 50. Max allowed value is 1000.
|
327
|
+
* @param {string} request.pageToken
|
328
|
+
* A page token, received from a previous `ListConversations` call.
|
329
|
+
* Provide this to retrieve the subsequent page.
|
330
|
+
* @param {string} request.filter
|
331
|
+
* A filter to apply on the list results. The supported features are:
|
332
|
+
* user_pseudo_id, state.
|
333
|
+
*
|
334
|
+
* Example:
|
335
|
+
* "user_pseudo_id = some_id"
|
336
|
+
* @param {string} request.orderBy
|
337
|
+
* A comma-separated list of fields to order by, sorted in ascending order.
|
338
|
+
* Use "desc" after a field name for descending.
|
339
|
+
* Supported fields:
|
340
|
+
* * `update_time`
|
341
|
+
* * `create_time`
|
342
|
+
* * `conversation_name`
|
343
|
+
*
|
344
|
+
* Example:
|
345
|
+
* "update_time desc"
|
346
|
+
* "create_time"
|
347
|
+
* @param {object} [options]
|
348
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
349
|
+
* @returns {Stream}
|
350
|
+
* An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1beta.Conversation|Conversation} on 'data' event.
|
351
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
352
|
+
* times as needed. Note that it can affect your quota.
|
353
|
+
* We recommend using `listConversationsAsync()`
|
354
|
+
* method described below for async iteration which you can stop as needed.
|
355
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
356
|
+
* for more details and examples.
|
357
|
+
*/
|
358
|
+
listConversationsStream(request?: protos.google.cloud.discoveryengine.v1beta.IListConversationsRequest, options?: CallOptions): Transform;
|
359
|
+
/**
|
360
|
+
* Equivalent to `listConversations`, but returns an iterable object.
|
361
|
+
*
|
362
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
363
|
+
* @param {Object} request
|
364
|
+
* The request object that will be sent.
|
365
|
+
* @param {string} request.parent
|
366
|
+
* Required. The data store resource name. Format:
|
367
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
|
368
|
+
* @param {number} request.pageSize
|
369
|
+
* Maximum number of results to return. If unspecified, defaults
|
370
|
+
* to 50. Max allowed value is 1000.
|
371
|
+
* @param {string} request.pageToken
|
372
|
+
* A page token, received from a previous `ListConversations` call.
|
373
|
+
* Provide this to retrieve the subsequent page.
|
374
|
+
* @param {string} request.filter
|
375
|
+
* A filter to apply on the list results. The supported features are:
|
376
|
+
* user_pseudo_id, state.
|
377
|
+
*
|
378
|
+
* Example:
|
379
|
+
* "user_pseudo_id = some_id"
|
380
|
+
* @param {string} request.orderBy
|
381
|
+
* A comma-separated list of fields to order by, sorted in ascending order.
|
382
|
+
* Use "desc" after a field name for descending.
|
383
|
+
* Supported fields:
|
384
|
+
* * `update_time`
|
385
|
+
* * `create_time`
|
386
|
+
* * `conversation_name`
|
387
|
+
*
|
388
|
+
* Example:
|
389
|
+
* "update_time desc"
|
390
|
+
* "create_time"
|
391
|
+
* @param {object} [options]
|
392
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
393
|
+
* @returns {Object}
|
394
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
395
|
+
* When you iterate the returned iterable, each element will be an object representing
|
396
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.Conversation|Conversation}. The API will be called under the hood as needed, once per the page,
|
397
|
+
* so you can stop the iteration when you don't need more results.
|
398
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
399
|
+
* for more details and examples.
|
400
|
+
* @example <caption>include:samples/generated/v1beta/conversational_search_service.list_conversations.js</caption>
|
401
|
+
* region_tag:discoveryengine_v1beta_generated_ConversationalSearchService_ListConversations_async
|
402
|
+
*/
|
403
|
+
listConversationsAsync(request?: protos.google.cloud.discoveryengine.v1beta.IListConversationsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1beta.IConversation>;
|
404
|
+
/**
|
405
|
+
* Return a fully-qualified projectLocationCollectionDataStore resource name string.
|
406
|
+
*
|
407
|
+
* @param {string} project
|
408
|
+
* @param {string} location
|
409
|
+
* @param {string} collection
|
410
|
+
* @param {string} data_store
|
411
|
+
* @returns {string} Resource name string.
|
412
|
+
*/
|
413
|
+
projectLocationCollectionDataStorePath(project: string, location: string, collection: string, dataStore: string): string;
|
414
|
+
/**
|
415
|
+
* Parse the project from ProjectLocationCollectionDataStore resource.
|
416
|
+
*
|
417
|
+
* @param {string} projectLocationCollectionDataStoreName
|
418
|
+
* A fully-qualified path representing project_location_collection_data_store resource.
|
419
|
+
* @returns {string} A string representing the project.
|
420
|
+
*/
|
421
|
+
matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
|
422
|
+
/**
|
423
|
+
* Parse the location from ProjectLocationCollectionDataStore resource.
|
424
|
+
*
|
425
|
+
* @param {string} projectLocationCollectionDataStoreName
|
426
|
+
* A fully-qualified path representing project_location_collection_data_store resource.
|
427
|
+
* @returns {string} A string representing the location.
|
428
|
+
*/
|
429
|
+
matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
|
430
|
+
/**
|
431
|
+
* Parse the collection from ProjectLocationCollectionDataStore resource.
|
432
|
+
*
|
433
|
+
* @param {string} projectLocationCollectionDataStoreName
|
434
|
+
* A fully-qualified path representing project_location_collection_data_store resource.
|
435
|
+
* @returns {string} A string representing the collection.
|
436
|
+
*/
|
437
|
+
matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
|
438
|
+
/**
|
439
|
+
* Parse the data_store from ProjectLocationCollectionDataStore resource.
|
440
|
+
*
|
441
|
+
* @param {string} projectLocationCollectionDataStoreName
|
442
|
+
* A fully-qualified path representing project_location_collection_data_store resource.
|
443
|
+
* @returns {string} A string representing the data_store.
|
444
|
+
*/
|
445
|
+
matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
|
446
|
+
/**
|
447
|
+
* Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
|
448
|
+
*
|
449
|
+
* @param {string} project
|
450
|
+
* @param {string} location
|
451
|
+
* @param {string} collection
|
452
|
+
* @param {string} data_store
|
453
|
+
* @param {string} branch
|
454
|
+
* @param {string} document
|
455
|
+
* @returns {string} Resource name string.
|
456
|
+
*/
|
457
|
+
projectLocationCollectionDataStoreBranchDocumentPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string): string;
|
458
|
+
/**
|
459
|
+
* Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.
|
460
|
+
*
|
461
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
462
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
463
|
+
* @returns {string} A string representing the project.
|
464
|
+
*/
|
465
|
+
matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
466
|
+
/**
|
467
|
+
* Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.
|
468
|
+
*
|
469
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
470
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
471
|
+
* @returns {string} A string representing the location.
|
472
|
+
*/
|
473
|
+
matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
474
|
+
/**
|
475
|
+
* Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.
|
476
|
+
*
|
477
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
478
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
479
|
+
* @returns {string} A string representing the collection.
|
480
|
+
*/
|
481
|
+
matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
482
|
+
/**
|
483
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.
|
484
|
+
*
|
485
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
486
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
487
|
+
* @returns {string} A string representing the data_store.
|
488
|
+
*/
|
489
|
+
matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
490
|
+
/**
|
491
|
+
* Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.
|
492
|
+
*
|
493
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
494
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
495
|
+
* @returns {string} A string representing the branch.
|
496
|
+
*/
|
497
|
+
matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
498
|
+
/**
|
499
|
+
* Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.
|
500
|
+
*
|
501
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
502
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
503
|
+
* @returns {string} A string representing the document.
|
504
|
+
*/
|
505
|
+
matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
506
|
+
/**
|
507
|
+
* Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
|
508
|
+
*
|
509
|
+
* @param {string} project
|
510
|
+
* @param {string} location
|
511
|
+
* @param {string} collection
|
512
|
+
* @param {string} data_store
|
513
|
+
* @param {string} conversation
|
514
|
+
* @returns {string} Resource name string.
|
515
|
+
*/
|
516
|
+
projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
|
517
|
+
/**
|
518
|
+
* Parse the project from ProjectLocationCollectionDataStoreConversation resource.
|
519
|
+
*
|
520
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
521
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
522
|
+
* @returns {string} A string representing the project.
|
523
|
+
*/
|
524
|
+
matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
525
|
+
/**
|
526
|
+
* Parse the location from ProjectLocationCollectionDataStoreConversation resource.
|
527
|
+
*
|
528
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
529
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
530
|
+
* @returns {string} A string representing the location.
|
531
|
+
*/
|
532
|
+
matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
533
|
+
/**
|
534
|
+
* Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
|
535
|
+
*
|
536
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
537
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
538
|
+
* @returns {string} A string representing the collection.
|
539
|
+
*/
|
540
|
+
matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
541
|
+
/**
|
542
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
|
543
|
+
*
|
544
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
545
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
546
|
+
* @returns {string} A string representing the data_store.
|
547
|
+
*/
|
548
|
+
matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
549
|
+
/**
|
550
|
+
* Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
|
551
|
+
*
|
552
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
553
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
554
|
+
* @returns {string} A string representing the conversation.
|
555
|
+
*/
|
556
|
+
matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
557
|
+
/**
|
558
|
+
* Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
|
559
|
+
*
|
560
|
+
* @param {string} project
|
561
|
+
* @param {string} location
|
562
|
+
* @param {string} collection
|
563
|
+
* @param {string} data_store
|
564
|
+
* @param {string} schema
|
565
|
+
* @returns {string} Resource name string.
|
566
|
+
*/
|
567
|
+
projectLocationCollectionDataStoreSchemaPath(project: string, location: string, collection: string, dataStore: string, schema: string): string;
|
568
|
+
/**
|
569
|
+
* Parse the project from ProjectLocationCollectionDataStoreSchema resource.
|
570
|
+
*
|
571
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
572
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
573
|
+
* @returns {string} A string representing the project.
|
574
|
+
*/
|
575
|
+
matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
576
|
+
/**
|
577
|
+
* Parse the location from ProjectLocationCollectionDataStoreSchema resource.
|
578
|
+
*
|
579
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
580
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
581
|
+
* @returns {string} A string representing the location.
|
582
|
+
*/
|
583
|
+
matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
584
|
+
/**
|
585
|
+
* Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
|
586
|
+
*
|
587
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
588
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
589
|
+
* @returns {string} A string representing the collection.
|
590
|
+
*/
|
591
|
+
matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
592
|
+
/**
|
593
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
|
594
|
+
*
|
595
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
596
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
597
|
+
* @returns {string} A string representing the data_store.
|
598
|
+
*/
|
599
|
+
matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
600
|
+
/**
|
601
|
+
* Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
|
602
|
+
*
|
603
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
604
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
605
|
+
* @returns {string} A string representing the schema.
|
606
|
+
*/
|
607
|
+
matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
608
|
+
/**
|
609
|
+
* Return a fully-qualified projectLocationCollectionDataStoreServingConfig resource name string.
|
610
|
+
*
|
611
|
+
* @param {string} project
|
612
|
+
* @param {string} location
|
613
|
+
* @param {string} collection
|
614
|
+
* @param {string} data_store
|
615
|
+
* @param {string} serving_config
|
616
|
+
* @returns {string} Resource name string.
|
617
|
+
*/
|
618
|
+
projectLocationCollectionDataStoreServingConfigPath(project: string, location: string, collection: string, dataStore: string, servingConfig: string): string;
|
619
|
+
/**
|
620
|
+
* Parse the project from ProjectLocationCollectionDataStoreServingConfig resource.
|
621
|
+
*
|
622
|
+
* @param {string} projectLocationCollectionDataStoreServingConfigName
|
623
|
+
* A fully-qualified path representing project_location_collection_data_store_serving_config resource.
|
624
|
+
* @returns {string} A string representing the project.
|
625
|
+
*/
|
626
|
+
matchProjectFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
|
627
|
+
/**
|
628
|
+
* Parse the location from ProjectLocationCollectionDataStoreServingConfig resource.
|
629
|
+
*
|
630
|
+
* @param {string} projectLocationCollectionDataStoreServingConfigName
|
631
|
+
* A fully-qualified path representing project_location_collection_data_store_serving_config resource.
|
632
|
+
* @returns {string} A string representing the location.
|
633
|
+
*/
|
634
|
+
matchLocationFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
|
635
|
+
/**
|
636
|
+
* Parse the collection from ProjectLocationCollectionDataStoreServingConfig resource.
|
637
|
+
*
|
638
|
+
* @param {string} projectLocationCollectionDataStoreServingConfigName
|
639
|
+
* A fully-qualified path representing project_location_collection_data_store_serving_config resource.
|
640
|
+
* @returns {string} A string representing the collection.
|
641
|
+
*/
|
642
|
+
matchCollectionFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
|
643
|
+
/**
|
644
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreServingConfig resource.
|
645
|
+
*
|
646
|
+
* @param {string} projectLocationCollectionDataStoreServingConfigName
|
647
|
+
* A fully-qualified path representing project_location_collection_data_store_serving_config resource.
|
648
|
+
* @returns {string} A string representing the data_store.
|
649
|
+
*/
|
650
|
+
matchDataStoreFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
|
651
|
+
/**
|
652
|
+
* Parse the serving_config from ProjectLocationCollectionDataStoreServingConfig resource.
|
653
|
+
*
|
654
|
+
* @param {string} projectLocationCollectionDataStoreServingConfigName
|
655
|
+
* A fully-qualified path representing project_location_collection_data_store_serving_config resource.
|
656
|
+
* @returns {string} A string representing the serving_config.
|
657
|
+
*/
|
658
|
+
matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
|
659
|
+
/**
|
660
|
+
* Return a fully-qualified projectLocationDataStore resource name string.
|
661
|
+
*
|
662
|
+
* @param {string} project
|
663
|
+
* @param {string} location
|
664
|
+
* @param {string} data_store
|
665
|
+
* @returns {string} Resource name string.
|
666
|
+
*/
|
667
|
+
projectLocationDataStorePath(project: string, location: string, dataStore: string): string;
|
668
|
+
/**
|
669
|
+
* Parse the project from ProjectLocationDataStore resource.
|
670
|
+
*
|
671
|
+
* @param {string} projectLocationDataStoreName
|
672
|
+
* A fully-qualified path representing project_location_data_store resource.
|
673
|
+
* @returns {string} A string representing the project.
|
674
|
+
*/
|
675
|
+
matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
|
676
|
+
/**
|
677
|
+
* Parse the location from ProjectLocationDataStore resource.
|
678
|
+
*
|
679
|
+
* @param {string} projectLocationDataStoreName
|
680
|
+
* A fully-qualified path representing project_location_data_store resource.
|
681
|
+
* @returns {string} A string representing the location.
|
682
|
+
*/
|
683
|
+
matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
|
684
|
+
/**
|
685
|
+
* Parse the data_store from ProjectLocationDataStore resource.
|
686
|
+
*
|
687
|
+
* @param {string} projectLocationDataStoreName
|
688
|
+
* A fully-qualified path representing project_location_data_store resource.
|
689
|
+
* @returns {string} A string representing the data_store.
|
690
|
+
*/
|
691
|
+
matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
|
692
|
+
/**
|
693
|
+
* Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
|
694
|
+
*
|
695
|
+
* @param {string} project
|
696
|
+
* @param {string} location
|
697
|
+
* @param {string} data_store
|
698
|
+
* @param {string} branch
|
699
|
+
* @param {string} document
|
700
|
+
* @returns {string} Resource name string.
|
701
|
+
*/
|
702
|
+
projectLocationDataStoreBranchDocumentPath(project: string, location: string, dataStore: string, branch: string, document: string): string;
|
703
|
+
/**
|
704
|
+
* Parse the project from ProjectLocationDataStoreBranchDocument resource.
|
705
|
+
*
|
706
|
+
* @param {string} projectLocationDataStoreBranchDocumentName
|
707
|
+
* A fully-qualified path representing project_location_data_store_branch_document resource.
|
708
|
+
* @returns {string} A string representing the project.
|
709
|
+
*/
|
710
|
+
matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
711
|
+
/**
|
712
|
+
* Parse the location from ProjectLocationDataStoreBranchDocument resource.
|
713
|
+
*
|
714
|
+
* @param {string} projectLocationDataStoreBranchDocumentName
|
715
|
+
* A fully-qualified path representing project_location_data_store_branch_document resource.
|
716
|
+
* @returns {string} A string representing the location.
|
717
|
+
*/
|
718
|
+
matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
719
|
+
/**
|
720
|
+
* Parse the data_store from ProjectLocationDataStoreBranchDocument resource.
|
721
|
+
*
|
722
|
+
* @param {string} projectLocationDataStoreBranchDocumentName
|
723
|
+
* A fully-qualified path representing project_location_data_store_branch_document resource.
|
724
|
+
* @returns {string} A string representing the data_store.
|
725
|
+
*/
|
726
|
+
matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
727
|
+
/**
|
728
|
+
* Parse the branch from ProjectLocationDataStoreBranchDocument resource.
|
729
|
+
*
|
730
|
+
* @param {string} projectLocationDataStoreBranchDocumentName
|
731
|
+
* A fully-qualified path representing project_location_data_store_branch_document resource.
|
732
|
+
* @returns {string} A string representing the branch.
|
733
|
+
*/
|
734
|
+
matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
735
|
+
/**
|
736
|
+
* Parse the document from ProjectLocationDataStoreBranchDocument resource.
|
737
|
+
*
|
738
|
+
* @param {string} projectLocationDataStoreBranchDocumentName
|
739
|
+
* A fully-qualified path representing project_location_data_store_branch_document resource.
|
740
|
+
* @returns {string} A string representing the document.
|
741
|
+
*/
|
742
|
+
matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
743
|
+
/**
|
744
|
+
* Return a fully-qualified projectLocationDataStoreConversation resource name string.
|
745
|
+
*
|
746
|
+
* @param {string} project
|
747
|
+
* @param {string} location
|
748
|
+
* @param {string} data_store
|
749
|
+
* @param {string} conversation
|
750
|
+
* @returns {string} Resource name string.
|
751
|
+
*/
|
752
|
+
projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
|
753
|
+
/**
|
754
|
+
* Parse the project from ProjectLocationDataStoreConversation resource.
|
755
|
+
*
|
756
|
+
* @param {string} projectLocationDataStoreConversationName
|
757
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
758
|
+
* @returns {string} A string representing the project.
|
759
|
+
*/
|
760
|
+
matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
761
|
+
/**
|
762
|
+
* Parse the location from ProjectLocationDataStoreConversation resource.
|
763
|
+
*
|
764
|
+
* @param {string} projectLocationDataStoreConversationName
|
765
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
766
|
+
* @returns {string} A string representing the location.
|
767
|
+
*/
|
768
|
+
matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
769
|
+
/**
|
770
|
+
* Parse the data_store from ProjectLocationDataStoreConversation resource.
|
771
|
+
*
|
772
|
+
* @param {string} projectLocationDataStoreConversationName
|
773
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
774
|
+
* @returns {string} A string representing the data_store.
|
775
|
+
*/
|
776
|
+
matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
777
|
+
/**
|
778
|
+
* Parse the conversation from ProjectLocationDataStoreConversation resource.
|
779
|
+
*
|
780
|
+
* @param {string} projectLocationDataStoreConversationName
|
781
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
782
|
+
* @returns {string} A string representing the conversation.
|
783
|
+
*/
|
784
|
+
matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
785
|
+
/**
|
786
|
+
* Return a fully-qualified projectLocationDataStoreSchema resource name string.
|
787
|
+
*
|
788
|
+
* @param {string} project
|
789
|
+
* @param {string} location
|
790
|
+
* @param {string} data_store
|
791
|
+
* @param {string} schema
|
792
|
+
* @returns {string} Resource name string.
|
793
|
+
*/
|
794
|
+
projectLocationDataStoreSchemaPath(project: string, location: string, dataStore: string, schema: string): string;
|
795
|
+
/**
|
796
|
+
* Parse the project from ProjectLocationDataStoreSchema resource.
|
797
|
+
*
|
798
|
+
* @param {string} projectLocationDataStoreSchemaName
|
799
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
800
|
+
* @returns {string} A string representing the project.
|
801
|
+
*/
|
802
|
+
matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
|
803
|
+
/**
|
804
|
+
* Parse the location from ProjectLocationDataStoreSchema resource.
|
805
|
+
*
|
806
|
+
* @param {string} projectLocationDataStoreSchemaName
|
807
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
808
|
+
* @returns {string} A string representing the location.
|
809
|
+
*/
|
810
|
+
matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
|
811
|
+
/**
|
812
|
+
* Parse the data_store from ProjectLocationDataStoreSchema resource.
|
813
|
+
*
|
814
|
+
* @param {string} projectLocationDataStoreSchemaName
|
815
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
816
|
+
* @returns {string} A string representing the data_store.
|
817
|
+
*/
|
818
|
+
matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
|
819
|
+
/**
|
820
|
+
* Parse the schema from ProjectLocationDataStoreSchema resource.
|
821
|
+
*
|
822
|
+
* @param {string} projectLocationDataStoreSchemaName
|
823
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
824
|
+
* @returns {string} A string representing the schema.
|
825
|
+
*/
|
826
|
+
matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
|
827
|
+
/**
|
828
|
+
* Return a fully-qualified projectLocationDataStoreServingConfig resource name string.
|
829
|
+
*
|
830
|
+
* @param {string} project
|
831
|
+
* @param {string} location
|
832
|
+
* @param {string} data_store
|
833
|
+
* @param {string} serving_config
|
834
|
+
* @returns {string} Resource name string.
|
835
|
+
*/
|
836
|
+
projectLocationDataStoreServingConfigPath(project: string, location: string, dataStore: string, servingConfig: string): string;
|
837
|
+
/**
|
838
|
+
* Parse the project from ProjectLocationDataStoreServingConfig resource.
|
839
|
+
*
|
840
|
+
* @param {string} projectLocationDataStoreServingConfigName
|
841
|
+
* A fully-qualified path representing project_location_data_store_serving_config resource.
|
842
|
+
* @returns {string} A string representing the project.
|
843
|
+
*/
|
844
|
+
matchProjectFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
|
845
|
+
/**
|
846
|
+
* Parse the location from ProjectLocationDataStoreServingConfig resource.
|
847
|
+
*
|
848
|
+
* @param {string} projectLocationDataStoreServingConfigName
|
849
|
+
* A fully-qualified path representing project_location_data_store_serving_config resource.
|
850
|
+
* @returns {string} A string representing the location.
|
851
|
+
*/
|
852
|
+
matchLocationFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
|
853
|
+
/**
|
854
|
+
* Parse the data_store from ProjectLocationDataStoreServingConfig resource.
|
855
|
+
*
|
856
|
+
* @param {string} projectLocationDataStoreServingConfigName
|
857
|
+
* A fully-qualified path representing project_location_data_store_serving_config resource.
|
858
|
+
* @returns {string} A string representing the data_store.
|
859
|
+
*/
|
860
|
+
matchDataStoreFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
|
861
|
+
/**
|
862
|
+
* Parse the serving_config from ProjectLocationDataStoreServingConfig resource.
|
863
|
+
*
|
864
|
+
* @param {string} projectLocationDataStoreServingConfigName
|
865
|
+
* A fully-qualified path representing project_location_data_store_serving_config resource.
|
866
|
+
* @returns {string} A string representing the serving_config.
|
867
|
+
*/
|
868
|
+
matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
|
869
|
+
/**
|
870
|
+
* Terminate the gRPC channel and close the client.
|
871
|
+
*
|
872
|
+
* The client will no longer be usable and all future behavior is undefined.
|
873
|
+
* @returns {Promise} A promise that resolves when the client is closed.
|
874
|
+
*/
|
875
|
+
close(): Promise<void>;
|
876
|
+
}
|