@google-cloud/discoveryengine 1.1.0 → 1.2.0
Sign up to get free protection for your applications and to get access to all the features.
- package/CHANGELOG.md +7 -0
- package/README.md +26 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +155 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/completion_service.proto +134 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/conversation.proto +138 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +306 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +121 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +318 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +343 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +159 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto +221 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +312 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/schema_service.proto +260 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +851 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +152 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +475 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/user_event_service.proto +154 -0
- package/build/protos/protos.d.ts +12587 -7
- package/build/protos/protos.js +34918 -3126
- package/build/protos/protos.json +3458 -5
- package/build/src/index.d.ts +3 -1
- package/build/src/index.js +4 -1
- package/build/src/v1alpha/completion_service_client.d.ts +603 -0
- package/build/src/v1alpha/completion_service_client.js +843 -0
- package/build/src/v1alpha/completion_service_client_config.json +43 -0
- package/build/src/v1alpha/conversational_search_service_client.d.ts +998 -0
- package/build/src/v1alpha/conversational_search_service_client.js +1275 -0
- package/build/src/v1alpha/conversational_search_service_client_config.json +68 -0
- package/build/src/v1alpha/document_service_client.d.ts +1140 -0
- package/build/src/v1alpha/document_service_client.js +1393 -0
- package/build/src/v1alpha/document_service_client_config.json +82 -0
- package/build/src/v1alpha/index.d.ts +8 -0
- package/build/src/v1alpha/index.js +37 -0
- package/build/src/v1alpha/recommendation_service_client.d.ts +735 -0
- package/build/src/v1alpha/recommendation_service_client.js +938 -0
- package/build/src/v1alpha/recommendation_service_client_config.json +43 -0
- package/build/src/v1alpha/schema_service_client.d.ts +935 -0
- package/build/src/v1alpha/schema_service_client.js +1327 -0
- package/build/src/v1alpha/schema_service_client_config.json +63 -0
- package/build/src/v1alpha/search_service_client.d.ts +1208 -0
- package/build/src/v1alpha/search_service_client.js +1432 -0
- package/build/src/v1alpha/search_service_client_config.json +43 -0
- package/build/src/v1alpha/site_search_engine_service_client.d.ts +704 -0
- package/build/src/v1alpha/site_search_engine_service_client.js +1087 -0
- package/build/src/v1alpha/site_search_engine_service_client_config.json +30 -0
- package/build/src/v1alpha/user_event_service_client.d.ts +853 -0
- package/build/src/v1alpha/user_event_service_client.js +1174 -0
- package/build/src/v1alpha/user_event_service_client_config.json +67 -0
- package/package.json +3 -3
@@ -0,0 +1,998 @@
|
|
1
|
+
/// <reference types="node" />
|
2
|
+
import type * as gax from 'google-gax';
|
3
|
+
import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback, LocationsClient, LocationProtos } 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 v1alpha
|
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
|
+
locationsClient: LocationsClient;
|
26
|
+
pathTemplates: {
|
27
|
+
[name: string]: gax.PathTemplate;
|
28
|
+
};
|
29
|
+
conversationalSearchServiceStub?: Promise<{
|
30
|
+
[name: string]: Function;
|
31
|
+
}>;
|
32
|
+
/**
|
33
|
+
* Construct an instance of ConversationalSearchServiceClient.
|
34
|
+
*
|
35
|
+
* @param {object} [options] - The configuration object.
|
36
|
+
* The options accepted by the constructor are described in detail
|
37
|
+
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
|
38
|
+
* The common options are:
|
39
|
+
* @param {object} [options.credentials] - Credentials object.
|
40
|
+
* @param {string} [options.credentials.client_email]
|
41
|
+
* @param {string} [options.credentials.private_key]
|
42
|
+
* @param {string} [options.email] - Account email address. Required when
|
43
|
+
* using a .pem or .p12 keyFilename.
|
44
|
+
* @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
|
45
|
+
* .p12 key downloaded from the Google Developers Console. If you provide
|
46
|
+
* a path to a JSON file, the projectId option below is not necessary.
|
47
|
+
* NOTE: .pem and .p12 require you to specify options.email as well.
|
48
|
+
* @param {number} [options.port] - The port on which to connect to
|
49
|
+
* the remote host.
|
50
|
+
* @param {string} [options.projectId] - The project ID from the Google
|
51
|
+
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
|
52
|
+
* the environment variable GCLOUD_PROJECT for your project ID. If your
|
53
|
+
* app is running in an environment which supports
|
54
|
+
* {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
|
55
|
+
* your project ID will be detected automatically.
|
56
|
+
* @param {string} [options.apiEndpoint] - The domain name of the
|
57
|
+
* API remote host.
|
58
|
+
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
|
59
|
+
* Follows the structure of {@link gapicConfig}.
|
60
|
+
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
|
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: true}, 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.v1alpha.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.v1alpha.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 {number[]} request.userLabels
|
135
|
+
* The user labels applied to a resource must meet the following requirements:
|
136
|
+
*
|
137
|
+
* * Each resource can have multiple labels, up to a maximum of 64.
|
138
|
+
* * Each label must be a key-value pair.
|
139
|
+
* * Keys have a minimum length of 1 character and a maximum length of 63
|
140
|
+
* characters and cannot be empty. Values can be empty and have a maximum
|
141
|
+
* length of 63 characters.
|
142
|
+
* * Keys and values can contain only lowercase letters, numeric characters,
|
143
|
+
* underscores, and dashes. All characters must use UTF-8 encoding, and
|
144
|
+
* international characters are allowed.
|
145
|
+
* * The key portion of a label must be unique. However, you can use the same
|
146
|
+
* key with multiple resources.
|
147
|
+
* * Keys must start with a lowercase letter or international character.
|
148
|
+
*
|
149
|
+
* See [Google Cloud
|
150
|
+
* Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
151
|
+
* for more details.
|
152
|
+
* @param {google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec} request.summarySpec
|
153
|
+
* A specification for configuring the summary returned in the response.
|
154
|
+
* @param {object} [options]
|
155
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
156
|
+
* @returns {Promise} - The promise which resolves to an array.
|
157
|
+
* The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1alpha.ConverseConversationResponse|ConverseConversationResponse}.
|
158
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
159
|
+
* for more details and examples.
|
160
|
+
* @example <caption>include:samples/generated/v1alpha/conversational_search_service.converse_conversation.js</caption>
|
161
|
+
* region_tag:discoveryengine_v1alpha_generated_ConversationalSearchService_ConverseConversation_async
|
162
|
+
*/
|
163
|
+
converseConversation(request?: protos.google.cloud.discoveryengine.v1alpha.IConverseConversationRequest, options?: CallOptions): Promise<[
|
164
|
+
protos.google.cloud.discoveryengine.v1alpha.IConverseConversationResponse,
|
165
|
+
(protos.google.cloud.discoveryengine.v1alpha.IConverseConversationRequest | undefined),
|
166
|
+
{} | undefined
|
167
|
+
]>;
|
168
|
+
converseConversation(request: protos.google.cloud.discoveryengine.v1alpha.IConverseConversationRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IConverseConversationResponse, protos.google.cloud.discoveryengine.v1alpha.IConverseConversationRequest | null | undefined, {} | null | undefined>): void;
|
169
|
+
converseConversation(request: protos.google.cloud.discoveryengine.v1alpha.IConverseConversationRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IConverseConversationResponse, protos.google.cloud.discoveryengine.v1alpha.IConverseConversationRequest | null | undefined, {} | null | undefined>): void;
|
170
|
+
/**
|
171
|
+
* Creates a Conversation.
|
172
|
+
*
|
173
|
+
* If the {@link protos.google.cloud.discoveryengine.v1alpha.Conversation|Conversation} to
|
174
|
+
* create already exists, an ALREADY_EXISTS error is returned.
|
175
|
+
*
|
176
|
+
* @param {Object} request
|
177
|
+
* The request object that will be sent.
|
178
|
+
* @param {string} request.parent
|
179
|
+
* Required. Full resource name of parent data store. Format:
|
180
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
|
181
|
+
* @param {google.cloud.discoveryengine.v1alpha.Conversation} request.conversation
|
182
|
+
* Required. The conversation to create.
|
183
|
+
* @param {object} [options]
|
184
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
185
|
+
* @returns {Promise} - The promise which resolves to an array.
|
186
|
+
* The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1alpha.Conversation|Conversation}.
|
187
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
188
|
+
* for more details and examples.
|
189
|
+
* @example <caption>include:samples/generated/v1alpha/conversational_search_service.create_conversation.js</caption>
|
190
|
+
* region_tag:discoveryengine_v1alpha_generated_ConversationalSearchService_CreateConversation_async
|
191
|
+
*/
|
192
|
+
createConversation(request?: protos.google.cloud.discoveryengine.v1alpha.ICreateConversationRequest, options?: CallOptions): Promise<[
|
193
|
+
protos.google.cloud.discoveryengine.v1alpha.IConversation,
|
194
|
+
(protos.google.cloud.discoveryengine.v1alpha.ICreateConversationRequest | undefined),
|
195
|
+
{} | undefined
|
196
|
+
]>;
|
197
|
+
createConversation(request: protos.google.cloud.discoveryengine.v1alpha.ICreateConversationRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IConversation, protos.google.cloud.discoveryengine.v1alpha.ICreateConversationRequest | null | undefined, {} | null | undefined>): void;
|
198
|
+
createConversation(request: protos.google.cloud.discoveryengine.v1alpha.ICreateConversationRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IConversation, protos.google.cloud.discoveryengine.v1alpha.ICreateConversationRequest | null | undefined, {} | null | undefined>): void;
|
199
|
+
/**
|
200
|
+
* Deletes a Conversation.
|
201
|
+
*
|
202
|
+
* If the {@link protos.google.cloud.discoveryengine.v1alpha.Conversation|Conversation} to
|
203
|
+
* delete does not exist, a NOT_FOUND error is returned.
|
204
|
+
*
|
205
|
+
* @param {Object} request
|
206
|
+
* The request object that will be sent.
|
207
|
+
* @param {string} request.name
|
208
|
+
* Required. The resource name of the Conversation to delete. Format:
|
209
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
|
210
|
+
* @param {object} [options]
|
211
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
212
|
+
* @returns {Promise} - The promise which resolves to an array.
|
213
|
+
* The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
|
214
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
215
|
+
* for more details and examples.
|
216
|
+
* @example <caption>include:samples/generated/v1alpha/conversational_search_service.delete_conversation.js</caption>
|
217
|
+
* region_tag:discoveryengine_v1alpha_generated_ConversationalSearchService_DeleteConversation_async
|
218
|
+
*/
|
219
|
+
deleteConversation(request?: protos.google.cloud.discoveryengine.v1alpha.IDeleteConversationRequest, options?: CallOptions): Promise<[
|
220
|
+
protos.google.protobuf.IEmpty,
|
221
|
+
(protos.google.cloud.discoveryengine.v1alpha.IDeleteConversationRequest | undefined),
|
222
|
+
{} | undefined
|
223
|
+
]>;
|
224
|
+
deleteConversation(request: protos.google.cloud.discoveryengine.v1alpha.IDeleteConversationRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteConversationRequest | null | undefined, {} | null | undefined>): void;
|
225
|
+
deleteConversation(request: protos.google.cloud.discoveryengine.v1alpha.IDeleteConversationRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteConversationRequest | null | undefined, {} | null | undefined>): void;
|
226
|
+
/**
|
227
|
+
* Updates a Conversation.
|
228
|
+
*
|
229
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Conversation|Conversation} action
|
230
|
+
* type cannot be changed. If the
|
231
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Conversation|Conversation} to update
|
232
|
+
* does not exist, a NOT_FOUND error is returned.
|
233
|
+
*
|
234
|
+
* @param {Object} request
|
235
|
+
* The request object that will be sent.
|
236
|
+
* @param {google.cloud.discoveryengine.v1alpha.Conversation} request.conversation
|
237
|
+
* Required. The Conversation to update.
|
238
|
+
* @param {google.protobuf.FieldMask} request.updateMask
|
239
|
+
* Indicates which fields in the provided
|
240
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Conversation|Conversation} to
|
241
|
+
* update. The following are NOT supported:
|
242
|
+
*
|
243
|
+
* * {@link protos.|conversation.name}
|
244
|
+
*
|
245
|
+
* If not set or empty, all supported fields are updated.
|
246
|
+
* @param {object} [options]
|
247
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
248
|
+
* @returns {Promise} - The promise which resolves to an array.
|
249
|
+
* The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1alpha.Conversation|Conversation}.
|
250
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
251
|
+
* for more details and examples.
|
252
|
+
* @example <caption>include:samples/generated/v1alpha/conversational_search_service.update_conversation.js</caption>
|
253
|
+
* region_tag:discoveryengine_v1alpha_generated_ConversationalSearchService_UpdateConversation_async
|
254
|
+
*/
|
255
|
+
updateConversation(request?: protos.google.cloud.discoveryengine.v1alpha.IUpdateConversationRequest, options?: CallOptions): Promise<[
|
256
|
+
protos.google.cloud.discoveryengine.v1alpha.IConversation,
|
257
|
+
(protos.google.cloud.discoveryengine.v1alpha.IUpdateConversationRequest | undefined),
|
258
|
+
{} | undefined
|
259
|
+
]>;
|
260
|
+
updateConversation(request: protos.google.cloud.discoveryengine.v1alpha.IUpdateConversationRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IConversation, protos.google.cloud.discoveryengine.v1alpha.IUpdateConversationRequest | null | undefined, {} | null | undefined>): void;
|
261
|
+
updateConversation(request: protos.google.cloud.discoveryengine.v1alpha.IUpdateConversationRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IConversation, protos.google.cloud.discoveryengine.v1alpha.IUpdateConversationRequest | null | undefined, {} | null | undefined>): void;
|
262
|
+
/**
|
263
|
+
* Gets a Conversation.
|
264
|
+
*
|
265
|
+
* @param {Object} request
|
266
|
+
* The request object that will be sent.
|
267
|
+
* @param {string} request.name
|
268
|
+
* Required. The resource name of the Conversation to get. Format:
|
269
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
|
270
|
+
* @param {object} [options]
|
271
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
272
|
+
* @returns {Promise} - The promise which resolves to an array.
|
273
|
+
* The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1alpha.Conversation|Conversation}.
|
274
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
275
|
+
* for more details and examples.
|
276
|
+
* @example <caption>include:samples/generated/v1alpha/conversational_search_service.get_conversation.js</caption>
|
277
|
+
* region_tag:discoveryengine_v1alpha_generated_ConversationalSearchService_GetConversation_async
|
278
|
+
*/
|
279
|
+
getConversation(request?: protos.google.cloud.discoveryengine.v1alpha.IGetConversationRequest, options?: CallOptions): Promise<[
|
280
|
+
protos.google.cloud.discoveryengine.v1alpha.IConversation,
|
281
|
+
(protos.google.cloud.discoveryengine.v1alpha.IGetConversationRequest | undefined),
|
282
|
+
{} | undefined
|
283
|
+
]>;
|
284
|
+
getConversation(request: protos.google.cloud.discoveryengine.v1alpha.IGetConversationRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IConversation, protos.google.cloud.discoveryengine.v1alpha.IGetConversationRequest | null | undefined, {} | null | undefined>): void;
|
285
|
+
getConversation(request: protos.google.cloud.discoveryengine.v1alpha.IGetConversationRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IConversation, protos.google.cloud.discoveryengine.v1alpha.IGetConversationRequest | null | undefined, {} | null | undefined>): void;
|
286
|
+
/**
|
287
|
+
* Lists all Conversations by their parent
|
288
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore}.
|
289
|
+
*
|
290
|
+
* @param {Object} request
|
291
|
+
* The request object that will be sent.
|
292
|
+
* @param {string} request.parent
|
293
|
+
* Required. The data store resource name. Format:
|
294
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
|
295
|
+
* @param {number} request.pageSize
|
296
|
+
* Maximum number of results to return. If unspecified, defaults
|
297
|
+
* to 50. Max allowed value is 1000.
|
298
|
+
* @param {string} request.pageToken
|
299
|
+
* A page token, received from a previous `ListConversations` call.
|
300
|
+
* Provide this to retrieve the subsequent page.
|
301
|
+
* @param {string} request.filter
|
302
|
+
* A filter to apply on the list results. The supported features are:
|
303
|
+
* user_pseudo_id, state.
|
304
|
+
*
|
305
|
+
* Example:
|
306
|
+
* "user_pseudo_id = some_id"
|
307
|
+
* @param {string} request.orderBy
|
308
|
+
* A comma-separated list of fields to order by, sorted in ascending order.
|
309
|
+
* Use "desc" after a field name for descending.
|
310
|
+
* Supported fields:
|
311
|
+
* * `update_time`
|
312
|
+
* * `create_time`
|
313
|
+
* * `conversation_name`
|
314
|
+
*
|
315
|
+
* Example:
|
316
|
+
* "update_time desc"
|
317
|
+
* "create_time"
|
318
|
+
* @param {object} [options]
|
319
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
320
|
+
* @returns {Promise} - The promise which resolves to an array.
|
321
|
+
* The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1alpha.Conversation|Conversation}.
|
322
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
323
|
+
* times as needed and will merge results from all the pages into this array.
|
324
|
+
* Note that it can affect your quota.
|
325
|
+
* We recommend using `listConversationsAsync()`
|
326
|
+
* method described below for async iteration which you can stop as needed.
|
327
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
328
|
+
* for more details and examples.
|
329
|
+
*/
|
330
|
+
listConversations(request?: protos.google.cloud.discoveryengine.v1alpha.IListConversationsRequest, options?: CallOptions): Promise<[
|
331
|
+
protos.google.cloud.discoveryengine.v1alpha.IConversation[],
|
332
|
+
protos.google.cloud.discoveryengine.v1alpha.IListConversationsRequest | null,
|
333
|
+
protos.google.cloud.discoveryengine.v1alpha.IListConversationsResponse
|
334
|
+
]>;
|
335
|
+
listConversations(request: protos.google.cloud.discoveryengine.v1alpha.IListConversationsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IListConversationsRequest, protos.google.cloud.discoveryengine.v1alpha.IListConversationsResponse | null | undefined, protos.google.cloud.discoveryengine.v1alpha.IConversation>): void;
|
336
|
+
listConversations(request: protos.google.cloud.discoveryengine.v1alpha.IListConversationsRequest, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IListConversationsRequest, protos.google.cloud.discoveryengine.v1alpha.IListConversationsResponse | null | undefined, protos.google.cloud.discoveryengine.v1alpha.IConversation>): void;
|
337
|
+
/**
|
338
|
+
* Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
|
339
|
+
* @param {Object} request
|
340
|
+
* The request object that will be sent.
|
341
|
+
* @param {string} request.parent
|
342
|
+
* Required. The data store resource name. Format:
|
343
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
|
344
|
+
* @param {number} request.pageSize
|
345
|
+
* Maximum number of results to return. If unspecified, defaults
|
346
|
+
* to 50. Max allowed value is 1000.
|
347
|
+
* @param {string} request.pageToken
|
348
|
+
* A page token, received from a previous `ListConversations` call.
|
349
|
+
* Provide this to retrieve the subsequent page.
|
350
|
+
* @param {string} request.filter
|
351
|
+
* A filter to apply on the list results. The supported features are:
|
352
|
+
* user_pseudo_id, state.
|
353
|
+
*
|
354
|
+
* Example:
|
355
|
+
* "user_pseudo_id = some_id"
|
356
|
+
* @param {string} request.orderBy
|
357
|
+
* A comma-separated list of fields to order by, sorted in ascending order.
|
358
|
+
* Use "desc" after a field name for descending.
|
359
|
+
* Supported fields:
|
360
|
+
* * `update_time`
|
361
|
+
* * `create_time`
|
362
|
+
* * `conversation_name`
|
363
|
+
*
|
364
|
+
* Example:
|
365
|
+
* "update_time desc"
|
366
|
+
* "create_time"
|
367
|
+
* @param {object} [options]
|
368
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
369
|
+
* @returns {Stream}
|
370
|
+
* An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1alpha.Conversation|Conversation} on 'data' event.
|
371
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
372
|
+
* times as needed. Note that it can affect your quota.
|
373
|
+
* We recommend using `listConversationsAsync()`
|
374
|
+
* method described below for async iteration which you can stop as needed.
|
375
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
376
|
+
* for more details and examples.
|
377
|
+
*/
|
378
|
+
listConversationsStream(request?: protos.google.cloud.discoveryengine.v1alpha.IListConversationsRequest, options?: CallOptions): Transform;
|
379
|
+
/**
|
380
|
+
* Equivalent to `listConversations`, but returns an iterable object.
|
381
|
+
*
|
382
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
383
|
+
* @param {Object} request
|
384
|
+
* The request object that will be sent.
|
385
|
+
* @param {string} request.parent
|
386
|
+
* Required. The data store resource name. Format:
|
387
|
+
* `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
|
388
|
+
* @param {number} request.pageSize
|
389
|
+
* Maximum number of results to return. If unspecified, defaults
|
390
|
+
* to 50. Max allowed value is 1000.
|
391
|
+
* @param {string} request.pageToken
|
392
|
+
* A page token, received from a previous `ListConversations` call.
|
393
|
+
* Provide this to retrieve the subsequent page.
|
394
|
+
* @param {string} request.filter
|
395
|
+
* A filter to apply on the list results. The supported features are:
|
396
|
+
* user_pseudo_id, state.
|
397
|
+
*
|
398
|
+
* Example:
|
399
|
+
* "user_pseudo_id = some_id"
|
400
|
+
* @param {string} request.orderBy
|
401
|
+
* A comma-separated list of fields to order by, sorted in ascending order.
|
402
|
+
* Use "desc" after a field name for descending.
|
403
|
+
* Supported fields:
|
404
|
+
* * `update_time`
|
405
|
+
* * `create_time`
|
406
|
+
* * `conversation_name`
|
407
|
+
*
|
408
|
+
* Example:
|
409
|
+
* "update_time desc"
|
410
|
+
* "create_time"
|
411
|
+
* @param {object} [options]
|
412
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
413
|
+
* @returns {Object}
|
414
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
415
|
+
* When you iterate the returned iterable, each element will be an object representing
|
416
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Conversation|Conversation}. The API will be called under the hood as needed, once per the page,
|
417
|
+
* so you can stop the iteration when you don't need more results.
|
418
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
419
|
+
* for more details and examples.
|
420
|
+
* @example <caption>include:samples/generated/v1alpha/conversational_search_service.list_conversations.js</caption>
|
421
|
+
* region_tag:discoveryengine_v1alpha_generated_ConversationalSearchService_ListConversations_async
|
422
|
+
*/
|
423
|
+
listConversationsAsync(request?: protos.google.cloud.discoveryengine.v1alpha.IListConversationsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1alpha.IConversation>;
|
424
|
+
/**
|
425
|
+
* Gets information about a location.
|
426
|
+
*
|
427
|
+
* @param {Object} request
|
428
|
+
* The request object that will be sent.
|
429
|
+
* @param {string} request.name
|
430
|
+
* Resource name for the location.
|
431
|
+
* @param {object} [options]
|
432
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
|
433
|
+
* @returns {Promise} - The promise which resolves to an array.
|
434
|
+
* The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
|
435
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
436
|
+
* for more details and examples.
|
437
|
+
* @example
|
438
|
+
* ```
|
439
|
+
* const [response] = await client.getLocation(request);
|
440
|
+
* ```
|
441
|
+
*/
|
442
|
+
getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
|
443
|
+
/**
|
444
|
+
* Lists information about the supported locations for this service. Returns an iterable object.
|
445
|
+
*
|
446
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
447
|
+
* @param {Object} request
|
448
|
+
* The request object that will be sent.
|
449
|
+
* @param {string} request.name
|
450
|
+
* The resource that owns the locations collection, if applicable.
|
451
|
+
* @param {string} request.filter
|
452
|
+
* The standard list filter.
|
453
|
+
* @param {number} request.pageSize
|
454
|
+
* The standard list page size.
|
455
|
+
* @param {string} request.pageToken
|
456
|
+
* The standard list page token.
|
457
|
+
* @param {object} [options]
|
458
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
459
|
+
* @returns {Object}
|
460
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
461
|
+
* When you iterate the returned iterable, each element will be an object representing
|
462
|
+
* {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
|
463
|
+
* so you can stop the iteration when you don't need more results.
|
464
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
465
|
+
* for more details and examples.
|
466
|
+
* @example
|
467
|
+
* ```
|
468
|
+
* const iterable = client.listLocationsAsync(request);
|
469
|
+
* for await (const response of iterable) {
|
470
|
+
* // process response
|
471
|
+
* }
|
472
|
+
* ```
|
473
|
+
*/
|
474
|
+
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
|
475
|
+
/**
|
476
|
+
* Return a fully-qualified projectLocationCollectionDataStore resource name string.
|
477
|
+
*
|
478
|
+
* @param {string} project
|
479
|
+
* @param {string} location
|
480
|
+
* @param {string} collection
|
481
|
+
* @param {string} data_store
|
482
|
+
* @returns {string} Resource name string.
|
483
|
+
*/
|
484
|
+
projectLocationCollectionDataStorePath(project: string, location: string, collection: string, dataStore: string): string;
|
485
|
+
/**
|
486
|
+
* Parse the project from ProjectLocationCollectionDataStore resource.
|
487
|
+
*
|
488
|
+
* @param {string} projectLocationCollectionDataStoreName
|
489
|
+
* A fully-qualified path representing project_location_collection_data_store resource.
|
490
|
+
* @returns {string} A string representing the project.
|
491
|
+
*/
|
492
|
+
matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
|
493
|
+
/**
|
494
|
+
* Parse the location from ProjectLocationCollectionDataStore resource.
|
495
|
+
*
|
496
|
+
* @param {string} projectLocationCollectionDataStoreName
|
497
|
+
* A fully-qualified path representing project_location_collection_data_store resource.
|
498
|
+
* @returns {string} A string representing the location.
|
499
|
+
*/
|
500
|
+
matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
|
501
|
+
/**
|
502
|
+
* Parse the collection from ProjectLocationCollectionDataStore resource.
|
503
|
+
*
|
504
|
+
* @param {string} projectLocationCollectionDataStoreName
|
505
|
+
* A fully-qualified path representing project_location_collection_data_store resource.
|
506
|
+
* @returns {string} A string representing the collection.
|
507
|
+
*/
|
508
|
+
matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
|
509
|
+
/**
|
510
|
+
* Parse the data_store from ProjectLocationCollectionDataStore resource.
|
511
|
+
*
|
512
|
+
* @param {string} projectLocationCollectionDataStoreName
|
513
|
+
* A fully-qualified path representing project_location_collection_data_store resource.
|
514
|
+
* @returns {string} A string representing the data_store.
|
515
|
+
*/
|
516
|
+
matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
|
517
|
+
/**
|
518
|
+
* Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
|
519
|
+
*
|
520
|
+
* @param {string} project
|
521
|
+
* @param {string} location
|
522
|
+
* @param {string} collection
|
523
|
+
* @param {string} data_store
|
524
|
+
* @param {string} branch
|
525
|
+
* @param {string} document
|
526
|
+
* @returns {string} Resource name string.
|
527
|
+
*/
|
528
|
+
projectLocationCollectionDataStoreBranchDocumentPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string): string;
|
529
|
+
/**
|
530
|
+
* Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.
|
531
|
+
*
|
532
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
533
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
534
|
+
* @returns {string} A string representing the project.
|
535
|
+
*/
|
536
|
+
matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
537
|
+
/**
|
538
|
+
* Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.
|
539
|
+
*
|
540
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
541
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
542
|
+
* @returns {string} A string representing the location.
|
543
|
+
*/
|
544
|
+
matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
545
|
+
/**
|
546
|
+
* Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.
|
547
|
+
*
|
548
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
549
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
550
|
+
* @returns {string} A string representing the collection.
|
551
|
+
*/
|
552
|
+
matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
553
|
+
/**
|
554
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.
|
555
|
+
*
|
556
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
557
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
558
|
+
* @returns {string} A string representing the data_store.
|
559
|
+
*/
|
560
|
+
matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
561
|
+
/**
|
562
|
+
* Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.
|
563
|
+
*
|
564
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
565
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
566
|
+
* @returns {string} A string representing the branch.
|
567
|
+
*/
|
568
|
+
matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
569
|
+
/**
|
570
|
+
* Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.
|
571
|
+
*
|
572
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
573
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
574
|
+
* @returns {string} A string representing the document.
|
575
|
+
*/
|
576
|
+
matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
577
|
+
/**
|
578
|
+
* Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
|
579
|
+
*
|
580
|
+
* @param {string} project
|
581
|
+
* @param {string} location
|
582
|
+
* @param {string} collection
|
583
|
+
* @param {string} data_store
|
584
|
+
* @param {string} conversation
|
585
|
+
* @returns {string} Resource name string.
|
586
|
+
*/
|
587
|
+
projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
|
588
|
+
/**
|
589
|
+
* Parse the project from ProjectLocationCollectionDataStoreConversation resource.
|
590
|
+
*
|
591
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
592
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
593
|
+
* @returns {string} A string representing the project.
|
594
|
+
*/
|
595
|
+
matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
596
|
+
/**
|
597
|
+
* Parse the location from ProjectLocationCollectionDataStoreConversation resource.
|
598
|
+
*
|
599
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
600
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
601
|
+
* @returns {string} A string representing the location.
|
602
|
+
*/
|
603
|
+
matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
604
|
+
/**
|
605
|
+
* Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
|
606
|
+
*
|
607
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
608
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
609
|
+
* @returns {string} A string representing the collection.
|
610
|
+
*/
|
611
|
+
matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
612
|
+
/**
|
613
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
|
614
|
+
*
|
615
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
616
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
617
|
+
* @returns {string} A string representing the data_store.
|
618
|
+
*/
|
619
|
+
matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
620
|
+
/**
|
621
|
+
* Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
|
622
|
+
*
|
623
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
624
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
625
|
+
* @returns {string} A string representing the conversation.
|
626
|
+
*/
|
627
|
+
matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
628
|
+
/**
|
629
|
+
* Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
|
630
|
+
*
|
631
|
+
* @param {string} project
|
632
|
+
* @param {string} location
|
633
|
+
* @param {string} collection
|
634
|
+
* @param {string} data_store
|
635
|
+
* @param {string} schema
|
636
|
+
* @returns {string} Resource name string.
|
637
|
+
*/
|
638
|
+
projectLocationCollectionDataStoreSchemaPath(project: string, location: string, collection: string, dataStore: string, schema: string): string;
|
639
|
+
/**
|
640
|
+
* Parse the project from ProjectLocationCollectionDataStoreSchema resource.
|
641
|
+
*
|
642
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
643
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
644
|
+
* @returns {string} A string representing the project.
|
645
|
+
*/
|
646
|
+
matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
647
|
+
/**
|
648
|
+
* Parse the location from ProjectLocationCollectionDataStoreSchema resource.
|
649
|
+
*
|
650
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
651
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
652
|
+
* @returns {string} A string representing the location.
|
653
|
+
*/
|
654
|
+
matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
655
|
+
/**
|
656
|
+
* Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
|
657
|
+
*
|
658
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
659
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
660
|
+
* @returns {string} A string representing the collection.
|
661
|
+
*/
|
662
|
+
matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
663
|
+
/**
|
664
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
|
665
|
+
*
|
666
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
667
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
668
|
+
* @returns {string} A string representing the data_store.
|
669
|
+
*/
|
670
|
+
matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
671
|
+
/**
|
672
|
+
* Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
|
673
|
+
*
|
674
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
675
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
676
|
+
* @returns {string} A string representing the schema.
|
677
|
+
*/
|
678
|
+
matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
679
|
+
/**
|
680
|
+
* Return a fully-qualified projectLocationCollectionDataStoreServingConfig resource name string.
|
681
|
+
*
|
682
|
+
* @param {string} project
|
683
|
+
* @param {string} location
|
684
|
+
* @param {string} collection
|
685
|
+
* @param {string} data_store
|
686
|
+
* @param {string} serving_config
|
687
|
+
* @returns {string} Resource name string.
|
688
|
+
*/
|
689
|
+
projectLocationCollectionDataStoreServingConfigPath(project: string, location: string, collection: string, dataStore: string, servingConfig: string): string;
|
690
|
+
/**
|
691
|
+
* Parse the project from ProjectLocationCollectionDataStoreServingConfig resource.
|
692
|
+
*
|
693
|
+
* @param {string} projectLocationCollectionDataStoreServingConfigName
|
694
|
+
* A fully-qualified path representing project_location_collection_data_store_serving_config resource.
|
695
|
+
* @returns {string} A string representing the project.
|
696
|
+
*/
|
697
|
+
matchProjectFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
|
698
|
+
/**
|
699
|
+
* Parse the location from ProjectLocationCollectionDataStoreServingConfig resource.
|
700
|
+
*
|
701
|
+
* @param {string} projectLocationCollectionDataStoreServingConfigName
|
702
|
+
* A fully-qualified path representing project_location_collection_data_store_serving_config resource.
|
703
|
+
* @returns {string} A string representing the location.
|
704
|
+
*/
|
705
|
+
matchLocationFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
|
706
|
+
/**
|
707
|
+
* Parse the collection from ProjectLocationCollectionDataStoreServingConfig resource.
|
708
|
+
*
|
709
|
+
* @param {string} projectLocationCollectionDataStoreServingConfigName
|
710
|
+
* A fully-qualified path representing project_location_collection_data_store_serving_config resource.
|
711
|
+
* @returns {string} A string representing the collection.
|
712
|
+
*/
|
713
|
+
matchCollectionFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
|
714
|
+
/**
|
715
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreServingConfig resource.
|
716
|
+
*
|
717
|
+
* @param {string} projectLocationCollectionDataStoreServingConfigName
|
718
|
+
* A fully-qualified path representing project_location_collection_data_store_serving_config resource.
|
719
|
+
* @returns {string} A string representing the data_store.
|
720
|
+
*/
|
721
|
+
matchDataStoreFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
|
722
|
+
/**
|
723
|
+
* Parse the serving_config from ProjectLocationCollectionDataStoreServingConfig resource.
|
724
|
+
*
|
725
|
+
* @param {string} projectLocationCollectionDataStoreServingConfigName
|
726
|
+
* A fully-qualified path representing project_location_collection_data_store_serving_config resource.
|
727
|
+
* @returns {string} A string representing the serving_config.
|
728
|
+
*/
|
729
|
+
matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
|
730
|
+
/**
|
731
|
+
* Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.
|
732
|
+
*
|
733
|
+
* @param {string} project
|
734
|
+
* @param {string} location
|
735
|
+
* @param {string} collection
|
736
|
+
* @param {string} engine
|
737
|
+
* @param {string} serving_config
|
738
|
+
* @returns {string} Resource name string.
|
739
|
+
*/
|
740
|
+
projectLocationCollectionEngineServingConfigPath(project: string, location: string, collection: string, engine: string, servingConfig: string): string;
|
741
|
+
/**
|
742
|
+
* Parse the project from ProjectLocationCollectionEngineServingConfig resource.
|
743
|
+
*
|
744
|
+
* @param {string} projectLocationCollectionEngineServingConfigName
|
745
|
+
* A fully-qualified path representing project_location_collection_engine_serving_config resource.
|
746
|
+
* @returns {string} A string representing the project.
|
747
|
+
*/
|
748
|
+
matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
|
749
|
+
/**
|
750
|
+
* Parse the location from ProjectLocationCollectionEngineServingConfig resource.
|
751
|
+
*
|
752
|
+
* @param {string} projectLocationCollectionEngineServingConfigName
|
753
|
+
* A fully-qualified path representing project_location_collection_engine_serving_config resource.
|
754
|
+
* @returns {string} A string representing the location.
|
755
|
+
*/
|
756
|
+
matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
|
757
|
+
/**
|
758
|
+
* Parse the collection from ProjectLocationCollectionEngineServingConfig resource.
|
759
|
+
*
|
760
|
+
* @param {string} projectLocationCollectionEngineServingConfigName
|
761
|
+
* A fully-qualified path representing project_location_collection_engine_serving_config resource.
|
762
|
+
* @returns {string} A string representing the collection.
|
763
|
+
*/
|
764
|
+
matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
|
765
|
+
/**
|
766
|
+
* Parse the engine from ProjectLocationCollectionEngineServingConfig resource.
|
767
|
+
*
|
768
|
+
* @param {string} projectLocationCollectionEngineServingConfigName
|
769
|
+
* A fully-qualified path representing project_location_collection_engine_serving_config resource.
|
770
|
+
* @returns {string} A string representing the engine.
|
771
|
+
*/
|
772
|
+
matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
|
773
|
+
/**
|
774
|
+
* Parse the serving_config from ProjectLocationCollectionEngineServingConfig resource.
|
775
|
+
*
|
776
|
+
* @param {string} projectLocationCollectionEngineServingConfigName
|
777
|
+
* A fully-qualified path representing project_location_collection_engine_serving_config resource.
|
778
|
+
* @returns {string} A string representing the serving_config.
|
779
|
+
*/
|
780
|
+
matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
|
781
|
+
/**
|
782
|
+
* Return a fully-qualified projectLocationDataStore resource name string.
|
783
|
+
*
|
784
|
+
* @param {string} project
|
785
|
+
* @param {string} location
|
786
|
+
* @param {string} data_store
|
787
|
+
* @returns {string} Resource name string.
|
788
|
+
*/
|
789
|
+
projectLocationDataStorePath(project: string, location: string, dataStore: string): string;
|
790
|
+
/**
|
791
|
+
* Parse the project from ProjectLocationDataStore resource.
|
792
|
+
*
|
793
|
+
* @param {string} projectLocationDataStoreName
|
794
|
+
* A fully-qualified path representing project_location_data_store resource.
|
795
|
+
* @returns {string} A string representing the project.
|
796
|
+
*/
|
797
|
+
matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
|
798
|
+
/**
|
799
|
+
* Parse the location from ProjectLocationDataStore resource.
|
800
|
+
*
|
801
|
+
* @param {string} projectLocationDataStoreName
|
802
|
+
* A fully-qualified path representing project_location_data_store resource.
|
803
|
+
* @returns {string} A string representing the location.
|
804
|
+
*/
|
805
|
+
matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
|
806
|
+
/**
|
807
|
+
* Parse the data_store from ProjectLocationDataStore resource.
|
808
|
+
*
|
809
|
+
* @param {string} projectLocationDataStoreName
|
810
|
+
* A fully-qualified path representing project_location_data_store resource.
|
811
|
+
* @returns {string} A string representing the data_store.
|
812
|
+
*/
|
813
|
+
matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
|
814
|
+
/**
|
815
|
+
* Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
|
816
|
+
*
|
817
|
+
* @param {string} project
|
818
|
+
* @param {string} location
|
819
|
+
* @param {string} data_store
|
820
|
+
* @param {string} branch
|
821
|
+
* @param {string} document
|
822
|
+
* @returns {string} Resource name string.
|
823
|
+
*/
|
824
|
+
projectLocationDataStoreBranchDocumentPath(project: string, location: string, dataStore: string, branch: string, document: string): string;
|
825
|
+
/**
|
826
|
+
* Parse the project from ProjectLocationDataStoreBranchDocument resource.
|
827
|
+
*
|
828
|
+
* @param {string} projectLocationDataStoreBranchDocumentName
|
829
|
+
* A fully-qualified path representing project_location_data_store_branch_document resource.
|
830
|
+
* @returns {string} A string representing the project.
|
831
|
+
*/
|
832
|
+
matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
833
|
+
/**
|
834
|
+
* Parse the location from ProjectLocationDataStoreBranchDocument resource.
|
835
|
+
*
|
836
|
+
* @param {string} projectLocationDataStoreBranchDocumentName
|
837
|
+
* A fully-qualified path representing project_location_data_store_branch_document resource.
|
838
|
+
* @returns {string} A string representing the location.
|
839
|
+
*/
|
840
|
+
matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
841
|
+
/**
|
842
|
+
* Parse the data_store from ProjectLocationDataStoreBranchDocument resource.
|
843
|
+
*
|
844
|
+
* @param {string} projectLocationDataStoreBranchDocumentName
|
845
|
+
* A fully-qualified path representing project_location_data_store_branch_document resource.
|
846
|
+
* @returns {string} A string representing the data_store.
|
847
|
+
*/
|
848
|
+
matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
849
|
+
/**
|
850
|
+
* Parse the branch from ProjectLocationDataStoreBranchDocument resource.
|
851
|
+
*
|
852
|
+
* @param {string} projectLocationDataStoreBranchDocumentName
|
853
|
+
* A fully-qualified path representing project_location_data_store_branch_document resource.
|
854
|
+
* @returns {string} A string representing the branch.
|
855
|
+
*/
|
856
|
+
matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
857
|
+
/**
|
858
|
+
* Parse the document from ProjectLocationDataStoreBranchDocument resource.
|
859
|
+
*
|
860
|
+
* @param {string} projectLocationDataStoreBranchDocumentName
|
861
|
+
* A fully-qualified path representing project_location_data_store_branch_document resource.
|
862
|
+
* @returns {string} A string representing the document.
|
863
|
+
*/
|
864
|
+
matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
865
|
+
/**
|
866
|
+
* Return a fully-qualified projectLocationDataStoreConversation resource name string.
|
867
|
+
*
|
868
|
+
* @param {string} project
|
869
|
+
* @param {string} location
|
870
|
+
* @param {string} data_store
|
871
|
+
* @param {string} conversation
|
872
|
+
* @returns {string} Resource name string.
|
873
|
+
*/
|
874
|
+
projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
|
875
|
+
/**
|
876
|
+
* Parse the project from ProjectLocationDataStoreConversation resource.
|
877
|
+
*
|
878
|
+
* @param {string} projectLocationDataStoreConversationName
|
879
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
880
|
+
* @returns {string} A string representing the project.
|
881
|
+
*/
|
882
|
+
matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
883
|
+
/**
|
884
|
+
* Parse the location from ProjectLocationDataStoreConversation resource.
|
885
|
+
*
|
886
|
+
* @param {string} projectLocationDataStoreConversationName
|
887
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
888
|
+
* @returns {string} A string representing the location.
|
889
|
+
*/
|
890
|
+
matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
891
|
+
/**
|
892
|
+
* Parse the data_store from ProjectLocationDataStoreConversation resource.
|
893
|
+
*
|
894
|
+
* @param {string} projectLocationDataStoreConversationName
|
895
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
896
|
+
* @returns {string} A string representing the data_store.
|
897
|
+
*/
|
898
|
+
matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
899
|
+
/**
|
900
|
+
* Parse the conversation from ProjectLocationDataStoreConversation resource.
|
901
|
+
*
|
902
|
+
* @param {string} projectLocationDataStoreConversationName
|
903
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
904
|
+
* @returns {string} A string representing the conversation.
|
905
|
+
*/
|
906
|
+
matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
907
|
+
/**
|
908
|
+
* Return a fully-qualified projectLocationDataStoreSchema resource name string.
|
909
|
+
*
|
910
|
+
* @param {string} project
|
911
|
+
* @param {string} location
|
912
|
+
* @param {string} data_store
|
913
|
+
* @param {string} schema
|
914
|
+
* @returns {string} Resource name string.
|
915
|
+
*/
|
916
|
+
projectLocationDataStoreSchemaPath(project: string, location: string, dataStore: string, schema: string): string;
|
917
|
+
/**
|
918
|
+
* Parse the project from ProjectLocationDataStoreSchema resource.
|
919
|
+
*
|
920
|
+
* @param {string} projectLocationDataStoreSchemaName
|
921
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
922
|
+
* @returns {string} A string representing the project.
|
923
|
+
*/
|
924
|
+
matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
|
925
|
+
/**
|
926
|
+
* Parse the location from ProjectLocationDataStoreSchema resource.
|
927
|
+
*
|
928
|
+
* @param {string} projectLocationDataStoreSchemaName
|
929
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
930
|
+
* @returns {string} A string representing the location.
|
931
|
+
*/
|
932
|
+
matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
|
933
|
+
/**
|
934
|
+
* Parse the data_store from ProjectLocationDataStoreSchema resource.
|
935
|
+
*
|
936
|
+
* @param {string} projectLocationDataStoreSchemaName
|
937
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
938
|
+
* @returns {string} A string representing the data_store.
|
939
|
+
*/
|
940
|
+
matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
|
941
|
+
/**
|
942
|
+
* Parse the schema from ProjectLocationDataStoreSchema resource.
|
943
|
+
*
|
944
|
+
* @param {string} projectLocationDataStoreSchemaName
|
945
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
946
|
+
* @returns {string} A string representing the schema.
|
947
|
+
*/
|
948
|
+
matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
|
949
|
+
/**
|
950
|
+
* Return a fully-qualified projectLocationDataStoreServingConfig resource name string.
|
951
|
+
*
|
952
|
+
* @param {string} project
|
953
|
+
* @param {string} location
|
954
|
+
* @param {string} data_store
|
955
|
+
* @param {string} serving_config
|
956
|
+
* @returns {string} Resource name string.
|
957
|
+
*/
|
958
|
+
projectLocationDataStoreServingConfigPath(project: string, location: string, dataStore: string, servingConfig: string): string;
|
959
|
+
/**
|
960
|
+
* Parse the project from ProjectLocationDataStoreServingConfig resource.
|
961
|
+
*
|
962
|
+
* @param {string} projectLocationDataStoreServingConfigName
|
963
|
+
* A fully-qualified path representing project_location_data_store_serving_config resource.
|
964
|
+
* @returns {string} A string representing the project.
|
965
|
+
*/
|
966
|
+
matchProjectFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
|
967
|
+
/**
|
968
|
+
* Parse the location from ProjectLocationDataStoreServingConfig resource.
|
969
|
+
*
|
970
|
+
* @param {string} projectLocationDataStoreServingConfigName
|
971
|
+
* A fully-qualified path representing project_location_data_store_serving_config resource.
|
972
|
+
* @returns {string} A string representing the location.
|
973
|
+
*/
|
974
|
+
matchLocationFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
|
975
|
+
/**
|
976
|
+
* Parse the data_store from ProjectLocationDataStoreServingConfig resource.
|
977
|
+
*
|
978
|
+
* @param {string} projectLocationDataStoreServingConfigName
|
979
|
+
* A fully-qualified path representing project_location_data_store_serving_config resource.
|
980
|
+
* @returns {string} A string representing the data_store.
|
981
|
+
*/
|
982
|
+
matchDataStoreFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
|
983
|
+
/**
|
984
|
+
* Parse the serving_config from ProjectLocationDataStoreServingConfig resource.
|
985
|
+
*
|
986
|
+
* @param {string} projectLocationDataStoreServingConfigName
|
987
|
+
* A fully-qualified path representing project_location_data_store_serving_config resource.
|
988
|
+
* @returns {string} A string representing the serving_config.
|
989
|
+
*/
|
990
|
+
matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
|
991
|
+
/**
|
992
|
+
* Terminate the gRPC channel and close the client.
|
993
|
+
*
|
994
|
+
* The client will no longer be usable and all future behavior is undefined.
|
995
|
+
* @returns {Promise} A promise that resolves when the client is closed.
|
996
|
+
*/
|
997
|
+
close(): Promise<void>;
|
998
|
+
}
|