@airweave/sdk 0.9.49 → 0.9.51

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. package/dist/cjs/Client.js +2 -2
  2. package/dist/cjs/api/resources/collections/client/Client.d.ts +3 -53
  3. package/dist/cjs/api/resources/collections/client/Client.js +5 -261
  4. package/dist/cjs/api/resources/collections/client/requests/index.d.ts +0 -2
  5. package/dist/cjs/api/resources/collections/index.d.ts +1 -0
  6. package/dist/cjs/api/resources/collections/index.js +1 -0
  7. package/dist/cjs/api/resources/collections/resources/index.d.ts +2 -0
  8. package/dist/cjs/api/resources/collections/resources/index.js +41 -0
  9. package/dist/cjs/api/resources/collections/resources/search/client/Client.d.ts +90 -0
  10. package/dist/cjs/api/resources/collections/resources/search/client/Client.js +330 -0
  11. package/dist/cjs/api/resources/collections/resources/search/client/index.d.ts +2 -0
  12. package/dist/cjs/api/resources/collections/resources/search/client/index.js +17 -0
  13. package/dist/cjs/api/resources/collections/{client → resources/search/client}/requests/ClassicSearchRequest.d.ts +3 -2
  14. package/dist/cjs/api/resources/collections/{client → resources/search/client}/requests/InstantSearchRequest.d.ts +4 -2
  15. package/dist/cjs/api/resources/collections/resources/search/client/requests/index.d.ts +2 -0
  16. package/dist/cjs/api/resources/collections/resources/search/client/requests/index.js +2 -0
  17. package/dist/cjs/api/resources/collections/resources/search/index.d.ts +1 -0
  18. package/dist/cjs/api/resources/collections/resources/search/index.js +17 -0
  19. package/dist/cjs/api/types/ConfigField.d.ts +1 -0
  20. package/dist/cjs/version.d.ts +1 -1
  21. package/dist/cjs/version.js +1 -1
  22. package/dist/esm/Client.mjs +2 -2
  23. package/dist/esm/api/resources/collections/client/Client.d.mts +3 -53
  24. package/dist/esm/api/resources/collections/client/Client.mjs +5 -261
  25. package/dist/esm/api/resources/collections/client/requests/index.d.mts +0 -2
  26. package/dist/esm/api/resources/collections/index.d.mts +1 -0
  27. package/dist/esm/api/resources/collections/index.mjs +1 -0
  28. package/dist/esm/api/resources/collections/resources/index.d.mts +2 -0
  29. package/dist/esm/api/resources/collections/resources/index.mjs +2 -0
  30. package/dist/esm/api/resources/collections/resources/search/client/Client.d.mts +90 -0
  31. package/dist/esm/api/resources/collections/resources/search/client/Client.mjs +293 -0
  32. package/dist/esm/api/resources/collections/resources/search/client/index.d.mts +2 -0
  33. package/dist/esm/api/resources/collections/resources/search/client/index.mjs +1 -0
  34. package/dist/esm/api/resources/collections/{client → resources/search/client}/requests/ClassicSearchRequest.d.mts +3 -2
  35. package/dist/esm/api/resources/collections/{client → resources/search/client}/requests/InstantSearchRequest.d.mts +4 -2
  36. package/dist/esm/api/resources/collections/resources/search/client/requests/index.d.mts +2 -0
  37. package/dist/esm/api/resources/collections/resources/search/client/requests/index.mjs +1 -0
  38. package/dist/esm/api/resources/collections/resources/search/index.d.mts +1 -0
  39. package/dist/esm/api/resources/collections/resources/search/index.mjs +1 -0
  40. package/dist/esm/api/types/ConfigField.d.mts +1 -0
  41. package/dist/esm/version.d.mts +1 -1
  42. package/dist/esm/version.mjs +1 -1
  43. package/package.json +1 -1
  44. package/reference.md +332 -325
  45. /package/dist/cjs/api/resources/collections/{client → resources/search/client}/requests/ClassicSearchRequest.js +0 -0
  46. /package/dist/cjs/api/resources/collections/{client → resources/search/client}/requests/InstantSearchRequest.js +0 -0
  47. /package/dist/esm/api/resources/collections/{client → resources/search/client}/requests/ClassicSearchRequest.mjs +0 -0
  48. /package/dist/esm/api/resources/collections/{client → resources/search/client}/requests/InstantSearchRequest.mjs +0 -0
@@ -15,6 +15,7 @@ import * as core from "../../../../core/index.mjs";
15
15
  import * as AirweaveSDK from "../../../index.mjs";
16
16
  import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.mjs";
17
17
  import * as errors from "../../../../errors/index.mjs";
18
+ import { Search } from "../resources/search/client/Client.mjs";
18
19
  /**
19
20
  * API endpoints for managing collections - logical groups of data sources that provide unified search capabilities
20
21
  */
@@ -22,6 +23,10 @@ export class Collections {
22
23
  constructor(_options) {
23
24
  this._options = _options;
24
25
  }
26
+ get search() {
27
+ var _a;
28
+ return ((_a = this._search) !== null && _a !== void 0 ? _a : (this._search = new Search(this._options)));
29
+ }
25
30
  /**
26
31
  * Retrieve all collections belonging to your organization.
27
32
  *
@@ -402,267 +407,6 @@ export class Collections {
402
407
  }
403
408
  });
404
409
  }
405
- /**
406
- * Direct vector search.
407
- *
408
- * @param {string} readableId
409
- * @param {AirweaveSDK.InstantSearchRequest} request
410
- * @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
411
- *
412
- * @throws {@link AirweaveSDK.UnprocessableEntityError}
413
- *
414
- * @example
415
- * await client.collections.instantSearch("readable_id", {
416
- * query: "query"
417
- * })
418
- */
419
- instantSearch(readableId, request, requestOptions) {
420
- return core.HttpResponsePromise.fromPromise(this.__instantSearch(readableId, request, requestOptions));
421
- }
422
- __instantSearch(readableId, request, requestOptions) {
423
- return __awaiter(this, void 0, void 0, function* () {
424
- var _a, _b, _c;
425
- let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
426
- const _response = yield core.fetcher({
427
- url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.AirweaveSDKEnvironment.Production, `collections/${encodeURIComponent(readableId)}/search/instant`),
428
- method: "POST",
429
- headers: _headers,
430
- contentType: "application/json",
431
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
432
- requestType: "json",
433
- body: request,
434
- timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
435
- maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
436
- abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
437
- });
438
- if (_response.ok) {
439
- return { data: _response.body, rawResponse: _response.rawResponse };
440
- }
441
- if (_response.error.reason === "status-code") {
442
- switch (_response.error.statusCode) {
443
- case 422:
444
- throw new AirweaveSDK.UnprocessableEntityError(_response.error.body, _response.rawResponse);
445
- default:
446
- throw new errors.AirweaveSDKError({
447
- statusCode: _response.error.statusCode,
448
- body: _response.error.body,
449
- rawResponse: _response.rawResponse,
450
- });
451
- }
452
- }
453
- switch (_response.error.reason) {
454
- case "non-json":
455
- throw new errors.AirweaveSDKError({
456
- statusCode: _response.error.statusCode,
457
- body: _response.error.rawBody,
458
- rawResponse: _response.rawResponse,
459
- });
460
- case "timeout":
461
- throw new errors.AirweaveSDKTimeoutError("Timeout exceeded when calling POST /collections/{readable_id}/search/instant.");
462
- case "unknown":
463
- throw new errors.AirweaveSDKError({
464
- message: _response.error.errorMessage,
465
- rawResponse: _response.rawResponse,
466
- });
467
- }
468
- });
469
- }
470
- /**
471
- * AI-optimized search.
472
- *
473
- * @param {string} readableId
474
- * @param {AirweaveSDK.ClassicSearchRequest} request
475
- * @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
476
- *
477
- * @throws {@link AirweaveSDK.UnprocessableEntityError}
478
- *
479
- * @example
480
- * await client.collections.classicSearch("readable_id", {
481
- * query: "query"
482
- * })
483
- */
484
- classicSearch(readableId, request, requestOptions) {
485
- return core.HttpResponsePromise.fromPromise(this.__classicSearch(readableId, request, requestOptions));
486
- }
487
- __classicSearch(readableId, request, requestOptions) {
488
- return __awaiter(this, void 0, void 0, function* () {
489
- var _a, _b, _c;
490
- let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
491
- const _response = yield core.fetcher({
492
- url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.AirweaveSDKEnvironment.Production, `collections/${encodeURIComponent(readableId)}/search/classic`),
493
- method: "POST",
494
- headers: _headers,
495
- contentType: "application/json",
496
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
497
- requestType: "json",
498
- body: request,
499
- timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
500
- maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
501
- abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
502
- });
503
- if (_response.ok) {
504
- return { data: _response.body, rawResponse: _response.rawResponse };
505
- }
506
- if (_response.error.reason === "status-code") {
507
- switch (_response.error.statusCode) {
508
- case 422:
509
- throw new AirweaveSDK.UnprocessableEntityError(_response.error.body, _response.rawResponse);
510
- default:
511
- throw new errors.AirweaveSDKError({
512
- statusCode: _response.error.statusCode,
513
- body: _response.error.body,
514
- rawResponse: _response.rawResponse,
515
- });
516
- }
517
- }
518
- switch (_response.error.reason) {
519
- case "non-json":
520
- throw new errors.AirweaveSDKError({
521
- statusCode: _response.error.statusCode,
522
- body: _response.error.rawBody,
523
- rawResponse: _response.rawResponse,
524
- });
525
- case "timeout":
526
- throw new errors.AirweaveSDKTimeoutError("Timeout exceeded when calling POST /collections/{readable_id}/search/classic.");
527
- case "unknown":
528
- throw new errors.AirweaveSDKError({
529
- message: _response.error.errorMessage,
530
- rawResponse: _response.rawResponse,
531
- });
532
- }
533
- });
534
- }
535
- /**
536
- * Agent that iteratively searches, reads, navigates hierarchies, and collects results.
537
- *
538
- * @param {string} readableId
539
- * @param {AirweaveSDK.AgenticSearchRequest} request
540
- * @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
541
- *
542
- * @throws {@link AirweaveSDK.UnprocessableEntityError}
543
- *
544
- * @example
545
- * await client.collections.agenticSearch("readable_id", {
546
- * query: "query"
547
- * })
548
- */
549
- agenticSearch(readableId, request, requestOptions) {
550
- return core.HttpResponsePromise.fromPromise(this.__agenticSearch(readableId, request, requestOptions));
551
- }
552
- __agenticSearch(readableId, request, requestOptions) {
553
- return __awaiter(this, void 0, void 0, function* () {
554
- var _a, _b, _c;
555
- let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
556
- const _response = yield core.fetcher({
557
- url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.AirweaveSDKEnvironment.Production, `collections/${encodeURIComponent(readableId)}/search/agentic`),
558
- method: "POST",
559
- headers: _headers,
560
- contentType: "application/json",
561
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
562
- requestType: "json",
563
- body: request,
564
- timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
565
- maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
566
- abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
567
- });
568
- if (_response.ok) {
569
- return { data: _response.body, rawResponse: _response.rawResponse };
570
- }
571
- if (_response.error.reason === "status-code") {
572
- switch (_response.error.statusCode) {
573
- case 422:
574
- throw new AirweaveSDK.UnprocessableEntityError(_response.error.body, _response.rawResponse);
575
- default:
576
- throw new errors.AirweaveSDKError({
577
- statusCode: _response.error.statusCode,
578
- body: _response.error.body,
579
- rawResponse: _response.rawResponse,
580
- });
581
- }
582
- }
583
- switch (_response.error.reason) {
584
- case "non-json":
585
- throw new errors.AirweaveSDKError({
586
- statusCode: _response.error.statusCode,
587
- body: _response.error.rawBody,
588
- rawResponse: _response.rawResponse,
589
- });
590
- case "timeout":
591
- throw new errors.AirweaveSDKTimeoutError("Timeout exceeded when calling POST /collections/{readable_id}/search/agentic.");
592
- case "unknown":
593
- throw new errors.AirweaveSDKError({
594
- message: _response.error.errorMessage,
595
- rawResponse: _response.rawResponse,
596
- });
597
- }
598
- });
599
- }
600
- /**
601
- * Streaming agentic search via Server-Sent Events. Returns real-time events as the agent searches.
602
- */
603
- streamAgenticSearch(readableId, request, requestOptions) {
604
- return core.HttpResponsePromise.fromPromise(this.__streamAgenticSearch(readableId, request, requestOptions));
605
- }
606
- __streamAgenticSearch(readableId, request, requestOptions) {
607
- return __awaiter(this, void 0, void 0, function* () {
608
- var _a, _b, _c;
609
- let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
610
- const _response = yield core.fetcher({
611
- url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.AirweaveSDKEnvironment.Production, `collections/${encodeURIComponent(readableId)}/search/agentic/stream`),
612
- method: "POST",
613
- headers: _headers,
614
- contentType: "application/json",
615
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
616
- requestType: "json",
617
- body: request,
618
- responseType: "sse",
619
- timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
620
- maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
621
- abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
622
- });
623
- if (_response.ok) {
624
- return {
625
- data: new core.Stream({
626
- stream: _response.body,
627
- parse: (data) => data,
628
- signal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
629
- eventShape: {
630
- type: "sse",
631
- streamTerminator: "[DONE]",
632
- },
633
- }),
634
- rawResponse: _response.rawResponse,
635
- };
636
- }
637
- if (_response.error.reason === "status-code") {
638
- switch (_response.error.statusCode) {
639
- case 422:
640
- throw new AirweaveSDK.UnprocessableEntityError(_response.error.body, _response.rawResponse);
641
- default:
642
- throw new errors.AirweaveSDKError({
643
- statusCode: _response.error.statusCode,
644
- body: _response.error.body,
645
- rawResponse: _response.rawResponse,
646
- });
647
- }
648
- }
649
- switch (_response.error.reason) {
650
- case "non-json":
651
- throw new errors.AirweaveSDKError({
652
- statusCode: _response.error.statusCode,
653
- body: _response.error.rawBody,
654
- rawResponse: _response.rawResponse,
655
- });
656
- case "timeout":
657
- throw new errors.AirweaveSDKTimeoutError("Timeout exceeded when calling POST /collections/{readable_id}/search/agentic/stream.");
658
- case "unknown":
659
- throw new errors.AirweaveSDKError({
660
- message: _response.error.errorMessage,
661
- rawResponse: _response.rawResponse,
662
- });
663
- }
664
- });
665
- }
666
410
  _getCustomAuthorizationHeaders() {
667
411
  return __awaiter(this, void 0, void 0, function* () {
668
412
  const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
@@ -1,5 +1,3 @@
1
1
  export { type ListCollectionsGetRequest } from "./ListCollectionsGetRequest.mjs";
2
2
  export { type CollectionCreate } from "./CollectionCreate.mjs";
3
3
  export { type CollectionUpdate } from "./CollectionUpdate.mjs";
4
- export { type InstantSearchRequest } from "./InstantSearchRequest.mjs";
5
- export { type ClassicSearchRequest } from "./ClassicSearchRequest.mjs";
@@ -1 +1,2 @@
1
1
  export * from "./client/index.mjs";
2
+ export * from "./resources/index.mjs";
@@ -1 +1,2 @@
1
1
  export * from "./client/index.mjs";
2
+ export * from "./resources/index.mjs";
@@ -0,0 +1,2 @@
1
+ export * as search from "./search/index.mjs";
2
+ export * from "./search/client/requests/index.mjs";
@@ -0,0 +1,2 @@
1
+ export * as search from "./search/index.mjs";
2
+ export * from "./search/client/requests/index.mjs";
@@ -0,0 +1,90 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as environments from "../../../../../../environments.mjs";
5
+ import * as core from "../../../../../../core/index.mjs";
6
+ import * as AirweaveSDK from "../../../../../index.mjs";
7
+ export declare namespace Search {
8
+ interface Options {
9
+ environment?: core.Supplier<environments.AirweaveSDKEnvironment | string>;
10
+ /** Specify a custom URL to connect the client to. */
11
+ baseUrl?: core.Supplier<string>;
12
+ apiKey: core.Supplier<string>;
13
+ /** Additional headers to include in requests. */
14
+ headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
15
+ }
16
+ interface RequestOptions {
17
+ /** The maximum time to wait for a response in seconds. */
18
+ timeoutInSeconds?: number;
19
+ /** The number of times to retry the request. Defaults to 2. */
20
+ maxRetries?: number;
21
+ /** A hook to abort the request. */
22
+ abortSignal?: AbortSignal;
23
+ /** Additional query string parameters to include in the request. */
24
+ queryParams?: Record<string, unknown>;
25
+ /** Additional headers to include in the request. */
26
+ headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
27
+ }
28
+ }
29
+ export declare class Search {
30
+ protected readonly _options: Search.Options;
31
+ constructor(_options: Search.Options);
32
+ /**
33
+ * Direct vector search.
34
+ *
35
+ * @param {string} readableId
36
+ * @param {AirweaveSDK.collections.InstantSearchRequest} request
37
+ * @param {Search.RequestOptions} requestOptions - Request-specific configuration.
38
+ *
39
+ * @throws {@link AirweaveSDK.UnprocessableEntityError}
40
+ *
41
+ * @example
42
+ * await client.collections.search.instant("customer-support-tickets-x7k9m", {
43
+ * query: "How do I reset my password?",
44
+ * retrieval_strategy: "hybrid",
45
+ * limit: 10
46
+ * })
47
+ */
48
+ instant(readableId: string, request: AirweaveSDK.collections.InstantSearchRequest, requestOptions?: Search.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SearchV2Response>;
49
+ private __instant;
50
+ /**
51
+ * AI-optimized search.
52
+ *
53
+ * @param {string} readableId
54
+ * @param {AirweaveSDK.collections.ClassicSearchRequest} request
55
+ * @param {Search.RequestOptions} requestOptions - Request-specific configuration.
56
+ *
57
+ * @throws {@link AirweaveSDK.UnprocessableEntityError}
58
+ *
59
+ * @example
60
+ * await client.collections.search.classic("customer-support-tickets-x7k9m", {
61
+ * query: "quarterly revenue report",
62
+ * limit: 10
63
+ * })
64
+ */
65
+ classic(readableId: string, request: AirweaveSDK.collections.ClassicSearchRequest, requestOptions?: Search.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SearchV2Response>;
66
+ private __classic;
67
+ /**
68
+ * Agent that iteratively searches, reads, navigates hierarchies, and collects results.
69
+ *
70
+ * @param {string} readableId
71
+ * @param {AirweaveSDK.AgenticSearchRequest} request
72
+ * @param {Search.RequestOptions} requestOptions - Request-specific configuration.
73
+ *
74
+ * @throws {@link AirweaveSDK.UnprocessableEntityError}
75
+ *
76
+ * @example
77
+ * await client.collections.search.agentic("customer-support-tickets-x7k9m", {
78
+ * query: "find all deployment-related docs from last month",
79
+ * thinking: true
80
+ * })
81
+ */
82
+ agentic(readableId: string, request: AirweaveSDK.AgenticSearchRequest, requestOptions?: Search.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SearchV2Response>;
83
+ private __agentic;
84
+ /**
85
+ * Streaming agentic search via Server-Sent Events. Returns real-time events as the agent searches.
86
+ */
87
+ streamAgentic(readableId: string, request: AirweaveSDK.AgenticSearchRequest, requestOptions?: Search.RequestOptions): core.HttpResponsePromise<core.Stream<AirweaveSDK.AgenticSearchEvent>>;
88
+ private __streamAgentic;
89
+ protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
90
+ }