bem-ai-sdk 0.28.0 → 0.29.0
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/CHANGELOG.md +16 -0
- package/client.d.mts +10 -10
- package/client.d.mts.map +1 -1
- package/client.d.ts +10 -10
- package/client.d.ts.map +1 -1
- package/client.js.map +1 -1
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/buckets.d.mts +9 -113
- package/resources/buckets.d.mts.map +1 -1
- package/resources/buckets.d.ts +9 -113
- package/resources/buckets.d.ts.map +1 -1
- package/resources/buckets.js +3 -3
- package/resources/buckets.js.map +1 -1
- package/resources/buckets.mjs +3 -3
- package/resources/buckets.mjs.map +1 -1
- package/resources/entities/entities.d.mts +52 -103
- package/resources/entities/entities.d.mts.map +1 -1
- package/resources/entities/entities.d.ts +52 -103
- package/resources/entities/entities.d.ts.map +1 -1
- package/resources/entities/entities.js.map +1 -1
- package/resources/entities/entities.mjs.map +1 -1
- package/resources/entities/index.d.mts +1 -1
- package/resources/entities/index.d.mts.map +1 -1
- package/resources/entities/index.d.ts +1 -1
- package/resources/entities/index.d.ts.map +1 -1
- package/resources/entities/index.js.map +1 -1
- package/resources/entities/index.mjs.map +1 -1
- package/resources/entity-types/entity-types.d.mts +8 -124
- package/resources/entity-types/entity-types.d.mts.map +1 -1
- package/resources/entity-types/entity-types.d.ts +8 -124
- package/resources/entity-types/entity-types.d.ts.map +1 -1
- package/resources/entity-types/entity-types.js.map +1 -1
- package/resources/entity-types/entity-types.mjs.map +1 -1
- package/resources/entity-types/index.d.mts +2 -2
- package/resources/entity-types/index.d.mts.map +1 -1
- package/resources/entity-types/index.d.ts +2 -2
- package/resources/entity-types/index.d.ts.map +1 -1
- package/resources/entity-types/index.js.map +1 -1
- package/resources/entity-types/index.mjs.map +1 -1
- package/resources/entity-types/reviewers.d.mts +10 -39
- package/resources/entity-types/reviewers.d.mts.map +1 -1
- package/resources/entity-types/reviewers.d.ts +10 -39
- package/resources/entity-types/reviewers.d.ts.map +1 -1
- package/resources/entity-types/reviewers.js +1 -1
- package/resources/entity-types/reviewers.js.map +1 -1
- package/resources/entity-types/reviewers.mjs +1 -1
- package/resources/entity-types/reviewers.mjs.map +1 -1
- package/resources/eval/eval.d.mts +2 -2
- package/resources/eval/eval.d.mts.map +1 -1
- package/resources/eval/eval.d.ts +2 -2
- package/resources/eval/eval.d.ts.map +1 -1
- package/resources/eval/eval.js.map +1 -1
- package/resources/eval/eval.mjs.map +1 -1
- package/resources/eval/index.d.mts +1 -1
- package/resources/eval/index.d.mts.map +1 -1
- package/resources/eval/index.d.ts +1 -1
- package/resources/eval/index.d.ts.map +1 -1
- package/resources/eval/index.js.map +1 -1
- package/resources/eval/index.mjs.map +1 -1
- package/resources/eval/score.d.mts +60 -219
- package/resources/eval/score.d.mts.map +1 -1
- package/resources/eval/score.d.ts +60 -219
- package/resources/eval/score.d.ts.map +1 -1
- package/resources/eval/score.js +2 -2
- package/resources/eval/score.js.map +1 -1
- package/resources/eval/score.mjs +2 -2
- package/resources/eval/score.mjs.map +1 -1
- package/resources/functions/functions.d.mts +364 -1095
- package/resources/functions/functions.d.mts.map +1 -1
- package/resources/functions/functions.d.ts +364 -1095
- package/resources/functions/functions.d.ts.map +1 -1
- package/resources/functions/functions.js.map +1 -1
- package/resources/functions/functions.mjs.map +1 -1
- package/resources/functions/index.d.mts +1 -1
- package/resources/functions/index.d.mts.map +1 -1
- package/resources/functions/index.d.ts +1 -1
- package/resources/functions/index.d.ts.map +1 -1
- package/resources/functions/index.js.map +1 -1
- package/resources/functions/index.mjs.map +1 -1
- package/resources/functions/versions.d.mts +2 -108
- package/resources/functions/versions.d.mts.map +1 -1
- package/resources/functions/versions.d.ts +2 -108
- package/resources/functions/versions.d.ts.map +1 -1
- package/resources/index.d.mts +5 -5
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +5 -5
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/outputs.d.mts +1 -1
- package/resources/outputs.d.mts.map +1 -1
- package/resources/outputs.d.ts +1 -1
- package/resources/outputs.d.ts.map +1 -1
- package/resources/views.d.mts +97 -745
- package/resources/views.d.mts.map +1 -1
- package/resources/views.d.ts +97 -745
- package/resources/views.d.ts.map +1 -1
- package/resources/workflows/workflows.d.mts +2 -19
- package/resources/workflows/workflows.d.mts.map +1 -1
- package/resources/workflows/workflows.d.ts +2 -19
- package/resources/workflows/workflows.d.ts.map +1 -1
- package/resources/workflows/workflows.js.map +1 -1
- package/resources/workflows/workflows.mjs.map +1 -1
- package/src/client.ts +38 -18
- package/src/resources/buckets.ts +9 -137
- package/src/resources/entities/entities.ts +61 -118
- package/src/resources/entities/index.ts +2 -0
- package/src/resources/entity-types/entity-types.ts +8 -151
- package/src/resources/entity-types/index.ts +2 -4
- package/src/resources/entity-types/reviewers.ts +11 -49
- package/src/resources/eval/eval.ts +8 -4
- package/src/resources/eval/index.ts +4 -2
- package/src/resources/eval/score.ts +66 -263
- package/src/resources/functions/functions.ts +411 -1249
- package/src/resources/functions/index.ts +8 -0
- package/src/resources/functions/versions.ts +2 -118
- package/src/resources/index.ts +19 -9
- package/src/resources/outputs.ts +1 -0
- package/src/resources/views.ts +118 -936
- package/src/resources/workflows/workflows.ts +2 -21
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/buckets.d.mts
CHANGED
|
@@ -26,31 +26,31 @@ export declare class Buckets extends APIResource {
|
|
|
26
26
|
*
|
|
27
27
|
* @example
|
|
28
28
|
* ```ts
|
|
29
|
-
* const
|
|
29
|
+
* const bucketV3 = await client.buckets.create({
|
|
30
30
|
* name: 'invoices',
|
|
31
31
|
* description: 'Knowledge graph for invoice documents',
|
|
32
32
|
* });
|
|
33
33
|
* ```
|
|
34
34
|
*/
|
|
35
|
-
create(body: BucketCreateParams, options?: RequestOptions): APIPromise<
|
|
35
|
+
create(body: BucketCreateParams, options?: RequestOptions): APIPromise<BucketV3>;
|
|
36
36
|
/**
|
|
37
37
|
* Get a Bucket
|
|
38
38
|
*
|
|
39
39
|
* @example
|
|
40
40
|
* ```ts
|
|
41
|
-
* const
|
|
41
|
+
* const bucketV3 = await client.buckets.retrieve('bucketID');
|
|
42
42
|
* ```
|
|
43
43
|
*/
|
|
44
|
-
retrieve(bucketID: string, options?: RequestOptions): APIPromise<
|
|
44
|
+
retrieve(bucketID: string, options?: RequestOptions): APIPromise<BucketV3>;
|
|
45
45
|
/**
|
|
46
46
|
* Update a Bucket
|
|
47
47
|
*
|
|
48
48
|
* @example
|
|
49
49
|
* ```ts
|
|
50
|
-
* const
|
|
50
|
+
* const bucketV3 = await client.buckets.update('bucketID');
|
|
51
51
|
* ```
|
|
52
52
|
*/
|
|
53
|
-
update(bucketID: string, body: BucketUpdateParams, options?: RequestOptions): APIPromise<
|
|
53
|
+
update(bucketID: string, body: BucketUpdateParams, options?: RequestOptions): APIPromise<BucketV3>;
|
|
54
54
|
/**
|
|
55
55
|
* List Buckets
|
|
56
56
|
*
|
|
@@ -78,75 +78,7 @@ export declare class Buckets extends APIResource {
|
|
|
78
78
|
* Every account+environment has exactly one default bucket. The default bucket can
|
|
79
79
|
* be renamed but never deleted.
|
|
80
80
|
*/
|
|
81
|
-
export interface
|
|
82
|
-
/**
|
|
83
|
-
* Stable public identifier for the bucket (`bkt_...`).
|
|
84
|
-
*/
|
|
85
|
-
bucketID: string;
|
|
86
|
-
/**
|
|
87
|
-
* Creation timestamp (RFC 3339).
|
|
88
|
-
*/
|
|
89
|
-
createdAt: string;
|
|
90
|
-
/**
|
|
91
|
-
* Optional human-facing note about the bucket.
|
|
92
|
-
*/
|
|
93
|
-
description: string;
|
|
94
|
-
/**
|
|
95
|
-
* Whether this is the account+environment's default bucket.
|
|
96
|
-
*/
|
|
97
|
-
isDefault: boolean;
|
|
98
|
-
/**
|
|
99
|
-
* Human-facing bucket name. Unique within an account+environment.
|
|
100
|
-
*/
|
|
101
|
-
name: string;
|
|
102
|
-
/**
|
|
103
|
-
* Last-update timestamp (RFC 3339).
|
|
104
|
-
*/
|
|
105
|
-
updatedAt: string;
|
|
106
|
-
}
|
|
107
|
-
/**
|
|
108
|
-
* A Bucket is a named partition of the knowledge graph within an
|
|
109
|
-
* account+environment. Entities, mentions, and relations are scoped to a bucket so
|
|
110
|
-
* a single account+environment can host multiple isolated graphs.
|
|
111
|
-
*
|
|
112
|
-
* Every account+environment has exactly one default bucket. The default bucket can
|
|
113
|
-
* be renamed but never deleted.
|
|
114
|
-
*/
|
|
115
|
-
export interface BucketRetrieveResponse {
|
|
116
|
-
/**
|
|
117
|
-
* Stable public identifier for the bucket (`bkt_...`).
|
|
118
|
-
*/
|
|
119
|
-
bucketID: string;
|
|
120
|
-
/**
|
|
121
|
-
* Creation timestamp (RFC 3339).
|
|
122
|
-
*/
|
|
123
|
-
createdAt: string;
|
|
124
|
-
/**
|
|
125
|
-
* Optional human-facing note about the bucket.
|
|
126
|
-
*/
|
|
127
|
-
description: string;
|
|
128
|
-
/**
|
|
129
|
-
* Whether this is the account+environment's default bucket.
|
|
130
|
-
*/
|
|
131
|
-
isDefault: boolean;
|
|
132
|
-
/**
|
|
133
|
-
* Human-facing bucket name. Unique within an account+environment.
|
|
134
|
-
*/
|
|
135
|
-
name: string;
|
|
136
|
-
/**
|
|
137
|
-
* Last-update timestamp (RFC 3339).
|
|
138
|
-
*/
|
|
139
|
-
updatedAt: string;
|
|
140
|
-
}
|
|
141
|
-
/**
|
|
142
|
-
* A Bucket is a named partition of the knowledge graph within an
|
|
143
|
-
* account+environment. Entities, mentions, and relations are scoped to a bucket so
|
|
144
|
-
* a single account+environment can host multiple isolated graphs.
|
|
145
|
-
*
|
|
146
|
-
* Every account+environment has exactly one default bucket. The default bucket can
|
|
147
|
-
* be renamed but never deleted.
|
|
148
|
-
*/
|
|
149
|
-
export interface BucketUpdateResponse {
|
|
81
|
+
export interface BucketV3 {
|
|
150
82
|
/**
|
|
151
83
|
* Stable public identifier for the bucket (`bkt_...`).
|
|
152
84
|
*/
|
|
@@ -176,48 +108,12 @@ export interface BucketUpdateResponse {
|
|
|
176
108
|
* Response body for listing buckets.
|
|
177
109
|
*/
|
|
178
110
|
export interface BucketListResponse {
|
|
179
|
-
buckets: Array<
|
|
111
|
+
buckets: Array<BucketV3>;
|
|
180
112
|
/**
|
|
181
113
|
* Total number of buckets matching the query, ignoring pagination.
|
|
182
114
|
*/
|
|
183
115
|
totalCount: number;
|
|
184
116
|
}
|
|
185
|
-
export declare namespace BucketListResponse {
|
|
186
|
-
/**
|
|
187
|
-
* A Bucket is a named partition of the knowledge graph within an
|
|
188
|
-
* account+environment. Entities, mentions, and relations are scoped to a bucket so
|
|
189
|
-
* a single account+environment can host multiple isolated graphs.
|
|
190
|
-
*
|
|
191
|
-
* Every account+environment has exactly one default bucket. The default bucket can
|
|
192
|
-
* be renamed but never deleted.
|
|
193
|
-
*/
|
|
194
|
-
interface Bucket {
|
|
195
|
-
/**
|
|
196
|
-
* Stable public identifier for the bucket (`bkt_...`).
|
|
197
|
-
*/
|
|
198
|
-
bucketID: string;
|
|
199
|
-
/**
|
|
200
|
-
* Creation timestamp (RFC 3339).
|
|
201
|
-
*/
|
|
202
|
-
createdAt: string;
|
|
203
|
-
/**
|
|
204
|
-
* Optional human-facing note about the bucket.
|
|
205
|
-
*/
|
|
206
|
-
description: string;
|
|
207
|
-
/**
|
|
208
|
-
* Whether this is the account+environment's default bucket.
|
|
209
|
-
*/
|
|
210
|
-
isDefault: boolean;
|
|
211
|
-
/**
|
|
212
|
-
* Human-facing bucket name. Unique within an account+environment.
|
|
213
|
-
*/
|
|
214
|
-
name: string;
|
|
215
|
-
/**
|
|
216
|
-
* Last-update timestamp (RFC 3339).
|
|
217
|
-
*/
|
|
218
|
-
updatedAt: string;
|
|
219
|
-
}
|
|
220
|
-
}
|
|
221
117
|
export interface BucketCreateParams {
|
|
222
118
|
/**
|
|
223
119
|
* Bucket name. Required and unique within the account+environment.
|
|
@@ -267,6 +163,6 @@ export interface BucketDeleteParams {
|
|
|
267
163
|
cascade?: boolean;
|
|
268
164
|
}
|
|
269
165
|
export declare namespace Buckets {
|
|
270
|
-
export { type
|
|
166
|
+
export { type BucketV3 as BucketV3, type BucketListResponse as BucketListResponse, type BucketCreateParams as BucketCreateParams, type BucketUpdateParams as BucketUpdateParams, type BucketListParams as BucketListParams, type BucketDeleteParams as BucketDeleteParams, };
|
|
271
167
|
}
|
|
272
168
|
//# sourceMappingURL=buckets.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"buckets.d.mts","sourceRoot":"","sources":["../src/resources/buckets.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,
|
|
1
|
+
{"version":3,"file":"buckets.d.mts","sourceRoot":"","sources":["../src/resources/buckets.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIhF;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAI1E;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIlG;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kBAAkB,CAAC;IAIjC;;;;;;;OAOG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;CAQpB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
|
package/resources/buckets.d.ts
CHANGED
|
@@ -26,31 +26,31 @@ export declare class Buckets extends APIResource {
|
|
|
26
26
|
*
|
|
27
27
|
* @example
|
|
28
28
|
* ```ts
|
|
29
|
-
* const
|
|
29
|
+
* const bucketV3 = await client.buckets.create({
|
|
30
30
|
* name: 'invoices',
|
|
31
31
|
* description: 'Knowledge graph for invoice documents',
|
|
32
32
|
* });
|
|
33
33
|
* ```
|
|
34
34
|
*/
|
|
35
|
-
create(body: BucketCreateParams, options?: RequestOptions): APIPromise<
|
|
35
|
+
create(body: BucketCreateParams, options?: RequestOptions): APIPromise<BucketV3>;
|
|
36
36
|
/**
|
|
37
37
|
* Get a Bucket
|
|
38
38
|
*
|
|
39
39
|
* @example
|
|
40
40
|
* ```ts
|
|
41
|
-
* const
|
|
41
|
+
* const bucketV3 = await client.buckets.retrieve('bucketID');
|
|
42
42
|
* ```
|
|
43
43
|
*/
|
|
44
|
-
retrieve(bucketID: string, options?: RequestOptions): APIPromise<
|
|
44
|
+
retrieve(bucketID: string, options?: RequestOptions): APIPromise<BucketV3>;
|
|
45
45
|
/**
|
|
46
46
|
* Update a Bucket
|
|
47
47
|
*
|
|
48
48
|
* @example
|
|
49
49
|
* ```ts
|
|
50
|
-
* const
|
|
50
|
+
* const bucketV3 = await client.buckets.update('bucketID');
|
|
51
51
|
* ```
|
|
52
52
|
*/
|
|
53
|
-
update(bucketID: string, body: BucketUpdateParams, options?: RequestOptions): APIPromise<
|
|
53
|
+
update(bucketID: string, body: BucketUpdateParams, options?: RequestOptions): APIPromise<BucketV3>;
|
|
54
54
|
/**
|
|
55
55
|
* List Buckets
|
|
56
56
|
*
|
|
@@ -78,75 +78,7 @@ export declare class Buckets extends APIResource {
|
|
|
78
78
|
* Every account+environment has exactly one default bucket. The default bucket can
|
|
79
79
|
* be renamed but never deleted.
|
|
80
80
|
*/
|
|
81
|
-
export interface
|
|
82
|
-
/**
|
|
83
|
-
* Stable public identifier for the bucket (`bkt_...`).
|
|
84
|
-
*/
|
|
85
|
-
bucketID: string;
|
|
86
|
-
/**
|
|
87
|
-
* Creation timestamp (RFC 3339).
|
|
88
|
-
*/
|
|
89
|
-
createdAt: string;
|
|
90
|
-
/**
|
|
91
|
-
* Optional human-facing note about the bucket.
|
|
92
|
-
*/
|
|
93
|
-
description: string;
|
|
94
|
-
/**
|
|
95
|
-
* Whether this is the account+environment's default bucket.
|
|
96
|
-
*/
|
|
97
|
-
isDefault: boolean;
|
|
98
|
-
/**
|
|
99
|
-
* Human-facing bucket name. Unique within an account+environment.
|
|
100
|
-
*/
|
|
101
|
-
name: string;
|
|
102
|
-
/**
|
|
103
|
-
* Last-update timestamp (RFC 3339).
|
|
104
|
-
*/
|
|
105
|
-
updatedAt: string;
|
|
106
|
-
}
|
|
107
|
-
/**
|
|
108
|
-
* A Bucket is a named partition of the knowledge graph within an
|
|
109
|
-
* account+environment. Entities, mentions, and relations are scoped to a bucket so
|
|
110
|
-
* a single account+environment can host multiple isolated graphs.
|
|
111
|
-
*
|
|
112
|
-
* Every account+environment has exactly one default bucket. The default bucket can
|
|
113
|
-
* be renamed but never deleted.
|
|
114
|
-
*/
|
|
115
|
-
export interface BucketRetrieveResponse {
|
|
116
|
-
/**
|
|
117
|
-
* Stable public identifier for the bucket (`bkt_...`).
|
|
118
|
-
*/
|
|
119
|
-
bucketID: string;
|
|
120
|
-
/**
|
|
121
|
-
* Creation timestamp (RFC 3339).
|
|
122
|
-
*/
|
|
123
|
-
createdAt: string;
|
|
124
|
-
/**
|
|
125
|
-
* Optional human-facing note about the bucket.
|
|
126
|
-
*/
|
|
127
|
-
description: string;
|
|
128
|
-
/**
|
|
129
|
-
* Whether this is the account+environment's default bucket.
|
|
130
|
-
*/
|
|
131
|
-
isDefault: boolean;
|
|
132
|
-
/**
|
|
133
|
-
* Human-facing bucket name. Unique within an account+environment.
|
|
134
|
-
*/
|
|
135
|
-
name: string;
|
|
136
|
-
/**
|
|
137
|
-
* Last-update timestamp (RFC 3339).
|
|
138
|
-
*/
|
|
139
|
-
updatedAt: string;
|
|
140
|
-
}
|
|
141
|
-
/**
|
|
142
|
-
* A Bucket is a named partition of the knowledge graph within an
|
|
143
|
-
* account+environment. Entities, mentions, and relations are scoped to a bucket so
|
|
144
|
-
* a single account+environment can host multiple isolated graphs.
|
|
145
|
-
*
|
|
146
|
-
* Every account+environment has exactly one default bucket. The default bucket can
|
|
147
|
-
* be renamed but never deleted.
|
|
148
|
-
*/
|
|
149
|
-
export interface BucketUpdateResponse {
|
|
81
|
+
export interface BucketV3 {
|
|
150
82
|
/**
|
|
151
83
|
* Stable public identifier for the bucket (`bkt_...`).
|
|
152
84
|
*/
|
|
@@ -176,48 +108,12 @@ export interface BucketUpdateResponse {
|
|
|
176
108
|
* Response body for listing buckets.
|
|
177
109
|
*/
|
|
178
110
|
export interface BucketListResponse {
|
|
179
|
-
buckets: Array<
|
|
111
|
+
buckets: Array<BucketV3>;
|
|
180
112
|
/**
|
|
181
113
|
* Total number of buckets matching the query, ignoring pagination.
|
|
182
114
|
*/
|
|
183
115
|
totalCount: number;
|
|
184
116
|
}
|
|
185
|
-
export declare namespace BucketListResponse {
|
|
186
|
-
/**
|
|
187
|
-
* A Bucket is a named partition of the knowledge graph within an
|
|
188
|
-
* account+environment. Entities, mentions, and relations are scoped to a bucket so
|
|
189
|
-
* a single account+environment can host multiple isolated graphs.
|
|
190
|
-
*
|
|
191
|
-
* Every account+environment has exactly one default bucket. The default bucket can
|
|
192
|
-
* be renamed but never deleted.
|
|
193
|
-
*/
|
|
194
|
-
interface Bucket {
|
|
195
|
-
/**
|
|
196
|
-
* Stable public identifier for the bucket (`bkt_...`).
|
|
197
|
-
*/
|
|
198
|
-
bucketID: string;
|
|
199
|
-
/**
|
|
200
|
-
* Creation timestamp (RFC 3339).
|
|
201
|
-
*/
|
|
202
|
-
createdAt: string;
|
|
203
|
-
/**
|
|
204
|
-
* Optional human-facing note about the bucket.
|
|
205
|
-
*/
|
|
206
|
-
description: string;
|
|
207
|
-
/**
|
|
208
|
-
* Whether this is the account+environment's default bucket.
|
|
209
|
-
*/
|
|
210
|
-
isDefault: boolean;
|
|
211
|
-
/**
|
|
212
|
-
* Human-facing bucket name. Unique within an account+environment.
|
|
213
|
-
*/
|
|
214
|
-
name: string;
|
|
215
|
-
/**
|
|
216
|
-
* Last-update timestamp (RFC 3339).
|
|
217
|
-
*/
|
|
218
|
-
updatedAt: string;
|
|
219
|
-
}
|
|
220
|
-
}
|
|
221
117
|
export interface BucketCreateParams {
|
|
222
118
|
/**
|
|
223
119
|
* Bucket name. Required and unique within the account+environment.
|
|
@@ -267,6 +163,6 @@ export interface BucketDeleteParams {
|
|
|
267
163
|
cascade?: boolean;
|
|
268
164
|
}
|
|
269
165
|
export declare namespace Buckets {
|
|
270
|
-
export { type
|
|
166
|
+
export { type BucketV3 as BucketV3, type BucketListResponse as BucketListResponse, type BucketCreateParams as BucketCreateParams, type BucketUpdateParams as BucketUpdateParams, type BucketListParams as BucketListParams, type BucketDeleteParams as BucketDeleteParams, };
|
|
271
167
|
}
|
|
272
168
|
//# sourceMappingURL=buckets.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"buckets.d.ts","sourceRoot":"","sources":["../src/resources/buckets.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,
|
|
1
|
+
{"version":3,"file":"buckets.d.ts","sourceRoot":"","sources":["../src/resources/buckets.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIhF;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAI1E;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIlG;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kBAAkB,CAAC;IAIjC;;;;;;;OAOG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;CAQpB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
|
package/resources/buckets.js
CHANGED
|
@@ -30,7 +30,7 @@ class Buckets extends resource_1.APIResource {
|
|
|
30
30
|
*
|
|
31
31
|
* @example
|
|
32
32
|
* ```ts
|
|
33
|
-
* const
|
|
33
|
+
* const bucketV3 = await client.buckets.create({
|
|
34
34
|
* name: 'invoices',
|
|
35
35
|
* description: 'Knowledge graph for invoice documents',
|
|
36
36
|
* });
|
|
@@ -44,7 +44,7 @@ class Buckets extends resource_1.APIResource {
|
|
|
44
44
|
*
|
|
45
45
|
* @example
|
|
46
46
|
* ```ts
|
|
47
|
-
* const
|
|
47
|
+
* const bucketV3 = await client.buckets.retrieve('bucketID');
|
|
48
48
|
* ```
|
|
49
49
|
*/
|
|
50
50
|
retrieve(bucketID, options) {
|
|
@@ -55,7 +55,7 @@ class Buckets extends resource_1.APIResource {
|
|
|
55
55
|
*
|
|
56
56
|
* @example
|
|
57
57
|
* ```ts
|
|
58
|
-
* const
|
|
58
|
+
* const bucketV3 = await client.buckets.update('bucketID');
|
|
59
59
|
* ```
|
|
60
60
|
*/
|
|
61
61
|
update(bucketID, body, options) {
|
package/resources/buckets.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"buckets.js","sourceRoot":"","sources":["../src/resources/buckets.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAEnD,oDAA8C;AAE9C;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,
|
|
1
|
+
{"version":3,"file":"buckets.js","sourceRoot":"","sources":["../src/resources/buckets.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAEnD,oDAA8C;AAE9C;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,QAAgB,EAAE,IAAwB,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,eAAe,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CACJ,QAAgB,EAChB,SAAgD,EAAE,EAClD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,eAAe,QAAQ,EAAE,EAAE;YACxD,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AA3ED,0BA2EC"}
|
package/resources/buckets.mjs
CHANGED
|
@@ -27,7 +27,7 @@ export class Buckets extends APIResource {
|
|
|
27
27
|
*
|
|
28
28
|
* @example
|
|
29
29
|
* ```ts
|
|
30
|
-
* const
|
|
30
|
+
* const bucketV3 = await client.buckets.create({
|
|
31
31
|
* name: 'invoices',
|
|
32
32
|
* description: 'Knowledge graph for invoice documents',
|
|
33
33
|
* });
|
|
@@ -41,7 +41,7 @@ export class Buckets extends APIResource {
|
|
|
41
41
|
*
|
|
42
42
|
* @example
|
|
43
43
|
* ```ts
|
|
44
|
-
* const
|
|
44
|
+
* const bucketV3 = await client.buckets.retrieve('bucketID');
|
|
45
45
|
* ```
|
|
46
46
|
*/
|
|
47
47
|
retrieve(bucketID, options) {
|
|
@@ -52,7 +52,7 @@ export class Buckets extends APIResource {
|
|
|
52
52
|
*
|
|
53
53
|
* @example
|
|
54
54
|
* ```ts
|
|
55
|
-
* const
|
|
55
|
+
* const bucketV3 = await client.buckets.update('bucketID');
|
|
56
56
|
* ```
|
|
57
57
|
*/
|
|
58
58
|
update(bucketID, body, options) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"buckets.mjs","sourceRoot":"","sources":["../src/resources/buckets.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,
|
|
1
|
+
{"version":3,"file":"buckets.mjs","sourceRoot":"","sources":["../src/resources/buckets.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,QAAgB,EAAE,IAAwB,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,eAAe,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CACJ,QAAgB,EAChB,SAAgD,EAAE,EAClD,OAAwB;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,eAAe,QAAQ,EAAE,EAAE;YACxD,KAAK,EAAE,EAAE,OAAO,EAAE;YAClB,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { APIResource } from "../../core/resource.mjs";
|
|
2
|
+
import * as EntitiesAPI from "./entities.mjs";
|
|
2
3
|
import * as SynonymsAPI from "./synonyms.mjs";
|
|
3
4
|
import { SynonymAddParams, SynonymAddResponse, SynonymRemoveParams, Synonyms } from "./synonyms.mjs";
|
|
4
5
|
import { APIPromise } from "../../core/api-promise.mjs";
|
|
@@ -71,6 +72,52 @@ export declare class Entities extends APIResource {
|
|
|
71
72
|
*/
|
|
72
73
|
retrieveSeedStatus(id: string, options?: RequestOptions): APIPromise<EntityRetrieveSeedStatusResponse>;
|
|
73
74
|
}
|
|
75
|
+
/**
|
|
76
|
+
* A compact view of an entity sitting on the far end of a relation edge — the
|
|
77
|
+
* stable public id, the canonical name, and the effective type. The full entity is
|
|
78
|
+
* fetched separately via the entity detail / File System endpoints.
|
|
79
|
+
*/
|
|
80
|
+
export interface RelatedEntity {
|
|
81
|
+
/**
|
|
82
|
+
* Stable public identifier for the entity (`ent_...`).
|
|
83
|
+
*/
|
|
84
|
+
id: string;
|
|
85
|
+
/**
|
|
86
|
+
* Canonical (most descriptive) surface form of the entity.
|
|
87
|
+
*/
|
|
88
|
+
canonical: string;
|
|
89
|
+
/**
|
|
90
|
+
* Hops from the queried entity. This endpoint returns direct relations, so this is
|
|
91
|
+
* 1 (a self-loop's far end is the queried entity itself, 0).
|
|
92
|
+
*/
|
|
93
|
+
depth: number;
|
|
94
|
+
/**
|
|
95
|
+
* Effective entity type.
|
|
96
|
+
*/
|
|
97
|
+
type: string;
|
|
98
|
+
}
|
|
99
|
+
/**
|
|
100
|
+
* The outcome of seeding one row.
|
|
101
|
+
*/
|
|
102
|
+
export interface SeedRowResult {
|
|
103
|
+
/**
|
|
104
|
+
* The canonical name from the input row.
|
|
105
|
+
*/
|
|
106
|
+
canonical: string;
|
|
107
|
+
/**
|
|
108
|
+
* What happened to this row: `created` (new entity), `merged-with` (matched an
|
|
109
|
+
* existing entity), or `rejected` (see `reason`).
|
|
110
|
+
*/
|
|
111
|
+
outcome: 'created' | 'merged-with' | 'rejected';
|
|
112
|
+
/**
|
|
113
|
+
* Public ID (`ent_...`) of the created or merged entity. Absent when rejected.
|
|
114
|
+
*/
|
|
115
|
+
entityID?: string;
|
|
116
|
+
/**
|
|
117
|
+
* Human-readable explanation when `outcome` is `rejected`.
|
|
118
|
+
*/
|
|
119
|
+
reason?: string;
|
|
120
|
+
}
|
|
74
121
|
/**
|
|
75
122
|
* An entity record, including its curation status and assigned type.
|
|
76
123
|
*/
|
|
@@ -131,35 +178,13 @@ export interface EntityBulkCreateResponse {
|
|
|
131
178
|
/**
|
|
132
179
|
* Per-row outcomes, in request order.
|
|
133
180
|
*/
|
|
134
|
-
results: Array<
|
|
181
|
+
results: Array<SeedRowResult>;
|
|
135
182
|
/**
|
|
136
183
|
* Per-outcome tally across a batch.
|
|
137
184
|
*/
|
|
138
185
|
summary: EntityBulkCreateResponse.Summary;
|
|
139
186
|
}
|
|
140
187
|
export declare namespace EntityBulkCreateResponse {
|
|
141
|
-
/**
|
|
142
|
-
* The outcome of seeding one row.
|
|
143
|
-
*/
|
|
144
|
-
interface Result {
|
|
145
|
-
/**
|
|
146
|
-
* The canonical name from the input row.
|
|
147
|
-
*/
|
|
148
|
-
canonical: string;
|
|
149
|
-
/**
|
|
150
|
-
* What happened to this row: `created` (new entity), `merged-with` (matched an
|
|
151
|
-
* existing entity), or `rejected` (see `reason`).
|
|
152
|
-
*/
|
|
153
|
-
outcome: 'created' | 'merged-with' | 'rejected';
|
|
154
|
-
/**
|
|
155
|
-
* Public ID (`ent_...`) of the created or merged entity. Absent when rejected.
|
|
156
|
-
*/
|
|
157
|
-
entityID?: string;
|
|
158
|
-
/**
|
|
159
|
-
* Human-readable explanation when `outcome` is `rejected`.
|
|
160
|
-
*/
|
|
161
|
-
reason?: string;
|
|
162
|
-
}
|
|
163
188
|
/**
|
|
164
189
|
* Per-outcome tally across a batch.
|
|
165
190
|
*/
|
|
@@ -268,33 +293,7 @@ export declare namespace EntityRetrieveRelationsResponse {
|
|
|
268
293
|
* stable public id, the canonical name, and the effective type. The full entity is
|
|
269
294
|
* fetched separately via the entity detail / File System endpoints.
|
|
270
295
|
*/
|
|
271
|
-
sourceEntity:
|
|
272
|
-
}
|
|
273
|
-
namespace Inbound {
|
|
274
|
-
/**
|
|
275
|
-
* A compact view of an entity sitting on the far end of a relation edge — the
|
|
276
|
-
* stable public id, the canonical name, and the effective type. The full entity is
|
|
277
|
-
* fetched separately via the entity detail / File System endpoints.
|
|
278
|
-
*/
|
|
279
|
-
interface SourceEntity {
|
|
280
|
-
/**
|
|
281
|
-
* Stable public identifier for the entity (`ent_...`).
|
|
282
|
-
*/
|
|
283
|
-
id: string;
|
|
284
|
-
/**
|
|
285
|
-
* Canonical (most descriptive) surface form of the entity.
|
|
286
|
-
*/
|
|
287
|
-
canonical: string;
|
|
288
|
-
/**
|
|
289
|
-
* Hops from the queried entity. This endpoint returns direct relations, so this is
|
|
290
|
-
* 1 (a self-loop's far end is the queried entity itself, 0).
|
|
291
|
-
*/
|
|
292
|
-
depth: number;
|
|
293
|
-
/**
|
|
294
|
-
* Effective entity type.
|
|
295
|
-
*/
|
|
296
|
-
type: string;
|
|
297
|
-
}
|
|
296
|
+
sourceEntity: EntitiesAPI.RelatedEntity;
|
|
298
297
|
}
|
|
299
298
|
/**
|
|
300
299
|
* One edge pointing AWAY from the queried entity (it is the source).
|
|
@@ -317,33 +316,7 @@ export declare namespace EntityRetrieveRelationsResponse {
|
|
|
317
316
|
* stable public id, the canonical name, and the effective type. The full entity is
|
|
318
317
|
* fetched separately via the entity detail / File System endpoints.
|
|
319
318
|
*/
|
|
320
|
-
targetEntity:
|
|
321
|
-
}
|
|
322
|
-
namespace Outbound {
|
|
323
|
-
/**
|
|
324
|
-
* A compact view of an entity sitting on the far end of a relation edge — the
|
|
325
|
-
* stable public id, the canonical name, and the effective type. The full entity is
|
|
326
|
-
* fetched separately via the entity detail / File System endpoints.
|
|
327
|
-
*/
|
|
328
|
-
interface TargetEntity {
|
|
329
|
-
/**
|
|
330
|
-
* Stable public identifier for the entity (`ent_...`).
|
|
331
|
-
*/
|
|
332
|
-
id: string;
|
|
333
|
-
/**
|
|
334
|
-
* Canonical (most descriptive) surface form of the entity.
|
|
335
|
-
*/
|
|
336
|
-
canonical: string;
|
|
337
|
-
/**
|
|
338
|
-
* Hops from the queried entity. This endpoint returns direct relations, so this is
|
|
339
|
-
* 1 (a self-loop's far end is the queried entity itself, 0).
|
|
340
|
-
*/
|
|
341
|
-
depth: number;
|
|
342
|
-
/**
|
|
343
|
-
* Effective entity type.
|
|
344
|
-
*/
|
|
345
|
-
type: string;
|
|
346
|
-
}
|
|
319
|
+
targetEntity: EntitiesAPI.RelatedEntity;
|
|
347
320
|
}
|
|
348
321
|
}
|
|
349
322
|
/**
|
|
@@ -381,31 +354,7 @@ export interface EntityRetrieveSeedStatusResponse {
|
|
|
381
354
|
/**
|
|
382
355
|
* Per-row outcomes. Present only once `status` is `completed`.
|
|
383
356
|
*/
|
|
384
|
-
results?: Array<
|
|
385
|
-
}
|
|
386
|
-
export declare namespace EntityRetrieveSeedStatusResponse {
|
|
387
|
-
/**
|
|
388
|
-
* The outcome of seeding one row.
|
|
389
|
-
*/
|
|
390
|
-
interface Result {
|
|
391
|
-
/**
|
|
392
|
-
* The canonical name from the input row.
|
|
393
|
-
*/
|
|
394
|
-
canonical: string;
|
|
395
|
-
/**
|
|
396
|
-
* What happened to this row: `created` (new entity), `merged-with` (matched an
|
|
397
|
-
* existing entity), or `rejected` (see `reason`).
|
|
398
|
-
*/
|
|
399
|
-
outcome: 'created' | 'merged-with' | 'rejected';
|
|
400
|
-
/**
|
|
401
|
-
* Public ID (`ent_...`) of the created or merged entity. Absent when rejected.
|
|
402
|
-
*/
|
|
403
|
-
entityID?: string;
|
|
404
|
-
/**
|
|
405
|
-
* Human-readable explanation when `outcome` is `rejected`.
|
|
406
|
-
*/
|
|
407
|
-
reason?: string;
|
|
408
|
-
}
|
|
357
|
+
results?: Array<SeedRowResult>;
|
|
409
358
|
}
|
|
410
359
|
export interface EntityUpdateParams {
|
|
411
360
|
/**
|
|
@@ -520,7 +469,7 @@ export interface EntityRetrieveRelationsParams {
|
|
|
520
469
|
relationType?: string;
|
|
521
470
|
}
|
|
522
471
|
export declare namespace Entities {
|
|
523
|
-
export { type EntityUpdateResponse as EntityUpdateResponse, type EntityBulkCreateResponse as EntityBulkCreateResponse, type EntityBulkValidateResponse as EntityBulkValidateResponse, type EntityRetrieveRelationsResponse as EntityRetrieveRelationsResponse, type EntityRetrieveSeedStatusResponse as EntityRetrieveSeedStatusResponse, type EntityUpdateParams as EntityUpdateParams, type EntityBulkCreateParams as EntityBulkCreateParams, type EntityBulkValidateParams as EntityBulkValidateParams, type EntityRetrieveRelationsParams as EntityRetrieveRelationsParams, };
|
|
472
|
+
export { type RelatedEntity as RelatedEntity, type SeedRowResult as SeedRowResult, type EntityUpdateResponse as EntityUpdateResponse, type EntityBulkCreateResponse as EntityBulkCreateResponse, type EntityBulkValidateResponse as EntityBulkValidateResponse, type EntityRetrieveRelationsResponse as EntityRetrieveRelationsResponse, type EntityRetrieveSeedStatusResponse as EntityRetrieveSeedStatusResponse, type EntityUpdateParams as EntityUpdateParams, type EntityBulkCreateParams as EntityBulkCreateParams, type EntityBulkValidateParams as EntityBulkValidateParams, type EntityRetrieveRelationsParams as EntityRetrieveRelationsParams, };
|
|
524
473
|
export { Synonyms as Synonyms, type SynonymAddResponse as SynonymAddResponse, type SynonymAddParams as SynonymAddParams, type SynonymRemoveParams as SynonymRemoveParams, };
|
|
525
474
|
}
|
|
526
475
|
//# sourceMappingURL=entities.d.mts.map
|