-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathClient.ts
739 lines (702 loc) · 34.2 KB
/
Client.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
/**
* This file was auto-generated by Fern from our API Definition.
*/
import * as stream from "stream";
import urlJoin from "url-join";
import * as Vectara from "./api/index";
import { ApiKeys } from "./api/resources/apiKeys/client/Client";
import { AppClients } from "./api/resources/appClients/client/Client";
import { Auth } from "./api/resources/auth/client/Client";
import { Chats } from "./api/resources/chats/client/Client";
import { Corpora } from "./api/resources/corpora/client/Client";
import { Documents } from "./api/resources/documents/client/Client";
import { Encoders } from "./api/resources/encoders/client/Client";
import { GenerationPresets } from "./api/resources/generationPresets/client/Client";
import { Index } from "./api/resources/index/client/Client";
import { Jobs } from "./api/resources/jobs/client/Client";
import { Llms } from "./api/resources/llms/client/Client";
import { QueryHistory } from "./api/resources/queryHistory/client/Client";
import { Rerankers } from "./api/resources/rerankers/client/Client";
import { Upload } from "./api/resources/upload/client/Client";
import { Users } from "./api/resources/users/client/Client";
import * as core from "./core";
import * as environments from "./environments";
import * as errors from "./errors/index";
import * as serializers from "./serialization/index";
export declare namespace VectaraClient {
interface Options {
environment?: core.Supplier<environments.VectaraEnvironment | environments.VectaraEnvironmentUrls>;
clientId?: core.Supplier<string>;
clientSecret?: core.Supplier<string>;
/** Override the x-api-key header */
apiKey?: core.Supplier<string | undefined>;
fetcher?: core.FetchFunction;
}
interface RequestOptions {
/** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
/** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
/** A hook to abort the request. */
abortSignal?: AbortSignal;
/** Override the x-api-key header */
apiKey?: string | undefined;
/** Additional headers to include in the request. */
headers?: Record<string, string>;
}
}
export class VectaraClient {
private readonly _oauthTokenProvider: core.OAuthTokenProvider | undefined;
protected _corpora: Corpora | undefined;
protected _upload: Upload | undefined;
protected _documents: Documents | undefined;
protected _index: Index | undefined;
protected _chats: Chats | undefined;
protected _llms: Llms | undefined;
protected _generationPresets: GenerationPresets | undefined;
protected _encoders: Encoders | undefined;
protected _rerankers: Rerankers | undefined;
protected _jobs: Jobs | undefined;
protected _users: Users | undefined;
protected _apiKeys: ApiKeys | undefined;
protected _appClients: AppClients | undefined;
protected _queryHistory: QueryHistory | undefined;
protected _auth: Auth | undefined;
constructor(protected readonly _options: VectaraClient.Options = {}) {
const clientId = this._options.clientId ?? process.env["VECTARA_CLIENT_ID"];
const clientSecret = this._options.clientSecret ?? process.env["VECTARA_CLIENT_SECRET"];
const apiKey = this._options.apiKey ?? process.env["VECTARA_API_KEY"];
if ((clientId == null || clientSecret == null) && apiKey == null) {
throw new Error(
"Either clientId and clientSecret are required (via arguments or VECTARA_CLIENT_ID/VECTARA_CLIENT_SECRET env vars) or apiKey is required (via argument or VECTARA_API_KEY env var)"
);
}
this._oauthTokenProvider = clientId != null && clientSecret != null ? new core.OAuthTokenProvider({
clientId,
clientSecret,
authClient: new Auth({
environment: this._options.environment,
}),
}) : undefined;
}
public get corpora(): Corpora {
return (this._corpora ??= new Corpora({
...this._options,
token: async () => await this._oauthTokenProvider?.getToken(),
}));
}
public get upload(): Upload {
return (this._upload ??= new Upload({
...this._options,
token: async () => await this._oauthTokenProvider?.getToken(),
}));
}
public get documents(): Documents {
return (this._documents ??= new Documents({
...this._options,
token: async () => await this._oauthTokenProvider?.getToken(),
}));
}
public get index(): Index {
return (this._index ??= new Index({
...this._options,
token: async () => await this._oauthTokenProvider?.getToken(),
}));
}
public get chats(): Chats {
return (this._chats ??= new Chats({
...this._options,
token: async () => await this._oauthTokenProvider?.getToken(),
}));
}
public get llms(): Llms {
return (this._llms ??= new Llms({
...this._options,
token: async () => await this._oauthTokenProvider?.getToken(),
}));
}
public get generationPresets(): GenerationPresets {
return (this._generationPresets ??= new GenerationPresets({
...this._options,
token: async () => await this._oauthTokenProvider?.getToken(),
}));
}
public get encoders(): Encoders {
return (this._encoders ??= new Encoders({
...this._options,
token: async () => await this._oauthTokenProvider?.getToken(),
}));
}
public get rerankers(): Rerankers {
return (this._rerankers ??= new Rerankers({
...this._options,
token: async () => await this._oauthTokenProvider?.getToken(),
}));
}
public get jobs(): Jobs {
return (this._jobs ??= new Jobs({
...this._options,
token: async () => await this._oauthTokenProvider?.getToken(),
}));
}
public get users(): Users {
return (this._users ??= new Users({
...this._options,
token: async () => await this._oauthTokenProvider?.getToken(),
}));
}
public get apiKeys(): ApiKeys {
return (this._apiKeys ??= new ApiKeys({
...this._options,
token: async () => await this._oauthTokenProvider?.getToken(),
}));
}
public get appClients(): AppClients {
return (this._appClients ??= new AppClients({
...this._options,
token: async () => await this._oauthTokenProvider?.getToken(),
}));
}
public get queryHistory(): QueryHistory {
return (this._queryHistory ??= new QueryHistory({
...this._options,
token: async () => await this._oauthTokenProvider?.getToken(),
}));
}
public get auth(): Auth {
return (this._auth ??= new Auth({
...this._options,
token: async () => await this._oauthTokenProvider?.getToken(),
}));
}
/**
* Perform a multipurpose query across to retrieve relevant information from one or more corpora and generate a response using Retrieval Augmented Generation (RAG).
*
* * Specify the unique `corpus_key` identifying the corpus to query. The `corpus_key` is [created in the Vectara Console UI](https://docs.vectara.com/docs/console-ui/creating-a-corpus) or the [Create Corpus API definition](https://docs.vectara.com/docs/api-reference/admin-apis/create-corpus). When creating a new corpus, you have the option to assign a custom `corpus_key` following your preferred naming convention. This key serves as a unique identifier for the corpus, allowing it to be referenced in search requests. For more information, see [Corpus Key Definition](https://docs.vectara.com/docs/api-reference/search-apis/search#corpus-key-definition).
* * Customize your search by specifying the query text (`query`), pagination details (`offset` and `limit`), and metadata filters (`metadata_filter`) to tailor your search results. [Learn more](https://docs.vectara.com/docs/api-reference/search-apis/search#query-definition)
* * Leverage advanced search capabilities like reranking (`reranker`) and opt-in Retrieval Augmented Generation (RAG) (`generation`) for enhanced query performance. Generation is opt in by setting the `generation` property. By excluding the property or by setting it to null, the response
* will not include generation. [Learn more](https://docs.vectara.com/docs/learn/grounded-generation/configure-query-summarization)
* * Specify Vectara's RAG-focused LLM (Mockingbird) for the `generation_preset_name`. [Learn more](https://docs.vectara.com/docs/learn/mockingbird-llm)
* * Use advanced summarization options that utilize detailed summarization parameters such as `max_response_characters`, `temperature`, and `frequency_penalty` for generating precise and relevant summaries. [Learn more](https://docs.vectara.com/docs/api-reference/search-apis/search#advanced-summarization-customization-options)
* * Customize citation formats in summaries using the `citations` object to include numeric, HTML, or Markdown links. [Learn more](https://docs.vectara.com/docs/api-reference/search-apis/search#citation-format-in-summary)
*
* For more detailed information, see this [Query API guide](https://docs.vectara.com/docs/api-reference/search-apis/search).
*/
public async queryStream(
request: Vectara.QueryStreamRequest,
requestOptions?: VectaraClient.RequestOptions
): Promise<core.Stream<Vectara.QueryStreamedResponse>> {
const { requestTimeout, requestTimeoutMillis, ..._body } = request;
const _response = await (this._options.fetcher ?? core.fetcher)<stream.Readable>({
url: urlJoin(
((await core.Supplier.get(this._options.environment)) ?? environments.VectaraEnvironment.Production)
.default,
"v2/query"
),
method: "POST",
headers: {
Authorization: await this._getAuthorizationHeader(),
"x-api-key":
(await core.Supplier.get(this._options.apiKey)) != null
? await core.Supplier.get(this._options.apiKey)
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "vectara",
"X-Fern-SDK-Version": "0.1.5",
"User-Agent": "vectara/0.1.5",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
"Request-Timeout": requestTimeout != null ? requestTimeout.toString() : undefined,
"Request-Timeout-Millis": requestTimeoutMillis != null ? requestTimeoutMillis.toString() : undefined,
...requestOptions?.headers,
},
contentType: "application/json",
requestType: "json",
body: {
...serializers.QueryStreamRequest.jsonOrThrow(_body, { unrecognizedObjectKeys: "strip" }),
stream_response: true,
},
responseType: "sse",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
return new core.Stream({
stream: _response.body,
parse: async (data) => {
return serializers.QueryStreamedResponse.parseOrThrow(data, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
});
},
signal: requestOptions?.abortSignal,
eventShape: {
type: "sse",
streamTerminator: "[DONE]",
},
});
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 400:
throw new Vectara.BadRequestError(
serializers.BadRequestErrorBody.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
})
);
case 403:
throw new Vectara.ForbiddenError(
serializers.Error_.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
})
);
case 404:
throw new Vectara.NotFoundError(
serializers.NotFoundErrorBody.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
})
);
default:
throw new errors.VectaraError({
statusCode: _response.error.statusCode,
body: _response.error.body,
});
}
}
switch (_response.error.reason) {
case "non-json":
throw new errors.VectaraError({
statusCode: _response.error.statusCode,
body: _response.error.rawBody,
});
case "timeout":
throw new errors.VectaraTimeoutError("Timeout exceeded when calling POST /v2/query.");
case "unknown":
throw new errors.VectaraError({
message: _response.error.errorMessage,
});
}
}
/**
* Perform a multipurpose query across to retrieve relevant information from one or more corpora and generate a response using Retrieval Augmented Generation (RAG).
*
* * Specify the unique `corpus_key` identifying the corpus to query. The `corpus_key` is [created in the Vectara Console UI](https://docs.vectara.com/docs/console-ui/creating-a-corpus) or the [Create Corpus API definition](https://docs.vectara.com/docs/api-reference/admin-apis/create-corpus). When creating a new corpus, you have the option to assign a custom `corpus_key` following your preferred naming convention. This key serves as a unique identifier for the corpus, allowing it to be referenced in search requests. For more information, see [Corpus Key Definition](https://docs.vectara.com/docs/api-reference/search-apis/search#corpus-key-definition).
* * Customize your search by specifying the query text (`query`), pagination details (`offset` and `limit`), and metadata filters (`metadata_filter`) to tailor your search results. [Learn more](https://docs.vectara.com/docs/api-reference/search-apis/search#query-definition)
* * Leverage advanced search capabilities like reranking (`reranker`) and opt-in Retrieval Augmented Generation (RAG) (`generation`) for enhanced query performance. Generation is opt in by setting the `generation` property. By excluding the property or by setting it to null, the response
* will not include generation. [Learn more](https://docs.vectara.com/docs/learn/grounded-generation/configure-query-summarization)
* * Specify Vectara's RAG-focused LLM (Mockingbird) for the `generation_preset_name`. [Learn more](https://docs.vectara.com/docs/learn/mockingbird-llm)
* * Use advanced summarization options that utilize detailed summarization parameters such as `max_response_characters`, `temperature`, and `frequency_penalty` for generating precise and relevant summaries. [Learn more](https://docs.vectara.com/docs/api-reference/search-apis/search#advanced-summarization-customization-options)
* * Customize citation formats in summaries using the `citations` object to include numeric, HTML, or Markdown links. [Learn more](https://docs.vectara.com/docs/api-reference/search-apis/search#citation-format-in-summary)
*
* For more detailed information, see this [Query API guide](https://docs.vectara.com/docs/api-reference/search-apis/search).
*
* @param {Vectara.QueryRequest} request
* @param {VectaraClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link Vectara.BadRequestError}
* @throws {@link Vectara.ForbiddenError}
* @throws {@link Vectara.NotFoundError}
*
* @example
* await client.query({
* query: "What is a hallucination?",
* search: {
* corpora: [{
* corpusKey: "corpus_key",
* metadataFilter: "",
* lexicalInterpolation: 0.005
* }],
* contextConfiguration: {
* sentencesBefore: 2,
* sentencesAfter: 2
* },
* reranker: {
* type: "customer_reranker",
* rerankerId: "rnk_272725719"
* }
* },
* generation: {
* responseLanguage: "eng",
* enableFactualConsistencyScore: true
* }
* })
*/
public async query(
request: Vectara.QueryRequest,
requestOptions?: VectaraClient.RequestOptions
): Promise<Vectara.QueryFullResponse> {
const { requestTimeout, requestTimeoutMillis, ..._body } = request;
const _response = await (this._options.fetcher ?? core.fetcher)({
url: urlJoin(
((await core.Supplier.get(this._options.environment)) ?? environments.VectaraEnvironment.Production)
.default,
"v2/query"
),
method: "POST",
headers: {
Authorization: await this._getAuthorizationHeader(),
"x-api-key":
(await core.Supplier.get(this._options.apiKey)) != null
? await core.Supplier.get(this._options.apiKey)
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "vectara",
"X-Fern-SDK-Version": "0.1.5",
"User-Agent": "vectara/0.1.5",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
"Request-Timeout": requestTimeout != null ? requestTimeout.toString() : undefined,
"Request-Timeout-Millis": requestTimeoutMillis != null ? requestTimeoutMillis.toString() : undefined,
...requestOptions?.headers,
},
contentType: "application/json",
requestType: "json",
body: {
...serializers.QueryRequest.jsonOrThrow(_body, { unrecognizedObjectKeys: "strip" }),
stream_response: false,
},
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
return serializers.QueryFullResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
});
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 400:
throw new Vectara.BadRequestError(
serializers.BadRequestErrorBody.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
})
);
case 403:
throw new Vectara.ForbiddenError(
serializers.Error_.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
})
);
case 404:
throw new Vectara.NotFoundError(
serializers.NotFoundErrorBody.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
})
);
default:
throw new errors.VectaraError({
statusCode: _response.error.statusCode,
body: _response.error.body,
});
}
}
switch (_response.error.reason) {
case "non-json":
throw new errors.VectaraError({
statusCode: _response.error.statusCode,
body: _response.error.rawBody,
});
case "timeout":
throw new errors.VectaraTimeoutError("Timeout exceeded when calling POST /v2/query.");
case "unknown":
throw new errors.VectaraError({
message: _response.error.errorMessage,
});
}
}
/**
* Create a chat while specifying the default retrieval parameters used by the prompt.
*/
public async chatStream(
request: Vectara.ChatStreamRequest,
requestOptions?: VectaraClient.RequestOptions
): Promise<core.Stream<Vectara.ChatStreamedResponse>> {
const { requestTimeout, requestTimeoutMillis, ..._body } = request;
const _response = await (this._options.fetcher ?? core.fetcher)<stream.Readable>({
url: urlJoin(
((await core.Supplier.get(this._options.environment)) ?? environments.VectaraEnvironment.Production)
.default,
"v2/chats"
),
method: "POST",
headers: {
Authorization: await this._getAuthorizationHeader(),
"x-api-key":
(await core.Supplier.get(this._options.apiKey)) != null
? await core.Supplier.get(this._options.apiKey)
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "vectara",
"X-Fern-SDK-Version": "0.1.5",
"User-Agent": "vectara/0.1.5",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
"Request-Timeout": requestTimeout != null ? requestTimeout.toString() : undefined,
"Request-Timeout-Millis": requestTimeoutMillis != null ? requestTimeoutMillis.toString() : undefined,
...requestOptions?.headers,
},
contentType: "application/json",
requestType: "json",
body: {
...serializers.ChatStreamRequest.jsonOrThrow(_body, { unrecognizedObjectKeys: "strip" }),
stream_response: true,
},
responseType: "sse",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
return new core.Stream({
stream: _response.body,
parse: async (data) => {
return serializers.ChatStreamedResponse.parseOrThrow(data, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
});
},
signal: requestOptions?.abortSignal,
eventShape: {
type: "sse",
streamTerminator: "[DONE]",
},
});
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 400:
throw new Vectara.BadRequestError(
serializers.BadRequestErrorBody.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
})
);
case 403:
throw new Vectara.ForbiddenError(
serializers.Error_.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
})
);
case 404:
throw new Vectara.NotFoundError(
serializers.NotFoundErrorBody.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
})
);
default:
throw new errors.VectaraError({
statusCode: _response.error.statusCode,
body: _response.error.body,
});
}
}
switch (_response.error.reason) {
case "non-json":
throw new errors.VectaraError({
statusCode: _response.error.statusCode,
body: _response.error.rawBody,
});
case "timeout":
throw new errors.VectaraTimeoutError("Timeout exceeded when calling POST /v2/chats.");
case "unknown":
throw new errors.VectaraError({
message: _response.error.errorMessage,
});
}
}
/**
* Create a chat while specifying the default retrieval parameters used by the prompt.
*
* @param {Vectara.ChatRequest} request
* @param {VectaraClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link Vectara.BadRequestError}
* @throws {@link Vectara.ForbiddenError}
* @throws {@link Vectara.NotFoundError}
*
* @example
* await client.chat({
* query: "What is a hallucination?",
* search: {
* corpora: [{
* corpusKey: "corpus_key",
* metadataFilter: "",
* lexicalInterpolation: 0.005
* }],
* contextConfiguration: {
* sentencesBefore: 2,
* sentencesAfter: 2
* },
* reranker: {
* type: "customer_reranker",
* rerankerId: "rnk_272725719"
* }
* },
* generation: {
* responseLanguage: "eng",
* enableFactualConsistencyScore: true,
* citations: {
* style: "none"
* }
* },
* chat: {
* store: true
* }
* })
*/
public async chat(
request: Vectara.ChatRequest,
requestOptions?: VectaraClient.RequestOptions
): Promise<Vectara.ChatFullResponse> {
const { requestTimeout, requestTimeoutMillis, ..._body } = request;
const _response = await (this._options.fetcher ?? core.fetcher)({
url: urlJoin(
((await core.Supplier.get(this._options.environment)) ?? environments.VectaraEnvironment.Production)
.default,
"v2/chats"
),
method: "POST",
headers: {
Authorization: await this._getAuthorizationHeader(),
"x-api-key":
(await core.Supplier.get(this._options.apiKey)) != null
? await core.Supplier.get(this._options.apiKey)
: undefined,
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "vectara",
"X-Fern-SDK-Version": "0.1.5",
"User-Agent": "vectara/0.1.5",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
"Request-Timeout": requestTimeout != null ? requestTimeout.toString() : undefined,
"Request-Timeout-Millis": requestTimeoutMillis != null ? requestTimeoutMillis.toString() : undefined,
...requestOptions?.headers,
},
contentType: "application/json",
requestType: "json",
body: {
...serializers.ChatRequest.jsonOrThrow(_body, { unrecognizedObjectKeys: "strip" }),
stream_response: false,
},
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
return serializers.ChatFullResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
});
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 400:
throw new Vectara.BadRequestError(
serializers.BadRequestErrorBody.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
})
);
case 403:
throw new Vectara.ForbiddenError(
serializers.Error_.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
})
);
case 404:
throw new Vectara.NotFoundError(
serializers.NotFoundErrorBody.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
skipValidation: true,
breadcrumbsPrefix: ["response"],
})
);
default:
throw new errors.VectaraError({
statusCode: _response.error.statusCode,
body: _response.error.body,
});
}
}
switch (_response.error.reason) {
case "non-json":
throw new errors.VectaraError({
statusCode: _response.error.statusCode,
body: _response.error.rawBody,
});
case "timeout":
throw new errors.VectaraTimeoutError("Timeout exceeded when calling POST /v2/chats.");
case "unknown":
throw new errors.VectaraError({
message: _response.error.errorMessage,
});
}
}
protected async _getAuthorizationHeader(): Promise<string | undefined> {
if (!this._oauthTokenProvider) return undefined;
const bearer = await this._oauthTokenProvider.getToken();
if (bearer != null) {
return `Bearer ${bearer}`;
}
return undefined;
}
}