@airweave/sdk 0.9.39 → 0.9.41
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/index.d.ts +1 -1
- package/dist/cjs/api/index.js +1 -1
- package/dist/cjs/api/resources/collections/client/Client.d.ts +0 -63
- package/dist/cjs/api/resources/collections/client/Client.js +0 -181
- package/dist/cjs/api/resources/collections/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/collections/index.d.ts +0 -1
- package/dist/cjs/api/resources/collections/index.js +0 -1
- package/dist/cjs/api/resources/index.d.ts +1 -2
- package/dist/cjs/api/resources/index.js +2 -3
- package/dist/cjs/api/types/AgenticSearchRequest.d.ts +7 -7
- package/dist/cjs/api/types/ClassicSearchRequest.d.ts +17 -0
- package/dist/cjs/api/types/EventType.d.ts +7 -1
- package/dist/cjs/api/types/EventType.js +6 -0
- package/dist/cjs/api/types/FeatureFlag.d.ts +1 -2
- package/dist/cjs/api/types/FeatureFlag.js +0 -1
- package/dist/cjs/api/types/{AgenticSearchFilterCondition.d.ts → FilterCondition.d.ts} +8 -8
- package/dist/cjs/api/types/{AgenticSearchFilterGroup.d.ts → FilterGroup.d.ts} +2 -2
- package/dist/cjs/api/types/{AgenticSearchFilterOperator.d.ts → FilterOperator.d.ts} +2 -2
- package/dist/cjs/api/types/{AgenticSearchFilterOperator.js → FilterOperator.js} +2 -2
- package/dist/{esm/api/types/AgenticSearchFilterableField.d.mts → cjs/api/types/FilterableField.d.ts} +3 -3
- package/dist/cjs/api/types/{AgenticSearchFilterableField.js → FilterableField.js} +2 -2
- package/dist/cjs/api/types/InstantSearchRequest.d.ts +19 -0
- package/dist/cjs/api/types/InternalAgenticSearchRequest.d.ts +19 -0
- package/dist/cjs/api/types/{AgenticSearchAccessControl.d.ts → SearchAccessControl.d.ts} +2 -2
- package/dist/{esm/api/types/AgenticSearchBreadcrumb.d.mts → cjs/api/types/SearchBreadcrumb.d.ts} +2 -2
- package/dist/cjs/api/types/{AgenticSearchResult.d.ts → SearchResult.d.ts} +5 -5
- package/dist/cjs/api/types/{AgenticSearchSystemMetadata.d.ts → SearchSystemMetadata.d.ts} +6 -6
- package/dist/cjs/api/types/SearchV2Response.d.ts +11 -0
- package/dist/cjs/api/types/UsageSnapshot.d.ts +4 -0
- package/dist/cjs/api/types/index.d.ts +13 -18
- package/dist/cjs/api/types/index.js +13 -18
- 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/index.d.mts +1 -1
- package/dist/esm/api/index.mjs +1 -1
- package/dist/esm/api/resources/collections/client/Client.d.mts +0 -63
- package/dist/esm/api/resources/collections/client/Client.mjs +0 -181
- package/dist/esm/api/resources/collections/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/collections/index.d.mts +0 -1
- package/dist/esm/api/resources/collections/index.mjs +0 -1
- package/dist/esm/api/resources/index.d.mts +1 -2
- package/dist/esm/api/resources/index.mjs +1 -2
- package/dist/esm/api/types/AgenticSearchRequest.d.mts +7 -7
- package/dist/esm/api/types/ClassicSearchRequest.d.mts +17 -0
- package/dist/esm/api/types/EventType.d.mts +7 -1
- package/dist/esm/api/types/EventType.mjs +6 -0
- package/dist/esm/api/types/FeatureFlag.d.mts +1 -2
- package/dist/esm/api/types/FeatureFlag.mjs +0 -1
- package/dist/esm/api/types/{AgenticSearchFilterCondition.d.mts → FilterCondition.d.mts} +8 -8
- package/dist/esm/api/types/{AgenticSearchFilterGroup.d.mts → FilterGroup.d.mts} +2 -2
- package/dist/esm/api/types/{AgenticSearchFilterOperator.d.mts → FilterOperator.d.mts} +2 -2
- package/dist/esm/api/types/{AgenticSearchFilterOperator.mjs → FilterOperator.mjs} +1 -1
- package/dist/{cjs/api/types/AgenticSearchFilterableField.d.ts → esm/api/types/FilterableField.d.mts} +3 -3
- package/dist/esm/api/types/{AgenticSearchFilterableField.mjs → FilterableField.mjs} +1 -1
- package/dist/esm/api/types/InstantSearchRequest.d.mts +19 -0
- package/dist/esm/api/types/InternalAgenticSearchRequest.d.mts +19 -0
- package/dist/esm/api/types/{AgenticSearchAccessControl.d.mts → SearchAccessControl.d.mts} +2 -2
- package/dist/{cjs/api/types/AgenticSearchBreadcrumb.d.ts → esm/api/types/SearchBreadcrumb.d.mts} +2 -2
- package/dist/esm/api/types/{AgenticSearchResult.d.mts → SearchResult.d.mts} +5 -5
- package/dist/esm/api/types/{AgenticSearchSystemMetadata.d.mts → SearchSystemMetadata.d.mts} +6 -6
- package/dist/esm/api/types/SearchV2Response.d.mts +11 -0
- package/dist/esm/api/types/UsageSnapshot.d.mts +4 -0
- package/dist/esm/api/types/index.d.mts +13 -18
- package/dist/esm/api/types/index.mjs +13 -18
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +0 -175
- package/dist/cjs/api/resources/collections/client/requests/SearchGetLegacyCollectionsReadableIdSearchGetRequest.d.ts +0 -26
- package/dist/cjs/api/resources/collections/types/SearchCollectionsReadableIdSearchPostRequest.d.ts +0 -5
- package/dist/cjs/api/resources/collections/types/index.d.ts +0 -1
- package/dist/cjs/api/resources/collections/types/index.js +0 -17
- package/dist/cjs/api/types/AgenticSearchAnswer.d.ts +0 -13
- package/dist/cjs/api/types/AgenticSearchCitation.d.ts +0 -10
- package/dist/cjs/api/types/AgenticSearchMode.d.ts +0 -14
- package/dist/cjs/api/types/AgenticSearchMode.js +0 -10
- package/dist/cjs/api/types/AgenticSearchResponse.d.ts +0 -11
- package/dist/cjs/api/types/AgenticSearchSystemMetadata.js +0 -5
- package/dist/cjs/api/types/LegacySearchRequest.d.ts +0 -39
- package/dist/cjs/api/types/LegacySearchRequest.js +0 -14
- package/dist/cjs/api/types/LegacySearchResponse.d.ts +0 -17
- package/dist/cjs/api/types/LegacySearchResponse.js +0 -5
- package/dist/cjs/api/types/QueryExpansionStrategy.d.ts +0 -12
- package/dist/cjs/api/types/QueryExpansionStrategy.js +0 -11
- package/dist/cjs/api/types/ResponseType.d.ts +0 -11
- package/dist/cjs/api/types/ResponseType.js +0 -10
- package/dist/cjs/api/types/SearchStatus.d.ts +0 -12
- package/dist/cjs/api/types/SearchStatus.js +0 -11
- package/dist/esm/api/resources/collections/client/requests/SearchGetLegacyCollectionsReadableIdSearchGetRequest.d.mts +0 -26
- package/dist/esm/api/resources/collections/types/SearchCollectionsReadableIdSearchPostRequest.d.mts +0 -5
- package/dist/esm/api/resources/collections/types/index.d.mts +0 -1
- package/dist/esm/api/resources/collections/types/index.mjs +0 -1
- package/dist/esm/api/types/AgenticSearchAnswer.d.mts +0 -13
- package/dist/esm/api/types/AgenticSearchCitation.d.mts +0 -10
- package/dist/esm/api/types/AgenticSearchMode.d.mts +0 -14
- package/dist/esm/api/types/AgenticSearchMode.mjs +0 -7
- package/dist/esm/api/types/AgenticSearchResponse.d.mts +0 -11
- package/dist/esm/api/types/AgenticSearchSystemMetadata.mjs +0 -4
- package/dist/esm/api/types/LegacySearchRequest.d.mts +0 -39
- package/dist/esm/api/types/LegacySearchRequest.mjs +0 -11
- package/dist/esm/api/types/LegacySearchResponse.d.mts +0 -17
- package/dist/esm/api/types/LegacySearchResponse.mjs +0 -4
- package/dist/esm/api/types/QueryExpansionStrategy.d.mts +0 -12
- package/dist/esm/api/types/QueryExpansionStrategy.mjs +0 -8
- package/dist/esm/api/types/ResponseType.d.mts +0 -11
- package/dist/esm/api/types/ResponseType.mjs +0 -7
- package/dist/esm/api/types/SearchStatus.d.mts +0 -12
- package/dist/esm/api/types/SearchStatus.mjs +0 -8
- /package/dist/cjs/api/{resources/collections/client/requests/SearchGetLegacyCollectionsReadableIdSearchGetRequest.js → types/ClassicSearchRequest.js} +0 -0
- /package/dist/cjs/api/{resources/collections/types/SearchCollectionsReadableIdSearchPostRequest.js → types/FilterCondition.js} +0 -0
- /package/dist/cjs/api/types/{AgenticSearchAccessControl.js → FilterGroup.js} +0 -0
- /package/dist/cjs/api/types/{AgenticSearchAnswer.js → InstantSearchRequest.js} +0 -0
- /package/dist/cjs/api/types/{AgenticSearchBreadcrumb.js → InternalAgenticSearchRequest.js} +0 -0
- /package/dist/cjs/api/types/{AgenticSearchCitation.js → SearchAccessControl.js} +0 -0
- /package/dist/cjs/api/types/{AgenticSearchFilterCondition.js → SearchBreadcrumb.js} +0 -0
- /package/dist/cjs/api/types/{AgenticSearchFilterGroup.js → SearchResult.js} +0 -0
- /package/dist/cjs/api/types/{AgenticSearchResponse.js → SearchSystemMetadata.js} +0 -0
- /package/dist/cjs/api/types/{AgenticSearchResult.js → SearchV2Response.js} +0 -0
- /package/dist/esm/api/{resources/collections/client/requests/SearchGetLegacyCollectionsReadableIdSearchGetRequest.mjs → types/ClassicSearchRequest.mjs} +0 -0
- /package/dist/esm/api/{resources/collections/types/SearchCollectionsReadableIdSearchPostRequest.mjs → types/FilterCondition.mjs} +0 -0
- /package/dist/esm/api/types/{AgenticSearchAccessControl.mjs → FilterGroup.mjs} +0 -0
- /package/dist/esm/api/types/{AgenticSearchAnswer.mjs → InstantSearchRequest.mjs} +0 -0
- /package/dist/esm/api/types/{AgenticSearchBreadcrumb.mjs → InternalAgenticSearchRequest.mjs} +0 -0
- /package/dist/esm/api/types/{AgenticSearchCitation.mjs → SearchAccessControl.mjs} +0 -0
- /package/dist/esm/api/types/{AgenticSearchFilterCondition.mjs → SearchBreadcrumb.mjs} +0 -0
- /package/dist/esm/api/types/{AgenticSearchFilterGroup.mjs → SearchResult.mjs} +0 -0
- /package/dist/esm/api/types/{AgenticSearchResponse.mjs → SearchSystemMetadata.mjs} +0 -0
- /package/dist/esm/api/types/{AgenticSearchResult.mjs → SearchV2Response.mjs} +0 -0
|
@@ -6,8 +6,8 @@ import * as AirweaveSDK from "../index.mjs";
|
|
|
6
6
|
* A single filter condition.
|
|
7
7
|
*
|
|
8
8
|
* Pydantic validates that:
|
|
9
|
-
* - ``field`` is a valid
|
|
10
|
-
* - ``operator`` is a valid
|
|
9
|
+
* - ``field`` is a valid FilterableField enum value
|
|
10
|
+
* - ``operator`` is a valid FilterOperator enum value
|
|
11
11
|
* - ``value`` matches the expected types
|
|
12
12
|
* - The combination of field + operator + value is semantically valid
|
|
13
13
|
*
|
|
@@ -20,17 +20,17 @@ import * as AirweaveSDK from "../index.mjs";
|
|
|
20
20
|
* "value": "2024-01-01T00:00:00Z"}
|
|
21
21
|
* {"field": "breadcrumbs.name", "operator": "contains", "value": "Engineering"}
|
|
22
22
|
*/
|
|
23
|
-
export interface
|
|
23
|
+
export interface FilterCondition {
|
|
24
24
|
/** Field to filter on (use dot notation for nested fields). */
|
|
25
|
-
field: AirweaveSDK.
|
|
25
|
+
field: AirweaveSDK.FilterableField;
|
|
26
26
|
/** The comparison operator to use. */
|
|
27
|
-
operator: AirweaveSDK.
|
|
27
|
+
operator: AirweaveSDK.FilterOperator;
|
|
28
28
|
/** Value to compare against. Use a list for 'in' and 'not_in' operators. */
|
|
29
|
-
value:
|
|
29
|
+
value: FilterCondition.Value;
|
|
30
30
|
}
|
|
31
|
-
export declare namespace
|
|
31
|
+
export declare namespace FilterCondition {
|
|
32
32
|
/**
|
|
33
33
|
* Value to compare against. Use a list for 'in' and 'not_in' operators.
|
|
34
34
|
*/
|
|
35
|
-
type Value = string | number |
|
|
35
|
+
type Value = string | number | boolean | string[] | number[];
|
|
36
36
|
}
|
|
@@ -31,7 +31,7 @@ import * as AirweaveSDK from "../index.mjs";
|
|
|
31
31
|
* "value": "Engineering"}
|
|
32
32
|
* ]}
|
|
33
33
|
*/
|
|
34
|
-
export interface
|
|
34
|
+
export interface FilterGroup {
|
|
35
35
|
/** Filter conditions within this group, combined with AND */
|
|
36
|
-
conditions: AirweaveSDK.
|
|
36
|
+
conditions: AirweaveSDK.FilterCondition[];
|
|
37
37
|
}
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
/**
|
|
5
5
|
* Supported filter operators.
|
|
6
6
|
*/
|
|
7
|
-
export type
|
|
8
|
-
export declare const
|
|
7
|
+
export type FilterOperator = "equals" | "not_equals" | "contains" | "greater_than" | "less_than" | "greater_than_or_equal" | "less_than_or_equal" | "in" | "not_in";
|
|
8
|
+
export declare const FilterOperator: {
|
|
9
9
|
readonly Equals: "equals";
|
|
10
10
|
readonly NotEquals: "not_equals";
|
|
11
11
|
readonly Contains: "contains";
|
package/dist/{cjs/api/types/AgenticSearchFilterableField.d.ts → esm/api/types/FilterableField.d.mts}
RENAMED
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
/**
|
|
5
|
-
* Filterable fields in
|
|
5
|
+
* Filterable fields in search.
|
|
6
6
|
*
|
|
7
7
|
* Uses dot notation for nested fields (e.g., breadcrumbs.name,
|
|
8
8
|
* airweave_system_metadata.source_name).
|
|
9
9
|
*/
|
|
10
|
-
export type
|
|
11
|
-
export declare const
|
|
10
|
+
export type FilterableField = "entity_id" | "name" | "created_at" | "updated_at" | "breadcrumbs.entity_id" | "breadcrumbs.name" | "breadcrumbs.entity_type" | "airweave_system_metadata.entity_type" | "airweave_system_metadata.source_name" | "airweave_system_metadata.original_entity_id" | "airweave_system_metadata.chunk_index" | "airweave_system_metadata.sync_id" | "airweave_system_metadata.sync_job_id";
|
|
11
|
+
export declare const FilterableField: {
|
|
12
12
|
readonly EntityId: "entity_id";
|
|
13
13
|
readonly Name: "name";
|
|
14
14
|
readonly CreatedAt: "created_at";
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as AirweaveSDK from "../index.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* Instant search request — embed query, fire at Vespa, return results.
|
|
7
|
+
*/
|
|
8
|
+
export interface InstantSearchRequest {
|
|
9
|
+
/** Search query text. */
|
|
10
|
+
query: string;
|
|
11
|
+
/** Which retrieval strategy to use. */
|
|
12
|
+
retrieval_strategy?: AirweaveSDK.RetrievalStrategy;
|
|
13
|
+
/** Filter groups (combined with OR). */
|
|
14
|
+
filter?: AirweaveSDK.FilterGroup[];
|
|
15
|
+
/** Max results to return. */
|
|
16
|
+
limit?: number;
|
|
17
|
+
/** Number of results to skip. */
|
|
18
|
+
offset?: number;
|
|
19
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as AirweaveSDK from "../index.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* Admin-only agentic search request with model override for evals.
|
|
7
|
+
*/
|
|
8
|
+
export interface InternalAgenticSearchRequest {
|
|
9
|
+
/** Search query text. */
|
|
10
|
+
query: string;
|
|
11
|
+
/** Enable extended thinking / chain-of-thought. */
|
|
12
|
+
thinking?: boolean;
|
|
13
|
+
/** Filter groups (combined with OR). */
|
|
14
|
+
filter?: AirweaveSDK.FilterGroup[];
|
|
15
|
+
/** Max results. None means agent decides. */
|
|
16
|
+
limit?: number;
|
|
17
|
+
/** LLM model override. Format: 'provider/model' e.g. 'together/zai-glm-5-thinking'. When not set, uses the default model from config. */
|
|
18
|
+
model?: string;
|
|
19
|
+
}
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
/**
|
|
5
|
-
* Access control in
|
|
5
|
+
* Access control in search result.
|
|
6
6
|
*/
|
|
7
|
-
export interface
|
|
7
|
+
export interface SearchAccessControl {
|
|
8
8
|
/** Principal IDs who can view this entity. None if unknown. */
|
|
9
9
|
viewers?: string[];
|
|
10
10
|
/** Whether this entity is publicly accessible. None if unknown. */
|
package/dist/{cjs/api/types/AgenticSearchBreadcrumb.d.ts → esm/api/types/SearchBreadcrumb.d.mts}
RENAMED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
/**
|
|
5
|
-
* Breadcrumb in
|
|
5
|
+
* Breadcrumb in search result.
|
|
6
6
|
*/
|
|
7
|
-
export interface
|
|
7
|
+
export interface SearchBreadcrumb {
|
|
8
8
|
/** ID of the entity in the source. */
|
|
9
9
|
entity_id: string;
|
|
10
10
|
/** Display name of the entity. */
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
*/
|
|
4
4
|
import * as AirweaveSDK from "../index.mjs";
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* Search result.
|
|
7
7
|
*/
|
|
8
|
-
export interface
|
|
8
|
+
export interface SearchResult {
|
|
9
9
|
/** Original entity ID. */
|
|
10
10
|
entity_id: string;
|
|
11
11
|
/** Entity display name. */
|
|
@@ -13,7 +13,7 @@ export interface AgenticSearchResult {
|
|
|
13
13
|
/** Relevance score from the search engine. */
|
|
14
14
|
relevance_score: number;
|
|
15
15
|
/** Breadcrumbs showing entity hierarchy. */
|
|
16
|
-
breadcrumbs: AirweaveSDK.
|
|
16
|
+
breadcrumbs: AirweaveSDK.SearchBreadcrumb[];
|
|
17
17
|
/** When the entity was created. */
|
|
18
18
|
created_at?: string;
|
|
19
19
|
/** When the entity was last updated. */
|
|
@@ -21,9 +21,9 @@ export interface AgenticSearchResult {
|
|
|
21
21
|
/** Semantically searchable text content */
|
|
22
22
|
textual_representation: string;
|
|
23
23
|
/** System metadata */
|
|
24
|
-
airweave_system_metadata: AirweaveSDK.
|
|
24
|
+
airweave_system_metadata: AirweaveSDK.SearchSystemMetadata;
|
|
25
25
|
/** Access control */
|
|
26
|
-
access: AirweaveSDK.
|
|
26
|
+
access: AirweaveSDK.SearchAccessControl;
|
|
27
27
|
/** URL to view the entity in its source application (e.g., Notion, Asana). */
|
|
28
28
|
web_url: string;
|
|
29
29
|
/** Download URL for file entities. Only present for FileEntity types. */
|
|
@@ -2,17 +2,17 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
/**
|
|
5
|
-
* System metadata in
|
|
5
|
+
* System metadata in search result.
|
|
6
6
|
*/
|
|
7
|
-
export interface
|
|
7
|
+
export interface SearchSystemMetadata {
|
|
8
8
|
/** Name of the source this entity belongs to. */
|
|
9
9
|
source_name: string;
|
|
10
10
|
/** Type of the entity this entity represents in the source. */
|
|
11
11
|
entity_type: string;
|
|
12
|
-
/** ID of the sync this entity belongs to. */
|
|
13
|
-
sync_id
|
|
14
|
-
/** ID of the sync job this entity belongs to. */
|
|
15
|
-
sync_job_id
|
|
12
|
+
/** ID of the sync this entity belongs to (None for federated). */
|
|
13
|
+
sync_id?: string;
|
|
14
|
+
/** ID of the sync job this entity belongs to (None for federated). */
|
|
15
|
+
sync_job_id?: string;
|
|
16
16
|
/** Index of the chunk in the file. */
|
|
17
17
|
chunk_index: number;
|
|
18
18
|
/** Original entity ID */
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as AirweaveSDK from "../index.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* Unified response for all search tiers.
|
|
7
|
+
*/
|
|
8
|
+
export interface SearchV2Response {
|
|
9
|
+
/** Search results ordered by relevance. */
|
|
10
|
+
results?: AirweaveSDK.SearchResult[];
|
|
11
|
+
}
|
|
@@ -9,6 +9,8 @@ export interface UsageSnapshot {
|
|
|
9
9
|
entities: number;
|
|
10
10
|
/** Search queries executed */
|
|
11
11
|
queries: number;
|
|
12
|
+
/** Normalized token usage from agentic search */
|
|
13
|
+
tokens?: number;
|
|
12
14
|
/** Source connections configured */
|
|
13
15
|
source_connections: number;
|
|
14
16
|
/** Team members in the organization */
|
|
@@ -17,6 +19,8 @@ export interface UsageSnapshot {
|
|
|
17
19
|
max_entities?: number;
|
|
18
20
|
/** Maximum queries allowed */
|
|
19
21
|
max_queries?: number;
|
|
22
|
+
/** Maximum normalized tokens allowed */
|
|
23
|
+
max_tokens?: number;
|
|
20
24
|
/** Maximum source connections allowed */
|
|
21
25
|
max_source_connections?: number;
|
|
22
26
|
/** Maximum team members allowed */
|
|
@@ -4,19 +4,7 @@ export * from "./ActionCheckRequest.mjs";
|
|
|
4
4
|
export * from "./ActionCheckResponse.mjs";
|
|
5
5
|
export * from "./AdminSearchDestination.mjs";
|
|
6
6
|
export * from "./AdminSyncInfo.mjs";
|
|
7
|
-
export * from "./AgenticSearchAccessControl.mjs";
|
|
8
|
-
export * from "./AgenticSearchAnswer.mjs";
|
|
9
|
-
export * from "./AgenticSearchBreadcrumb.mjs";
|
|
10
|
-
export * from "./AgenticSearchCitation.mjs";
|
|
11
|
-
export * from "./AgenticSearchFilterCondition.mjs";
|
|
12
|
-
export * from "./AgenticSearchFilterGroup.mjs";
|
|
13
|
-
export * from "./AgenticSearchFilterOperator.mjs";
|
|
14
|
-
export * from "./AgenticSearchFilterableField.mjs";
|
|
15
|
-
export * from "./AgenticSearchMode.mjs";
|
|
16
7
|
export * from "./AgenticSearchRequest.mjs";
|
|
17
|
-
export * from "./AgenticSearchResponse.mjs";
|
|
18
|
-
export * from "./AgenticSearchResult.mjs";
|
|
19
|
-
export * from "./AgenticSearchSystemMetadata.mjs";
|
|
20
8
|
export * from "./AuthProviderAuthentication.mjs";
|
|
21
9
|
export * from "./AuthProviderConnection.mjs";
|
|
22
10
|
export * from "./AuthProviderConnectionCreate.mjs";
|
|
@@ -38,6 +26,7 @@ export * from "./BrowseTreeResponse.mjs";
|
|
|
38
26
|
export * from "./CheckStatus.mjs";
|
|
39
27
|
export * from "./CheckoutSessionRequest.mjs";
|
|
40
28
|
export * from "./CheckoutSessionResponse.mjs";
|
|
29
|
+
export * from "./ClassicSearchRequest.mjs";
|
|
41
30
|
export * from "./Collection.mjs";
|
|
42
31
|
export * from "./CollectionStatus.mjs";
|
|
43
32
|
export * from "./ConfigField.mjs";
|
|
@@ -61,13 +50,17 @@ export * from "./EntityTypeStats.mjs";
|
|
|
61
50
|
export * from "./EventType.mjs";
|
|
62
51
|
export * from "./FeatureFlag.mjs";
|
|
63
52
|
export * from "./Fields.mjs";
|
|
53
|
+
export * from "./FilterCondition.mjs";
|
|
54
|
+
export * from "./FilterGroup.mjs";
|
|
55
|
+
export * from "./FilterOperator.mjs";
|
|
56
|
+
export * from "./FilterableField.mjs";
|
|
64
57
|
export * from "./HttpValidationError.mjs";
|
|
65
58
|
export * from "./HandlerConfig.mjs";
|
|
66
59
|
export * from "./HealthStatus.mjs";
|
|
60
|
+
export * from "./InstantSearchRequest.mjs";
|
|
61
|
+
export * from "./InternalAgenticSearchRequest.mjs";
|
|
67
62
|
export * from "./InvitationCreate.mjs";
|
|
68
63
|
export * from "./InvitationResponse.mjs";
|
|
69
|
-
export * from "./LegacySearchRequest.mjs";
|
|
70
|
-
export * from "./LegacySearchResponse.mjs";
|
|
71
64
|
export * from "./LivenessResponse.mjs";
|
|
72
65
|
export * from "./MemberResponse.mjs";
|
|
73
66
|
export * from "./MessageResponse.mjs";
|
|
@@ -82,17 +75,18 @@ export * from "./OrganizationBilling.mjs";
|
|
|
82
75
|
export * from "./OrganizationCreate.mjs";
|
|
83
76
|
export * from "./OrganizationMetrics.mjs";
|
|
84
77
|
export * from "./OrganizationWithRole.mjs";
|
|
85
|
-
export * from "./QueryExpansionStrategy.mjs";
|
|
86
78
|
export * from "./RateLimitErrorResponse.mjs";
|
|
87
79
|
export * from "./ReadinessResponse.mjs";
|
|
88
80
|
export * from "./RecoveryTask.mjs";
|
|
89
|
-
export * from "./ResponseType.mjs";
|
|
90
|
-
export * from "./RetrievalStrategy.mjs";
|
|
91
81
|
export * from "./ScheduleConfig.mjs";
|
|
92
82
|
export * from "./ScheduleDetails.mjs";
|
|
83
|
+
export * from "./SearchAccessControl.mjs";
|
|
84
|
+
export * from "./SearchBreadcrumb.mjs";
|
|
93
85
|
export * from "./SearchRequest.mjs";
|
|
94
86
|
export * from "./SearchResponse.mjs";
|
|
95
|
-
export * from "./
|
|
87
|
+
export * from "./SearchResult.mjs";
|
|
88
|
+
export * from "./SearchSystemMetadata.mjs";
|
|
89
|
+
export * from "./SearchV2Response.mjs";
|
|
96
90
|
export * from "./SingleActionCheckResponse.mjs";
|
|
97
91
|
export * from "./Source.mjs";
|
|
98
92
|
export * from "./SourceConnection.mjs";
|
|
@@ -125,3 +119,4 @@ export * from "./WebhookMessage.mjs";
|
|
|
125
119
|
export * from "./WebhookMessageWithAttempts.mjs";
|
|
126
120
|
export * from "./WebhookSubscription.mjs";
|
|
127
121
|
export * from "./WebhookSubscriptionDetail.mjs";
|
|
122
|
+
export * from "./RetrievalStrategy.mjs";
|
|
@@ -4,19 +4,7 @@ export * from "./ActionCheckRequest.mjs";
|
|
|
4
4
|
export * from "./ActionCheckResponse.mjs";
|
|
5
5
|
export * from "./AdminSearchDestination.mjs";
|
|
6
6
|
export * from "./AdminSyncInfo.mjs";
|
|
7
|
-
export * from "./AgenticSearchAccessControl.mjs";
|
|
8
|
-
export * from "./AgenticSearchAnswer.mjs";
|
|
9
|
-
export * from "./AgenticSearchBreadcrumb.mjs";
|
|
10
|
-
export * from "./AgenticSearchCitation.mjs";
|
|
11
|
-
export * from "./AgenticSearchFilterCondition.mjs";
|
|
12
|
-
export * from "./AgenticSearchFilterGroup.mjs";
|
|
13
|
-
export * from "./AgenticSearchFilterOperator.mjs";
|
|
14
|
-
export * from "./AgenticSearchFilterableField.mjs";
|
|
15
|
-
export * from "./AgenticSearchMode.mjs";
|
|
16
7
|
export * from "./AgenticSearchRequest.mjs";
|
|
17
|
-
export * from "./AgenticSearchResponse.mjs";
|
|
18
|
-
export * from "./AgenticSearchResult.mjs";
|
|
19
|
-
export * from "./AgenticSearchSystemMetadata.mjs";
|
|
20
8
|
export * from "./AuthProviderAuthentication.mjs";
|
|
21
9
|
export * from "./AuthProviderConnection.mjs";
|
|
22
10
|
export * from "./AuthProviderConnectionCreate.mjs";
|
|
@@ -38,6 +26,7 @@ export * from "./BrowseTreeResponse.mjs";
|
|
|
38
26
|
export * from "./CheckStatus.mjs";
|
|
39
27
|
export * from "./CheckoutSessionRequest.mjs";
|
|
40
28
|
export * from "./CheckoutSessionResponse.mjs";
|
|
29
|
+
export * from "./ClassicSearchRequest.mjs";
|
|
41
30
|
export * from "./Collection.mjs";
|
|
42
31
|
export * from "./CollectionStatus.mjs";
|
|
43
32
|
export * from "./ConfigField.mjs";
|
|
@@ -61,13 +50,17 @@ export * from "./EntityTypeStats.mjs";
|
|
|
61
50
|
export * from "./EventType.mjs";
|
|
62
51
|
export * from "./FeatureFlag.mjs";
|
|
63
52
|
export * from "./Fields.mjs";
|
|
53
|
+
export * from "./FilterCondition.mjs";
|
|
54
|
+
export * from "./FilterGroup.mjs";
|
|
55
|
+
export * from "./FilterOperator.mjs";
|
|
56
|
+
export * from "./FilterableField.mjs";
|
|
64
57
|
export * from "./HttpValidationError.mjs";
|
|
65
58
|
export * from "./HandlerConfig.mjs";
|
|
66
59
|
export * from "./HealthStatus.mjs";
|
|
60
|
+
export * from "./InstantSearchRequest.mjs";
|
|
61
|
+
export * from "./InternalAgenticSearchRequest.mjs";
|
|
67
62
|
export * from "./InvitationCreate.mjs";
|
|
68
63
|
export * from "./InvitationResponse.mjs";
|
|
69
|
-
export * from "./LegacySearchRequest.mjs";
|
|
70
|
-
export * from "./LegacySearchResponse.mjs";
|
|
71
64
|
export * from "./LivenessResponse.mjs";
|
|
72
65
|
export * from "./MemberResponse.mjs";
|
|
73
66
|
export * from "./MessageResponse.mjs";
|
|
@@ -82,17 +75,18 @@ export * from "./OrganizationBilling.mjs";
|
|
|
82
75
|
export * from "./OrganizationCreate.mjs";
|
|
83
76
|
export * from "./OrganizationMetrics.mjs";
|
|
84
77
|
export * from "./OrganizationWithRole.mjs";
|
|
85
|
-
export * from "./QueryExpansionStrategy.mjs";
|
|
86
78
|
export * from "./RateLimitErrorResponse.mjs";
|
|
87
79
|
export * from "./ReadinessResponse.mjs";
|
|
88
80
|
export * from "./RecoveryTask.mjs";
|
|
89
|
-
export * from "./ResponseType.mjs";
|
|
90
|
-
export * from "./RetrievalStrategy.mjs";
|
|
91
81
|
export * from "./ScheduleConfig.mjs";
|
|
92
82
|
export * from "./ScheduleDetails.mjs";
|
|
83
|
+
export * from "./SearchAccessControl.mjs";
|
|
84
|
+
export * from "./SearchBreadcrumb.mjs";
|
|
93
85
|
export * from "./SearchRequest.mjs";
|
|
94
86
|
export * from "./SearchResponse.mjs";
|
|
95
|
-
export * from "./
|
|
87
|
+
export * from "./SearchResult.mjs";
|
|
88
|
+
export * from "./SearchSystemMetadata.mjs";
|
|
89
|
+
export * from "./SearchV2Response.mjs";
|
|
96
90
|
export * from "./SingleActionCheckResponse.mjs";
|
|
97
91
|
export * from "./Source.mjs";
|
|
98
92
|
export * from "./SourceConnection.mjs";
|
|
@@ -125,3 +119,4 @@ export * from "./WebhookMessage.mjs";
|
|
|
125
119
|
export * from "./WebhookMessageWithAttempts.mjs";
|
|
126
120
|
export * from "./WebhookSubscription.mjs";
|
|
127
121
|
export * from "./WebhookSubscriptionDetail.mjs";
|
|
122
|
+
export * from "./RetrievalStrategy.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "v0.9.
|
|
1
|
+
export declare const SDK_VERSION = "v0.9.41";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "v0.9.
|
|
1
|
+
export const SDK_VERSION = "v0.9.41";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -508,181 +508,6 @@ await client.collections.update("customer-support-tickets-x7k9m", {
|
|
|
508
508
|
</dl>
|
|
509
509
|
</details>
|
|
510
510
|
|
|
511
|
-
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">searchGetLegacy</a>(readableId, { ...params }) -> AirweaveSDK.LegacySearchResponse</code></summary>
|
|
512
|
-
<dl>
|
|
513
|
-
<dd>
|
|
514
|
-
|
|
515
|
-
#### 📝 Description
|
|
516
|
-
|
|
517
|
-
<dl>
|
|
518
|
-
<dd>
|
|
519
|
-
|
|
520
|
-
<dl>
|
|
521
|
-
<dd>
|
|
522
|
-
|
|
523
|
-
**DEPRECATED**: Use POST /collections/{readable_id}/search instead.
|
|
524
|
-
|
|
525
|
-
This legacy GET endpoint provides basic search functionality via query parameters.
|
|
526
|
-
Migrate to the POST endpoint for access to advanced features like:
|
|
527
|
-
|
|
528
|
-
- Structured filters
|
|
529
|
-
- Query expansion
|
|
530
|
-
- Reranking
|
|
531
|
-
- Streaming responses
|
|
532
|
-
</dd>
|
|
533
|
-
</dl>
|
|
534
|
-
</dd>
|
|
535
|
-
</dl>
|
|
536
|
-
|
|
537
|
-
#### 🔌 Usage
|
|
538
|
-
|
|
539
|
-
<dl>
|
|
540
|
-
<dd>
|
|
541
|
-
|
|
542
|
-
<dl>
|
|
543
|
-
<dd>
|
|
544
|
-
|
|
545
|
-
```typescript
|
|
546
|
-
await client.collections.searchGetLegacy("customer-support-tickets-x7k9m", {
|
|
547
|
-
query: "How do I reset my password?",
|
|
548
|
-
response_type: "raw",
|
|
549
|
-
limit: 10,
|
|
550
|
-
offset: 0,
|
|
551
|
-
recency_bias: 1.1,
|
|
552
|
-
});
|
|
553
|
-
```
|
|
554
|
-
|
|
555
|
-
</dd>
|
|
556
|
-
</dl>
|
|
557
|
-
</dd>
|
|
558
|
-
</dl>
|
|
559
|
-
|
|
560
|
-
#### ⚙️ Parameters
|
|
561
|
-
|
|
562
|
-
<dl>
|
|
563
|
-
<dd>
|
|
564
|
-
|
|
565
|
-
<dl>
|
|
566
|
-
<dd>
|
|
567
|
-
|
|
568
|
-
**readableId:** `string` — The unique readable identifier of the collection to search
|
|
569
|
-
|
|
570
|
-
</dd>
|
|
571
|
-
</dl>
|
|
572
|
-
|
|
573
|
-
<dl>
|
|
574
|
-
<dd>
|
|
575
|
-
|
|
576
|
-
**request:** `AirweaveSDK.SearchGetLegacyCollectionsReadableIdSearchGetRequest`
|
|
577
|
-
|
|
578
|
-
</dd>
|
|
579
|
-
</dl>
|
|
580
|
-
|
|
581
|
-
<dl>
|
|
582
|
-
<dd>
|
|
583
|
-
|
|
584
|
-
**requestOptions:** `Collections.RequestOptions`
|
|
585
|
-
|
|
586
|
-
</dd>
|
|
587
|
-
</dl>
|
|
588
|
-
</dd>
|
|
589
|
-
</dl>
|
|
590
|
-
|
|
591
|
-
</dd>
|
|
592
|
-
</dl>
|
|
593
|
-
</details>
|
|
594
|
-
|
|
595
|
-
<details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">search</a>(readableId, { ...params }) -> AirweaveSDK.SearchResponse</code></summary>
|
|
596
|
-
<dl>
|
|
597
|
-
<dd>
|
|
598
|
-
|
|
599
|
-
#### 📝 Description
|
|
600
|
-
|
|
601
|
-
<dl>
|
|
602
|
-
<dd>
|
|
603
|
-
|
|
604
|
-
<dl>
|
|
605
|
-
<dd>
|
|
606
|
-
|
|
607
|
-
Search your collection using semantic and hybrid search.
|
|
608
|
-
|
|
609
|
-
This is the primary search endpoint providing powerful AI-powered search capabilities:
|
|
610
|
-
|
|
611
|
-
**Search Strategies:**
|
|
612
|
-
|
|
613
|
-
- **hybrid** (default): Combines neural (semantic) and keyword (BM25) matching
|
|
614
|
-
- **neural**: Pure semantic search using embeddings
|
|
615
|
-
- **keyword**: Traditional keyword-based BM25 search
|
|
616
|
-
|
|
617
|
-
**Features:**
|
|
618
|
-
|
|
619
|
-
- **Query expansion**: Generate query variations to improve recall
|
|
620
|
-
- **Filter interpretation**: Extract structured filters from natural language
|
|
621
|
-
- **Reranking**: LLM-based reranking for improved relevance
|
|
622
|
-
- **Answer generation**: AI-generated answers based on search results
|
|
623
|
-
|
|
624
|
-
**Note**: Accepts both new SearchRequest and legacy LegacySearchRequest formats
|
|
625
|
-
for backwards compatibility.
|
|
626
|
-
|
|
627
|
-
</dd>
|
|
628
|
-
</dl>
|
|
629
|
-
</dd>
|
|
630
|
-
</dl>
|
|
631
|
-
|
|
632
|
-
#### 🔌 Usage
|
|
633
|
-
|
|
634
|
-
<dl>
|
|
635
|
-
<dd>
|
|
636
|
-
|
|
637
|
-
<dl>
|
|
638
|
-
<dd>
|
|
639
|
-
|
|
640
|
-
```typescript
|
|
641
|
-
await client.collections.search("customer-support-tickets-x7k9m", {
|
|
642
|
-
query: "How do I reset my password?",
|
|
643
|
-
});
|
|
644
|
-
```
|
|
645
|
-
|
|
646
|
-
</dd>
|
|
647
|
-
</dl>
|
|
648
|
-
</dd>
|
|
649
|
-
</dl>
|
|
650
|
-
|
|
651
|
-
#### ⚙️ Parameters
|
|
652
|
-
|
|
653
|
-
<dl>
|
|
654
|
-
<dd>
|
|
655
|
-
|
|
656
|
-
<dl>
|
|
657
|
-
<dd>
|
|
658
|
-
|
|
659
|
-
**readableId:** `string` — The unique readable identifier of the collection to search
|
|
660
|
-
|
|
661
|
-
</dd>
|
|
662
|
-
</dl>
|
|
663
|
-
|
|
664
|
-
<dl>
|
|
665
|
-
<dd>
|
|
666
|
-
|
|
667
|
-
**request:** `AirweaveSDK.SearchCollectionsReadableIdSearchPostRequest`
|
|
668
|
-
|
|
669
|
-
</dd>
|
|
670
|
-
</dl>
|
|
671
|
-
|
|
672
|
-
<dl>
|
|
673
|
-
<dd>
|
|
674
|
-
|
|
675
|
-
**requestOptions:** `Collections.RequestOptions`
|
|
676
|
-
|
|
677
|
-
</dd>
|
|
678
|
-
</dl>
|
|
679
|
-
</dd>
|
|
680
|
-
</dl>
|
|
681
|
-
|
|
682
|
-
</dd>
|
|
683
|
-
</dl>
|
|
684
|
-
</details>
|
|
685
|
-
|
|
686
511
|
## source-connections
|
|
687
512
|
|
|
688
513
|
<details><summary><code>client.sourceConnections.<a href="/src/api/resources/sourceConnections/client/Client.ts">list</a>({ ...params }) -> AirweaveSDK.SourceConnectionListItem[]</code></summary>
|
|
@@ -1,26 +0,0 @@
|
|
|
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: "How do I reset my password?",
|
|
9
|
-
* response_type: "raw",
|
|
10
|
-
* limit: 10,
|
|
11
|
-
* offset: 0,
|
|
12
|
-
* recency_bias: 1.1
|
|
13
|
-
* }
|
|
14
|
-
*/
|
|
15
|
-
export interface SearchGetLegacyCollectionsReadableIdSearchGetRequest {
|
|
16
|
-
/** The search query text to find relevant documents and data */
|
|
17
|
-
query: string;
|
|
18
|
-
/** Format of the response: 'raw' returns search results, 'completion' returns AI-generated answers */
|
|
19
|
-
response_type?: AirweaveSDK.ResponseType;
|
|
20
|
-
/** Maximum number of results to return */
|
|
21
|
-
limit?: number;
|
|
22
|
-
/** Number of results to skip for pagination */
|
|
23
|
-
offset?: number;
|
|
24
|
-
/** How much to weigh recency vs similarity (0=similarity only, 1=recency only) */
|
|
25
|
-
recency_bias?: number;
|
|
26
|
-
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from "./SearchCollectionsReadableIdSearchPostRequest.js";
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
-
if (k2 === undefined) k2 = k;
|
|
4
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
-
}
|
|
8
|
-
Object.defineProperty(o, k2, desc);
|
|
9
|
-
}) : (function(o, m, k, k2) {
|
|
10
|
-
if (k2 === undefined) k2 = k;
|
|
11
|
-
o[k2] = m[k];
|
|
12
|
-
}));
|
|
13
|
-
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
-
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
-
};
|
|
16
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
-
__exportStar(require("./SearchCollectionsReadableIdSearchPostRequest.js"), exports);
|