@airweave/sdk 0.3.43 → 0.3.44
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/collections/client/Client.d.ts +33 -0
- package/dist/cjs/api/resources/collections/client/Client.js +96 -1
- package/dist/cjs/api/resources/collections/client/requests/SearchCollectionCollectionsReadableIdSearchGetRequest.d.ts +16 -0
- package/dist/cjs/api/resources/collections/client/requests/SearchRequest.d.ts +36 -0
- package/dist/cjs/api/resources/collections/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/whiteLabels/client/Client.d.ts +7 -7
- package/dist/cjs/api/resources/whiteLabels/client/Client.js +9 -9
- package/dist/cjs/api/resources/whiteLabels/client/requests/{BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodePost.d.ts → BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions.d.ts} +1 -1
- package/dist/cjs/api/resources/whiteLabels/client/requests/BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions.js +5 -0
- package/dist/cjs/api/resources/whiteLabels/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/types/DatetimeRange.d.ts +34 -0
- package/dist/cjs/api/types/DatetimeRange.js +5 -0
- package/dist/cjs/api/types/FieldCondition.d.ts +33 -0
- package/dist/cjs/api/types/FieldCondition.js +5 -0
- package/dist/cjs/api/types/Filter.d.ts +28 -0
- package/dist/cjs/api/types/Filter.js +5 -0
- package/dist/cjs/api/types/GeoBoundingBox.d.ts +13 -0
- package/dist/cjs/api/types/GeoBoundingBox.js +5 -0
- package/dist/cjs/api/types/GeoLineString.d.ts +11 -0
- package/dist/cjs/api/types/GeoLineString.js +5 -0
- package/dist/cjs/api/types/GeoPoint.d.ts +12 -0
- package/dist/cjs/api/types/GeoPoint.js +5 -0
- package/dist/cjs/api/types/GeoPolygon.d.ts +13 -0
- package/dist/cjs/api/types/GeoPolygon.js +5 -0
- package/dist/cjs/api/types/GeoRadius.d.ts +13 -0
- package/dist/cjs/api/types/GeoRadius.js +5 -0
- package/dist/cjs/api/types/HasIdCondition.d.ts +16 -0
- package/dist/cjs/api/types/HasIdCondition.js +5 -0
- package/dist/cjs/api/types/HasVectorCondition.d.ts +10 -0
- package/dist/cjs/api/types/HasVectorCondition.js +5 -0
- package/dist/cjs/api/types/IsEmptyCondition.d.ts +11 -0
- package/dist/cjs/api/types/IsEmptyCondition.js +5 -0
- package/dist/cjs/api/types/IsNullCondition.d.ts +11 -0
- package/dist/cjs/api/types/IsNullCondition.js +5 -0
- package/dist/cjs/api/types/MatchAny.d.ts +16 -0
- package/dist/cjs/api/types/MatchAny.js +5 -0
- package/dist/cjs/api/types/MatchExcept.d.ts +16 -0
- package/dist/cjs/api/types/MatchExcept.js +5 -0
- package/dist/cjs/api/types/MatchText.d.ts +10 -0
- package/dist/cjs/api/types/MatchText.js +5 -0
- package/dist/cjs/api/types/MatchValue.d.ts +16 -0
- package/dist/cjs/api/types/MatchValue.js +5 -0
- package/dist/cjs/api/types/MinShould.d.ts +16 -0
- package/dist/cjs/api/types/MinShould.js +5 -0
- package/dist/cjs/api/types/Nested.d.ts +13 -0
- package/dist/cjs/api/types/Nested.js +5 -0
- package/dist/cjs/api/types/NestedCondition.d.ts +8 -0
- package/dist/cjs/api/types/NestedCondition.js +5 -0
- package/dist/cjs/api/types/PayloadField.d.ts +10 -0
- package/dist/cjs/api/types/PayloadField.js +5 -0
- package/dist/cjs/api/types/QueryExpansionStrategy.d.ts +12 -0
- package/dist/cjs/api/types/QueryExpansionStrategy.js +11 -0
- package/dist/cjs/api/types/Range.d.ts +16 -0
- package/dist/cjs/api/types/Range.js +5 -0
- package/dist/cjs/api/types/ValuesCount.d.ts +16 -0
- package/dist/cjs/api/types/ValuesCount.js +5 -0
- package/dist/cjs/api/types/index.d.ts +23 -0
- package/dist/cjs/api/types/index.js +23 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/collections/client/Client.d.mts +33 -0
- package/dist/esm/api/resources/collections/client/Client.mjs +96 -1
- package/dist/esm/api/resources/collections/client/requests/SearchCollectionCollectionsReadableIdSearchGetRequest.d.mts +16 -0
- package/dist/esm/api/resources/collections/client/requests/SearchRequest.d.mts +36 -0
- package/dist/esm/api/resources/collections/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/whiteLabels/client/Client.d.mts +7 -7
- package/dist/esm/api/resources/whiteLabels/client/Client.mjs +9 -9
- package/dist/esm/api/resources/whiteLabels/client/requests/{BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodePost.d.mts → BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions.d.mts} +1 -1
- package/dist/esm/api/resources/whiteLabels/client/requests/BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions.mjs +4 -0
- package/dist/esm/api/resources/whiteLabels/client/requests/index.d.mts +1 -1
- package/dist/esm/api/types/DatetimeRange.d.mts +34 -0
- package/dist/esm/api/types/DatetimeRange.mjs +4 -0
- package/dist/esm/api/types/FieldCondition.d.mts +33 -0
- package/dist/esm/api/types/FieldCondition.mjs +4 -0
- package/dist/esm/api/types/Filter.d.mts +28 -0
- package/dist/esm/api/types/Filter.mjs +4 -0
- package/dist/esm/api/types/GeoBoundingBox.d.mts +13 -0
- package/dist/esm/api/types/GeoBoundingBox.mjs +4 -0
- package/dist/esm/api/types/GeoLineString.d.mts +11 -0
- package/dist/esm/api/types/GeoLineString.mjs +4 -0
- package/dist/esm/api/types/GeoPoint.d.mts +12 -0
- package/dist/esm/api/types/GeoPoint.mjs +4 -0
- package/dist/esm/api/types/GeoPolygon.d.mts +13 -0
- package/dist/esm/api/types/GeoPolygon.mjs +4 -0
- package/dist/esm/api/types/GeoRadius.d.mts +13 -0
- package/dist/esm/api/types/GeoRadius.mjs +4 -0
- package/dist/esm/api/types/HasIdCondition.d.mts +16 -0
- package/dist/esm/api/types/HasIdCondition.mjs +4 -0
- package/dist/esm/api/types/HasVectorCondition.d.mts +10 -0
- package/dist/esm/api/types/HasVectorCondition.mjs +4 -0
- package/dist/esm/api/types/IsEmptyCondition.d.mts +11 -0
- package/dist/esm/api/types/IsEmptyCondition.mjs +4 -0
- package/dist/esm/api/types/IsNullCondition.d.mts +11 -0
- package/dist/esm/api/types/IsNullCondition.mjs +4 -0
- package/dist/esm/api/types/MatchAny.d.mts +16 -0
- package/dist/esm/api/types/MatchAny.mjs +4 -0
- package/dist/esm/api/types/MatchExcept.d.mts +16 -0
- package/dist/esm/api/types/MatchExcept.mjs +4 -0
- package/dist/esm/api/types/MatchText.d.mts +10 -0
- package/dist/esm/api/types/MatchText.mjs +4 -0
- package/dist/esm/api/types/MatchValue.d.mts +16 -0
- package/dist/esm/api/types/MatchValue.mjs +4 -0
- package/dist/esm/api/types/MinShould.d.mts +16 -0
- package/dist/esm/api/types/MinShould.mjs +4 -0
- package/dist/esm/api/types/Nested.d.mts +13 -0
- package/dist/esm/api/types/Nested.mjs +4 -0
- package/dist/esm/api/types/NestedCondition.d.mts +8 -0
- package/dist/esm/api/types/NestedCondition.mjs +4 -0
- package/dist/esm/api/types/PayloadField.d.mts +10 -0
- package/dist/esm/api/types/PayloadField.mjs +4 -0
- package/dist/esm/api/types/QueryExpansionStrategy.d.mts +12 -0
- package/dist/esm/api/types/QueryExpansionStrategy.mjs +8 -0
- package/dist/esm/api/types/Range.d.mts +16 -0
- package/dist/esm/api/types/Range.mjs +4 -0
- package/dist/esm/api/types/ValuesCount.d.mts +16 -0
- package/dist/esm/api/types/ValuesCount.mjs +4 -0
- package/dist/esm/api/types/index.d.mts +23 -0
- package/dist/esm/api/types/index.mjs +23 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +95 -5
- /package/dist/cjs/api/resources/{whiteLabels/client/requests/BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodePost.js → collections/client/requests/SearchRequest.js} +0 -0
- /package/dist/esm/api/resources/{whiteLabels/client/requests/BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodePost.mjs → collections/client/requests/SearchRequest.mjs} +0 -0
package/dist/cjs/Client.js
CHANGED
|
@@ -50,8 +50,8 @@ class AirweaveSDKClient {
|
|
|
50
50
|
"X-Organization-ID": _options === null || _options === void 0 ? void 0 : _options.organizationId,
|
|
51
51
|
"X-Fern-Language": "JavaScript",
|
|
52
52
|
"X-Fern-SDK-Name": "@airweave/sdk",
|
|
53
|
-
"X-Fern-SDK-Version": "v0.3.
|
|
54
|
-
"User-Agent": "@airweave/sdk/v0.3.
|
|
53
|
+
"X-Fern-SDK-Version": "v0.3.44",
|
|
54
|
+
"User-Agent": "@airweave/sdk/v0.3.44",
|
|
55
55
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
56
56
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
57
57
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -127,6 +127,9 @@ export declare class Collections {
|
|
|
127
127
|
/**
|
|
128
128
|
* Search across all data sources within the specified collection.
|
|
129
129
|
*
|
|
130
|
+
* This GET endpoint provides basic search functionality. For advanced filtering
|
|
131
|
+
* and options, use the POST /search endpoint.
|
|
132
|
+
*
|
|
130
133
|
* @param {string} readableId - The unique readable identifier of the collection to search
|
|
131
134
|
* @param {AirweaveSDK.SearchCollectionCollectionsReadableIdSearchGetRequest} request
|
|
132
135
|
* @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -140,6 +143,36 @@ export declare class Collections {
|
|
|
140
143
|
*/
|
|
141
144
|
searchCollection(readableId: string, request: AirweaveSDK.SearchCollectionCollectionsReadableIdSearchGetRequest, requestOptions?: Collections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SearchResponse>;
|
|
142
145
|
private __searchCollection;
|
|
146
|
+
/**
|
|
147
|
+
* Advanced search with comprehensive filtering and options.
|
|
148
|
+
*
|
|
149
|
+
* This endpoint supports:
|
|
150
|
+
* - Metadata filtering using Qdrant's native filter syntax
|
|
151
|
+
* - Pagination with offset and limit
|
|
152
|
+
* - Score threshold filtering
|
|
153
|
+
* - Query expansion strategies
|
|
154
|
+
*
|
|
155
|
+
* @param {string} readableId - The unique readable identifier of the collection to search
|
|
156
|
+
* @param {AirweaveSDK.SearchRequest} request
|
|
157
|
+
* @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
|
|
158
|
+
*
|
|
159
|
+
* @throws {@link AirweaveSDK.UnprocessableEntityError}
|
|
160
|
+
*
|
|
161
|
+
* @example
|
|
162
|
+
* await client.collections.searchCollectionAdvanced("readable_id", {
|
|
163
|
+
* query: "customer payment issues",
|
|
164
|
+
* filter: {
|
|
165
|
+
* must: {
|
|
166
|
+
* key: "key"
|
|
167
|
+
* }
|
|
168
|
+
* },
|
|
169
|
+
* limit: 50,
|
|
170
|
+
* score_threshold: 0.7,
|
|
171
|
+
* response_type: "completion"
|
|
172
|
+
* })
|
|
173
|
+
*/
|
|
174
|
+
searchCollectionAdvanced(readableId: string, request: AirweaveSDK.SearchRequest, requestOptions?: Collections.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SearchResponse>;
|
|
175
|
+
private __searchCollectionAdvanced;
|
|
143
176
|
/**
|
|
144
177
|
* Trigger data synchronization for all source connections in the collection.
|
|
145
178
|
*
|
|
@@ -404,6 +404,9 @@ class Collections {
|
|
|
404
404
|
/**
|
|
405
405
|
* Search across all data sources within the specified collection.
|
|
406
406
|
*
|
|
407
|
+
* This GET endpoint provides basic search functionality. For advanced filtering
|
|
408
|
+
* and options, use the POST /search endpoint.
|
|
409
|
+
*
|
|
407
410
|
* @param {string} readableId - The unique readable identifier of the collection to search
|
|
408
411
|
* @param {AirweaveSDK.SearchCollectionCollectionsReadableIdSearchGetRequest} request
|
|
409
412
|
* @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -421,12 +424,24 @@ class Collections {
|
|
|
421
424
|
__searchCollection(readableId, request, requestOptions) {
|
|
422
425
|
return __awaiter(this, void 0, void 0, function* () {
|
|
423
426
|
var _a, _b, _c;
|
|
424
|
-
const { query, response_type: responseType } = request;
|
|
427
|
+
const { query, response_type: responseType, limit, offset, score_threshold: scoreThreshold, expansion_strategy: expansionStrategy, } = request;
|
|
425
428
|
const _queryParams = {};
|
|
426
429
|
_queryParams["query"] = query;
|
|
427
430
|
if (responseType != null) {
|
|
428
431
|
_queryParams["response_type"] = responseType;
|
|
429
432
|
}
|
|
433
|
+
if (limit != null) {
|
|
434
|
+
_queryParams["limit"] = limit.toString();
|
|
435
|
+
}
|
|
436
|
+
if (offset != null) {
|
|
437
|
+
_queryParams["offset"] = offset.toString();
|
|
438
|
+
}
|
|
439
|
+
if (scoreThreshold != null) {
|
|
440
|
+
_queryParams["score_threshold"] = scoreThreshold.toString();
|
|
441
|
+
}
|
|
442
|
+
if (expansionStrategy != null) {
|
|
443
|
+
_queryParams["expansion_strategy"] = expansionStrategy;
|
|
444
|
+
}
|
|
430
445
|
const _response = yield core.fetcher({
|
|
431
446
|
url: core.url.join((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.AirweaveSDKEnvironment.Production, `collections/${encodeURIComponent(readableId)}/search`),
|
|
432
447
|
method: "GET",
|
|
@@ -471,6 +486,86 @@ class Collections {
|
|
|
471
486
|
}
|
|
472
487
|
});
|
|
473
488
|
}
|
|
489
|
+
/**
|
|
490
|
+
* Advanced search with comprehensive filtering and options.
|
|
491
|
+
*
|
|
492
|
+
* This endpoint supports:
|
|
493
|
+
* - Metadata filtering using Qdrant's native filter syntax
|
|
494
|
+
* - Pagination with offset and limit
|
|
495
|
+
* - Score threshold filtering
|
|
496
|
+
* - Query expansion strategies
|
|
497
|
+
*
|
|
498
|
+
* @param {string} readableId - The unique readable identifier of the collection to search
|
|
499
|
+
* @param {AirweaveSDK.SearchRequest} request
|
|
500
|
+
* @param {Collections.RequestOptions} requestOptions - Request-specific configuration.
|
|
501
|
+
*
|
|
502
|
+
* @throws {@link AirweaveSDK.UnprocessableEntityError}
|
|
503
|
+
*
|
|
504
|
+
* @example
|
|
505
|
+
* await client.collections.searchCollectionAdvanced("readable_id", {
|
|
506
|
+
* query: "customer payment issues",
|
|
507
|
+
* filter: {
|
|
508
|
+
* must: {
|
|
509
|
+
* key: "key"
|
|
510
|
+
* }
|
|
511
|
+
* },
|
|
512
|
+
* limit: 50,
|
|
513
|
+
* score_threshold: 0.7,
|
|
514
|
+
* response_type: "completion"
|
|
515
|
+
* })
|
|
516
|
+
*/
|
|
517
|
+
searchCollectionAdvanced(readableId, request, requestOptions) {
|
|
518
|
+
return core.HttpResponsePromise.fromPromise(this.__searchCollectionAdvanced(readableId, request, requestOptions));
|
|
519
|
+
}
|
|
520
|
+
__searchCollectionAdvanced(readableId, request, requestOptions) {
|
|
521
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
522
|
+
var _a, _b, _c;
|
|
523
|
+
const _response = yield core.fetcher({
|
|
524
|
+
url: core.url.join((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.AirweaveSDKEnvironment.Production, `collections/${encodeURIComponent(readableId)}/search`),
|
|
525
|
+
method: "POST",
|
|
526
|
+
headers: (0, headers_js_1.mergeHeaders)((_c = this._options) === null || _c === void 0 ? void 0 : _c.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
|
|
527
|
+
"X-API-Key": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.apiKey,
|
|
528
|
+
"X-Organization-ID": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationId,
|
|
529
|
+
}), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
530
|
+
contentType: "application/json",
|
|
531
|
+
requestType: "json",
|
|
532
|
+
body: request,
|
|
533
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
534
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
535
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
536
|
+
});
|
|
537
|
+
if (_response.ok) {
|
|
538
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
539
|
+
}
|
|
540
|
+
if (_response.error.reason === "status-code") {
|
|
541
|
+
switch (_response.error.statusCode) {
|
|
542
|
+
case 422:
|
|
543
|
+
throw new AirweaveSDK.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
544
|
+
default:
|
|
545
|
+
throw new errors.AirweaveSDKError({
|
|
546
|
+
statusCode: _response.error.statusCode,
|
|
547
|
+
body: _response.error.body,
|
|
548
|
+
rawResponse: _response.rawResponse,
|
|
549
|
+
});
|
|
550
|
+
}
|
|
551
|
+
}
|
|
552
|
+
switch (_response.error.reason) {
|
|
553
|
+
case "non-json":
|
|
554
|
+
throw new errors.AirweaveSDKError({
|
|
555
|
+
statusCode: _response.error.statusCode,
|
|
556
|
+
body: _response.error.rawBody,
|
|
557
|
+
rawResponse: _response.rawResponse,
|
|
558
|
+
});
|
|
559
|
+
case "timeout":
|
|
560
|
+
throw new errors.AirweaveSDKTimeoutError("Timeout exceeded when calling POST /collections/{readable_id}/search.");
|
|
561
|
+
case "unknown":
|
|
562
|
+
throw new errors.AirweaveSDKError({
|
|
563
|
+
message: _response.error.errorMessage,
|
|
564
|
+
rawResponse: _response.rawResponse,
|
|
565
|
+
});
|
|
566
|
+
}
|
|
567
|
+
});
|
|
568
|
+
}
|
|
474
569
|
/**
|
|
475
570
|
* Trigger data synchronization for all source connections in the collection.
|
|
476
571
|
*
|
|
@@ -17,4 +17,20 @@ export interface SearchCollectionCollectionsReadableIdSearchGetRequest {
|
|
|
17
17
|
* Format of the response: 'raw' returns search results, 'completion' returns AI-generated answers
|
|
18
18
|
*/
|
|
19
19
|
response_type?: AirweaveSDK.ResponseType;
|
|
20
|
+
/**
|
|
21
|
+
* Maximum number of results to return
|
|
22
|
+
*/
|
|
23
|
+
limit?: number;
|
|
24
|
+
/**
|
|
25
|
+
* Number of results to skip for pagination
|
|
26
|
+
*/
|
|
27
|
+
offset?: number;
|
|
28
|
+
/**
|
|
29
|
+
* Minimum similarity score threshold
|
|
30
|
+
*/
|
|
31
|
+
score_threshold?: number;
|
|
32
|
+
/**
|
|
33
|
+
* Query expansion strategy (auto, llm, or no_expansion)
|
|
34
|
+
*/
|
|
35
|
+
expansion_strategy?: AirweaveSDK.QueryExpansionStrategy;
|
|
20
36
|
}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as AirweaveSDK from "../../../../index.js";
|
|
5
|
+
/**
|
|
6
|
+
* @example
|
|
7
|
+
* {
|
|
8
|
+
* query: "customer payment issues",
|
|
9
|
+
* filter: {
|
|
10
|
+
* must: {
|
|
11
|
+
* key: "key"
|
|
12
|
+
* }
|
|
13
|
+
* },
|
|
14
|
+
* limit: 50,
|
|
15
|
+
* score_threshold: 0.7,
|
|
16
|
+
* response_type: "completion"
|
|
17
|
+
* }
|
|
18
|
+
*/
|
|
19
|
+
export interface SearchRequest {
|
|
20
|
+
/** The search query text */
|
|
21
|
+
query: string;
|
|
22
|
+
/** Qdrant native filter for metadata-based filtering */
|
|
23
|
+
filter?: AirweaveSDK.Filter;
|
|
24
|
+
/** Number of results to skip */
|
|
25
|
+
offset?: number;
|
|
26
|
+
/** Maximum number of results to return */
|
|
27
|
+
limit?: number;
|
|
28
|
+
/** Minimum similarity score threshold */
|
|
29
|
+
score_threshold?: number;
|
|
30
|
+
/** Whether to summarize results */
|
|
31
|
+
summarize?: boolean;
|
|
32
|
+
/** Type of response (raw or completion) */
|
|
33
|
+
response_type?: AirweaveSDK.ResponseType;
|
|
34
|
+
/** Query expansion strategy. Enhances recall by expanding the query with synonyms, related terms, and other variations, but increases latency. */
|
|
35
|
+
expansion_strategy?: AirweaveSDK.QueryExpansionStrategy;
|
|
36
|
+
}
|
|
@@ -3,3 +3,4 @@ export { type CollectionCreate } from "./CollectionCreate.js";
|
|
|
3
3
|
export { type CollectionUpdate } from "./CollectionUpdate.js";
|
|
4
4
|
export { type DeleteCollectionCollectionsReadableIdDeleteRequest } from "./DeleteCollectionCollectionsReadableIdDeleteRequest.js";
|
|
5
5
|
export { type SearchCollectionCollectionsReadableIdSearchGetRequest } from "./SearchCollectionCollectionsReadableIdSearchGetRequest.js";
|
|
6
|
+
export { type SearchRequest } from "./SearchRequest.js";
|
|
@@ -147,10 +147,10 @@ export declare class WhiteLabels {
|
|
|
147
147
|
* @throws {@link AirweaveSDK.UnprocessableEntityError}
|
|
148
148
|
*
|
|
149
149
|
* @example
|
|
150
|
-
* await client.whiteLabels.
|
|
150
|
+
* await client.whiteLabels.getWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlOptions("white_label_id")
|
|
151
151
|
*/
|
|
152
|
-
|
|
153
|
-
private
|
|
152
|
+
getWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlOptions(whiteLabelId: string, requestOptions?: WhiteLabels.RequestOptions): core.HttpResponsePromise<string>;
|
|
153
|
+
private __getWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlOptions;
|
|
154
154
|
/**
|
|
155
155
|
* List all source connections created through a specific white label integration.
|
|
156
156
|
*
|
|
@@ -178,16 +178,16 @@ export declare class WhiteLabels {
|
|
|
178
178
|
* tracking and branding purposes.
|
|
179
179
|
*
|
|
180
180
|
* @param {string} whiteLabelId - The unique identifier of the white label integration
|
|
181
|
-
* @param {AirweaveSDK.
|
|
181
|
+
* @param {AirweaveSDK.BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions} request
|
|
182
182
|
* @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
|
|
183
183
|
*
|
|
184
184
|
* @throws {@link AirweaveSDK.UnprocessableEntityError}
|
|
185
185
|
*
|
|
186
186
|
* @example
|
|
187
|
-
* await client.whiteLabels.
|
|
187
|
+
* await client.whiteLabels.exchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions("white_label_id", {
|
|
188
188
|
* code: "4/P7q7W91a-oMsCeLvIaQm6bTrgtp7"
|
|
189
189
|
* })
|
|
190
190
|
*/
|
|
191
|
-
|
|
192
|
-
private
|
|
191
|
+
exchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions(whiteLabelId: string, request: AirweaveSDK.BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions, requestOptions?: WhiteLabels.RequestOptions): core.HttpResponsePromise<AirweaveSDK.SourceConnection>;
|
|
192
|
+
private __exchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions;
|
|
193
193
|
}
|
|
@@ -409,12 +409,12 @@ class WhiteLabels {
|
|
|
409
409
|
* @throws {@link AirweaveSDK.UnprocessableEntityError}
|
|
410
410
|
*
|
|
411
411
|
* @example
|
|
412
|
-
* await client.whiteLabels.
|
|
412
|
+
* await client.whiteLabels.getWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlOptions("white_label_id")
|
|
413
413
|
*/
|
|
414
|
-
|
|
415
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
414
|
+
getWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlOptions(whiteLabelId, requestOptions) {
|
|
415
|
+
return core.HttpResponsePromise.fromPromise(this.__getWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlOptions(whiteLabelId, requestOptions));
|
|
416
416
|
}
|
|
417
|
-
|
|
417
|
+
__getWhiteLabelOauth2AuthUrlWhiteLabelsWhiteLabelIdOauth2AuthUrlOptions(whiteLabelId, requestOptions) {
|
|
418
418
|
return __awaiter(this, void 0, void 0, function* () {
|
|
419
419
|
var _a, _b, _c;
|
|
420
420
|
const _response = yield core.fetcher({
|
|
@@ -537,20 +537,20 @@ class WhiteLabels {
|
|
|
537
537
|
* tracking and branding purposes.
|
|
538
538
|
*
|
|
539
539
|
* @param {string} whiteLabelId - The unique identifier of the white label integration
|
|
540
|
-
* @param {AirweaveSDK.
|
|
540
|
+
* @param {AirweaveSDK.BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions} request
|
|
541
541
|
* @param {WhiteLabels.RequestOptions} requestOptions - Request-specific configuration.
|
|
542
542
|
*
|
|
543
543
|
* @throws {@link AirweaveSDK.UnprocessableEntityError}
|
|
544
544
|
*
|
|
545
545
|
* @example
|
|
546
|
-
* await client.whiteLabels.
|
|
546
|
+
* await client.whiteLabels.exchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions("white_label_id", {
|
|
547
547
|
* code: "4/P7q7W91a-oMsCeLvIaQm6bTrgtp7"
|
|
548
548
|
* })
|
|
549
549
|
*/
|
|
550
|
-
|
|
551
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
550
|
+
exchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions(whiteLabelId, request, requestOptions) {
|
|
551
|
+
return core.HttpResponsePromise.fromPromise(this.__exchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions(whiteLabelId, request, requestOptions));
|
|
552
552
|
}
|
|
553
|
-
|
|
553
|
+
__exchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions(whiteLabelId, request, requestOptions) {
|
|
554
554
|
return __awaiter(this, void 0, void 0, function* () {
|
|
555
555
|
var _a, _b, _c;
|
|
556
556
|
const _response = yield core.fetcher({
|
|
@@ -8,7 +8,7 @@ import * as AirweaveSDK from "../../../../index.js";
|
|
|
8
8
|
* code: "4/P7q7W91a-oMsCeLvIaQm6bTrgtp7"
|
|
9
9
|
* }
|
|
10
10
|
*/
|
|
11
|
-
export interface
|
|
11
|
+
export interface BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions {
|
|
12
12
|
/** The OAuth2 authorization code received from the OAuth callback after customer authentication */
|
|
13
13
|
code: string;
|
|
14
14
|
/** Optional configuration for the source connection. If not provided, a source connection will be created automatically with default settings. The white label integration is automatically linked to the source connection. */
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
export { type WhiteLabelCreate } from "./WhiteLabelCreate.js";
|
|
2
2
|
export { type WhiteLabelUpdate } from "./WhiteLabelUpdate.js";
|
|
3
|
-
export { type
|
|
3
|
+
export { type BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions } from "./BodyExchangeWhiteLabelOauth2CodeWhiteLabelsWhiteLabelIdOauth2CodeOptions.js";
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Range filter request
|
|
6
|
+
*/
|
|
7
|
+
export interface DatetimeRange {
|
|
8
|
+
/** point.key < range.lt */
|
|
9
|
+
lt?: DatetimeRange.Lt;
|
|
10
|
+
/** point.key > range.gt */
|
|
11
|
+
gt?: DatetimeRange.Gt;
|
|
12
|
+
/** point.key >= range.gte */
|
|
13
|
+
gte?: DatetimeRange.Gte;
|
|
14
|
+
/** point.key <= range.lte */
|
|
15
|
+
lte?: DatetimeRange.Lte;
|
|
16
|
+
}
|
|
17
|
+
export declare namespace DatetimeRange {
|
|
18
|
+
/**
|
|
19
|
+
* point.key < range.lt
|
|
20
|
+
*/
|
|
21
|
+
type Lt = string | string;
|
|
22
|
+
/**
|
|
23
|
+
* point.key > range.gt
|
|
24
|
+
*/
|
|
25
|
+
type Gt = string | string;
|
|
26
|
+
/**
|
|
27
|
+
* point.key >= range.gte
|
|
28
|
+
*/
|
|
29
|
+
type Gte = string | string;
|
|
30
|
+
/**
|
|
31
|
+
* point.key <= range.lte
|
|
32
|
+
*/
|
|
33
|
+
type Lte = string | string;
|
|
34
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as AirweaveSDK from "../index.js";
|
|
5
|
+
/**
|
|
6
|
+
* All possible payload filtering conditions
|
|
7
|
+
*/
|
|
8
|
+
export interface FieldCondition {
|
|
9
|
+
/** Payload key */
|
|
10
|
+
key: string;
|
|
11
|
+
/** Check if point has field with a given value */
|
|
12
|
+
match?: FieldCondition.Match;
|
|
13
|
+
/** Check if points value lies in a given range */
|
|
14
|
+
range?: AirweaveSDK.Range;
|
|
15
|
+
/** Check if points geolocation lies in a given area */
|
|
16
|
+
geo_bounding_box?: AirweaveSDK.GeoBoundingBox;
|
|
17
|
+
/** Check if geo point is within a given radius */
|
|
18
|
+
geo_radius?: AirweaveSDK.GeoRadius;
|
|
19
|
+
/** Check if geo point is within a given polygon */
|
|
20
|
+
geo_polygon?: AirweaveSDK.GeoPolygon;
|
|
21
|
+
/** Check number of values of the field */
|
|
22
|
+
values_count?: AirweaveSDK.ValuesCount;
|
|
23
|
+
/** Check that the field is empty, alternative syntax for `is_empty: \"field_name\"` */
|
|
24
|
+
is_empty?: boolean;
|
|
25
|
+
/** Check that the field is null, alternative syntax for `is_null: \"field_name\"` */
|
|
26
|
+
is_null?: boolean;
|
|
27
|
+
}
|
|
28
|
+
export declare namespace FieldCondition {
|
|
29
|
+
/**
|
|
30
|
+
* Check if point has field with a given value
|
|
31
|
+
*/
|
|
32
|
+
type Match = AirweaveSDK.MatchValue | AirweaveSDK.MatchText | AirweaveSDK.MatchAny | AirweaveSDK.MatchExcept;
|
|
33
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as AirweaveSDK from "../index.js";
|
|
5
|
+
export interface Filter {
|
|
6
|
+
/** At least one of those conditions should match */
|
|
7
|
+
should?: Filter.Should;
|
|
8
|
+
/** At least minimum amount of given conditions should match */
|
|
9
|
+
min_should?: AirweaveSDK.MinShould;
|
|
10
|
+
/** All conditions must match */
|
|
11
|
+
must?: Filter.Must;
|
|
12
|
+
/** All conditions must NOT match */
|
|
13
|
+
must_not?: Filter.MustNot;
|
|
14
|
+
}
|
|
15
|
+
export declare namespace Filter {
|
|
16
|
+
/**
|
|
17
|
+
* At least one of those conditions should match
|
|
18
|
+
*/
|
|
19
|
+
type Should = (AirweaveSDK.FieldCondition | AirweaveSDK.IsEmptyCondition | AirweaveSDK.IsNullCondition | AirweaveSDK.HasIdCondition | AirweaveSDK.HasVectorCondition | AirweaveSDK.NestedCondition | AirweaveSDK.Filter)[] | AirweaveSDK.FieldCondition | AirweaveSDK.IsEmptyCondition | AirweaveSDK.IsNullCondition | AirweaveSDK.HasIdCondition | AirweaveSDK.HasVectorCondition | AirweaveSDK.NestedCondition | AirweaveSDK.Filter;
|
|
20
|
+
/**
|
|
21
|
+
* All conditions must match
|
|
22
|
+
*/
|
|
23
|
+
type Must = (AirweaveSDK.FieldCondition | AirweaveSDK.IsEmptyCondition | AirweaveSDK.IsNullCondition | AirweaveSDK.HasIdCondition | AirweaveSDK.HasVectorCondition | AirweaveSDK.NestedCondition | AirweaveSDK.Filter)[] | AirweaveSDK.FieldCondition | AirweaveSDK.IsEmptyCondition | AirweaveSDK.IsNullCondition | AirweaveSDK.HasIdCondition | AirweaveSDK.HasVectorCondition | AirweaveSDK.NestedCondition | AirweaveSDK.Filter;
|
|
24
|
+
/**
|
|
25
|
+
* All conditions must NOT match
|
|
26
|
+
*/
|
|
27
|
+
type MustNot = (AirweaveSDK.FieldCondition | AirweaveSDK.IsEmptyCondition | AirweaveSDK.IsNullCondition | AirweaveSDK.HasIdCondition | AirweaveSDK.HasVectorCondition | AirweaveSDK.NestedCondition | AirweaveSDK.Filter)[] | AirweaveSDK.FieldCondition | AirweaveSDK.IsEmptyCondition | AirweaveSDK.IsNullCondition | AirweaveSDK.HasIdCondition | AirweaveSDK.HasVectorCondition | AirweaveSDK.NestedCondition | AirweaveSDK.Filter;
|
|
28
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as AirweaveSDK from "../index.js";
|
|
5
|
+
/**
|
|
6
|
+
* Geo filter request Matches coordinates inside the rectangle, described by coordinates of lop-left and bottom-right edges
|
|
7
|
+
*/
|
|
8
|
+
export interface GeoBoundingBox {
|
|
9
|
+
/** Geo filter request Matches coordinates inside the rectangle, described by coordinates of lop-left and bottom-right edges */
|
|
10
|
+
top_left: AirweaveSDK.GeoPoint;
|
|
11
|
+
/** Geo filter request Matches coordinates inside the rectangle, described by coordinates of lop-left and bottom-right edges */
|
|
12
|
+
bottom_right: AirweaveSDK.GeoPoint;
|
|
13
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as AirweaveSDK from "../index.js";
|
|
5
|
+
/**
|
|
6
|
+
* Ordered sequence of GeoPoints representing the line
|
|
7
|
+
*/
|
|
8
|
+
export interface GeoLineString {
|
|
9
|
+
/** Ordered sequence of GeoPoints representing the line */
|
|
10
|
+
points: AirweaveSDK.GeoPoint[];
|
|
11
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as AirweaveSDK from "../index.js";
|
|
5
|
+
/**
|
|
6
|
+
* Geo filter request Matches coordinates inside the polygon, defined by `exterior` and `interiors`
|
|
7
|
+
*/
|
|
8
|
+
export interface GeoPolygon {
|
|
9
|
+
/** Geo filter request Matches coordinates inside the polygon, defined by `exterior` and `interiors` */
|
|
10
|
+
exterior: AirweaveSDK.GeoLineString;
|
|
11
|
+
/** Interior lines (if present) bound holes within the surface each GeoLineString must consist of a minimum of 4 points, and the first and last points must be the same. */
|
|
12
|
+
interiors?: AirweaveSDK.GeoLineString[];
|
|
13
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as AirweaveSDK from "../index.js";
|
|
5
|
+
/**
|
|
6
|
+
* Geo filter request Matches coordinates inside the circle of `radius` and center with coordinates `center`
|
|
7
|
+
*/
|
|
8
|
+
export interface GeoRadius {
|
|
9
|
+
/** Geo filter request Matches coordinates inside the circle of `radius` and center with coordinates `center` */
|
|
10
|
+
center: AirweaveSDK.GeoPoint;
|
|
11
|
+
/** Radius of the area in meters */
|
|
12
|
+
radius: number;
|
|
13
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* ID-based filtering condition
|
|
6
|
+
*/
|
|
7
|
+
export interface HasIdCondition {
|
|
8
|
+
/** ID-based filtering condition */
|
|
9
|
+
has_id: HasIdCondition.HasId.Item[];
|
|
10
|
+
}
|
|
11
|
+
export declare namespace HasIdCondition {
|
|
12
|
+
type HasId = HasId.Item[];
|
|
13
|
+
namespace HasId {
|
|
14
|
+
type Item = number | string;
|
|
15
|
+
}
|
|
16
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Filter points which have specific vector assigned
|
|
6
|
+
*/
|
|
7
|
+
export interface HasVectorCondition {
|
|
8
|
+
/** Filter points which have specific vector assigned */
|
|
9
|
+
has_vector: string;
|
|
10
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as AirweaveSDK from "../index.js";
|
|
5
|
+
/**
|
|
6
|
+
* Select points with empty payload for a specified field
|
|
7
|
+
*/
|
|
8
|
+
export interface IsEmptyCondition {
|
|
9
|
+
/** Select points with empty payload for a specified field */
|
|
10
|
+
is_empty: AirweaveSDK.PayloadField;
|
|
11
|
+
}
|