tako-sdk 0.1.5 → 1.0.2
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/LICENSE +21 -0
- package/README.md +92 -77
- package/dist/index.cjs +3485 -186
- package/dist/index.d.cts +3518 -146
- package/dist/index.d.ts +3518 -146
- package/dist/index.js +3146 -178
- package/package.json +39 -22
package/dist/index.d.ts
CHANGED
|
@@ -1,209 +1,3581 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
2
|
+
* Knowledge Search API
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
3
11
|
*/
|
|
4
|
-
declare
|
|
5
|
-
|
|
6
|
-
|
|
12
|
+
declare const BASE_PATH: string;
|
|
13
|
+
interface ConfigurationParameters {
|
|
14
|
+
basePath?: string;
|
|
15
|
+
fetchApi?: FetchAPI;
|
|
16
|
+
middleware?: Middleware[];
|
|
17
|
+
queryParamsStringify?: (params: HTTPQuery) => string;
|
|
18
|
+
username?: string;
|
|
19
|
+
password?: string;
|
|
20
|
+
apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>);
|
|
21
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
|
|
22
|
+
headers?: HTTPHeaders;
|
|
23
|
+
credentials?: RequestCredentials;
|
|
7
24
|
}
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
25
|
+
declare class Configuration {
|
|
26
|
+
private configuration;
|
|
27
|
+
constructor(configuration?: ConfigurationParameters);
|
|
28
|
+
set config(configuration: Configuration);
|
|
29
|
+
get basePath(): string;
|
|
30
|
+
get fetchApi(): FetchAPI | undefined;
|
|
31
|
+
get middleware(): Middleware[];
|
|
32
|
+
get queryParamsStringify(): (params: HTTPQuery) => string;
|
|
33
|
+
get username(): string | undefined;
|
|
34
|
+
get password(): string | undefined;
|
|
35
|
+
get apiKey(): ((name: string) => string | Promise<string>) | undefined;
|
|
36
|
+
get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
|
|
37
|
+
get headers(): HTTPHeaders | undefined;
|
|
38
|
+
get credentials(): RequestCredentials | undefined;
|
|
39
|
+
}
|
|
40
|
+
declare const DefaultConfig: Configuration;
|
|
41
|
+
/**
|
|
42
|
+
* This is the base class for all generated API classes.
|
|
43
|
+
*/
|
|
44
|
+
declare class BaseAPI {
|
|
45
|
+
protected configuration: Configuration;
|
|
46
|
+
private static readonly jsonRegex;
|
|
47
|
+
private middleware;
|
|
48
|
+
constructor(configuration?: Configuration);
|
|
49
|
+
withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
|
|
50
|
+
withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
|
|
51
|
+
withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
|
|
52
|
+
/**
|
|
53
|
+
* Check if the given MIME is a JSON MIME.
|
|
54
|
+
* JSON MIME examples:
|
|
55
|
+
* application/json
|
|
56
|
+
* application/json; charset=UTF8
|
|
57
|
+
* APPLICATION/JSON
|
|
58
|
+
* application/vnd.company+json
|
|
59
|
+
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
|
60
|
+
* @return True if the given MIME is JSON, false otherwise.
|
|
61
|
+
*/
|
|
62
|
+
protected isJsonMime(mime: string | null | undefined): boolean;
|
|
63
|
+
protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
|
|
64
|
+
private createFetchParams;
|
|
65
|
+
private fetchApi;
|
|
66
|
+
/**
|
|
67
|
+
* Create a shallow clone of `this` by constructing a new instance
|
|
68
|
+
* and then shallow cloning data members.
|
|
69
|
+
*/
|
|
70
|
+
private clone;
|
|
12
71
|
}
|
|
13
|
-
|
|
14
|
-
|
|
72
|
+
declare class ResponseError extends Error {
|
|
73
|
+
response: Response;
|
|
74
|
+
name: "ResponseError";
|
|
75
|
+
constructor(response: Response, msg?: string);
|
|
15
76
|
}
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
77
|
+
declare class FetchError extends Error {
|
|
78
|
+
cause: Error;
|
|
79
|
+
name: "FetchError";
|
|
80
|
+
constructor(cause: Error, msg?: string);
|
|
19
81
|
}
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
82
|
+
declare class RequiredError extends Error {
|
|
83
|
+
field: string;
|
|
84
|
+
name: "RequiredError";
|
|
85
|
+
constructor(field: string, msg?: string);
|
|
86
|
+
}
|
|
87
|
+
declare const COLLECTION_FORMATS: {
|
|
88
|
+
csv: string;
|
|
89
|
+
ssv: string;
|
|
90
|
+
tsv: string;
|
|
91
|
+
pipes: string;
|
|
92
|
+
};
|
|
93
|
+
type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
|
|
94
|
+
type Json = any;
|
|
95
|
+
type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
|
|
96
|
+
type HTTPHeaders = {
|
|
97
|
+
[key: string]: string;
|
|
98
|
+
};
|
|
99
|
+
type HTTPQuery = {
|
|
100
|
+
[key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
|
|
101
|
+
};
|
|
102
|
+
type HTTPBody = Json | FormData | URLSearchParams;
|
|
103
|
+
type HTTPRequestInit = {
|
|
104
|
+
headers?: HTTPHeaders;
|
|
105
|
+
method: HTTPMethod;
|
|
106
|
+
credentials?: RequestCredentials;
|
|
107
|
+
body?: HTTPBody;
|
|
108
|
+
};
|
|
109
|
+
type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
|
|
110
|
+
type InitOverrideFunction = (requestContext: {
|
|
111
|
+
init: HTTPRequestInit;
|
|
112
|
+
context: RequestOpts;
|
|
113
|
+
}) => Promise<RequestInit>;
|
|
114
|
+
interface FetchParams {
|
|
24
115
|
url: string;
|
|
116
|
+
init: RequestInit;
|
|
25
117
|
}
|
|
26
|
-
interface
|
|
27
|
-
|
|
28
|
-
|
|
118
|
+
interface RequestOpts {
|
|
119
|
+
path: string;
|
|
120
|
+
method: HTTPMethod;
|
|
121
|
+
headers: HTTPHeaders;
|
|
122
|
+
query?: HTTPQuery;
|
|
123
|
+
body?: HTTPBody;
|
|
29
124
|
}
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
methodologies?: Methodology[];
|
|
39
|
-
}
|
|
40
|
-
interface KnowledgeSearchResponse {
|
|
41
|
-
outputs: {
|
|
42
|
-
knowledge_cards: KnowledgeCard[];
|
|
43
|
-
};
|
|
125
|
+
declare function querystring(params: HTTPQuery, prefix?: string): string;
|
|
126
|
+
declare function exists(json: any, key: string): boolean;
|
|
127
|
+
declare function mapValues(data: any, fn: (item: any) => any): {
|
|
128
|
+
[key: string]: any;
|
|
129
|
+
};
|
|
130
|
+
declare function canConsumeForm(consumes: Consume[]): boolean;
|
|
131
|
+
interface Consume {
|
|
132
|
+
contentType: string;
|
|
44
133
|
}
|
|
45
|
-
interface
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
134
|
+
interface RequestContext {
|
|
135
|
+
fetch: FetchAPI;
|
|
136
|
+
url: string;
|
|
137
|
+
init: RequestInit;
|
|
138
|
+
}
|
|
139
|
+
interface ResponseContext {
|
|
140
|
+
fetch: FetchAPI;
|
|
141
|
+
url: string;
|
|
142
|
+
init: RequestInit;
|
|
143
|
+
response: Response;
|
|
49
144
|
}
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
145
|
+
interface ErrorContext {
|
|
146
|
+
fetch: FetchAPI;
|
|
147
|
+
url: string;
|
|
148
|
+
init: RequestInit;
|
|
149
|
+
error: unknown;
|
|
150
|
+
response?: Response;
|
|
54
151
|
}
|
|
55
|
-
|
|
56
|
-
|
|
152
|
+
interface Middleware {
|
|
153
|
+
pre?(context: RequestContext): Promise<FetchParams | void>;
|
|
154
|
+
post?(context: ResponseContext): Promise<Response | void>;
|
|
155
|
+
onError?(context: ErrorContext): Promise<Response | void>;
|
|
57
156
|
}
|
|
58
|
-
|
|
59
|
-
|
|
157
|
+
interface ApiResponse<T> {
|
|
158
|
+
raw: Response;
|
|
159
|
+
value(): Promise<T>;
|
|
60
160
|
}
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
161
|
+
interface ResponseTransformer<T> {
|
|
162
|
+
(json: any): T;
|
|
163
|
+
}
|
|
164
|
+
declare class JSONApiResponse<T> {
|
|
165
|
+
raw: Response;
|
|
166
|
+
private transformer;
|
|
167
|
+
constructor(raw: Response, transformer?: ResponseTransformer<T>);
|
|
168
|
+
value(): Promise<T>;
|
|
169
|
+
}
|
|
170
|
+
declare class VoidApiResponse {
|
|
171
|
+
raw: Response;
|
|
172
|
+
constructor(raw: Response);
|
|
173
|
+
value(): Promise<void>;
|
|
70
174
|
}
|
|
175
|
+
declare class BlobApiResponse {
|
|
176
|
+
raw: Response;
|
|
177
|
+
constructor(raw: Response);
|
|
178
|
+
value(): Promise<Blob>;
|
|
179
|
+
}
|
|
180
|
+
declare class TextApiResponse {
|
|
181
|
+
raw: Response;
|
|
182
|
+
constructor(raw: Response);
|
|
183
|
+
value(): Promise<string>;
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
/**
|
|
187
|
+
* Knowledge Search API
|
|
188
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
189
|
+
*
|
|
190
|
+
* The version of the OpenAPI document: 1.0.0
|
|
191
|
+
*
|
|
192
|
+
*
|
|
193
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
194
|
+
* https://openapi-generator.tech
|
|
195
|
+
* Do not edit the class manually.
|
|
196
|
+
*/
|
|
71
197
|
/**
|
|
72
|
-
*
|
|
198
|
+
*
|
|
199
|
+
* @export
|
|
200
|
+
* @interface KnowledgeCardMethodology
|
|
73
201
|
*/
|
|
74
|
-
interface
|
|
75
|
-
/**
|
|
76
|
-
|
|
202
|
+
interface KnowledgeCardMethodology {
|
|
203
|
+
/**
|
|
204
|
+
* The name of the methodology
|
|
205
|
+
* @type {string}
|
|
206
|
+
* @memberof KnowledgeCardMethodology
|
|
207
|
+
*/
|
|
208
|
+
methodology_name: string | null;
|
|
77
209
|
/**
|
|
78
|
-
* The
|
|
79
|
-
*
|
|
210
|
+
* The description of the methodology
|
|
211
|
+
* @type {string}
|
|
212
|
+
* @memberof KnowledgeCardMethodology
|
|
80
213
|
*/
|
|
81
|
-
|
|
214
|
+
methodology_description: string | null;
|
|
82
215
|
}
|
|
83
216
|
/**
|
|
84
|
-
*
|
|
217
|
+
* Check if a given object implements the KnowledgeCardMethodology interface.
|
|
218
|
+
*/
|
|
219
|
+
declare function instanceOfKnowledgeCardMethodology(value: object): value is KnowledgeCardMethodology;
|
|
220
|
+
declare function KnowledgeCardMethodologyFromJSON(json: any): KnowledgeCardMethodology;
|
|
221
|
+
declare function KnowledgeCardMethodologyFromJSONTyped(json: any, ignoreDiscriminator: boolean): KnowledgeCardMethodology;
|
|
222
|
+
declare function KnowledgeCardMethodologyToJSON(json: any): KnowledgeCardMethodology;
|
|
223
|
+
declare function KnowledgeCardMethodologyToJSONTyped(value?: KnowledgeCardMethodology | null, ignoreDiscriminator?: boolean): any;
|
|
224
|
+
|
|
225
|
+
/**
|
|
226
|
+
* Knowledge Search API
|
|
227
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
228
|
+
*
|
|
229
|
+
* The version of the OpenAPI document: 1.0.0
|
|
230
|
+
*
|
|
231
|
+
*
|
|
232
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
233
|
+
* https://openapi-generator.tech
|
|
234
|
+
* Do not edit the class manually.
|
|
235
|
+
*/
|
|
236
|
+
/**
|
|
237
|
+
*
|
|
238
|
+
* @export
|
|
85
239
|
*/
|
|
86
|
-
|
|
87
|
-
|
|
240
|
+
declare const CardSourceIndex: {
|
|
241
|
+
readonly Tako: "tako";
|
|
242
|
+
readonly Web: "web";
|
|
243
|
+
readonly ConnectedData: "connected_data";
|
|
244
|
+
readonly TakoDeepV2: "tako_deep_v2";
|
|
245
|
+
};
|
|
246
|
+
type CardSourceIndex = typeof CardSourceIndex[keyof typeof CardSourceIndex];
|
|
247
|
+
declare function instanceOfCardSourceIndex(value: any): boolean;
|
|
248
|
+
declare function CardSourceIndexFromJSON(json: any): CardSourceIndex;
|
|
249
|
+
declare function CardSourceIndexFromJSONTyped(json: any, ignoreDiscriminator: boolean): CardSourceIndex;
|
|
250
|
+
declare function CardSourceIndexToJSON(value?: CardSourceIndex | null): any;
|
|
251
|
+
declare function CardSourceIndexToJSONTyped(value: any, ignoreDiscriminator: boolean): CardSourceIndex;
|
|
252
|
+
|
|
253
|
+
/**
|
|
254
|
+
* Knowledge Search API
|
|
255
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
256
|
+
*
|
|
257
|
+
* The version of the OpenAPI document: 1.0.0
|
|
258
|
+
*
|
|
259
|
+
*
|
|
260
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
261
|
+
* https://openapi-generator.tech
|
|
262
|
+
* Do not edit the class manually.
|
|
263
|
+
*/
|
|
264
|
+
|
|
265
|
+
/**
|
|
266
|
+
*
|
|
267
|
+
* @export
|
|
268
|
+
* @interface KnowledgeCardSourceIndexesInner
|
|
269
|
+
*/
|
|
270
|
+
interface KnowledgeCardSourceIndexesInner {
|
|
271
|
+
/**
|
|
272
|
+
*
|
|
273
|
+
* @type {CardSourceIndex}
|
|
274
|
+
* @memberof KnowledgeCardSourceIndexesInner
|
|
275
|
+
*/
|
|
276
|
+
index_type: CardSourceIndex;
|
|
277
|
+
/**
|
|
278
|
+
* An ID for a segment of a source index
|
|
279
|
+
* @type {string}
|
|
280
|
+
* @memberof KnowledgeCardSourceIndexesInner
|
|
281
|
+
*/
|
|
282
|
+
segment_id: string;
|
|
88
283
|
}
|
|
89
284
|
/**
|
|
90
|
-
*
|
|
285
|
+
* Check if a given object implements the KnowledgeCardSourceIndexesInner interface.
|
|
286
|
+
*/
|
|
287
|
+
declare function instanceOfKnowledgeCardSourceIndexesInner(value: object): value is KnowledgeCardSourceIndexesInner;
|
|
288
|
+
declare function KnowledgeCardSourceIndexesInnerFromJSON(json: any): KnowledgeCardSourceIndexesInner;
|
|
289
|
+
declare function KnowledgeCardSourceIndexesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): KnowledgeCardSourceIndexesInner;
|
|
290
|
+
declare function KnowledgeCardSourceIndexesInnerToJSON(json: any): KnowledgeCardSourceIndexesInner;
|
|
291
|
+
declare function KnowledgeCardSourceIndexesInnerToJSONTyped(value?: KnowledgeCardSourceIndexesInner | null, ignoreDiscriminator?: boolean): any;
|
|
292
|
+
|
|
293
|
+
/**
|
|
294
|
+
* Knowledge Search API
|
|
295
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
296
|
+
*
|
|
297
|
+
* The version of the OpenAPI document: 1.0.0
|
|
298
|
+
*
|
|
299
|
+
*
|
|
300
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
301
|
+
* https://openapi-generator.tech
|
|
302
|
+
* Do not edit the class manually.
|
|
303
|
+
*/
|
|
304
|
+
|
|
305
|
+
/**
|
|
306
|
+
* The index of the source
|
|
307
|
+
* @export
|
|
308
|
+
* @interface SourceIndex
|
|
91
309
|
*/
|
|
92
|
-
interface
|
|
93
|
-
/**
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
/**
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
310
|
+
interface SourceIndex {
|
|
311
|
+
/**
|
|
312
|
+
*
|
|
313
|
+
* @type {CardSourceIndex}
|
|
314
|
+
* @memberof SourceIndex
|
|
315
|
+
*/
|
|
316
|
+
index_type: CardSourceIndex;
|
|
317
|
+
/**
|
|
318
|
+
* An ID for a segment of a source index (optional for private indexes)
|
|
319
|
+
* @type {string}
|
|
320
|
+
* @memberof SourceIndex
|
|
321
|
+
*/
|
|
322
|
+
segment_id: string;
|
|
323
|
+
/**
|
|
324
|
+
* An ID for a private index
|
|
325
|
+
* @type {string}
|
|
326
|
+
* @memberof SourceIndex
|
|
327
|
+
*/
|
|
328
|
+
private_index_id: string;
|
|
103
329
|
}
|
|
104
|
-
|
|
330
|
+
/**
|
|
331
|
+
* Check if a given object implements the SourceIndex interface.
|
|
332
|
+
*/
|
|
333
|
+
declare function instanceOfSourceIndex(value: object): value is SourceIndex;
|
|
334
|
+
declare function SourceIndexFromJSON(json: any): SourceIndex;
|
|
335
|
+
declare function SourceIndexFromJSONTyped(json: any, ignoreDiscriminator: boolean): SourceIndex;
|
|
336
|
+
declare function SourceIndexToJSON(json: any): SourceIndex;
|
|
337
|
+
declare function SourceIndexToJSONTyped(value?: SourceIndex | null, ignoreDiscriminator?: boolean): any;
|
|
338
|
+
|
|
339
|
+
/**
|
|
340
|
+
* Knowledge Search API
|
|
341
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
342
|
+
*
|
|
343
|
+
* The version of the OpenAPI document: 1.0.0
|
|
344
|
+
*
|
|
345
|
+
*
|
|
346
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
347
|
+
* https://openapi-generator.tech
|
|
348
|
+
* Do not edit the class manually.
|
|
349
|
+
*/
|
|
350
|
+
|
|
351
|
+
/**
|
|
352
|
+
*
|
|
353
|
+
* @export
|
|
354
|
+
* @interface KnowledgeCardSource
|
|
355
|
+
*/
|
|
356
|
+
interface KnowledgeCardSource {
|
|
357
|
+
/**
|
|
358
|
+
* The name of the source
|
|
359
|
+
* @type {string}
|
|
360
|
+
* @memberof KnowledgeCardSource
|
|
361
|
+
*/
|
|
362
|
+
source_name: string | null;
|
|
363
|
+
/**
|
|
364
|
+
* The description of the source
|
|
365
|
+
* @type {string}
|
|
366
|
+
* @memberof KnowledgeCardSource
|
|
367
|
+
*/
|
|
368
|
+
source_description: string | null;
|
|
369
|
+
/**
|
|
370
|
+
*
|
|
371
|
+
* @type {SourceIndex}
|
|
372
|
+
* @memberof KnowledgeCardSource
|
|
373
|
+
*/
|
|
374
|
+
source_index: SourceIndex;
|
|
375
|
+
/**
|
|
376
|
+
* The URL of the source
|
|
377
|
+
* @type {string}
|
|
378
|
+
* @memberof KnowledgeCardSource
|
|
379
|
+
*/
|
|
380
|
+
url: string | null;
|
|
381
|
+
/**
|
|
382
|
+
* Raw excerpt(s) retrieved from the source page — the unmodified web content the answer was grounded in, NOT the synthesized answer. Populated for WEB sources; null for sources that don't carry an extracted excerpt (e.g. TAKO sources).
|
|
383
|
+
* @type {string}
|
|
384
|
+
* @memberof KnowledgeCardSource
|
|
385
|
+
*/
|
|
386
|
+
source_text?: string | null;
|
|
105
387
|
}
|
|
106
|
-
|
|
388
|
+
/**
|
|
389
|
+
* Check if a given object implements the KnowledgeCardSource interface.
|
|
390
|
+
*/
|
|
391
|
+
declare function instanceOfKnowledgeCardSource(value: object): value is KnowledgeCardSource;
|
|
392
|
+
declare function KnowledgeCardSourceFromJSON(json: any): KnowledgeCardSource;
|
|
393
|
+
declare function KnowledgeCardSourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): KnowledgeCardSource;
|
|
394
|
+
declare function KnowledgeCardSourceToJSON(json: any): KnowledgeCardSource;
|
|
395
|
+
declare function KnowledgeCardSourceToJSONTyped(value?: KnowledgeCardSource | null, ignoreDiscriminator?: boolean): any;
|
|
396
|
+
|
|
397
|
+
/**
|
|
398
|
+
* Knowledge Search API
|
|
399
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
400
|
+
*
|
|
401
|
+
* The version of the OpenAPI document: 1.0.0
|
|
402
|
+
*
|
|
403
|
+
*
|
|
404
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
405
|
+
* https://openapi-generator.tech
|
|
406
|
+
* Do not edit the class manually.
|
|
407
|
+
*/
|
|
408
|
+
/**
|
|
409
|
+
*
|
|
410
|
+
* @export
|
|
411
|
+
*/
|
|
412
|
+
declare const ContentFormat: {
|
|
413
|
+
readonly Csv: "csv";
|
|
414
|
+
readonly Text: "text";
|
|
415
|
+
};
|
|
416
|
+
type ContentFormat = typeof ContentFormat[keyof typeof ContentFormat];
|
|
417
|
+
declare function instanceOfContentFormat(value: any): boolean;
|
|
418
|
+
declare function ContentFormatFromJSON(json: any): ContentFormat;
|
|
419
|
+
declare function ContentFormatFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContentFormat;
|
|
420
|
+
declare function ContentFormatToJSON(value?: ContentFormat | null): any;
|
|
421
|
+
declare function ContentFormatToJSONTyped(value: any, ignoreDiscriminator: boolean): ContentFormat;
|
|
422
|
+
|
|
423
|
+
/**
|
|
424
|
+
* Knowledge Search API
|
|
425
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
426
|
+
*
|
|
427
|
+
* The version of the OpenAPI document: 1.0.0
|
|
428
|
+
*
|
|
429
|
+
*
|
|
430
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
431
|
+
* https://openapi-generator.tech
|
|
432
|
+
* Do not edit the class manually.
|
|
433
|
+
*/
|
|
434
|
+
|
|
435
|
+
/**
|
|
436
|
+
* Describes the downloadable content behind a result. `cost` is the USD the
|
|
437
|
+
* /contents call will charge for this result (Tako card CSV is free; web text is
|
|
438
|
+
* the canonical Contents rate). The inline fields (`data`/`total_rows`/
|
|
439
|
+
* `truncated`) are populated only by auto-contents / `/contents` inline mode;
|
|
440
|
+
* when unset, this is just the quote (format + cost), fetched later via the
|
|
441
|
+
* Contents endpoint (a Tako card URL -> ChartConfig -> CSV; any other URL ->
|
|
442
|
+
* page text).
|
|
443
|
+
* @export
|
|
444
|
+
* @interface ResultContent
|
|
445
|
+
*/
|
|
446
|
+
interface ResultContent {
|
|
447
|
+
/**
|
|
448
|
+
*
|
|
449
|
+
* @type {ContentFormat}
|
|
450
|
+
* @memberof ResultContent
|
|
451
|
+
*/
|
|
452
|
+
format: ContentFormat;
|
|
453
|
+
/**
|
|
454
|
+
*
|
|
455
|
+
* @type {number}
|
|
456
|
+
* @memberof ResultContent
|
|
457
|
+
*/
|
|
458
|
+
cost?: number;
|
|
459
|
+
/**
|
|
460
|
+
*
|
|
461
|
+
* @type {string}
|
|
462
|
+
* @memberof ResultContent
|
|
463
|
+
*/
|
|
464
|
+
data?: string | null;
|
|
465
|
+
/**
|
|
466
|
+
*
|
|
467
|
+
* @type {number}
|
|
468
|
+
* @memberof ResultContent
|
|
469
|
+
*/
|
|
470
|
+
total_rows?: number | null;
|
|
471
|
+
/**
|
|
472
|
+
*
|
|
473
|
+
* @type {boolean}
|
|
474
|
+
* @memberof ResultContent
|
|
475
|
+
*/
|
|
476
|
+
truncated?: boolean;
|
|
107
477
|
}
|
|
108
|
-
|
|
478
|
+
/**
|
|
479
|
+
* Check if a given object implements the ResultContent interface.
|
|
480
|
+
*/
|
|
481
|
+
declare function instanceOfResultContent(value: object): value is ResultContent;
|
|
482
|
+
declare function ResultContentFromJSON(json: any): ResultContent;
|
|
483
|
+
declare function ResultContentFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResultContent;
|
|
484
|
+
declare function ResultContentToJSON(json: any): ResultContent;
|
|
485
|
+
declare function ResultContentToJSONTyped(value?: ResultContent | null, ignoreDiscriminator?: boolean): any;
|
|
486
|
+
|
|
487
|
+
/**
|
|
488
|
+
* Knowledge Search API
|
|
489
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
490
|
+
*
|
|
491
|
+
* The version of the OpenAPI document: 1.0.0
|
|
492
|
+
*
|
|
493
|
+
*
|
|
494
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
495
|
+
* https://openapi-generator.tech
|
|
496
|
+
* Do not edit the class manually.
|
|
497
|
+
*/
|
|
498
|
+
/**
|
|
499
|
+
*
|
|
500
|
+
* @export
|
|
501
|
+
*/
|
|
502
|
+
declare const KnowledgeCardRelevance: {
|
|
503
|
+
readonly High: "High";
|
|
504
|
+
readonly Medium: "Medium";
|
|
505
|
+
readonly Low: "Low";
|
|
506
|
+
};
|
|
507
|
+
type KnowledgeCardRelevance = typeof KnowledgeCardRelevance[keyof typeof KnowledgeCardRelevance];
|
|
508
|
+
declare function instanceOfKnowledgeCardRelevance(value: any): boolean;
|
|
509
|
+
declare function KnowledgeCardRelevanceFromJSON(json: any): KnowledgeCardRelevance;
|
|
510
|
+
declare function KnowledgeCardRelevanceFromJSONTyped(json: any, ignoreDiscriminator: boolean): KnowledgeCardRelevance;
|
|
511
|
+
declare function KnowledgeCardRelevanceToJSON(value?: KnowledgeCardRelevance | null): any;
|
|
512
|
+
declare function KnowledgeCardRelevanceToJSONTyped(value: any, ignoreDiscriminator: boolean): KnowledgeCardRelevance;
|
|
513
|
+
|
|
514
|
+
/**
|
|
515
|
+
* Knowledge Search API
|
|
516
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
517
|
+
*
|
|
518
|
+
* The version of the OpenAPI document: 1.0.0
|
|
519
|
+
*
|
|
520
|
+
*
|
|
521
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
522
|
+
* https://openapi-generator.tech
|
|
523
|
+
* Do not edit the class manually.
|
|
524
|
+
*/
|
|
525
|
+
|
|
526
|
+
/**
|
|
527
|
+
* A Tako knowledge card on the new search/answer surface. Mirrors the
|
|
528
|
+
* legacy KnowledgeCard minus data_url / visualization_data / ideal_viz_decisions,
|
|
529
|
+
* plus a `content` download descriptor.
|
|
530
|
+
* @export
|
|
531
|
+
* @interface TakoCard
|
|
532
|
+
*/
|
|
533
|
+
interface TakoCard {
|
|
534
|
+
/**
|
|
535
|
+
*
|
|
536
|
+
* @type {string}
|
|
537
|
+
* @memberof TakoCard
|
|
538
|
+
*/
|
|
539
|
+
card_id?: string | null;
|
|
540
|
+
/**
|
|
541
|
+
*
|
|
542
|
+
* @type {string}
|
|
543
|
+
* @memberof TakoCard
|
|
544
|
+
*/
|
|
545
|
+
title?: string | null;
|
|
546
|
+
/**
|
|
547
|
+
*
|
|
548
|
+
* @type {string}
|
|
549
|
+
* @memberof TakoCard
|
|
550
|
+
*/
|
|
551
|
+
description?: string | null;
|
|
552
|
+
/**
|
|
553
|
+
*
|
|
554
|
+
* @type {string}
|
|
555
|
+
* @memberof TakoCard
|
|
556
|
+
*/
|
|
557
|
+
semantic_description?: string | null;
|
|
558
|
+
/**
|
|
559
|
+
*
|
|
560
|
+
* @type {string}
|
|
561
|
+
* @memberof TakoCard
|
|
562
|
+
*/
|
|
563
|
+
webpage_url?: string | null;
|
|
564
|
+
/**
|
|
565
|
+
*
|
|
566
|
+
* @type {string}
|
|
567
|
+
* @memberof TakoCard
|
|
568
|
+
*/
|
|
569
|
+
image_url?: string | null;
|
|
570
|
+
/**
|
|
571
|
+
*
|
|
572
|
+
* @type {string}
|
|
573
|
+
* @memberof TakoCard
|
|
574
|
+
*/
|
|
575
|
+
embed_url?: string | null;
|
|
576
|
+
/**
|
|
577
|
+
*
|
|
578
|
+
* @type {Array<KnowledgeCardSource>}
|
|
579
|
+
* @memberof TakoCard
|
|
580
|
+
*/
|
|
581
|
+
sources?: Array<KnowledgeCardSource> | null;
|
|
582
|
+
/**
|
|
583
|
+
*
|
|
584
|
+
* @type {Array<KnowledgeCardMethodology>}
|
|
585
|
+
* @memberof TakoCard
|
|
586
|
+
*/
|
|
587
|
+
methodologies?: Array<KnowledgeCardMethodology> | null;
|
|
588
|
+
/**
|
|
589
|
+
*
|
|
590
|
+
* @type {Array<KnowledgeCardSourceIndexesInner>}
|
|
591
|
+
* @memberof TakoCard
|
|
592
|
+
*/
|
|
593
|
+
source_indexes?: Array<KnowledgeCardSourceIndexesInner> | null;
|
|
594
|
+
/**
|
|
595
|
+
*
|
|
596
|
+
* @type {string}
|
|
597
|
+
* @memberof TakoCard
|
|
598
|
+
*/
|
|
599
|
+
card_type?: string | null;
|
|
600
|
+
/**
|
|
601
|
+
*
|
|
602
|
+
* @type {KnowledgeCardRelevance}
|
|
603
|
+
* @memberof TakoCard
|
|
604
|
+
*/
|
|
605
|
+
relevance?: KnowledgeCardRelevance | null;
|
|
606
|
+
/**
|
|
607
|
+
*
|
|
608
|
+
* @type {ResultContent}
|
|
609
|
+
* @memberof TakoCard
|
|
610
|
+
*/
|
|
611
|
+
content?: ResultContent | null;
|
|
612
|
+
/**
|
|
613
|
+
* Numeric relevance of this card to the query on a 1.0-5.0 scale (5.0 = exact match; higher is more relevant). Only populated for entitled accounts; null otherwise.
|
|
614
|
+
* @type {number}
|
|
615
|
+
* @memberof TakoCard
|
|
616
|
+
*/
|
|
617
|
+
relevance_score?: number | null;
|
|
109
618
|
}
|
|
110
|
-
type ValidTakoDataFormatVariable = TakoDataFormatTemporalVariable | TakoDataFormatCategoricalVariable | TakoDataFormatVariable | TakoDataFormatQuantitativeVariable;
|
|
111
619
|
/**
|
|
112
|
-
*
|
|
620
|
+
* Check if a given object implements the TakoCard interface.
|
|
621
|
+
*/
|
|
622
|
+
declare function instanceOfTakoCard(value: object): value is TakoCard;
|
|
623
|
+
declare function TakoCardFromJSON(json: any): TakoCard;
|
|
624
|
+
declare function TakoCardFromJSONTyped(json: any, ignoreDiscriminator: boolean): TakoCard;
|
|
625
|
+
declare function TakoCardToJSON(json: any): TakoCard;
|
|
626
|
+
declare function TakoCardToJSONTyped(value?: TakoCard | null, ignoreDiscriminator?: boolean): any;
|
|
627
|
+
|
|
628
|
+
/**
|
|
629
|
+
* Knowledge Search API
|
|
630
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
631
|
+
*
|
|
632
|
+
* The version of the OpenAPI document: 1.0.0
|
|
633
|
+
*
|
|
634
|
+
*
|
|
635
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
636
|
+
* https://openapi-generator.tech
|
|
637
|
+
* Do not edit the class manually.
|
|
113
638
|
*/
|
|
114
|
-
|
|
115
|
-
|
|
639
|
+
|
|
640
|
+
/**
|
|
641
|
+
* A single raw web search result returned by the WEB source index.
|
|
642
|
+
*
|
|
643
|
+
* Distinct from `KnowledgeCardSource` (a citation inside a synthesized
|
|
644
|
+
* answer) and `KnowledgeCard` (a Tako visualization). Web results are
|
|
645
|
+
* raw retrieval output — title, URL, optional snippet — independent of
|
|
646
|
+
* any LLM synthesis that may also happen over them.
|
|
647
|
+
* @export
|
|
648
|
+
* @interface WebResult
|
|
649
|
+
*/
|
|
650
|
+
interface WebResult {
|
|
651
|
+
/**
|
|
652
|
+
* Title of the web page.
|
|
653
|
+
* @type {string}
|
|
654
|
+
* @memberof WebResult
|
|
655
|
+
*/
|
|
116
656
|
title: string;
|
|
117
|
-
/** The description of the dataset */
|
|
118
|
-
description?: string | null;
|
|
119
|
-
/** Details about all variables in the dataset */
|
|
120
|
-
variables: ValidTakoDataFormatVariable[];
|
|
121
657
|
/**
|
|
122
|
-
*
|
|
123
|
-
*
|
|
658
|
+
* URL of the web page.
|
|
659
|
+
* @type {string}
|
|
660
|
+
* @memberof WebResult
|
|
661
|
+
*/
|
|
662
|
+
url: string;
|
|
663
|
+
/**
|
|
664
|
+
* Excerpt(s) from the page that matched the query.
|
|
665
|
+
* @type {string}
|
|
666
|
+
* @memberof WebResult
|
|
667
|
+
*/
|
|
668
|
+
snippet?: string | null;
|
|
669
|
+
/**
|
|
670
|
+
* Publisher / domain name, when extractable from the URL.
|
|
671
|
+
* @type {string}
|
|
672
|
+
* @memberof WebResult
|
|
673
|
+
*/
|
|
674
|
+
source_name?: string | null;
|
|
675
|
+
/**
|
|
676
|
+
* Publication date of the page, when available.
|
|
677
|
+
* @type {string}
|
|
678
|
+
* @memberof WebResult
|
|
679
|
+
*/
|
|
680
|
+
publish_date?: string | null;
|
|
681
|
+
/**
|
|
682
|
+
* Downloadable content descriptor for this result, fetched via the Contents endpoint. Web results are always downloadable as text. None for callers that do not populate it.
|
|
683
|
+
* @type {ResultContent}
|
|
684
|
+
* @memberof WebResult
|
|
685
|
+
*/
|
|
686
|
+
content?: ResultContent | null;
|
|
687
|
+
/**
|
|
688
|
+
* 1-based citation number that the answer's inline [N] markers reference. Set only when the answer inline-cites this result (the Agent API); None on raw-retrieval surfaces.
|
|
689
|
+
* @type {number}
|
|
690
|
+
* @memberof WebResult
|
|
691
|
+
*/
|
|
692
|
+
citation_number?: number | null;
|
|
693
|
+
}
|
|
694
|
+
/**
|
|
695
|
+
* Check if a given object implements the WebResult interface.
|
|
696
|
+
*/
|
|
697
|
+
declare function instanceOfWebResult(value: object): value is WebResult;
|
|
698
|
+
declare function WebResultFromJSON(json: any): WebResult;
|
|
699
|
+
declare function WebResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebResult;
|
|
700
|
+
declare function WebResultToJSON(json: any): WebResult;
|
|
701
|
+
declare function WebResultToJSONTyped(value?: WebResult | null, ignoreDiscriminator?: boolean): any;
|
|
702
|
+
|
|
703
|
+
/**
|
|
704
|
+
* Knowledge Search API
|
|
705
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
706
|
+
*
|
|
707
|
+
* The version of the OpenAPI document: 1.0.0
|
|
708
|
+
*
|
|
709
|
+
*
|
|
710
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
711
|
+
* https://openapi-generator.tech
|
|
712
|
+
* Do not edit the class manually.
|
|
713
|
+
*/
|
|
714
|
+
|
|
715
|
+
/**
|
|
716
|
+
* Final agent output. answer is markdown; cards reuse the sibling TakoCard.
|
|
717
|
+
* @export
|
|
718
|
+
* @interface AgentResult
|
|
719
|
+
*/
|
|
720
|
+
interface AgentResult {
|
|
721
|
+
/**
|
|
722
|
+
*
|
|
723
|
+
* @type {string}
|
|
724
|
+
* @memberof AgentResult
|
|
124
725
|
*/
|
|
125
|
-
|
|
726
|
+
answer?: string | null;
|
|
727
|
+
/**
|
|
728
|
+
*
|
|
729
|
+
* @type {Array<TakoCard>}
|
|
730
|
+
* @memberof AgentResult
|
|
731
|
+
*/
|
|
732
|
+
cards?: Array<TakoCard>;
|
|
733
|
+
/**
|
|
734
|
+
*
|
|
735
|
+
* @type {Array<WebResult>}
|
|
736
|
+
* @memberof AgentResult
|
|
737
|
+
*/
|
|
738
|
+
web_results?: Array<WebResult>;
|
|
739
|
+
/**
|
|
740
|
+
*
|
|
741
|
+
* @type {string}
|
|
742
|
+
* @memberof AgentResult
|
|
743
|
+
*/
|
|
744
|
+
request_id?: string | null;
|
|
126
745
|
}
|
|
127
|
-
|
|
746
|
+
/**
|
|
747
|
+
* Check if a given object implements the AgentResult interface.
|
|
748
|
+
*/
|
|
749
|
+
declare function instanceOfAgentResult(value: object): value is AgentResult;
|
|
750
|
+
declare function AgentResultFromJSON(json: any): AgentResult;
|
|
751
|
+
declare function AgentResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): AgentResult;
|
|
752
|
+
declare function AgentResultToJSON(json: any): AgentResult;
|
|
753
|
+
declare function AgentResultToJSONTyped(value?: AgentResult | null, ignoreDiscriminator?: boolean): any;
|
|
754
|
+
|
|
755
|
+
/**
|
|
756
|
+
* Knowledge Search API
|
|
757
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
758
|
+
*
|
|
759
|
+
* The version of the OpenAPI document: 1.0.0
|
|
760
|
+
*
|
|
761
|
+
*
|
|
762
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
763
|
+
* https://openapi-generator.tech
|
|
764
|
+
* Do not edit the class manually.
|
|
765
|
+
*/
|
|
766
|
+
/**
|
|
767
|
+
*
|
|
768
|
+
* @export
|
|
769
|
+
*/
|
|
770
|
+
declare const AgentRunStatus: {
|
|
771
|
+
readonly Queued: "queued";
|
|
772
|
+
readonly Running: "running";
|
|
773
|
+
readonly Completed: "completed";
|
|
774
|
+
readonly Failed: "failed";
|
|
775
|
+
};
|
|
776
|
+
type AgentRunStatus = typeof AgentRunStatus[keyof typeof AgentRunStatus];
|
|
777
|
+
declare function instanceOfAgentRunStatus(value: any): boolean;
|
|
778
|
+
declare function AgentRunStatusFromJSON(json: any): AgentRunStatus;
|
|
779
|
+
declare function AgentRunStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): AgentRunStatus;
|
|
780
|
+
declare function AgentRunStatusToJSON(value?: AgentRunStatus | null): any;
|
|
781
|
+
declare function AgentRunStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): AgentRunStatus;
|
|
782
|
+
|
|
783
|
+
/**
|
|
784
|
+
* Knowledge Search API
|
|
785
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
786
|
+
*
|
|
787
|
+
* The version of the OpenAPI document: 1.0.0
|
|
788
|
+
*
|
|
789
|
+
*
|
|
790
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
791
|
+
* https://openapi-generator.tech
|
|
792
|
+
* Do not edit the class manually.
|
|
793
|
+
*/
|
|
794
|
+
/**
|
|
795
|
+
*
|
|
796
|
+
* @export
|
|
797
|
+
* @interface ErrorObject
|
|
798
|
+
*/
|
|
799
|
+
interface ErrorObject {
|
|
800
|
+
/**
|
|
801
|
+
*
|
|
802
|
+
* @type {string}
|
|
803
|
+
* @memberof ErrorObject
|
|
804
|
+
*/
|
|
805
|
+
code: string;
|
|
806
|
+
/**
|
|
807
|
+
*
|
|
808
|
+
* @type {string}
|
|
809
|
+
* @memberof ErrorObject
|
|
810
|
+
*/
|
|
128
811
|
message: string;
|
|
129
|
-
id: string;
|
|
130
812
|
}
|
|
813
|
+
/**
|
|
814
|
+
* Check if a given object implements the ErrorObject interface.
|
|
815
|
+
*/
|
|
816
|
+
declare function instanceOfErrorObject(value: object): value is ErrorObject;
|
|
817
|
+
declare function ErrorObjectFromJSON(json: any): ErrorObject;
|
|
818
|
+
declare function ErrorObjectFromJSONTyped(json: any, ignoreDiscriminator: boolean): ErrorObject;
|
|
819
|
+
declare function ErrorObjectToJSON(json: any): ErrorObject;
|
|
820
|
+
declare function ErrorObjectToJSONTyped(value?: ErrorObject | null, ignoreDiscriminator?: boolean): any;
|
|
821
|
+
|
|
822
|
+
/**
|
|
823
|
+
* Knowledge Search API
|
|
824
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
825
|
+
*
|
|
826
|
+
* The version of the OpenAPI document: 1.0.0
|
|
827
|
+
*
|
|
828
|
+
*
|
|
829
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
830
|
+
* https://openapi-generator.tech
|
|
831
|
+
* Do not edit the class manually.
|
|
832
|
+
*/
|
|
131
833
|
|
|
132
834
|
/**
|
|
133
|
-
*
|
|
835
|
+
* The run resource returned by dispatch (202) and poll (GET).
|
|
836
|
+
* @export
|
|
837
|
+
* @interface AgentRun
|
|
134
838
|
*/
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
839
|
+
interface AgentRun {
|
|
840
|
+
/**
|
|
841
|
+
*
|
|
842
|
+
* @type {string}
|
|
843
|
+
* @memberof AgentRun
|
|
844
|
+
*/
|
|
845
|
+
run_id: string;
|
|
846
|
+
/**
|
|
847
|
+
*
|
|
848
|
+
* @type {AgentRunObjectEnum}
|
|
849
|
+
* @memberof AgentRun
|
|
850
|
+
*/
|
|
851
|
+
object?: AgentRunObjectEnum;
|
|
852
|
+
/**
|
|
853
|
+
*
|
|
854
|
+
* @type {string}
|
|
855
|
+
* @memberof AgentRun
|
|
856
|
+
*/
|
|
857
|
+
thread_id?: string | null;
|
|
858
|
+
/**
|
|
859
|
+
*
|
|
860
|
+
* @type {AgentRunStatus}
|
|
861
|
+
* @memberof AgentRun
|
|
862
|
+
*/
|
|
863
|
+
status: AgentRunStatus;
|
|
864
|
+
/**
|
|
865
|
+
*
|
|
866
|
+
* @type {string}
|
|
867
|
+
* @memberof AgentRun
|
|
868
|
+
*/
|
|
869
|
+
created_at: string;
|
|
870
|
+
/**
|
|
871
|
+
*
|
|
872
|
+
* @type {string}
|
|
873
|
+
* @memberof AgentRun
|
|
874
|
+
*/
|
|
875
|
+
completed_at?: string | null;
|
|
139
876
|
/**
|
|
140
|
-
*
|
|
141
|
-
* @
|
|
877
|
+
*
|
|
878
|
+
* @type {AgentResult}
|
|
879
|
+
* @memberof AgentRun
|
|
142
880
|
*/
|
|
143
|
-
|
|
881
|
+
result?: AgentResult | null;
|
|
882
|
+
/**
|
|
883
|
+
*
|
|
884
|
+
* @type {ErrorObject}
|
|
885
|
+
* @memberof AgentRun
|
|
886
|
+
*/
|
|
887
|
+
error?: ErrorObject | null;
|
|
888
|
+
}
|
|
889
|
+
/**
|
|
890
|
+
* @export
|
|
891
|
+
*/
|
|
892
|
+
declare const AgentRunObjectEnum: {
|
|
893
|
+
readonly AgentRun: "agent.run";
|
|
894
|
+
};
|
|
895
|
+
type AgentRunObjectEnum = typeof AgentRunObjectEnum[keyof typeof AgentRunObjectEnum];
|
|
896
|
+
/**
|
|
897
|
+
* Check if a given object implements the AgentRun interface.
|
|
898
|
+
*/
|
|
899
|
+
declare function instanceOfAgentRun(value: object): value is AgentRun;
|
|
900
|
+
declare function AgentRunFromJSON(json: any): AgentRun;
|
|
901
|
+
declare function AgentRunFromJSONTyped(json: any, ignoreDiscriminator: boolean): AgentRun;
|
|
902
|
+
declare function AgentRunToJSON(json: any): AgentRun;
|
|
903
|
+
declare function AgentRunToJSONTyped(value?: AgentRun | null, ignoreDiscriminator?: boolean): any;
|
|
904
|
+
|
|
905
|
+
/**
|
|
906
|
+
* Knowledge Search API
|
|
907
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
908
|
+
*
|
|
909
|
+
* The version of the OpenAPI document: 1.0.0
|
|
910
|
+
*
|
|
911
|
+
*
|
|
912
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
913
|
+
* https://openapi-generator.tech
|
|
914
|
+
* Do not edit the class manually.
|
|
915
|
+
*/
|
|
916
|
+
/**
|
|
917
|
+
* Public effort taxonomy for the Agent API. Only MEDIUM is supported in v1;
|
|
918
|
+
* the generated OpenAPI/SDK advertises exactly these members, so we add values
|
|
919
|
+
* (low/high) only as the agent gains public support for them.
|
|
920
|
+
* @export
|
|
921
|
+
*/
|
|
922
|
+
declare const AgentEffortLevel: {
|
|
923
|
+
readonly Medium: "medium";
|
|
924
|
+
};
|
|
925
|
+
type AgentEffortLevel = typeof AgentEffortLevel[keyof typeof AgentEffortLevel];
|
|
926
|
+
declare function instanceOfAgentEffortLevel(value: any): boolean;
|
|
927
|
+
declare function AgentEffortLevelFromJSON(json: any): AgentEffortLevel;
|
|
928
|
+
declare function AgentEffortLevelFromJSONTyped(json: any, ignoreDiscriminator: boolean): AgentEffortLevel;
|
|
929
|
+
declare function AgentEffortLevelToJSON(value?: AgentEffortLevel | null): any;
|
|
930
|
+
declare function AgentEffortLevelToJSONTyped(value: any, ignoreDiscriminator: boolean): AgentEffortLevel;
|
|
931
|
+
|
|
932
|
+
/**
|
|
933
|
+
* Knowledge Search API
|
|
934
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
935
|
+
*
|
|
936
|
+
* The version of the OpenAPI document: 1.0.0
|
|
937
|
+
*
|
|
938
|
+
*
|
|
939
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
940
|
+
* https://openapi-generator.tech
|
|
941
|
+
* Do not edit the class manually.
|
|
942
|
+
*/
|
|
943
|
+
/**
|
|
944
|
+
*
|
|
945
|
+
* @export
|
|
946
|
+
* @interface AgentOutputSettings
|
|
947
|
+
*/
|
|
948
|
+
interface AgentOutputSettings {
|
|
144
949
|
/**
|
|
145
|
-
*
|
|
146
|
-
* @
|
|
147
|
-
* @
|
|
148
|
-
* @param body Request body
|
|
149
|
-
* @returns Response data
|
|
950
|
+
* Render card preview images in dark mode. Omit to use the default (dark).
|
|
951
|
+
* @type {boolean}
|
|
952
|
+
* @memberof AgentOutputSettings
|
|
150
953
|
*/
|
|
151
|
-
|
|
954
|
+
image_dark_mode?: boolean | null;
|
|
955
|
+
}
|
|
956
|
+
/**
|
|
957
|
+
* Check if a given object implements the AgentOutputSettings interface.
|
|
958
|
+
*/
|
|
959
|
+
declare function instanceOfAgentOutputSettings(value: object): value is AgentOutputSettings;
|
|
960
|
+
declare function AgentOutputSettingsFromJSON(json: any): AgentOutputSettings;
|
|
961
|
+
declare function AgentOutputSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AgentOutputSettings;
|
|
962
|
+
declare function AgentOutputSettingsToJSON(json: any): AgentOutputSettings;
|
|
963
|
+
declare function AgentOutputSettingsToJSONTyped(value?: AgentOutputSettings | null, ignoreDiscriminator?: boolean): any;
|
|
964
|
+
|
|
965
|
+
/**
|
|
966
|
+
* Knowledge Search API
|
|
967
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
968
|
+
*
|
|
969
|
+
* The version of the OpenAPI document: 1.0.0
|
|
970
|
+
*
|
|
971
|
+
*
|
|
972
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
973
|
+
* https://openapi-generator.tech
|
|
974
|
+
* Do not edit the class manually.
|
|
975
|
+
*/
|
|
976
|
+
|
|
977
|
+
/**
|
|
978
|
+
*
|
|
979
|
+
* @export
|
|
980
|
+
* @interface AgentRunRequest
|
|
981
|
+
*/
|
|
982
|
+
interface AgentRunRequest {
|
|
152
983
|
/**
|
|
153
|
-
*
|
|
154
|
-
* @
|
|
155
|
-
* @
|
|
156
|
-
* @returns Knowledge search results
|
|
984
|
+
* Natural-language request for the agent.
|
|
985
|
+
* @type {string}
|
|
986
|
+
* @memberof AgentRunRequest
|
|
157
987
|
*/
|
|
158
|
-
|
|
988
|
+
query: string;
|
|
159
989
|
/**
|
|
160
|
-
*
|
|
161
|
-
* @
|
|
162
|
-
* @
|
|
990
|
+
* Existing thread to continue (follow-up). Omit to start a new thread.
|
|
991
|
+
* @type {string}
|
|
992
|
+
* @memberof AgentRunRequest
|
|
163
993
|
*/
|
|
164
|
-
|
|
994
|
+
thread_id?: string | null;
|
|
165
995
|
/**
|
|
166
|
-
*
|
|
167
|
-
* @
|
|
168
|
-
* @
|
|
169
|
-
* @param query The query to visualize the dataset
|
|
170
|
-
* @returns Knowledge search results
|
|
996
|
+
* Agent effort level. Only 'medium' is currently supported.
|
|
997
|
+
* @type {AgentEffortLevel}
|
|
998
|
+
* @memberof AgentRunRequest
|
|
171
999
|
*/
|
|
172
|
-
|
|
1000
|
+
effort?: AgentEffortLevel;
|
|
173
1001
|
/**
|
|
174
|
-
*
|
|
175
|
-
* @
|
|
176
|
-
* @
|
|
1002
|
+
* Which sources the agent may use: 'data' (curated knowledge) and/or 'web' (open-web search). Defaults to ['data', 'web']. The legacy value 'tako' is accepted as a synonym for 'data'.
|
|
1003
|
+
* @type {Array<AgentRunRequestSourceIndexesEnum>}
|
|
1004
|
+
* @memberof AgentRunRequest
|
|
177
1005
|
*/
|
|
178
|
-
|
|
1006
|
+
source_indexes?: Array<AgentRunRequestSourceIndexesEnum>;
|
|
179
1007
|
/**
|
|
180
|
-
*
|
|
181
|
-
* @
|
|
182
|
-
* @
|
|
1008
|
+
* BCP-47 locale. Drives the language of the agent's answer (a non-English locale makes the agent respond in that language) and the locale used when rendering card preview images. Defaults to en-US.
|
|
1009
|
+
* @type {string}
|
|
1010
|
+
* @memberof AgentRunRequest
|
|
183
1011
|
*/
|
|
184
|
-
|
|
1012
|
+
locale?: string;
|
|
185
1013
|
/**
|
|
186
|
-
*
|
|
187
|
-
* @
|
|
188
|
-
* @
|
|
189
|
-
* @returns The file ID from the presigned URL response
|
|
1014
|
+
* IANA timezone (e.g. 'America/New_York') used to render dates/times in card preview images. Does not affect the returned data.
|
|
1015
|
+
* @type {string}
|
|
1016
|
+
* @memberof AgentRunRequest
|
|
190
1017
|
*/
|
|
191
|
-
|
|
1018
|
+
timezone?: string | null;
|
|
192
1019
|
/**
|
|
193
|
-
*
|
|
194
|
-
* @
|
|
195
|
-
* @
|
|
196
|
-
* @returns Object containing 'message' and 'id' fields
|
|
1020
|
+
* Settings controlling the response/rendering.
|
|
1021
|
+
* @type {AgentOutputSettings}
|
|
1022
|
+
* @memberof AgentRunRequest
|
|
197
1023
|
*/
|
|
198
|
-
|
|
1024
|
+
output_settings?: AgentOutputSettings | null;
|
|
199
1025
|
}
|
|
1026
|
+
/**
|
|
1027
|
+
* @export
|
|
1028
|
+
*/
|
|
1029
|
+
declare const AgentRunRequestSourceIndexesEnum: {
|
|
1030
|
+
readonly Data: "data";
|
|
1031
|
+
readonly Web: "web";
|
|
1032
|
+
};
|
|
1033
|
+
type AgentRunRequestSourceIndexesEnum = typeof AgentRunRequestSourceIndexesEnum[keyof typeof AgentRunRequestSourceIndexesEnum];
|
|
1034
|
+
/**
|
|
1035
|
+
* Check if a given object implements the AgentRunRequest interface.
|
|
1036
|
+
*/
|
|
1037
|
+
declare function instanceOfAgentRunRequest(value: object): value is AgentRunRequest;
|
|
1038
|
+
declare function AgentRunRequestFromJSON(json: any): AgentRunRequest;
|
|
1039
|
+
declare function AgentRunRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AgentRunRequest;
|
|
1040
|
+
declare function AgentRunRequestToJSON(json: any): AgentRunRequest;
|
|
1041
|
+
declare function AgentRunRequestToJSONTyped(value?: AgentRunRequest | null, ignoreDiscriminator?: boolean): any;
|
|
1042
|
+
|
|
1043
|
+
/**
|
|
1044
|
+
* Knowledge Search API
|
|
1045
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1046
|
+
*
|
|
1047
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1048
|
+
*
|
|
1049
|
+
*
|
|
1050
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1051
|
+
* https://openapi-generator.tech
|
|
1052
|
+
* Do not edit the class manually.
|
|
1053
|
+
*/
|
|
200
1054
|
|
|
1055
|
+
interface CreateAgentRunRequest {
|
|
1056
|
+
agentRunRequest?: AgentRunRequest;
|
|
1057
|
+
}
|
|
1058
|
+
interface GetAgentRunRequest {
|
|
1059
|
+
runId: string | null;
|
|
1060
|
+
startingAfter?: number;
|
|
1061
|
+
}
|
|
201
1062
|
/**
|
|
202
|
-
*
|
|
203
|
-
*
|
|
204
|
-
* @
|
|
205
|
-
* @
|
|
1063
|
+
* AgentApi - interface
|
|
1064
|
+
*
|
|
1065
|
+
* @export
|
|
1066
|
+
* @interface AgentApiInterface
|
|
206
1067
|
*/
|
|
207
|
-
|
|
1068
|
+
interface AgentApiInterface {
|
|
1069
|
+
/**
|
|
1070
|
+
* Creates request options for createAgentRun without sending the request
|
|
1071
|
+
* @param {AgentRunRequest} [agentRunRequest]
|
|
1072
|
+
* @throws {RequiredError}
|
|
1073
|
+
* @memberof AgentApiInterface
|
|
1074
|
+
*/
|
|
1075
|
+
createAgentRunRequestOpts(requestParameters: CreateAgentRunRequest): Promise<RequestOpts>;
|
|
1076
|
+
/**
|
|
1077
|
+
* Dispatch a deep-research agent run. Returns 202 with an AgentRun object; poll GET /v1/agent/runs/{run_id} until status is \'completed\' or \'failed\'.
|
|
1078
|
+
* @summary Dispatch an agent run
|
|
1079
|
+
* @param {AgentRunRequest} [agentRunRequest]
|
|
1080
|
+
* @param {*} [options] Override http request option.
|
|
1081
|
+
* @throws {RequiredError}
|
|
1082
|
+
* @memberof AgentApiInterface
|
|
1083
|
+
*/
|
|
1084
|
+
createAgentRunRaw(requestParameters: CreateAgentRunRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<AgentRun>>;
|
|
1085
|
+
/**
|
|
1086
|
+
* Dispatch a deep-research agent run. Returns 202 with an AgentRun object; poll GET /v1/agent/runs/{run_id} until status is \'completed\' or \'failed\'.
|
|
1087
|
+
* Dispatch an agent run
|
|
1088
|
+
*/
|
|
1089
|
+
createAgentRun(requestParameters: CreateAgentRunRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<AgentRun>;
|
|
1090
|
+
/**
|
|
1091
|
+
* Creates request options for getAgentRun without sending the request
|
|
1092
|
+
* @param {string} runId Run ID returned by POST /v1/agent/runs
|
|
1093
|
+
* @param {number} [startingAfter] SSE resume cursor (Accept: text/event-stream only). Replay events with seq strictly greater than this value. Equivalent to the Last-Event-ID header.
|
|
1094
|
+
* @throws {RequiredError}
|
|
1095
|
+
* @memberof AgentApiInterface
|
|
1096
|
+
*/
|
|
1097
|
+
getAgentRunRequestOpts(requestParameters: GetAgentRunRequest): Promise<RequestOpts>;
|
|
1098
|
+
/**
|
|
1099
|
+
* Retrieve the current state of an agent run. Poll until status is \'completed\' or \'failed\'. result is populated when status is \'completed\'.
|
|
1100
|
+
* @summary Poll an agent run
|
|
1101
|
+
* @param {string} runId Run ID returned by POST /v1/agent/runs
|
|
1102
|
+
* @param {number} [startingAfter] SSE resume cursor (Accept: text/event-stream only). Replay events with seq strictly greater than this value. Equivalent to the Last-Event-ID header.
|
|
1103
|
+
* @param {*} [options] Override http request option.
|
|
1104
|
+
* @throws {RequiredError}
|
|
1105
|
+
* @memberof AgentApiInterface
|
|
1106
|
+
*/
|
|
1107
|
+
getAgentRunRaw(requestParameters: GetAgentRunRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<AgentRun>>;
|
|
1108
|
+
/**
|
|
1109
|
+
* Retrieve the current state of an agent run. Poll until status is \'completed\' or \'failed\'. result is populated when status is \'completed\'.
|
|
1110
|
+
* Poll an agent run
|
|
1111
|
+
*/
|
|
1112
|
+
getAgentRun(requestParameters: GetAgentRunRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<AgentRun>;
|
|
1113
|
+
}
|
|
1114
|
+
/**
|
|
1115
|
+
*
|
|
1116
|
+
*/
|
|
1117
|
+
declare class AgentApi extends BaseAPI implements AgentApiInterface {
|
|
1118
|
+
/**
|
|
1119
|
+
* Creates request options for createAgentRun without sending the request
|
|
1120
|
+
*/
|
|
1121
|
+
createAgentRunRequestOpts(requestParameters: CreateAgentRunRequest): Promise<RequestOpts>;
|
|
1122
|
+
/**
|
|
1123
|
+
* Dispatch a deep-research agent run. Returns 202 with an AgentRun object; poll GET /v1/agent/runs/{run_id} until status is \'completed\' or \'failed\'.
|
|
1124
|
+
* Dispatch an agent run
|
|
1125
|
+
*/
|
|
1126
|
+
createAgentRunRaw(requestParameters: CreateAgentRunRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<AgentRun>>;
|
|
1127
|
+
/**
|
|
1128
|
+
* Dispatch a deep-research agent run. Returns 202 with an AgentRun object; poll GET /v1/agent/runs/{run_id} until status is \'completed\' or \'failed\'.
|
|
1129
|
+
* Dispatch an agent run
|
|
1130
|
+
*/
|
|
1131
|
+
createAgentRun(requestParameters?: CreateAgentRunRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<AgentRun>;
|
|
1132
|
+
/**
|
|
1133
|
+
* Creates request options for getAgentRun without sending the request
|
|
1134
|
+
*/
|
|
1135
|
+
getAgentRunRequestOpts(requestParameters: GetAgentRunRequest): Promise<RequestOpts>;
|
|
1136
|
+
/**
|
|
1137
|
+
* Retrieve the current state of an agent run. Poll until status is \'completed\' or \'failed\'. result is populated when status is \'completed\'.
|
|
1138
|
+
* Poll an agent run
|
|
1139
|
+
*/
|
|
1140
|
+
getAgentRunRaw(requestParameters: GetAgentRunRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<AgentRun>>;
|
|
1141
|
+
/**
|
|
1142
|
+
* Retrieve the current state of an agent run. Poll until status is \'completed\' or \'failed\'. result is populated when status is \'completed\'.
|
|
1143
|
+
* Poll an agent run
|
|
1144
|
+
*/
|
|
1145
|
+
getAgentRun(requestParameters: GetAgentRunRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<AgentRun>;
|
|
1146
|
+
}
|
|
1147
|
+
|
|
1148
|
+
/**
|
|
1149
|
+
* Knowledge Search API
|
|
1150
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1151
|
+
*
|
|
1152
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1153
|
+
*
|
|
1154
|
+
*
|
|
1155
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1156
|
+
* https://openapi-generator.tech
|
|
1157
|
+
* Do not edit the class manually.
|
|
1158
|
+
*/
|
|
1159
|
+
|
|
1160
|
+
/**
|
|
1161
|
+
* Response for POST /api/v1/answer — synthesized answer + retrieval.
|
|
1162
|
+
* @export
|
|
1163
|
+
* @interface AnswerResponse
|
|
1164
|
+
*/
|
|
1165
|
+
interface AnswerResponse {
|
|
1166
|
+
/**
|
|
1167
|
+
* Synthesized text answer.
|
|
1168
|
+
* @type {string}
|
|
1169
|
+
* @memberof AnswerResponse
|
|
1170
|
+
*/
|
|
1171
|
+
answer: string;
|
|
1172
|
+
/**
|
|
1173
|
+
* Tako cards backing the answer; cards[0] is the lead card — the best one to show alongside the answer.
|
|
1174
|
+
* @type {Array<TakoCard>}
|
|
1175
|
+
* @memberof AnswerResponse
|
|
1176
|
+
*/
|
|
1177
|
+
cards?: Array<TakoCard>;
|
|
1178
|
+
/**
|
|
1179
|
+
*
|
|
1180
|
+
* @type {Array<WebResult>}
|
|
1181
|
+
* @memberof AnswerResponse
|
|
1182
|
+
*/
|
|
1183
|
+
web_results?: Array<WebResult>;
|
|
1184
|
+
/**
|
|
1185
|
+
* Total quoted USD cost of the data inlined on this response — the summed per-fetch price of the results whose payload was populated (one charge per distinct extracted web URL; Tako card CSV is free). This is the QUOTE, not necessarily the amount billed: on a depleted prepaid (PAYG) balance the charge is clamped to the remaining balance, so the amount actually drawn can be less. A result's own `cost` is a per-fetch quote present whenever it is downloadable, so a result that was requested but whose extraction was skipped or failed still carries its quote; that un-inlined quote is excluded here. 0 when no contents were inlined.
|
|
1186
|
+
* @type {number}
|
|
1187
|
+
* @memberof AnswerResponse
|
|
1188
|
+
*/
|
|
1189
|
+
contents_total_cost?: number;
|
|
1190
|
+
/**
|
|
1191
|
+
*
|
|
1192
|
+
* @type {string}
|
|
1193
|
+
* @memberof AnswerResponse
|
|
1194
|
+
*/
|
|
1195
|
+
request_id: string;
|
|
1196
|
+
}
|
|
1197
|
+
/**
|
|
1198
|
+
* Check if a given object implements the AnswerResponse interface.
|
|
1199
|
+
*/
|
|
1200
|
+
declare function instanceOfAnswerResponse(value: object): value is AnswerResponse;
|
|
1201
|
+
declare function AnswerResponseFromJSON(json: any): AnswerResponse;
|
|
1202
|
+
declare function AnswerResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AnswerResponse;
|
|
1203
|
+
declare function AnswerResponseToJSON(json: any): AnswerResponse;
|
|
1204
|
+
declare function AnswerResponseToJSONTyped(value?: AnswerResponse | null, ignoreDiscriminator?: boolean): any;
|
|
1205
|
+
|
|
1206
|
+
/**
|
|
1207
|
+
* Knowledge Search API
|
|
1208
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1209
|
+
*
|
|
1210
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1211
|
+
*
|
|
1212
|
+
*
|
|
1213
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1214
|
+
* https://openapi-generator.tech
|
|
1215
|
+
* Do not edit the class manually.
|
|
1216
|
+
*/
|
|
1217
|
+
/**
|
|
1218
|
+
* Request for POST /api/v1/classify — a batch of queries to score.
|
|
1219
|
+
* @export
|
|
1220
|
+
* @interface ClassifyRequest
|
|
1221
|
+
*/
|
|
1222
|
+
interface ClassifyRequest {
|
|
1223
|
+
/**
|
|
1224
|
+
* Queries to classify (1..200). Each is scored independently.
|
|
1225
|
+
* @type {Array<string>}
|
|
1226
|
+
* @memberof ClassifyRequest
|
|
1227
|
+
*/
|
|
1228
|
+
queries: Array<string>;
|
|
1229
|
+
}
|
|
1230
|
+
/**
|
|
1231
|
+
* Check if a given object implements the ClassifyRequest interface.
|
|
1232
|
+
*/
|
|
1233
|
+
declare function instanceOfClassifyRequest(value: object): value is ClassifyRequest;
|
|
1234
|
+
declare function ClassifyRequestFromJSON(json: any): ClassifyRequest;
|
|
1235
|
+
declare function ClassifyRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ClassifyRequest;
|
|
1236
|
+
declare function ClassifyRequestToJSON(json: any): ClassifyRequest;
|
|
1237
|
+
declare function ClassifyRequestToJSONTyped(value?: ClassifyRequest | null, ignoreDiscriminator?: boolean): any;
|
|
1238
|
+
|
|
1239
|
+
/**
|
|
1240
|
+
* Knowledge Search API
|
|
1241
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1242
|
+
*
|
|
1243
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1244
|
+
*
|
|
1245
|
+
*
|
|
1246
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1247
|
+
* https://openapi-generator.tech
|
|
1248
|
+
* Do not edit the class manually.
|
|
1249
|
+
*/
|
|
1250
|
+
/**
|
|
1251
|
+
*
|
|
1252
|
+
* @export
|
|
1253
|
+
* @interface QueryClassification
|
|
1254
|
+
*/
|
|
1255
|
+
interface QueryClassification {
|
|
1256
|
+
/**
|
|
1257
|
+
*
|
|
1258
|
+
* @type {string}
|
|
1259
|
+
* @memberof QueryClassification
|
|
1260
|
+
*/
|
|
1261
|
+
query: string;
|
|
1262
|
+
/**
|
|
1263
|
+
*
|
|
1264
|
+
* @type {number}
|
|
1265
|
+
* @memberof QueryClassification
|
|
1266
|
+
*/
|
|
1267
|
+
score: number;
|
|
1268
|
+
/**
|
|
1269
|
+
*
|
|
1270
|
+
* @type {boolean}
|
|
1271
|
+
* @memberof QueryClassification
|
|
1272
|
+
*/
|
|
1273
|
+
keep: boolean;
|
|
1274
|
+
}
|
|
1275
|
+
/**
|
|
1276
|
+
* Check if a given object implements the QueryClassification interface.
|
|
1277
|
+
*/
|
|
1278
|
+
declare function instanceOfQueryClassification(value: object): value is QueryClassification;
|
|
1279
|
+
declare function QueryClassificationFromJSON(json: any): QueryClassification;
|
|
1280
|
+
declare function QueryClassificationFromJSONTyped(json: any, ignoreDiscriminator: boolean): QueryClassification;
|
|
1281
|
+
declare function QueryClassificationToJSON(json: any): QueryClassification;
|
|
1282
|
+
declare function QueryClassificationToJSONTyped(value?: QueryClassification | null, ignoreDiscriminator?: boolean): any;
|
|
1283
|
+
|
|
1284
|
+
/**
|
|
1285
|
+
* Knowledge Search API
|
|
1286
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1287
|
+
*
|
|
1288
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1289
|
+
*
|
|
1290
|
+
*
|
|
1291
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1292
|
+
* https://openapi-generator.tech
|
|
1293
|
+
* Do not edit the class manually.
|
|
1294
|
+
*/
|
|
1295
|
+
|
|
1296
|
+
/**
|
|
1297
|
+
* Response for POST /api/v1/classify — one classification per input query,
|
|
1298
|
+
* in request order.
|
|
1299
|
+
* @export
|
|
1300
|
+
* @interface ClassifyResponse
|
|
1301
|
+
*/
|
|
1302
|
+
interface ClassifyResponse {
|
|
1303
|
+
/**
|
|
1304
|
+
*
|
|
1305
|
+
* @type {Array<QueryClassification>}
|
|
1306
|
+
* @memberof ClassifyResponse
|
|
1307
|
+
*/
|
|
1308
|
+
results?: Array<QueryClassification>;
|
|
1309
|
+
}
|
|
1310
|
+
/**
|
|
1311
|
+
* Check if a given object implements the ClassifyResponse interface.
|
|
1312
|
+
*/
|
|
1313
|
+
declare function instanceOfClassifyResponse(value: object): value is ClassifyResponse;
|
|
1314
|
+
declare function ClassifyResponseFromJSON(json: any): ClassifyResponse;
|
|
1315
|
+
declare function ClassifyResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ClassifyResponse;
|
|
1316
|
+
declare function ClassifyResponseToJSON(json: any): ClassifyResponse;
|
|
1317
|
+
declare function ClassifyResponseToJSONTyped(value?: ClassifyResponse | null, ignoreDiscriminator?: boolean): any;
|
|
1318
|
+
|
|
1319
|
+
/**
|
|
1320
|
+
* Knowledge Search API
|
|
1321
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1322
|
+
*
|
|
1323
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1324
|
+
*
|
|
1325
|
+
*
|
|
1326
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1327
|
+
* https://openapi-generator.tech
|
|
1328
|
+
* Do not edit the class manually.
|
|
1329
|
+
*/
|
|
1330
|
+
/**
|
|
1331
|
+
* How /contents returns the content. URL (default) is the existing
|
|
1332
|
+
* presigned-download behavior; INLINE returns the content in the response body
|
|
1333
|
+
* (CSV text capped at 1000 rows, or web text) and skips the S3 upload.
|
|
1334
|
+
* @export
|
|
1335
|
+
*/
|
|
1336
|
+
declare const ContentsDeliveryMode: {
|
|
1337
|
+
readonly Url: "url";
|
|
1338
|
+
readonly Inline: "inline";
|
|
1339
|
+
};
|
|
1340
|
+
type ContentsDeliveryMode = typeof ContentsDeliveryMode[keyof typeof ContentsDeliveryMode];
|
|
1341
|
+
declare function instanceOfContentsDeliveryMode(value: any): boolean;
|
|
1342
|
+
declare function ContentsDeliveryModeFromJSON(json: any): ContentsDeliveryMode;
|
|
1343
|
+
declare function ContentsDeliveryModeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContentsDeliveryMode;
|
|
1344
|
+
declare function ContentsDeliveryModeToJSON(value?: ContentsDeliveryMode | null): any;
|
|
1345
|
+
declare function ContentsDeliveryModeToJSONTyped(value: any, ignoreDiscriminator: boolean): ContentsDeliveryMode;
|
|
1346
|
+
|
|
1347
|
+
/**
|
|
1348
|
+
* Knowledge Search API
|
|
1349
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1350
|
+
*
|
|
1351
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1352
|
+
*
|
|
1353
|
+
*
|
|
1354
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1355
|
+
* https://openapi-generator.tech
|
|
1356
|
+
* Do not edit the class manually.
|
|
1357
|
+
*/
|
|
1358
|
+
|
|
1359
|
+
/**
|
|
1360
|
+
* Request body for POST /api/v1/contents.
|
|
1361
|
+
*
|
|
1362
|
+
* The caller passes the result URL it wants downloadable content for; the
|
|
1363
|
+
* endpoint detects the right content from the URL itself. A Tako card URL
|
|
1364
|
+
* resolves to a CSV of the card's underlying data; any other URL resolves to
|
|
1365
|
+
* the page's extracted full text. `mode` controls delivery: `url` (default)
|
|
1366
|
+
* returns a presigned download link; `inline` returns the content in the
|
|
1367
|
+
* response.
|
|
1368
|
+
* @export
|
|
1369
|
+
* @interface ContentsRequest
|
|
1370
|
+
*/
|
|
1371
|
+
interface ContentsRequest {
|
|
1372
|
+
/**
|
|
1373
|
+
* The result URL to fetch downloadable content for (a TakoCard.webpage_url or a WebResult.url). A Tako card URL yields a CSV of the card's data; any other URL yields the page's extracted text.
|
|
1374
|
+
* @type {string}
|
|
1375
|
+
* @memberof ContentsRequest
|
|
1376
|
+
*/
|
|
1377
|
+
url: string;
|
|
1378
|
+
/**
|
|
1379
|
+
* Delivery mode: 'url' (default) returns a presigned download link; 'inline' returns the content in the response body (CSV capped at 1000 rows, with total_rows; or web text).
|
|
1380
|
+
* @type {ContentsDeliveryMode}
|
|
1381
|
+
* @memberof ContentsRequest
|
|
1382
|
+
*/
|
|
1383
|
+
mode?: ContentsDeliveryMode;
|
|
1384
|
+
}
|
|
1385
|
+
/**
|
|
1386
|
+
* Check if a given object implements the ContentsRequest interface.
|
|
1387
|
+
*/
|
|
1388
|
+
declare function instanceOfContentsRequest(value: object): value is ContentsRequest;
|
|
1389
|
+
declare function ContentsRequestFromJSON(json: any): ContentsRequest;
|
|
1390
|
+
declare function ContentsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContentsRequest;
|
|
1391
|
+
declare function ContentsRequestToJSON(json: any): ContentsRequest;
|
|
1392
|
+
declare function ContentsRequestToJSONTyped(value?: ContentsRequest | null, ignoreDiscriminator?: boolean): any;
|
|
1393
|
+
|
|
1394
|
+
/**
|
|
1395
|
+
* Knowledge Search API
|
|
1396
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1397
|
+
*
|
|
1398
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1399
|
+
*
|
|
1400
|
+
*
|
|
1401
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1402
|
+
* https://openapi-generator.tech
|
|
1403
|
+
* Do not edit the class manually.
|
|
1404
|
+
*/
|
|
1405
|
+
|
|
1406
|
+
/**
|
|
1407
|
+
* A single downloadable artifact.
|
|
1408
|
+
*
|
|
1409
|
+
* Inherits `format` + `cost` + the inline fields (`data`/`total_rows`/
|
|
1410
|
+
* `truncated`) from ResultContent. URL mode additionally populates
|
|
1411
|
+
* `url`/`expires_at` (a short-lived presigned download link); INLINE mode
|
|
1412
|
+
* populates the inherited inline fields and leaves `url`/`expires_at` null.
|
|
1413
|
+
* @export
|
|
1414
|
+
* @interface ContentItem
|
|
1415
|
+
*/
|
|
1416
|
+
interface ContentItem {
|
|
1417
|
+
/**
|
|
1418
|
+
*
|
|
1419
|
+
* @type {ContentFormat}
|
|
1420
|
+
* @memberof ContentItem
|
|
1421
|
+
*/
|
|
1422
|
+
format: ContentFormat;
|
|
1423
|
+
/**
|
|
1424
|
+
*
|
|
1425
|
+
* @type {number}
|
|
1426
|
+
* @memberof ContentItem
|
|
1427
|
+
*/
|
|
1428
|
+
cost?: number;
|
|
1429
|
+
/**
|
|
1430
|
+
*
|
|
1431
|
+
* @type {string}
|
|
1432
|
+
* @memberof ContentItem
|
|
1433
|
+
*/
|
|
1434
|
+
data?: string | null;
|
|
1435
|
+
/**
|
|
1436
|
+
*
|
|
1437
|
+
* @type {number}
|
|
1438
|
+
* @memberof ContentItem
|
|
1439
|
+
*/
|
|
1440
|
+
total_rows?: number | null;
|
|
1441
|
+
/**
|
|
1442
|
+
*
|
|
1443
|
+
* @type {boolean}
|
|
1444
|
+
* @memberof ContentItem
|
|
1445
|
+
*/
|
|
1446
|
+
truncated?: boolean;
|
|
1447
|
+
/**
|
|
1448
|
+
* The originating result URL that was resolved.
|
|
1449
|
+
* @type {string}
|
|
1450
|
+
* @memberof ContentItem
|
|
1451
|
+
*/
|
|
1452
|
+
source_url: string;
|
|
1453
|
+
/**
|
|
1454
|
+
* Presigned, short-lived URL to download the content.
|
|
1455
|
+
* @type {string}
|
|
1456
|
+
* @memberof ContentItem
|
|
1457
|
+
*/
|
|
1458
|
+
url?: string | null;
|
|
1459
|
+
/**
|
|
1460
|
+
* ISO-8601 UTC timestamp when `url` expires.
|
|
1461
|
+
* @type {string}
|
|
1462
|
+
* @memberof ContentItem
|
|
1463
|
+
*/
|
|
1464
|
+
expires_at?: string | null;
|
|
1465
|
+
}
|
|
1466
|
+
/**
|
|
1467
|
+
* Check if a given object implements the ContentItem interface.
|
|
1468
|
+
*/
|
|
1469
|
+
declare function instanceOfContentItem(value: object): value is ContentItem;
|
|
1470
|
+
declare function ContentItemFromJSON(json: any): ContentItem;
|
|
1471
|
+
declare function ContentItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContentItem;
|
|
1472
|
+
declare function ContentItemToJSON(json: any): ContentItem;
|
|
1473
|
+
declare function ContentItemToJSONTyped(value?: ContentItem | null, ignoreDiscriminator?: boolean): any;
|
|
1474
|
+
|
|
1475
|
+
/**
|
|
1476
|
+
* Knowledge Search API
|
|
1477
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1478
|
+
*
|
|
1479
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1480
|
+
*
|
|
1481
|
+
*
|
|
1482
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1483
|
+
* https://openapi-generator.tech
|
|
1484
|
+
* Do not edit the class manually.
|
|
1485
|
+
*/
|
|
1486
|
+
|
|
1487
|
+
/**
|
|
1488
|
+
* Response for POST /api/v1/contents.
|
|
1489
|
+
*
|
|
1490
|
+
* `contents` is a list so the contract stays stable if a single result ever
|
|
1491
|
+
* yields multiple artifacts; today it always carries exactly one item.
|
|
1492
|
+
* @export
|
|
1493
|
+
* @interface ContentsResponse
|
|
1494
|
+
*/
|
|
1495
|
+
interface ContentsResponse {
|
|
1496
|
+
/**
|
|
1497
|
+
*
|
|
1498
|
+
* @type {Array<ContentItem>}
|
|
1499
|
+
* @memberof ContentsResponse
|
|
1500
|
+
*/
|
|
1501
|
+
contents?: Array<ContentItem>;
|
|
1502
|
+
/**
|
|
1503
|
+
*
|
|
1504
|
+
* @type {string}
|
|
1505
|
+
* @memberof ContentsResponse
|
|
1506
|
+
*/
|
|
1507
|
+
request_id: string;
|
|
1508
|
+
}
|
|
1509
|
+
/**
|
|
1510
|
+
* Check if a given object implements the ContentsResponse interface.
|
|
1511
|
+
*/
|
|
1512
|
+
declare function instanceOfContentsResponse(value: object): value is ContentsResponse;
|
|
1513
|
+
declare function ContentsResponseFromJSON(json: any): ContentsResponse;
|
|
1514
|
+
declare function ContentsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContentsResponse;
|
|
1515
|
+
declare function ContentsResponseToJSON(json: any): ContentsResponse;
|
|
1516
|
+
declare function ContentsResponseToJSONTyped(value?: ContentsResponse | null, ignoreDiscriminator?: boolean): any;
|
|
1517
|
+
|
|
1518
|
+
/**
|
|
1519
|
+
* Knowledge Search API
|
|
1520
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1521
|
+
*
|
|
1522
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1523
|
+
*
|
|
1524
|
+
*
|
|
1525
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1526
|
+
* https://openapi-generator.tech
|
|
1527
|
+
* Do not edit the class manually.
|
|
1528
|
+
*/
|
|
1529
|
+
/**
|
|
1530
|
+
* Component types supported for thin viz schemas with builder support.
|
|
1531
|
+
*
|
|
1532
|
+
* These component types have dedicated builders that process configurations,
|
|
1533
|
+
* add defaults, and apply theme styling automatically.
|
|
1534
|
+
* @export
|
|
1535
|
+
*/
|
|
1536
|
+
declare const ComponentTypeEnum: {
|
|
1537
|
+
readonly CategoricalBar: "categorical_bar";
|
|
1538
|
+
readonly Choropleth: "choropleth";
|
|
1539
|
+
readonly DataTableChart: "data_table_chart";
|
|
1540
|
+
readonly FinancialBoxes: "financial_boxes";
|
|
1541
|
+
readonly GenericTimeseries: "generic_timeseries";
|
|
1542
|
+
readonly Header: "header";
|
|
1543
|
+
readonly Heatmap: "heatmap";
|
|
1544
|
+
readonly Histogram: "histogram";
|
|
1545
|
+
readonly Marimekko: "marimekko";
|
|
1546
|
+
readonly Pie: "pie";
|
|
1547
|
+
readonly Scatter: "scatter";
|
|
1548
|
+
readonly Table: "table";
|
|
1549
|
+
readonly Boxplot: "boxplot";
|
|
1550
|
+
readonly Treemap: "treemap";
|
|
1551
|
+
readonly Waterfall: "waterfall";
|
|
1552
|
+
readonly Sankey: "sankey";
|
|
1553
|
+
readonly Bubble: "bubble";
|
|
1554
|
+
readonly PersonCard: "person_card";
|
|
1555
|
+
readonly Timeline: "timeline";
|
|
1556
|
+
readonly TopLevelMetric: "top_level_metric";
|
|
1557
|
+
};
|
|
1558
|
+
type ComponentTypeEnum = typeof ComponentTypeEnum[keyof typeof ComponentTypeEnum];
|
|
1559
|
+
declare function instanceOfComponentTypeEnum(value: any): boolean;
|
|
1560
|
+
declare function ComponentTypeEnumFromJSON(json: any): ComponentTypeEnum;
|
|
1561
|
+
declare function ComponentTypeEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): ComponentTypeEnum;
|
|
1562
|
+
declare function ComponentTypeEnumToJSON(value?: ComponentTypeEnum | null): any;
|
|
1563
|
+
declare function ComponentTypeEnumToJSONTyped(value: any, ignoreDiscriminator: boolean): ComponentTypeEnum;
|
|
1564
|
+
|
|
1565
|
+
/**
|
|
1566
|
+
* Knowledge Search API
|
|
1567
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1568
|
+
*
|
|
1569
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1570
|
+
*
|
|
1571
|
+
*
|
|
1572
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1573
|
+
* https://openapi-generator.tech
|
|
1574
|
+
* Do not edit the class manually.
|
|
1575
|
+
*/
|
|
1576
|
+
|
|
1577
|
+
/**
|
|
1578
|
+
* Configuration for a single component in a card.
|
|
1579
|
+
* @export
|
|
1580
|
+
* @interface ComponentConfig
|
|
1581
|
+
*/
|
|
1582
|
+
interface ComponentConfig {
|
|
1583
|
+
/**
|
|
1584
|
+
* Component type:
|
|
1585
|
+
* - bubble: Bubble chart (scatter plot with size dimension for 3-variable data)
|
|
1586
|
+
* - categorical_bar: Bar chart with categorical x-axis (e.g., regions, products)
|
|
1587
|
+
* - choropleth: Choropleth map showing geographic data with color intensity by region (US states or world)
|
|
1588
|
+
* - data_table_chart: Bar chart with auto-generated data table below showing values
|
|
1589
|
+
* - financial_boxes: Financial metric boxes with values and growth indicators (e.g., Revenue, EPS)
|
|
1590
|
+
* - generic_timeseries: timeseries chart
|
|
1591
|
+
* - header: Card header with title and description, automatically styled with theme
|
|
1592
|
+
* - heatmap: 2D heatmap with color intensity representing values (e.g., correlation matrix)
|
|
1593
|
+
* - histogram: Histogram chart showing frequency distribution of values
|
|
1594
|
+
* - person_card: Person profile card from an Exa person search result (includes career, education, and about tabs)
|
|
1595
|
+
* - pie: Pie chart showing proportional data as slices of a circle
|
|
1596
|
+
* - scatter: Scatter plot showing relationships between two continuous variables
|
|
1597
|
+
* - table: Data table with configurable columns and rows
|
|
1598
|
+
* - boxplot: Box plot showing statistical distributions (min, Q1, median, Q3, max)
|
|
1599
|
+
* - treemap: Treemap chart showing hierarchical data as proportional rectangles
|
|
1600
|
+
* - waterfall: Waterfall chart showing incremental positive/negative changes (e.g., income statement breakdown)
|
|
1601
|
+
* @type {ComponentTypeEnum}
|
|
1602
|
+
* @memberof ComponentConfig
|
|
1603
|
+
*/
|
|
1604
|
+
component_type: ComponentTypeEnum;
|
|
1605
|
+
/**
|
|
1606
|
+
* Component variant (e.g., 'simple', 'financial')
|
|
1607
|
+
* @type {string}
|
|
1608
|
+
* @memberof ComponentConfig
|
|
1609
|
+
*/
|
|
1610
|
+
component_variant?: string | null;
|
|
1611
|
+
/**
|
|
1612
|
+
* Component configuration data
|
|
1613
|
+
* @type {{ [key: string]: any; }}
|
|
1614
|
+
* @memberof ComponentConfig
|
|
1615
|
+
*/
|
|
1616
|
+
config: {
|
|
1617
|
+
[key: string]: any;
|
|
1618
|
+
};
|
|
1619
|
+
}
|
|
1620
|
+
/**
|
|
1621
|
+
* Check if a given object implements the ComponentConfig interface.
|
|
1622
|
+
*/
|
|
1623
|
+
declare function instanceOfComponentConfig(value: object): value is ComponentConfig;
|
|
1624
|
+
declare function ComponentConfigFromJSON(json: any): ComponentConfig;
|
|
1625
|
+
declare function ComponentConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean): ComponentConfig;
|
|
1626
|
+
declare function ComponentConfigToJSON(json: any): ComponentConfig;
|
|
1627
|
+
declare function ComponentConfigToJSONTyped(value?: ComponentConfig | null, ignoreDiscriminator?: boolean): any;
|
|
1628
|
+
|
|
1629
|
+
/**
|
|
1630
|
+
* Knowledge Search API
|
|
1631
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1632
|
+
*
|
|
1633
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1634
|
+
*
|
|
1635
|
+
*
|
|
1636
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1637
|
+
* https://openapi-generator.tech
|
|
1638
|
+
* Do not edit the class manually.
|
|
1639
|
+
*/
|
|
1640
|
+
|
|
1641
|
+
/**
|
|
1642
|
+
* Request model for creating a card directly with components.
|
|
1643
|
+
* @export
|
|
1644
|
+
* @interface CreateCardRequest
|
|
1645
|
+
*/
|
|
1646
|
+
interface CreateCardRequest {
|
|
1647
|
+
/**
|
|
1648
|
+
* Full component configurations
|
|
1649
|
+
* @type {Array<ComponentConfig>}
|
|
1650
|
+
* @memberof CreateCardRequest
|
|
1651
|
+
*/
|
|
1652
|
+
components: Array<ComponentConfig>;
|
|
1653
|
+
/**
|
|
1654
|
+
* Card title (falls back to header component title)
|
|
1655
|
+
* @type {string}
|
|
1656
|
+
* @memberof CreateCardRequest
|
|
1657
|
+
*/
|
|
1658
|
+
title?: string | null;
|
|
1659
|
+
/**
|
|
1660
|
+
* Card description
|
|
1661
|
+
* @type {string}
|
|
1662
|
+
* @memberof CreateCardRequest
|
|
1663
|
+
*/
|
|
1664
|
+
description?: string | null;
|
|
1665
|
+
/**
|
|
1666
|
+
* Data source attribution (displayed in footer)
|
|
1667
|
+
* @type {string}
|
|
1668
|
+
* @memberof CreateCardRequest
|
|
1669
|
+
*/
|
|
1670
|
+
source?: string | null;
|
|
1671
|
+
/**
|
|
1672
|
+
* Chart height in pixels. When set, overrides the default aspect-ratio-based height for all chart components in this card. Must be between 100 and 2000.
|
|
1673
|
+
* @type {number}
|
|
1674
|
+
* @memberof CreateCardRequest
|
|
1675
|
+
*/
|
|
1676
|
+
height?: number | null;
|
|
1677
|
+
/**
|
|
1678
|
+
* When True, the embed iframe operates in postMessage mode: the parent page injects visualization_data via window.postMessage after the iframe loads, rather than having data inlined in the embed URL. The response will include embed_mode='postmessage' when this is True, or embed_mode='post' otherwise.
|
|
1679
|
+
* @type {boolean}
|
|
1680
|
+
* @memberof CreateCardRequest
|
|
1681
|
+
*/
|
|
1682
|
+
postmessage_embed?: boolean;
|
|
1683
|
+
/**
|
|
1684
|
+
* Target ISO 4217 currency code (e.g., 'USD', 'EUR'). When set, datasets with recognized currency units are converted to this currency using historical exchange rates. A methodology section is added explaining the conversion.
|
|
1685
|
+
* @type {string}
|
|
1686
|
+
* @memberof CreateCardRequest
|
|
1687
|
+
*/
|
|
1688
|
+
normalize_currencies?: string | null;
|
|
1689
|
+
/**
|
|
1690
|
+
* Minutes to keep preview image available for download (ZDR only). Min 1, max 1440 (24h). When set on a ZDR card, a temporary preview image is generated and available for download until the TTL expires. Ignored for non-ZDR cards.
|
|
1691
|
+
* @type {number}
|
|
1692
|
+
* @memberof CreateCardRequest
|
|
1693
|
+
*/
|
|
1694
|
+
image_ttl_minutes?: number | null;
|
|
1695
|
+
}
|
|
1696
|
+
/**
|
|
1697
|
+
* Check if a given object implements the CreateCardRequest interface.
|
|
1698
|
+
*/
|
|
1699
|
+
declare function instanceOfCreateCardRequest(value: object): value is CreateCardRequest;
|
|
1700
|
+
declare function CreateCardRequestFromJSON(json: any): CreateCardRequest;
|
|
1701
|
+
declare function CreateCardRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateCardRequest;
|
|
1702
|
+
declare function CreateCardRequestToJSON(json: any): CreateCardRequest;
|
|
1703
|
+
declare function CreateCardRequestToJSONTyped(value?: CreateCardRequest | null, ignoreDiscriminator?: boolean): any;
|
|
1704
|
+
|
|
1705
|
+
/**
|
|
1706
|
+
* Knowledge Search API
|
|
1707
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1708
|
+
*
|
|
1709
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1710
|
+
*
|
|
1711
|
+
*
|
|
1712
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1713
|
+
* https://openapi-generator.tech
|
|
1714
|
+
* Do not edit the class manually.
|
|
1715
|
+
*/
|
|
1716
|
+
/**
|
|
1717
|
+
* Documents a decision made by Tako's ideal viz logic for a specific ChartJS property.
|
|
1718
|
+
*
|
|
1719
|
+
* .. deprecated::
|
|
1720
|
+
* This class is deprecated in favor of the structured VizDecisions system.
|
|
1721
|
+
* Use VizDecisions with specific decision types (AggregationDecision, VizTypeDecision, etc.)
|
|
1722
|
+
* instead. The new system provides:
|
|
1723
|
+
* - Structured decision tracking with typed fields
|
|
1724
|
+
* - Override support (apply_override, reset_to_default)
|
|
1725
|
+
* - Better LLM context generation (get_summary_for_llm)
|
|
1726
|
+
*
|
|
1727
|
+
* Example migration:
|
|
1728
|
+
* # Old way (deprecated):
|
|
1729
|
+
* decisions.append(IdealVizDecision(
|
|
1730
|
+
* property_path="y_aggregation",
|
|
1731
|
+
* reason="Applied PCSS due to different units"
|
|
1732
|
+
* ))
|
|
1733
|
+
*
|
|
1734
|
+
* # New way:
|
|
1735
|
+
* viz_decisions.set_decision(
|
|
1736
|
+
* DecisionType.LEFT_AXIS_AGGREGATION,
|
|
1737
|
+
* AggregationDecision(
|
|
1738
|
+
* value="pcss",
|
|
1739
|
+
* source=DecisionSource.DATA_DRIVEN,
|
|
1740
|
+
* reason_code="different_units",
|
|
1741
|
+
* reason_display="Applied PCSS due to different units",
|
|
1742
|
+
* )
|
|
1743
|
+
* )
|
|
1744
|
+
*
|
|
1745
|
+
* This class will be removed in a future version.
|
|
1746
|
+
* @export
|
|
1747
|
+
* @interface IdealVizDecision
|
|
1748
|
+
*/
|
|
1749
|
+
interface IdealVizDecision {
|
|
1750
|
+
/**
|
|
1751
|
+
* ChartJS property path
|
|
1752
|
+
* @type {string}
|
|
1753
|
+
* @memberof IdealVizDecision
|
|
1754
|
+
*/
|
|
1755
|
+
property_path: string;
|
|
1756
|
+
/**
|
|
1757
|
+
* Human-friendly display name for the property path
|
|
1758
|
+
* @type {string}
|
|
1759
|
+
* @memberof IdealVizDecision
|
|
1760
|
+
*/
|
|
1761
|
+
property_path_display_name?: string | null;
|
|
1762
|
+
/**
|
|
1763
|
+
* Why this decision was made
|
|
1764
|
+
* @type {string}
|
|
1765
|
+
* @memberof IdealVizDecision
|
|
1766
|
+
*/
|
|
1767
|
+
reason: string;
|
|
1768
|
+
}
|
|
1769
|
+
/**
|
|
1770
|
+
* Check if a given object implements the IdealVizDecision interface.
|
|
1771
|
+
*/
|
|
1772
|
+
declare function instanceOfIdealVizDecision(value: object): value is IdealVizDecision;
|
|
1773
|
+
declare function IdealVizDecisionFromJSON(json: any): IdealVizDecision;
|
|
1774
|
+
declare function IdealVizDecisionFromJSONTyped(json: any, ignoreDiscriminator: boolean): IdealVizDecision;
|
|
1775
|
+
declare function IdealVizDecisionToJSON(json: any): IdealVizDecision;
|
|
1776
|
+
declare function IdealVizDecisionToJSONTyped(value?: IdealVizDecision | null, ignoreDiscriminator?: boolean): any;
|
|
1777
|
+
|
|
1778
|
+
/**
|
|
1779
|
+
* Knowledge Search API
|
|
1780
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1781
|
+
*
|
|
1782
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1783
|
+
*
|
|
1784
|
+
*
|
|
1785
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1786
|
+
* https://openapi-generator.tech
|
|
1787
|
+
* Do not edit the class manually.
|
|
1788
|
+
*/
|
|
1789
|
+
|
|
1790
|
+
/**
|
|
1791
|
+
*
|
|
1792
|
+
* @export
|
|
1793
|
+
* @interface KnowledgeCard
|
|
1794
|
+
*/
|
|
1795
|
+
interface KnowledgeCard {
|
|
1796
|
+
/**
|
|
1797
|
+
* The unique ID of the knowledge card
|
|
1798
|
+
* @type {string}
|
|
1799
|
+
* @memberof KnowledgeCard
|
|
1800
|
+
*/
|
|
1801
|
+
card_id: string | null;
|
|
1802
|
+
/**
|
|
1803
|
+
* The unique ID of the knowledge card
|
|
1804
|
+
* @type {string}
|
|
1805
|
+
* @memberof KnowledgeCard
|
|
1806
|
+
*/
|
|
1807
|
+
title: string | null;
|
|
1808
|
+
/**
|
|
1809
|
+
* The unique ID of the knowledge card
|
|
1810
|
+
* @type {string}
|
|
1811
|
+
* @memberof KnowledgeCard
|
|
1812
|
+
*/
|
|
1813
|
+
description: string | null;
|
|
1814
|
+
/**
|
|
1815
|
+
* The unique ID of the knowledge card
|
|
1816
|
+
* @type {string}
|
|
1817
|
+
* @memberof KnowledgeCard
|
|
1818
|
+
*/
|
|
1819
|
+
semantic_description?: string | null;
|
|
1820
|
+
/**
|
|
1821
|
+
* The unique ID of the knowledge card
|
|
1822
|
+
* @type {string}
|
|
1823
|
+
* @memberof KnowledgeCard
|
|
1824
|
+
*/
|
|
1825
|
+
webpage_url: string | null;
|
|
1826
|
+
/**
|
|
1827
|
+
* The unique ID of the knowledge card
|
|
1828
|
+
* @type {string}
|
|
1829
|
+
* @memberof KnowledgeCard
|
|
1830
|
+
*/
|
|
1831
|
+
image_url: string | null;
|
|
1832
|
+
/**
|
|
1833
|
+
* The unique ID of the knowledge card
|
|
1834
|
+
* @type {string}
|
|
1835
|
+
* @memberof KnowledgeCard
|
|
1836
|
+
*/
|
|
1837
|
+
embed_url: string | null;
|
|
1838
|
+
/**
|
|
1839
|
+
* The sources of the knowledge card
|
|
1840
|
+
* @type {Array<KnowledgeCardSource>}
|
|
1841
|
+
* @memberof KnowledgeCard
|
|
1842
|
+
*/
|
|
1843
|
+
sources: Array<KnowledgeCardSource> | null;
|
|
1844
|
+
/**
|
|
1845
|
+
* The methodologies of the knowledge card
|
|
1846
|
+
* @type {Array<KnowledgeCardMethodology>}
|
|
1847
|
+
* @memberof KnowledgeCard
|
|
1848
|
+
*/
|
|
1849
|
+
methodologies: Array<KnowledgeCardMethodology> | null;
|
|
1850
|
+
/**
|
|
1851
|
+
* The source indexes of the knowledge card
|
|
1852
|
+
* @type {Array<KnowledgeCardSourceIndexesInner>}
|
|
1853
|
+
* @memberof KnowledgeCard
|
|
1854
|
+
*/
|
|
1855
|
+
source_indexes: Array<KnowledgeCardSourceIndexesInner> | null;
|
|
1856
|
+
/**
|
|
1857
|
+
* The unique ID of the knowledge card
|
|
1858
|
+
* @type {string}
|
|
1859
|
+
* @memberof KnowledgeCard
|
|
1860
|
+
*/
|
|
1861
|
+
card_type: string | null;
|
|
1862
|
+
/**
|
|
1863
|
+
* URL of downloadable data of the knowledge card. This needs to be enabled on an account level. Contact support to enable this feature.
|
|
1864
|
+
* @type {string}
|
|
1865
|
+
* @memberof KnowledgeCard
|
|
1866
|
+
*/
|
|
1867
|
+
data_url: string | null;
|
|
1868
|
+
/**
|
|
1869
|
+
* How relevant this knowledge card is to the search query
|
|
1870
|
+
* @type {KnowledgeCardRelevance}
|
|
1871
|
+
* @memberof KnowledgeCard
|
|
1872
|
+
*/
|
|
1873
|
+
relevance: KnowledgeCardRelevance | null;
|
|
1874
|
+
/**
|
|
1875
|
+
* The visualization data of the knowledge card. Null when the card's sources do not permit raw data export (protected sources); the card remains renderable via embed_url.
|
|
1876
|
+
* @type {{ [key: string]: any; }}
|
|
1877
|
+
* @memberof KnowledgeCard
|
|
1878
|
+
*/
|
|
1879
|
+
visualization_data: {
|
|
1880
|
+
[key: string]: any;
|
|
1881
|
+
} | null;
|
|
1882
|
+
/**
|
|
1883
|
+
* Decisions made by Tako's ideal viz logic when constructing this visualization. DEPRECATED: Use ChartConfig.viz_decisions for the new structured system with override support.
|
|
1884
|
+
* @type {Array<IdealVizDecision>}
|
|
1885
|
+
* @memberof KnowledgeCard
|
|
1886
|
+
*/
|
|
1887
|
+
ideal_viz_decisions?: Array<IdealVizDecision> | null;
|
|
1888
|
+
}
|
|
1889
|
+
/**
|
|
1890
|
+
* Check if a given object implements the KnowledgeCard interface.
|
|
1891
|
+
*/
|
|
1892
|
+
declare function instanceOfKnowledgeCard(value: object): value is KnowledgeCard;
|
|
1893
|
+
declare function KnowledgeCardFromJSON(json: any): KnowledgeCard;
|
|
1894
|
+
declare function KnowledgeCardFromJSONTyped(json: any, ignoreDiscriminator: boolean): KnowledgeCard;
|
|
1895
|
+
declare function KnowledgeCardToJSON(json: any): KnowledgeCard;
|
|
1896
|
+
declare function KnowledgeCardToJSONTyped(value?: KnowledgeCard | null, ignoreDiscriminator?: boolean): any;
|
|
1897
|
+
|
|
1898
|
+
/**
|
|
1899
|
+
* Knowledge Search API
|
|
1900
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1901
|
+
*
|
|
1902
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1903
|
+
*
|
|
1904
|
+
*
|
|
1905
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1906
|
+
* https://openapi-generator.tech
|
|
1907
|
+
* Do not edit the class manually.
|
|
1908
|
+
*/
|
|
1909
|
+
/**
|
|
1910
|
+
* Public effort taxonomy for the new endpoints. FAST is the default. INSTANT
|
|
1911
|
+
* serves cached embeds without re-running data retrieval and is available in all
|
|
1912
|
+
* environments (cannot be combined with sources.data.defer_data_retrieval).
|
|
1913
|
+
* DEEP widens TAKO retrieval and adds an LLM rerank for higher-quality results
|
|
1914
|
+
* (slower; billed at a premium tier). The generated OpenAPI/SDK advertises
|
|
1915
|
+
* exactly these members, so we add values only as the pipeline gains support.
|
|
1916
|
+
* @export
|
|
1917
|
+
*/
|
|
1918
|
+
declare const SearchEffortLevel: {
|
|
1919
|
+
readonly Fast: "fast";
|
|
1920
|
+
readonly Instant: "instant";
|
|
1921
|
+
readonly Deep: "deep";
|
|
1922
|
+
};
|
|
1923
|
+
type SearchEffortLevel = typeof SearchEffortLevel[keyof typeof SearchEffortLevel];
|
|
1924
|
+
declare function instanceOfSearchEffortLevel(value: any): boolean;
|
|
1925
|
+
declare function SearchEffortLevelFromJSON(json: any): SearchEffortLevel;
|
|
1926
|
+
declare function SearchEffortLevelFromJSONTyped(json: any, ignoreDiscriminator: boolean): SearchEffortLevel;
|
|
1927
|
+
declare function SearchEffortLevelToJSON(value?: SearchEffortLevel | null): any;
|
|
1928
|
+
declare function SearchEffortLevelToJSONTyped(value: any, ignoreDiscriminator: boolean): SearchEffortLevel;
|
|
1929
|
+
|
|
1930
|
+
/**
|
|
1931
|
+
* Knowledge Search API
|
|
1932
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1933
|
+
*
|
|
1934
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1935
|
+
*
|
|
1936
|
+
*
|
|
1937
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1938
|
+
* https://openapi-generator.tech
|
|
1939
|
+
* Do not edit the class manually.
|
|
1940
|
+
*/
|
|
1941
|
+
/**
|
|
1942
|
+
*
|
|
1943
|
+
* @export
|
|
1944
|
+
* @interface OutputSettings
|
|
1945
|
+
*/
|
|
1946
|
+
interface OutputSettings {
|
|
1947
|
+
/**
|
|
1948
|
+
* Whether to render card preview images in dark mode.
|
|
1949
|
+
* @type {boolean}
|
|
1950
|
+
* @memberof OutputSettings
|
|
1951
|
+
*/
|
|
1952
|
+
image_dark_mode?: boolean | null;
|
|
1953
|
+
/**
|
|
1954
|
+
* Instant mode only. When false (default), instant returns existing cached embeds as-is (fastest) and never writes. When true, instant retrieves data for embeds that are missing or stale, then creates or refreshes their static embeds — slower for those, but it writes the result. Embeds already fresh (within the refresh cadence) are still served as-is, not re-retrieved or updated.
|
|
1955
|
+
* @type {boolean}
|
|
1956
|
+
* @memberof OutputSettings
|
|
1957
|
+
*/
|
|
1958
|
+
force_refresh?: boolean;
|
|
1959
|
+
}
|
|
1960
|
+
/**
|
|
1961
|
+
* Check if a given object implements the OutputSettings interface.
|
|
1962
|
+
*/
|
|
1963
|
+
declare function instanceOfOutputSettings(value: object): value is OutputSettings;
|
|
1964
|
+
declare function OutputSettingsFromJSON(json: any): OutputSettings;
|
|
1965
|
+
declare function OutputSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): OutputSettings;
|
|
1966
|
+
declare function OutputSettingsToJSON(json: any): OutputSettings;
|
|
1967
|
+
declare function OutputSettingsToJSONTyped(value?: OutputSettings | null, ignoreDiscriminator?: boolean): any;
|
|
1968
|
+
|
|
1969
|
+
/**
|
|
1970
|
+
* Knowledge Search API
|
|
1971
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
1972
|
+
*
|
|
1973
|
+
* The version of the OpenAPI document: 1.0.0
|
|
1974
|
+
*
|
|
1975
|
+
*
|
|
1976
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1977
|
+
* https://openapi-generator.tech
|
|
1978
|
+
* Do not edit the class manually.
|
|
1979
|
+
*/
|
|
1980
|
+
/**
|
|
1981
|
+
*
|
|
1982
|
+
* @export
|
|
1983
|
+
* @interface TakoSourceSettings
|
|
1984
|
+
*/
|
|
1985
|
+
interface TakoSourceSettings {
|
|
1986
|
+
/**
|
|
1987
|
+
* Maximum number of results to return for this source. 1-20.
|
|
1988
|
+
* @type {number}
|
|
1989
|
+
* @memberof TakoSourceSettings
|
|
1990
|
+
*/
|
|
1991
|
+
count?: number;
|
|
1992
|
+
/**
|
|
1993
|
+
* Inline this source's underlying data (CSV for Tako cards, extracted text for web results) directly in the response.
|
|
1994
|
+
* @type {boolean}
|
|
1995
|
+
* @memberof TakoSourceSettings
|
|
1996
|
+
*/
|
|
1997
|
+
include_contents?: boolean;
|
|
1998
|
+
/**
|
|
1999
|
+
* Defer the expensive data-retrieval step: cards return faster with a semantic_description and a less detailed description. Mutually exclusive with include_contents (cannot inline data that was not fetched).
|
|
2000
|
+
* @type {boolean}
|
|
2001
|
+
* @memberof TakoSourceSettings
|
|
2002
|
+
*/
|
|
2003
|
+
defer_data_retrieval?: boolean;
|
|
2004
|
+
}
|
|
2005
|
+
/**
|
|
2006
|
+
* Check if a given object implements the TakoSourceSettings interface.
|
|
2007
|
+
*/
|
|
2008
|
+
declare function instanceOfTakoSourceSettings(value: object): value is TakoSourceSettings;
|
|
2009
|
+
declare function TakoSourceSettingsFromJSON(json: any): TakoSourceSettings;
|
|
2010
|
+
declare function TakoSourceSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): TakoSourceSettings;
|
|
2011
|
+
declare function TakoSourceSettingsToJSON(json: any): TakoSourceSettings;
|
|
2012
|
+
declare function TakoSourceSettingsToJSONTyped(value?: TakoSourceSettings | null, ignoreDiscriminator?: boolean): any;
|
|
2013
|
+
|
|
2014
|
+
/**
|
|
2015
|
+
* Knowledge Search API
|
|
2016
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2017
|
+
*
|
|
2018
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2019
|
+
*
|
|
2020
|
+
*
|
|
2021
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2022
|
+
* https://openapi-generator.tech
|
|
2023
|
+
* Do not edit the class manually.
|
|
2024
|
+
*/
|
|
2025
|
+
/**
|
|
2026
|
+
*
|
|
2027
|
+
* @export
|
|
2028
|
+
* @interface SourceSettings
|
|
2029
|
+
*/
|
|
2030
|
+
interface SourceSettings {
|
|
2031
|
+
/**
|
|
2032
|
+
* Maximum number of results to return for this source. 1-20.
|
|
2033
|
+
* @type {number}
|
|
2034
|
+
* @memberof SourceSettings
|
|
2035
|
+
*/
|
|
2036
|
+
count?: number;
|
|
2037
|
+
/**
|
|
2038
|
+
* Inline this source's underlying data (CSV for Tako cards, extracted text for web results) directly in the response.
|
|
2039
|
+
* @type {boolean}
|
|
2040
|
+
* @memberof SourceSettings
|
|
2041
|
+
*/
|
|
2042
|
+
include_contents?: boolean;
|
|
2043
|
+
}
|
|
2044
|
+
/**
|
|
2045
|
+
* Check if a given object implements the SourceSettings interface.
|
|
2046
|
+
*/
|
|
2047
|
+
declare function instanceOfSourceSettings(value: object): value is SourceSettings;
|
|
2048
|
+
declare function SourceSettingsFromJSON(json: any): SourceSettings;
|
|
2049
|
+
declare function SourceSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SourceSettings;
|
|
2050
|
+
declare function SourceSettingsToJSON(json: any): SourceSettings;
|
|
2051
|
+
declare function SourceSettingsToJSONTyped(value?: SourceSettings | null, ignoreDiscriminator?: boolean): any;
|
|
2052
|
+
|
|
2053
|
+
/**
|
|
2054
|
+
* Knowledge Search API
|
|
2055
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2056
|
+
*
|
|
2057
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2058
|
+
*
|
|
2059
|
+
*
|
|
2060
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2061
|
+
* https://openapi-generator.tech
|
|
2062
|
+
* Do not edit the class manually.
|
|
2063
|
+
*/
|
|
2064
|
+
|
|
2065
|
+
/**
|
|
2066
|
+
* Per-source settings. An index is searched iff its field is present.
|
|
2067
|
+
*
|
|
2068
|
+
* The Tako data source is named `data`. The legacy key `tako` is still
|
|
2069
|
+
* accepted as a synonym (mapped to `data` before validation).
|
|
2070
|
+
* @export
|
|
2071
|
+
* @interface Sources
|
|
2072
|
+
*/
|
|
2073
|
+
interface Sources {
|
|
2074
|
+
/**
|
|
2075
|
+
* Tako data source (curated knowledge). Searched iff present. The legacy key 'tako' is accepted as a synonym.
|
|
2076
|
+
* @type {TakoSourceSettings}
|
|
2077
|
+
* @memberof Sources
|
|
2078
|
+
*/
|
|
2079
|
+
data?: TakoSourceSettings | null;
|
|
2080
|
+
/**
|
|
2081
|
+
* Web source. Searched iff present.
|
|
2082
|
+
* @type {SourceSettings}
|
|
2083
|
+
* @memberof Sources
|
|
2084
|
+
*/
|
|
2085
|
+
web?: SourceSettings | null;
|
|
2086
|
+
}
|
|
2087
|
+
/**
|
|
2088
|
+
* Check if a given object implements the Sources interface.
|
|
2089
|
+
*/
|
|
2090
|
+
declare function instanceOfSources(value: object): value is Sources;
|
|
2091
|
+
declare function SourcesFromJSON(json: any): Sources;
|
|
2092
|
+
declare function SourcesFromJSONTyped(json: any, ignoreDiscriminator: boolean): Sources;
|
|
2093
|
+
declare function SourcesToJSON(json: any): Sources;
|
|
2094
|
+
declare function SourcesToJSONTyped(value?: Sources | null, ignoreDiscriminator?: boolean): any;
|
|
2095
|
+
|
|
2096
|
+
/**
|
|
2097
|
+
* Knowledge Search API
|
|
2098
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2099
|
+
*
|
|
2100
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2101
|
+
*
|
|
2102
|
+
*
|
|
2103
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2104
|
+
* https://openapi-generator.tech
|
|
2105
|
+
* Do not edit the class manually.
|
|
2106
|
+
*/
|
|
2107
|
+
|
|
2108
|
+
/**
|
|
2109
|
+
*
|
|
2110
|
+
* @export
|
|
2111
|
+
* @interface SearchRequest
|
|
2112
|
+
*/
|
|
2113
|
+
interface SearchRequest {
|
|
2114
|
+
/**
|
|
2115
|
+
* Natural language search query.
|
|
2116
|
+
* @type {string}
|
|
2117
|
+
* @memberof SearchRequest
|
|
2118
|
+
*/
|
|
2119
|
+
query: string;
|
|
2120
|
+
/**
|
|
2121
|
+
* Search effort level: 'fast' (default), 'instant', or 'deep'.
|
|
2122
|
+
* @type {SearchEffortLevel}
|
|
2123
|
+
* @memberof SearchRequest
|
|
2124
|
+
*/
|
|
2125
|
+
effort?: SearchEffortLevel;
|
|
2126
|
+
/**
|
|
2127
|
+
* Per-source settings. An index is searched iff its key is present; defaults to {data:{}, web:{}} (data + web, count 5 each). The legacy key 'tako' is accepted as a synonym for 'data'.
|
|
2128
|
+
* @type {Sources}
|
|
2129
|
+
* @memberof SearchRequest
|
|
2130
|
+
*/
|
|
2131
|
+
sources?: Sources;
|
|
2132
|
+
/**
|
|
2133
|
+
* ISO 3166-1 alpha-2 country code for localization.
|
|
2134
|
+
* @type {string}
|
|
2135
|
+
* @memberof SearchRequest
|
|
2136
|
+
*/
|
|
2137
|
+
country_code?: string;
|
|
2138
|
+
/**
|
|
2139
|
+
* BCP-47 locale tag for language/formatting.
|
|
2140
|
+
* @type {string}
|
|
2141
|
+
* @memberof SearchRequest
|
|
2142
|
+
*/
|
|
2143
|
+
locale?: string;
|
|
2144
|
+
/**
|
|
2145
|
+
* IANA timezone (e.g. 'America/New_York').
|
|
2146
|
+
* @type {string}
|
|
2147
|
+
* @memberof SearchRequest
|
|
2148
|
+
*/
|
|
2149
|
+
timezone?: string | null;
|
|
2150
|
+
/**
|
|
2151
|
+
* Settings controlling the response shape.
|
|
2152
|
+
* @type {OutputSettings}
|
|
2153
|
+
* @memberof SearchRequest
|
|
2154
|
+
*/
|
|
2155
|
+
output_settings?: OutputSettings | null;
|
|
2156
|
+
}
|
|
2157
|
+
/**
|
|
2158
|
+
* Check if a given object implements the SearchRequest interface.
|
|
2159
|
+
*/
|
|
2160
|
+
declare function instanceOfSearchRequest(value: object): value is SearchRequest;
|
|
2161
|
+
declare function SearchRequestFromJSON(json: any): SearchRequest;
|
|
2162
|
+
declare function SearchRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SearchRequest;
|
|
2163
|
+
declare function SearchRequestToJSON(json: any): SearchRequest;
|
|
2164
|
+
declare function SearchRequestToJSONTyped(value?: SearchRequest | null, ignoreDiscriminator?: boolean): any;
|
|
2165
|
+
|
|
2166
|
+
/**
|
|
2167
|
+
* Knowledge Search API
|
|
2168
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2169
|
+
*
|
|
2170
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2171
|
+
*
|
|
2172
|
+
*
|
|
2173
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2174
|
+
* https://openapi-generator.tech
|
|
2175
|
+
* Do not edit the class manually.
|
|
2176
|
+
*/
|
|
2177
|
+
|
|
2178
|
+
/**
|
|
2179
|
+
*
|
|
2180
|
+
* @export
|
|
2181
|
+
* @interface SearchResponse
|
|
2182
|
+
*/
|
|
2183
|
+
interface SearchResponse {
|
|
2184
|
+
/**
|
|
2185
|
+
*
|
|
2186
|
+
* @type {Array<TakoCard>}
|
|
2187
|
+
* @memberof SearchResponse
|
|
2188
|
+
*/
|
|
2189
|
+
cards?: Array<TakoCard>;
|
|
2190
|
+
/**
|
|
2191
|
+
*
|
|
2192
|
+
* @type {Array<WebResult>}
|
|
2193
|
+
* @memberof SearchResponse
|
|
2194
|
+
*/
|
|
2195
|
+
web_results?: Array<WebResult>;
|
|
2196
|
+
/**
|
|
2197
|
+
* Total quoted USD cost of the data inlined on this response — the summed per-fetch price of the results whose payload was populated (one charge per distinct extracted web URL; Tako card CSV is free). This is the QUOTE, not necessarily the amount billed: on a depleted prepaid (PAYG) balance the charge is clamped to the remaining balance, so the amount actually drawn can be less. A result's own `cost` is a per-fetch quote present whenever it is downloadable, so a result that was requested but whose extraction was skipped or failed still carries its quote; that un-inlined quote is excluded here. 0 when no contents were inlined.
|
|
2198
|
+
* @type {number}
|
|
2199
|
+
* @memberof SearchResponse
|
|
2200
|
+
*/
|
|
2201
|
+
contents_total_cost?: number;
|
|
2202
|
+
/**
|
|
2203
|
+
*
|
|
2204
|
+
* @type {string}
|
|
2205
|
+
* @memberof SearchResponse
|
|
2206
|
+
*/
|
|
2207
|
+
request_id: string;
|
|
2208
|
+
}
|
|
2209
|
+
/**
|
|
2210
|
+
* Check if a given object implements the SearchResponse interface.
|
|
2211
|
+
*/
|
|
2212
|
+
declare function instanceOfSearchResponse(value: object): value is SearchResponse;
|
|
2213
|
+
declare function SearchResponseFromJSON(json: any): SearchResponse;
|
|
2214
|
+
declare function SearchResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SearchResponse;
|
|
2215
|
+
declare function SearchResponseToJSON(json: any): SearchResponse;
|
|
2216
|
+
declare function SearchResponseToJSONTyped(value?: SearchResponse | null, ignoreDiscriminator?: boolean): any;
|
|
2217
|
+
|
|
2218
|
+
/**
|
|
2219
|
+
* Knowledge Search API
|
|
2220
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2221
|
+
*
|
|
2222
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2223
|
+
*
|
|
2224
|
+
*
|
|
2225
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2226
|
+
* https://openapi-generator.tech
|
|
2227
|
+
* Do not edit the class manually.
|
|
2228
|
+
*/
|
|
2229
|
+
|
|
2230
|
+
interface AnswerRequest {
|
|
2231
|
+
searchRequest?: SearchRequest;
|
|
2232
|
+
}
|
|
2233
|
+
interface ClassifyOperationRequest {
|
|
2234
|
+
classifyRequest?: ClassifyRequest;
|
|
2235
|
+
}
|
|
2236
|
+
interface ContentsOperationRequest {
|
|
2237
|
+
contentsRequest?: ContentsRequest;
|
|
2238
|
+
}
|
|
2239
|
+
interface CreateCardOperationRequest {
|
|
2240
|
+
createCardRequest?: CreateCardRequest;
|
|
2241
|
+
}
|
|
2242
|
+
interface SearchOperationRequest {
|
|
2243
|
+
searchRequest?: SearchRequest;
|
|
2244
|
+
}
|
|
2245
|
+
/**
|
|
2246
|
+
* TakoApi - interface
|
|
2247
|
+
*
|
|
2248
|
+
* @export
|
|
2249
|
+
* @interface TakoApiInterface
|
|
2250
|
+
*/
|
|
2251
|
+
interface TakoApiInterface {
|
|
2252
|
+
/**
|
|
2253
|
+
* Creates request options for answer without sending the request
|
|
2254
|
+
* @param {SearchRequest} [searchRequest]
|
|
2255
|
+
* @throws {RequiredError}
|
|
2256
|
+
* @memberof TakoApiInterface
|
|
2257
|
+
*/
|
|
2258
|
+
answerRequestOpts(requestParameters: AnswerRequest): Promise<RequestOpts>;
|
|
2259
|
+
/**
|
|
2260
|
+
* Fast-pipeline retrieval plus an LLM-synthesized answer with confidence. Replaces the grounding endpoint.
|
|
2261
|
+
* @summary Answer
|
|
2262
|
+
* @param {SearchRequest} [searchRequest]
|
|
2263
|
+
* @param {*} [options] Override http request option.
|
|
2264
|
+
* @throws {RequiredError}
|
|
2265
|
+
* @memberof TakoApiInterface
|
|
2266
|
+
*/
|
|
2267
|
+
answerRaw(requestParameters: AnswerRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<AnswerResponse>>;
|
|
2268
|
+
/**
|
|
2269
|
+
* Fast-pipeline retrieval plus an LLM-synthesized answer with confidence. Replaces the grounding endpoint.
|
|
2270
|
+
* Answer
|
|
2271
|
+
*/
|
|
2272
|
+
answer(requestParameters: AnswerRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<AnswerResponse>;
|
|
2273
|
+
/**
|
|
2274
|
+
* Creates request options for classify without sending the request
|
|
2275
|
+
* @param {ClassifyRequest} [classifyRequest]
|
|
2276
|
+
* @throws {RequiredError}
|
|
2277
|
+
* @memberof TakoApiInterface
|
|
2278
|
+
*/
|
|
2279
|
+
classifyRequestOpts(requestParameters: ClassifyOperationRequest): Promise<RequestOpts>;
|
|
2280
|
+
/**
|
|
2281
|
+
* Score a batch of queries for whether Tako search will return a result. Returns a probability and a recall-skewed keep flag per query. Free; intended for pre-filtering before /v3/search.
|
|
2282
|
+
* @summary Classify queries
|
|
2283
|
+
* @param {ClassifyRequest} [classifyRequest]
|
|
2284
|
+
* @param {*} [options] Override http request option.
|
|
2285
|
+
* @throws {RequiredError}
|
|
2286
|
+
* @memberof TakoApiInterface
|
|
2287
|
+
*/
|
|
2288
|
+
classifyRaw(requestParameters: ClassifyOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<ClassifyResponse>>;
|
|
2289
|
+
/**
|
|
2290
|
+
* Score a batch of queries for whether Tako search will return a result. Returns a probability and a recall-skewed keep flag per query. Free; intended for pre-filtering before /v3/search.
|
|
2291
|
+
* Classify queries
|
|
2292
|
+
*/
|
|
2293
|
+
classify(requestParameters: ClassifyOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ClassifyResponse>;
|
|
2294
|
+
/**
|
|
2295
|
+
* Creates request options for contents without sending the request
|
|
2296
|
+
* @param {ContentsRequest} [contentsRequest]
|
|
2297
|
+
* @throws {RequiredError}
|
|
2298
|
+
* @memberof TakoApiInterface
|
|
2299
|
+
*/
|
|
2300
|
+
contentsRequestOpts(requestParameters: ContentsOperationRequest): Promise<RequestOpts>;
|
|
2301
|
+
/**
|
|
2302
|
+
* Download the content behind a search result: a CSV of a Tako card\'s underlying data, or the full text of a web page. Returns a short-lived presigned download URL. Protected-source cards (data export not available) return 403.
|
|
2303
|
+
* @summary Download content
|
|
2304
|
+
* @param {ContentsRequest} [contentsRequest]
|
|
2305
|
+
* @param {*} [options] Override http request option.
|
|
2306
|
+
* @throws {RequiredError}
|
|
2307
|
+
* @memberof TakoApiInterface
|
|
2308
|
+
*/
|
|
2309
|
+
contentsRaw(requestParameters: ContentsOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<ContentsResponse>>;
|
|
2310
|
+
/**
|
|
2311
|
+
* Download the content behind a search result: a CSV of a Tako card\'s underlying data, or the full text of a web page. Returns a short-lived presigned download URL. Protected-source cards (data export not available) return 403.
|
|
2312
|
+
* Download content
|
|
2313
|
+
*/
|
|
2314
|
+
contents(requestParameters: ContentsOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ContentsResponse>;
|
|
2315
|
+
/**
|
|
2316
|
+
* Creates request options for createCard without sending the request
|
|
2317
|
+
* @param {CreateCardRequest} [createCardRequest]
|
|
2318
|
+
* @throws {RequiredError}
|
|
2319
|
+
* @memberof TakoApiInterface
|
|
2320
|
+
*/
|
|
2321
|
+
createCardRequestOpts(requestParameters: CreateCardOperationRequest): Promise<RequestOpts>;
|
|
2322
|
+
/**
|
|
2323
|
+
* Create a visualization card directly from component configurations. Supported component types: header, generic_timeseries, categorical_bar, stock_boxes, financial_boxes, table.
|
|
2324
|
+
* @param {CreateCardRequest} [createCardRequest]
|
|
2325
|
+
* @param {*} [options] Override http request option.
|
|
2326
|
+
* @throws {RequiredError}
|
|
2327
|
+
* @memberof TakoApiInterface
|
|
2328
|
+
*/
|
|
2329
|
+
createCardRaw(requestParameters: CreateCardOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<KnowledgeCard>>;
|
|
2330
|
+
/**
|
|
2331
|
+
* Create a visualization card directly from component configurations. Supported component types: header, generic_timeseries, categorical_bar, stock_boxes, financial_boxes, table.
|
|
2332
|
+
*/
|
|
2333
|
+
createCard(requestParameters: CreateCardOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<KnowledgeCard>;
|
|
2334
|
+
/**
|
|
2335
|
+
* Creates request options for search without sending the request
|
|
2336
|
+
* @param {SearchRequest} [searchRequest]
|
|
2337
|
+
* @throws {RequiredError}
|
|
2338
|
+
* @memberof TakoApiInterface
|
|
2339
|
+
*/
|
|
2340
|
+
searchRequestOpts(requestParameters: SearchOperationRequest): Promise<RequestOpts>;
|
|
2341
|
+
/**
|
|
2342
|
+
* Fast-pipeline knowledge search. Returns Tako cards (and web results when requested) with no LLM synthesis.
|
|
2343
|
+
* @summary Search
|
|
2344
|
+
* @param {SearchRequest} [searchRequest]
|
|
2345
|
+
* @param {*} [options] Override http request option.
|
|
2346
|
+
* @throws {RequiredError}
|
|
2347
|
+
* @memberof TakoApiInterface
|
|
2348
|
+
*/
|
|
2349
|
+
searchRaw(requestParameters: SearchOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<SearchResponse>>;
|
|
2350
|
+
/**
|
|
2351
|
+
* Fast-pipeline knowledge search. Returns Tako cards (and web results when requested) with no LLM synthesis.
|
|
2352
|
+
* Search
|
|
2353
|
+
*/
|
|
2354
|
+
search(requestParameters: SearchOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<SearchResponse>;
|
|
2355
|
+
}
|
|
2356
|
+
/**
|
|
2357
|
+
*
|
|
2358
|
+
*/
|
|
2359
|
+
declare class TakoApi extends BaseAPI implements TakoApiInterface {
|
|
2360
|
+
/**
|
|
2361
|
+
* Creates request options for answer without sending the request
|
|
2362
|
+
*/
|
|
2363
|
+
answerRequestOpts(requestParameters: AnswerRequest): Promise<RequestOpts>;
|
|
2364
|
+
/**
|
|
2365
|
+
* Fast-pipeline retrieval plus an LLM-synthesized answer with confidence. Replaces the grounding endpoint.
|
|
2366
|
+
* Answer
|
|
2367
|
+
*/
|
|
2368
|
+
answerRaw(requestParameters: AnswerRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<AnswerResponse>>;
|
|
2369
|
+
/**
|
|
2370
|
+
* Fast-pipeline retrieval plus an LLM-synthesized answer with confidence. Replaces the grounding endpoint.
|
|
2371
|
+
* Answer
|
|
2372
|
+
*/
|
|
2373
|
+
answer(requestParameters?: AnswerRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<AnswerResponse>;
|
|
2374
|
+
/**
|
|
2375
|
+
* Creates request options for classify without sending the request
|
|
2376
|
+
*/
|
|
2377
|
+
classifyRequestOpts(requestParameters: ClassifyOperationRequest): Promise<RequestOpts>;
|
|
2378
|
+
/**
|
|
2379
|
+
* Score a batch of queries for whether Tako search will return a result. Returns a probability and a recall-skewed keep flag per query. Free; intended for pre-filtering before /v3/search.
|
|
2380
|
+
* Classify queries
|
|
2381
|
+
*/
|
|
2382
|
+
classifyRaw(requestParameters: ClassifyOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<ClassifyResponse>>;
|
|
2383
|
+
/**
|
|
2384
|
+
* Score a batch of queries for whether Tako search will return a result. Returns a probability and a recall-skewed keep flag per query. Free; intended for pre-filtering before /v3/search.
|
|
2385
|
+
* Classify queries
|
|
2386
|
+
*/
|
|
2387
|
+
classify(requestParameters?: ClassifyOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ClassifyResponse>;
|
|
2388
|
+
/**
|
|
2389
|
+
* Creates request options for contents without sending the request
|
|
2390
|
+
*/
|
|
2391
|
+
contentsRequestOpts(requestParameters: ContentsOperationRequest): Promise<RequestOpts>;
|
|
2392
|
+
/**
|
|
2393
|
+
* Download the content behind a search result: a CSV of a Tako card\'s underlying data, or the full text of a web page. Returns a short-lived presigned download URL. Protected-source cards (data export not available) return 403.
|
|
2394
|
+
* Download content
|
|
2395
|
+
*/
|
|
2396
|
+
contentsRaw(requestParameters: ContentsOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<ContentsResponse>>;
|
|
2397
|
+
/**
|
|
2398
|
+
* Download the content behind a search result: a CSV of a Tako card\'s underlying data, or the full text of a web page. Returns a short-lived presigned download URL. Protected-source cards (data export not available) return 403.
|
|
2399
|
+
* Download content
|
|
2400
|
+
*/
|
|
2401
|
+
contents(requestParameters?: ContentsOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ContentsResponse>;
|
|
2402
|
+
/**
|
|
2403
|
+
* Creates request options for createCard without sending the request
|
|
2404
|
+
*/
|
|
2405
|
+
createCardRequestOpts(requestParameters: CreateCardOperationRequest): Promise<RequestOpts>;
|
|
2406
|
+
/**
|
|
2407
|
+
* Create a visualization card directly from component configurations. Supported component types: header, generic_timeseries, categorical_bar, stock_boxes, financial_boxes, table.
|
|
2408
|
+
*/
|
|
2409
|
+
createCardRaw(requestParameters: CreateCardOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<KnowledgeCard>>;
|
|
2410
|
+
/**
|
|
2411
|
+
* Create a visualization card directly from component configurations. Supported component types: header, generic_timeseries, categorical_bar, stock_boxes, financial_boxes, table.
|
|
2412
|
+
*/
|
|
2413
|
+
createCard(requestParameters?: CreateCardOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<KnowledgeCard>;
|
|
2414
|
+
/**
|
|
2415
|
+
* Creates request options for search without sending the request
|
|
2416
|
+
*/
|
|
2417
|
+
searchRequestOpts(requestParameters: SearchOperationRequest): Promise<RequestOpts>;
|
|
2418
|
+
/**
|
|
2419
|
+
* Fast-pipeline knowledge search. Returns Tako cards (and web results when requested) with no LLM synthesis.
|
|
2420
|
+
* Search
|
|
2421
|
+
*/
|
|
2422
|
+
searchRaw(requestParameters: SearchOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<SearchResponse>>;
|
|
2423
|
+
/**
|
|
2424
|
+
* Fast-pipeline knowledge search. Returns Tako cards (and web results when requested) with no LLM synthesis.
|
|
2425
|
+
* Search
|
|
2426
|
+
*/
|
|
2427
|
+
search(requestParameters?: SearchOperationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<SearchResponse>;
|
|
2428
|
+
}
|
|
2429
|
+
|
|
2430
|
+
/**
|
|
2431
|
+
* Knowledge Search API
|
|
2432
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2433
|
+
*
|
|
2434
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2435
|
+
*
|
|
2436
|
+
*
|
|
2437
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2438
|
+
* https://openapi-generator.tech
|
|
2439
|
+
* Do not edit the class manually.
|
|
2440
|
+
*/
|
|
2441
|
+
/**
|
|
2442
|
+
*
|
|
2443
|
+
* @export
|
|
2444
|
+
*/
|
|
2445
|
+
declare const APIErrorType: {
|
|
2446
|
+
readonly BadRequest: "BAD_REQUEST";
|
|
2447
|
+
readonly AuthenticationError: "AUTHENTICATION_ERROR";
|
|
2448
|
+
readonly InternalServerError: "INTERNAL_SERVER_ERROR";
|
|
2449
|
+
readonly RelevantResultsNotFound: "RELEVANT_RESULTS_NOT_FOUND";
|
|
2450
|
+
readonly RateLimitExceeded: "RATE_LIMIT_EXCEEDED";
|
|
2451
|
+
readonly PaymentRequired: "PAYMENT_REQUIRED";
|
|
2452
|
+
readonly RequestTimeout: "REQUEST_TIMEOUT";
|
|
2453
|
+
readonly Forbidden: "FORBIDDEN";
|
|
2454
|
+
readonly NotFound: "NOT_FOUND";
|
|
2455
|
+
};
|
|
2456
|
+
type APIErrorType = typeof APIErrorType[keyof typeof APIErrorType];
|
|
2457
|
+
declare function instanceOfAPIErrorType(value: any): boolean;
|
|
2458
|
+
declare function APIErrorTypeFromJSON(json: any): APIErrorType;
|
|
2459
|
+
declare function APIErrorTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): APIErrorType;
|
|
2460
|
+
declare function APIErrorTypeToJSON(value?: APIErrorType | null): any;
|
|
2461
|
+
declare function APIErrorTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): APIErrorType;
|
|
2462
|
+
|
|
2463
|
+
/**
|
|
2464
|
+
* Knowledge Search API
|
|
2465
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2466
|
+
*
|
|
2467
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2468
|
+
*
|
|
2469
|
+
*
|
|
2470
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2471
|
+
* https://openapi-generator.tech
|
|
2472
|
+
* Do not edit the class manually.
|
|
2473
|
+
*/
|
|
2474
|
+
|
|
2475
|
+
/**
|
|
2476
|
+
*
|
|
2477
|
+
* @export
|
|
2478
|
+
* @interface AgentResultEvent
|
|
2479
|
+
*/
|
|
2480
|
+
interface AgentResultEvent {
|
|
2481
|
+
/**
|
|
2482
|
+
*
|
|
2483
|
+
* @type {AgentResultEventKindEnum}
|
|
2484
|
+
* @memberof AgentResultEvent
|
|
2485
|
+
*/
|
|
2486
|
+
kind?: AgentResultEventKindEnum;
|
|
2487
|
+
/**
|
|
2488
|
+
*
|
|
2489
|
+
* @type {string}
|
|
2490
|
+
* @memberof AgentResultEvent
|
|
2491
|
+
*/
|
|
2492
|
+
id: string;
|
|
2493
|
+
/**
|
|
2494
|
+
*
|
|
2495
|
+
* @type {AgentResult}
|
|
2496
|
+
* @memberof AgentResultEvent
|
|
2497
|
+
*/
|
|
2498
|
+
data: AgentResult;
|
|
2499
|
+
}
|
|
2500
|
+
/**
|
|
2501
|
+
* @export
|
|
2502
|
+
*/
|
|
2503
|
+
declare const AgentResultEventKindEnum: {
|
|
2504
|
+
readonly AgentResult: "agent_result";
|
|
2505
|
+
};
|
|
2506
|
+
type AgentResultEventKindEnum = typeof AgentResultEventKindEnum[keyof typeof AgentResultEventKindEnum];
|
|
2507
|
+
/**
|
|
2508
|
+
* Check if a given object implements the AgentResultEvent interface.
|
|
2509
|
+
*/
|
|
2510
|
+
declare function instanceOfAgentResultEvent(value: object): value is AgentResultEvent;
|
|
2511
|
+
declare function AgentResultEventFromJSON(json: any): AgentResultEvent;
|
|
2512
|
+
declare function AgentResultEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): AgentResultEvent;
|
|
2513
|
+
declare function AgentResultEventToJSON(json: any): AgentResultEvent;
|
|
2514
|
+
declare function AgentResultEventToJSONTyped(value?: AgentResultEvent | null, ignoreDiscriminator?: boolean): any;
|
|
2515
|
+
|
|
2516
|
+
/**
|
|
2517
|
+
* Knowledge Search API
|
|
2518
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2519
|
+
*
|
|
2520
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2521
|
+
*
|
|
2522
|
+
*
|
|
2523
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2524
|
+
* https://openapi-generator.tech
|
|
2525
|
+
* Do not edit the class manually.
|
|
2526
|
+
*/
|
|
2527
|
+
/**
|
|
2528
|
+
* Signals that the data pipeline produced chart(s) for the answer. Carries
|
|
2529
|
+
* only chart references; the answer text streams in `text` events and the
|
|
2530
|
+
* structured result arrives in the terminal `agent_result` event, not here.
|
|
2531
|
+
* @export
|
|
2532
|
+
* @interface DataPipelineAnswerEvent
|
|
2533
|
+
*/
|
|
2534
|
+
interface DataPipelineAnswerEvent {
|
|
2535
|
+
/**
|
|
2536
|
+
*
|
|
2537
|
+
* @type {DataPipelineAnswerEventKindEnum}
|
|
2538
|
+
* @memberof DataPipelineAnswerEvent
|
|
2539
|
+
*/
|
|
2540
|
+
kind?: DataPipelineAnswerEventKindEnum;
|
|
2541
|
+
/**
|
|
2542
|
+
*
|
|
2543
|
+
* @type {string}
|
|
2544
|
+
* @memberof DataPipelineAnswerEvent
|
|
2545
|
+
*/
|
|
2546
|
+
id: string;
|
|
2547
|
+
/**
|
|
2548
|
+
*
|
|
2549
|
+
* @type {Array<string>}
|
|
2550
|
+
* @memberof DataPipelineAnswerEvent
|
|
2551
|
+
*/
|
|
2552
|
+
chart_refs?: Array<string>;
|
|
2553
|
+
}
|
|
2554
|
+
/**
|
|
2555
|
+
* @export
|
|
2556
|
+
*/
|
|
2557
|
+
declare const DataPipelineAnswerEventKindEnum: {
|
|
2558
|
+
readonly DataPipelineAnswer: "data_pipeline_answer";
|
|
2559
|
+
};
|
|
2560
|
+
type DataPipelineAnswerEventKindEnum = typeof DataPipelineAnswerEventKindEnum[keyof typeof DataPipelineAnswerEventKindEnum];
|
|
2561
|
+
/**
|
|
2562
|
+
* Check if a given object implements the DataPipelineAnswerEvent interface.
|
|
2563
|
+
*/
|
|
2564
|
+
declare function instanceOfDataPipelineAnswerEvent(value: object): value is DataPipelineAnswerEvent;
|
|
2565
|
+
declare function DataPipelineAnswerEventFromJSON(json: any): DataPipelineAnswerEvent;
|
|
2566
|
+
declare function DataPipelineAnswerEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataPipelineAnswerEvent;
|
|
2567
|
+
declare function DataPipelineAnswerEventToJSON(json: any): DataPipelineAnswerEvent;
|
|
2568
|
+
declare function DataPipelineAnswerEventToJSONTyped(value?: DataPipelineAnswerEvent | null, ignoreDiscriminator?: boolean): any;
|
|
2569
|
+
|
|
2570
|
+
/**
|
|
2571
|
+
* Knowledge Search API
|
|
2572
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2573
|
+
*
|
|
2574
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2575
|
+
*
|
|
2576
|
+
*
|
|
2577
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2578
|
+
* https://openapi-generator.tech
|
|
2579
|
+
* Do not edit the class manually.
|
|
2580
|
+
*/
|
|
2581
|
+
/**
|
|
2582
|
+
*
|
|
2583
|
+
* @export
|
|
2584
|
+
* @interface HeartbeatEvent
|
|
2585
|
+
*/
|
|
2586
|
+
interface HeartbeatEvent {
|
|
2587
|
+
/**
|
|
2588
|
+
*
|
|
2589
|
+
* @type {HeartbeatEventKindEnum}
|
|
2590
|
+
* @memberof HeartbeatEvent
|
|
2591
|
+
*/
|
|
2592
|
+
kind?: HeartbeatEventKindEnum;
|
|
2593
|
+
}
|
|
2594
|
+
/**
|
|
2595
|
+
* @export
|
|
2596
|
+
*/
|
|
2597
|
+
declare const HeartbeatEventKindEnum: {
|
|
2598
|
+
readonly Heartbeat: "heartbeat";
|
|
2599
|
+
};
|
|
2600
|
+
type HeartbeatEventKindEnum = typeof HeartbeatEventKindEnum[keyof typeof HeartbeatEventKindEnum];
|
|
2601
|
+
/**
|
|
2602
|
+
* Check if a given object implements the HeartbeatEvent interface.
|
|
2603
|
+
*/
|
|
2604
|
+
declare function instanceOfHeartbeatEvent(value: object): value is HeartbeatEvent;
|
|
2605
|
+
declare function HeartbeatEventFromJSON(json: any): HeartbeatEvent;
|
|
2606
|
+
declare function HeartbeatEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): HeartbeatEvent;
|
|
2607
|
+
declare function HeartbeatEventToJSON(json: any): HeartbeatEvent;
|
|
2608
|
+
declare function HeartbeatEventToJSONTyped(value?: HeartbeatEvent | null, ignoreDiscriminator?: boolean): any;
|
|
2609
|
+
|
|
2610
|
+
/**
|
|
2611
|
+
* Knowledge Search API
|
|
2612
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2613
|
+
*
|
|
2614
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2615
|
+
*
|
|
2616
|
+
*
|
|
2617
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2618
|
+
* https://openapi-generator.tech
|
|
2619
|
+
* Do not edit the class manually.
|
|
2620
|
+
*/
|
|
2621
|
+
/**
|
|
2622
|
+
*
|
|
2623
|
+
* @export
|
|
2624
|
+
* @interface ReasoningEvent
|
|
2625
|
+
*/
|
|
2626
|
+
interface ReasoningEvent {
|
|
2627
|
+
/**
|
|
2628
|
+
*
|
|
2629
|
+
* @type {ReasoningEventKindEnum}
|
|
2630
|
+
* @memberof ReasoningEvent
|
|
2631
|
+
*/
|
|
2632
|
+
kind?: ReasoningEventKindEnum;
|
|
2633
|
+
/**
|
|
2634
|
+
*
|
|
2635
|
+
* @type {string}
|
|
2636
|
+
* @memberof ReasoningEvent
|
|
2637
|
+
*/
|
|
2638
|
+
id: string;
|
|
2639
|
+
/**
|
|
2640
|
+
*
|
|
2641
|
+
* @type {string}
|
|
2642
|
+
* @memberof ReasoningEvent
|
|
2643
|
+
*/
|
|
2644
|
+
delta: string;
|
|
2645
|
+
/**
|
|
2646
|
+
*
|
|
2647
|
+
* @type {boolean}
|
|
2648
|
+
* @memberof ReasoningEvent
|
|
2649
|
+
*/
|
|
2650
|
+
done?: boolean;
|
|
2651
|
+
}
|
|
2652
|
+
/**
|
|
2653
|
+
* @export
|
|
2654
|
+
*/
|
|
2655
|
+
declare const ReasoningEventKindEnum: {
|
|
2656
|
+
readonly Reasoning: "reasoning";
|
|
2657
|
+
};
|
|
2658
|
+
type ReasoningEventKindEnum = typeof ReasoningEventKindEnum[keyof typeof ReasoningEventKindEnum];
|
|
2659
|
+
/**
|
|
2660
|
+
* Check if a given object implements the ReasoningEvent interface.
|
|
2661
|
+
*/
|
|
2662
|
+
declare function instanceOfReasoningEvent(value: object): value is ReasoningEvent;
|
|
2663
|
+
declare function ReasoningEventFromJSON(json: any): ReasoningEvent;
|
|
2664
|
+
declare function ReasoningEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReasoningEvent;
|
|
2665
|
+
declare function ReasoningEventToJSON(json: any): ReasoningEvent;
|
|
2666
|
+
declare function ReasoningEventToJSONTyped(value?: ReasoningEvent | null, ignoreDiscriminator?: boolean): any;
|
|
2667
|
+
|
|
2668
|
+
/**
|
|
2669
|
+
* Knowledge Search API
|
|
2670
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2671
|
+
*
|
|
2672
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2673
|
+
*
|
|
2674
|
+
*
|
|
2675
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2676
|
+
* https://openapi-generator.tech
|
|
2677
|
+
* Do not edit the class manually.
|
|
2678
|
+
*/
|
|
2679
|
+
/**
|
|
2680
|
+
*
|
|
2681
|
+
* @export
|
|
2682
|
+
* @interface StatusEvent
|
|
2683
|
+
*/
|
|
2684
|
+
interface StatusEvent {
|
|
2685
|
+
/**
|
|
2686
|
+
*
|
|
2687
|
+
* @type {StatusEventKindEnum}
|
|
2688
|
+
* @memberof StatusEvent
|
|
2689
|
+
*/
|
|
2690
|
+
kind?: StatusEventKindEnum;
|
|
2691
|
+
/**
|
|
2692
|
+
*
|
|
2693
|
+
* @type {string}
|
|
2694
|
+
* @memberof StatusEvent
|
|
2695
|
+
*/
|
|
2696
|
+
message: string;
|
|
2697
|
+
/**
|
|
2698
|
+
*
|
|
2699
|
+
* @type {string}
|
|
2700
|
+
* @memberof StatusEvent
|
|
2701
|
+
*/
|
|
2702
|
+
parent_id?: string | null;
|
|
2703
|
+
}
|
|
2704
|
+
/**
|
|
2705
|
+
* @export
|
|
2706
|
+
*/
|
|
2707
|
+
declare const StatusEventKindEnum: {
|
|
2708
|
+
readonly Status: "status";
|
|
2709
|
+
};
|
|
2710
|
+
type StatusEventKindEnum = typeof StatusEventKindEnum[keyof typeof StatusEventKindEnum];
|
|
2711
|
+
/**
|
|
2712
|
+
* Check if a given object implements the StatusEvent interface.
|
|
2713
|
+
*/
|
|
2714
|
+
declare function instanceOfStatusEvent(value: object): value is StatusEvent;
|
|
2715
|
+
declare function StatusEventFromJSON(json: any): StatusEvent;
|
|
2716
|
+
declare function StatusEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): StatusEvent;
|
|
2717
|
+
declare function StatusEventToJSON(json: any): StatusEvent;
|
|
2718
|
+
declare function StatusEventToJSONTyped(value?: StatusEvent | null, ignoreDiscriminator?: boolean): any;
|
|
2719
|
+
|
|
2720
|
+
/**
|
|
2721
|
+
* Knowledge Search API
|
|
2722
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2723
|
+
*
|
|
2724
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2725
|
+
*
|
|
2726
|
+
*
|
|
2727
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2728
|
+
* https://openapi-generator.tech
|
|
2729
|
+
* Do not edit the class manually.
|
|
2730
|
+
*/
|
|
2731
|
+
/**
|
|
2732
|
+
*
|
|
2733
|
+
* @export
|
|
2734
|
+
* @interface StreamDoneEvent
|
|
2735
|
+
*/
|
|
2736
|
+
interface StreamDoneEvent {
|
|
2737
|
+
/**
|
|
2738
|
+
*
|
|
2739
|
+
* @type {StreamDoneEventKindEnum}
|
|
2740
|
+
* @memberof StreamDoneEvent
|
|
2741
|
+
*/
|
|
2742
|
+
kind?: StreamDoneEventKindEnum;
|
|
2743
|
+
}
|
|
2744
|
+
/**
|
|
2745
|
+
* @export
|
|
2746
|
+
*/
|
|
2747
|
+
declare const StreamDoneEventKindEnum: {
|
|
2748
|
+
readonly StreamDone: "stream_done";
|
|
2749
|
+
};
|
|
2750
|
+
type StreamDoneEventKindEnum = typeof StreamDoneEventKindEnum[keyof typeof StreamDoneEventKindEnum];
|
|
2751
|
+
/**
|
|
2752
|
+
* Check if a given object implements the StreamDoneEvent interface.
|
|
2753
|
+
*/
|
|
2754
|
+
declare function instanceOfStreamDoneEvent(value: object): value is StreamDoneEvent;
|
|
2755
|
+
declare function StreamDoneEventFromJSON(json: any): StreamDoneEvent;
|
|
2756
|
+
declare function StreamDoneEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): StreamDoneEvent;
|
|
2757
|
+
declare function StreamDoneEventToJSON(json: any): StreamDoneEvent;
|
|
2758
|
+
declare function StreamDoneEventToJSONTyped(value?: StreamDoneEvent | null, ignoreDiscriminator?: boolean): any;
|
|
2759
|
+
|
|
2760
|
+
/**
|
|
2761
|
+
* Knowledge Search API
|
|
2762
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2763
|
+
*
|
|
2764
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2765
|
+
*
|
|
2766
|
+
*
|
|
2767
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2768
|
+
* https://openapi-generator.tech
|
|
2769
|
+
* Do not edit the class manually.
|
|
2770
|
+
*/
|
|
2771
|
+
/**
|
|
2772
|
+
*
|
|
2773
|
+
* @export
|
|
2774
|
+
* @interface StreamResetEvent
|
|
2775
|
+
*/
|
|
2776
|
+
interface StreamResetEvent {
|
|
2777
|
+
/**
|
|
2778
|
+
*
|
|
2779
|
+
* @type {StreamResetEventKindEnum}
|
|
2780
|
+
* @memberof StreamResetEvent
|
|
2781
|
+
*/
|
|
2782
|
+
kind?: StreamResetEventKindEnum;
|
|
2783
|
+
}
|
|
2784
|
+
/**
|
|
2785
|
+
* @export
|
|
2786
|
+
*/
|
|
2787
|
+
declare const StreamResetEventKindEnum: {
|
|
2788
|
+
readonly StreamReset: "stream_reset";
|
|
2789
|
+
};
|
|
2790
|
+
type StreamResetEventKindEnum = typeof StreamResetEventKindEnum[keyof typeof StreamResetEventKindEnum];
|
|
2791
|
+
/**
|
|
2792
|
+
* Check if a given object implements the StreamResetEvent interface.
|
|
2793
|
+
*/
|
|
2794
|
+
declare function instanceOfStreamResetEvent(value: object): value is StreamResetEvent;
|
|
2795
|
+
declare function StreamResetEventFromJSON(json: any): StreamResetEvent;
|
|
2796
|
+
declare function StreamResetEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): StreamResetEvent;
|
|
2797
|
+
declare function StreamResetEventToJSON(json: any): StreamResetEvent;
|
|
2798
|
+
declare function StreamResetEventToJSONTyped(value?: StreamResetEvent | null, ignoreDiscriminator?: boolean): any;
|
|
2799
|
+
|
|
2800
|
+
/**
|
|
2801
|
+
* Knowledge Search API
|
|
2802
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2803
|
+
*
|
|
2804
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2805
|
+
*
|
|
2806
|
+
*
|
|
2807
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2808
|
+
* https://openapi-generator.tech
|
|
2809
|
+
* Do not edit the class manually.
|
|
2810
|
+
*/
|
|
2811
|
+
/**
|
|
2812
|
+
*
|
|
2813
|
+
* @export
|
|
2814
|
+
* @interface SubagentEvent
|
|
2815
|
+
*/
|
|
2816
|
+
interface SubagentEvent {
|
|
2817
|
+
/**
|
|
2818
|
+
*
|
|
2819
|
+
* @type {SubagentEventKindEnum}
|
|
2820
|
+
* @memberof SubagentEvent
|
|
2821
|
+
*/
|
|
2822
|
+
kind?: SubagentEventKindEnum;
|
|
2823
|
+
/**
|
|
2824
|
+
*
|
|
2825
|
+
* @type {string}
|
|
2826
|
+
* @memberof SubagentEvent
|
|
2827
|
+
*/
|
|
2828
|
+
agent_id: string;
|
|
2829
|
+
/**
|
|
2830
|
+
*
|
|
2831
|
+
* @type {string}
|
|
2832
|
+
* @memberof SubagentEvent
|
|
2833
|
+
*/
|
|
2834
|
+
subagent_type: string;
|
|
2835
|
+
/**
|
|
2836
|
+
*
|
|
2837
|
+
* @type {string}
|
|
2838
|
+
* @memberof SubagentEvent
|
|
2839
|
+
*/
|
|
2840
|
+
parent_id?: string | null;
|
|
2841
|
+
/**
|
|
2842
|
+
*
|
|
2843
|
+
* @type {SubagentEventEventEnum}
|
|
2844
|
+
* @memberof SubagentEvent
|
|
2845
|
+
*/
|
|
2846
|
+
event: SubagentEventEventEnum;
|
|
2847
|
+
}
|
|
2848
|
+
/**
|
|
2849
|
+
* @export
|
|
2850
|
+
*/
|
|
2851
|
+
declare const SubagentEventKindEnum: {
|
|
2852
|
+
readonly Subagent: "subagent";
|
|
2853
|
+
};
|
|
2854
|
+
type SubagentEventKindEnum = typeof SubagentEventKindEnum[keyof typeof SubagentEventKindEnum];
|
|
2855
|
+
/**
|
|
2856
|
+
* @export
|
|
2857
|
+
*/
|
|
2858
|
+
declare const SubagentEventEventEnum: {
|
|
2859
|
+
readonly Dispatch: "dispatch";
|
|
2860
|
+
readonly Complete: "complete";
|
|
2861
|
+
};
|
|
2862
|
+
type SubagentEventEventEnum = typeof SubagentEventEventEnum[keyof typeof SubagentEventEventEnum];
|
|
2863
|
+
/**
|
|
2864
|
+
* Check if a given object implements the SubagentEvent interface.
|
|
2865
|
+
*/
|
|
2866
|
+
declare function instanceOfSubagentEvent(value: object): value is SubagentEvent;
|
|
2867
|
+
declare function SubagentEventFromJSON(json: any): SubagentEvent;
|
|
2868
|
+
declare function SubagentEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubagentEvent;
|
|
2869
|
+
declare function SubagentEventToJSON(json: any): SubagentEvent;
|
|
2870
|
+
declare function SubagentEventToJSONTyped(value?: SubagentEvent | null, ignoreDiscriminator?: boolean): any;
|
|
2871
|
+
|
|
2872
|
+
/**
|
|
2873
|
+
* Knowledge Search API
|
|
2874
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2875
|
+
*
|
|
2876
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2877
|
+
*
|
|
2878
|
+
*
|
|
2879
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2880
|
+
* https://openapi-generator.tech
|
|
2881
|
+
* Do not edit the class manually.
|
|
2882
|
+
*/
|
|
2883
|
+
/**
|
|
2884
|
+
*
|
|
2885
|
+
* @export
|
|
2886
|
+
* @interface TextEvent
|
|
2887
|
+
*/
|
|
2888
|
+
interface TextEvent {
|
|
2889
|
+
/**
|
|
2890
|
+
*
|
|
2891
|
+
* @type {TextEventKindEnum}
|
|
2892
|
+
* @memberof TextEvent
|
|
2893
|
+
*/
|
|
2894
|
+
kind?: TextEventKindEnum;
|
|
2895
|
+
/**
|
|
2896
|
+
*
|
|
2897
|
+
* @type {string}
|
|
2898
|
+
* @memberof TextEvent
|
|
2899
|
+
*/
|
|
2900
|
+
id: string;
|
|
2901
|
+
/**
|
|
2902
|
+
*
|
|
2903
|
+
* @type {string}
|
|
2904
|
+
* @memberof TextEvent
|
|
2905
|
+
*/
|
|
2906
|
+
delta: string;
|
|
2907
|
+
/**
|
|
2908
|
+
*
|
|
2909
|
+
* @type {boolean}
|
|
2910
|
+
* @memberof TextEvent
|
|
2911
|
+
*/
|
|
2912
|
+
done?: boolean;
|
|
2913
|
+
}
|
|
2914
|
+
/**
|
|
2915
|
+
* @export
|
|
2916
|
+
*/
|
|
2917
|
+
declare const TextEventKindEnum: {
|
|
2918
|
+
readonly Text: "text";
|
|
2919
|
+
};
|
|
2920
|
+
type TextEventKindEnum = typeof TextEventKindEnum[keyof typeof TextEventKindEnum];
|
|
2921
|
+
/**
|
|
2922
|
+
* Check if a given object implements the TextEvent interface.
|
|
2923
|
+
*/
|
|
2924
|
+
declare function instanceOfTextEvent(value: object): value is TextEvent;
|
|
2925
|
+
declare function TextEventFromJSON(json: any): TextEvent;
|
|
2926
|
+
declare function TextEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): TextEvent;
|
|
2927
|
+
declare function TextEventToJSON(json: any): TextEvent;
|
|
2928
|
+
declare function TextEventToJSONTyped(value?: TextEvent | null, ignoreDiscriminator?: boolean): any;
|
|
2929
|
+
|
|
2930
|
+
/**
|
|
2931
|
+
* Knowledge Search API
|
|
2932
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
2933
|
+
*
|
|
2934
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2935
|
+
*
|
|
2936
|
+
*
|
|
2937
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2938
|
+
* https://openapi-generator.tech
|
|
2939
|
+
* Do not edit the class manually.
|
|
2940
|
+
*/
|
|
2941
|
+
/**
|
|
2942
|
+
*
|
|
2943
|
+
* @export
|
|
2944
|
+
* @interface ToolCallEvent
|
|
2945
|
+
*/
|
|
2946
|
+
interface ToolCallEvent {
|
|
2947
|
+
/**
|
|
2948
|
+
*
|
|
2949
|
+
* @type {ToolCallEventKindEnum}
|
|
2950
|
+
* @memberof ToolCallEvent
|
|
2951
|
+
*/
|
|
2952
|
+
kind?: ToolCallEventKindEnum;
|
|
2953
|
+
/**
|
|
2954
|
+
*
|
|
2955
|
+
* @type {string}
|
|
2956
|
+
* @memberof ToolCallEvent
|
|
2957
|
+
*/
|
|
2958
|
+
id: string;
|
|
2959
|
+
/**
|
|
2960
|
+
*
|
|
2961
|
+
* @type {string}
|
|
2962
|
+
* @memberof ToolCallEvent
|
|
2963
|
+
*/
|
|
2964
|
+
tool: string;
|
|
2965
|
+
/**
|
|
2966
|
+
*
|
|
2967
|
+
* @type {string}
|
|
2968
|
+
* @memberof ToolCallEvent
|
|
2969
|
+
*/
|
|
2970
|
+
status_message?: string | null;
|
|
2971
|
+
/**
|
|
2972
|
+
*
|
|
2973
|
+
* @type {string}
|
|
2974
|
+
* @memberof ToolCallEvent
|
|
2975
|
+
*/
|
|
2976
|
+
parent_id?: string | null;
|
|
2977
|
+
/**
|
|
2978
|
+
*
|
|
2979
|
+
* @type {boolean}
|
|
2980
|
+
* @memberof ToolCallEvent
|
|
2981
|
+
*/
|
|
2982
|
+
done?: boolean;
|
|
2983
|
+
}
|
|
2984
|
+
/**
|
|
2985
|
+
* @export
|
|
2986
|
+
*/
|
|
2987
|
+
declare const ToolCallEventKindEnum: {
|
|
2988
|
+
readonly ToolCall: "tool_call";
|
|
2989
|
+
};
|
|
2990
|
+
type ToolCallEventKindEnum = typeof ToolCallEventKindEnum[keyof typeof ToolCallEventKindEnum];
|
|
2991
|
+
/**
|
|
2992
|
+
* Check if a given object implements the ToolCallEvent interface.
|
|
2993
|
+
*/
|
|
2994
|
+
declare function instanceOfToolCallEvent(value: object): value is ToolCallEvent;
|
|
2995
|
+
declare function ToolCallEventFromJSON(json: any): ToolCallEvent;
|
|
2996
|
+
declare function ToolCallEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): ToolCallEvent;
|
|
2997
|
+
declare function ToolCallEventToJSON(json: any): ToolCallEvent;
|
|
2998
|
+
declare function ToolCallEventToJSONTyped(value?: ToolCallEvent | null, ignoreDiscriminator?: boolean): any;
|
|
2999
|
+
|
|
3000
|
+
/**
|
|
3001
|
+
* Knowledge Search API
|
|
3002
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3003
|
+
*
|
|
3004
|
+
* The version of the OpenAPI document: 1.0.0
|
|
3005
|
+
*
|
|
3006
|
+
*
|
|
3007
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3008
|
+
* https://openapi-generator.tech
|
|
3009
|
+
* Do not edit the class manually.
|
|
3010
|
+
*/
|
|
3011
|
+
/**
|
|
3012
|
+
*
|
|
3013
|
+
* @export
|
|
3014
|
+
* @interface ToolErrorEvent
|
|
3015
|
+
*/
|
|
3016
|
+
interface ToolErrorEvent {
|
|
3017
|
+
/**
|
|
3018
|
+
*
|
|
3019
|
+
* @type {ToolErrorEventKindEnum}
|
|
3020
|
+
* @memberof ToolErrorEvent
|
|
3021
|
+
*/
|
|
3022
|
+
kind?: ToolErrorEventKindEnum;
|
|
3023
|
+
/**
|
|
3024
|
+
*
|
|
3025
|
+
* @type {string}
|
|
3026
|
+
* @memberof ToolErrorEvent
|
|
3027
|
+
*/
|
|
3028
|
+
id: string;
|
|
3029
|
+
/**
|
|
3030
|
+
*
|
|
3031
|
+
* @type {string}
|
|
3032
|
+
* @memberof ToolErrorEvent
|
|
3033
|
+
*/
|
|
3034
|
+
tool: string;
|
|
3035
|
+
/**
|
|
3036
|
+
*
|
|
3037
|
+
* @type {string}
|
|
3038
|
+
* @memberof ToolErrorEvent
|
|
3039
|
+
*/
|
|
3040
|
+
error: string;
|
|
3041
|
+
/**
|
|
3042
|
+
*
|
|
3043
|
+
* @type {string}
|
|
3044
|
+
* @memberof ToolErrorEvent
|
|
3045
|
+
*/
|
|
3046
|
+
parent_id?: string | null;
|
|
3047
|
+
}
|
|
3048
|
+
/**
|
|
3049
|
+
* @export
|
|
3050
|
+
*/
|
|
3051
|
+
declare const ToolErrorEventKindEnum: {
|
|
3052
|
+
readonly ToolError: "tool_error";
|
|
3053
|
+
};
|
|
3054
|
+
type ToolErrorEventKindEnum = typeof ToolErrorEventKindEnum[keyof typeof ToolErrorEventKindEnum];
|
|
3055
|
+
/**
|
|
3056
|
+
* Check if a given object implements the ToolErrorEvent interface.
|
|
3057
|
+
*/
|
|
3058
|
+
declare function instanceOfToolErrorEvent(value: object): value is ToolErrorEvent;
|
|
3059
|
+
declare function ToolErrorEventFromJSON(json: any): ToolErrorEvent;
|
|
3060
|
+
declare function ToolErrorEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): ToolErrorEvent;
|
|
3061
|
+
declare function ToolErrorEventToJSON(json: any): ToolErrorEvent;
|
|
3062
|
+
declare function ToolErrorEventToJSONTyped(value?: ToolErrorEvent | null, ignoreDiscriminator?: boolean): any;
|
|
3063
|
+
|
|
3064
|
+
/**
|
|
3065
|
+
* Knowledge Search API
|
|
3066
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3067
|
+
*
|
|
3068
|
+
* The version of the OpenAPI document: 1.0.0
|
|
3069
|
+
*
|
|
3070
|
+
*
|
|
3071
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3072
|
+
* https://openapi-generator.tech
|
|
3073
|
+
* Do not edit the class manually.
|
|
3074
|
+
*/
|
|
3075
|
+
/**
|
|
3076
|
+
*
|
|
3077
|
+
* @export
|
|
3078
|
+
* @interface ToolResultEvent
|
|
3079
|
+
*/
|
|
3080
|
+
interface ToolResultEvent {
|
|
3081
|
+
/**
|
|
3082
|
+
*
|
|
3083
|
+
* @type {ToolResultEventKindEnum}
|
|
3084
|
+
* @memberof ToolResultEvent
|
|
3085
|
+
*/
|
|
3086
|
+
kind?: ToolResultEventKindEnum;
|
|
3087
|
+
/**
|
|
3088
|
+
*
|
|
3089
|
+
* @type {string}
|
|
3090
|
+
* @memberof ToolResultEvent
|
|
3091
|
+
*/
|
|
3092
|
+
id: string;
|
|
3093
|
+
/**
|
|
3094
|
+
*
|
|
3095
|
+
* @type {string}
|
|
3096
|
+
* @memberof ToolResultEvent
|
|
3097
|
+
*/
|
|
3098
|
+
tool: string;
|
|
3099
|
+
/**
|
|
3100
|
+
*
|
|
3101
|
+
* @type {number}
|
|
3102
|
+
* @memberof ToolResultEvent
|
|
3103
|
+
*/
|
|
3104
|
+
elapsed_ms?: number;
|
|
3105
|
+
/**
|
|
3106
|
+
*
|
|
3107
|
+
* @type {string}
|
|
3108
|
+
* @memberof ToolResultEvent
|
|
3109
|
+
*/
|
|
3110
|
+
link?: string | null;
|
|
3111
|
+
/**
|
|
3112
|
+
*
|
|
3113
|
+
* @type {string}
|
|
3114
|
+
* @memberof ToolResultEvent
|
|
3115
|
+
*/
|
|
3116
|
+
parent_id?: string | null;
|
|
3117
|
+
}
|
|
3118
|
+
/**
|
|
3119
|
+
* @export
|
|
3120
|
+
*/
|
|
3121
|
+
declare const ToolResultEventKindEnum: {
|
|
3122
|
+
readonly ToolResult: "tool_result";
|
|
3123
|
+
};
|
|
3124
|
+
type ToolResultEventKindEnum = typeof ToolResultEventKindEnum[keyof typeof ToolResultEventKindEnum];
|
|
3125
|
+
/**
|
|
3126
|
+
* Check if a given object implements the ToolResultEvent interface.
|
|
3127
|
+
*/
|
|
3128
|
+
declare function instanceOfToolResultEvent(value: object): value is ToolResultEvent;
|
|
3129
|
+
declare function ToolResultEventFromJSON(json: any): ToolResultEvent;
|
|
3130
|
+
declare function ToolResultEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): ToolResultEvent;
|
|
3131
|
+
declare function ToolResultEventToJSON(json: any): ToolResultEvent;
|
|
3132
|
+
declare function ToolResultEventToJSONTyped(value?: ToolResultEvent | null, ignoreDiscriminator?: boolean): any;
|
|
3133
|
+
|
|
3134
|
+
/**
|
|
3135
|
+
* Knowledge Search API
|
|
3136
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3137
|
+
*
|
|
3138
|
+
* The version of the OpenAPI document: 1.0.0
|
|
3139
|
+
*
|
|
3140
|
+
*
|
|
3141
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3142
|
+
* https://openapi-generator.tech
|
|
3143
|
+
* Do not edit the class manually.
|
|
3144
|
+
*/
|
|
3145
|
+
/**
|
|
3146
|
+
*
|
|
3147
|
+
* @export
|
|
3148
|
+
* @interface ToolRetryEvent
|
|
3149
|
+
*/
|
|
3150
|
+
interface ToolRetryEvent {
|
|
3151
|
+
/**
|
|
3152
|
+
*
|
|
3153
|
+
* @type {ToolRetryEventKindEnum}
|
|
3154
|
+
* @memberof ToolRetryEvent
|
|
3155
|
+
*/
|
|
3156
|
+
kind?: ToolRetryEventKindEnum;
|
|
3157
|
+
/**
|
|
3158
|
+
*
|
|
3159
|
+
* @type {string}
|
|
3160
|
+
* @memberof ToolRetryEvent
|
|
3161
|
+
*/
|
|
3162
|
+
id: string;
|
|
3163
|
+
/**
|
|
3164
|
+
*
|
|
3165
|
+
* @type {string}
|
|
3166
|
+
* @memberof ToolRetryEvent
|
|
3167
|
+
*/
|
|
3168
|
+
tool: string;
|
|
3169
|
+
/**
|
|
3170
|
+
*
|
|
3171
|
+
* @type {string}
|
|
3172
|
+
* @memberof ToolRetryEvent
|
|
3173
|
+
*/
|
|
3174
|
+
error: string;
|
|
3175
|
+
/**
|
|
3176
|
+
*
|
|
3177
|
+
* @type {number}
|
|
3178
|
+
* @memberof ToolRetryEvent
|
|
3179
|
+
*/
|
|
3180
|
+
elapsed_ms?: number;
|
|
3181
|
+
/**
|
|
3182
|
+
*
|
|
3183
|
+
* @type {string}
|
|
3184
|
+
* @memberof ToolRetryEvent
|
|
3185
|
+
*/
|
|
3186
|
+
parent_id?: string | null;
|
|
3187
|
+
}
|
|
3188
|
+
/**
|
|
3189
|
+
* @export
|
|
3190
|
+
*/
|
|
3191
|
+
declare const ToolRetryEventKindEnum: {
|
|
3192
|
+
readonly ToolRetry: "tool_retry";
|
|
3193
|
+
};
|
|
3194
|
+
type ToolRetryEventKindEnum = typeof ToolRetryEventKindEnum[keyof typeof ToolRetryEventKindEnum];
|
|
3195
|
+
/**
|
|
3196
|
+
* Check if a given object implements the ToolRetryEvent interface.
|
|
3197
|
+
*/
|
|
3198
|
+
declare function instanceOfToolRetryEvent(value: object): value is ToolRetryEvent;
|
|
3199
|
+
declare function ToolRetryEventFromJSON(json: any): ToolRetryEvent;
|
|
3200
|
+
declare function ToolRetryEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): ToolRetryEvent;
|
|
3201
|
+
declare function ToolRetryEventToJSON(json: any): ToolRetryEvent;
|
|
3202
|
+
declare function ToolRetryEventToJSONTyped(value?: ToolRetryEvent | null, ignoreDiscriminator?: boolean): any;
|
|
3203
|
+
|
|
3204
|
+
/**
|
|
3205
|
+
* Knowledge Search API
|
|
3206
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3207
|
+
*
|
|
3208
|
+
* The version of the OpenAPI document: 1.0.0
|
|
3209
|
+
*
|
|
3210
|
+
*
|
|
3211
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3212
|
+
* https://openapi-generator.tech
|
|
3213
|
+
* Do not edit the class manually.
|
|
3214
|
+
*/
|
|
3215
|
+
|
|
3216
|
+
/**
|
|
3217
|
+
* @type Block
|
|
3218
|
+
*
|
|
3219
|
+
* @export
|
|
3220
|
+
*/
|
|
3221
|
+
type Block = {
|
|
3222
|
+
kind: 'agent_result';
|
|
3223
|
+
} & AgentResultEvent | {
|
|
3224
|
+
kind: 'data_pipeline_answer';
|
|
3225
|
+
} & DataPipelineAnswerEvent | {
|
|
3226
|
+
kind: 'heartbeat';
|
|
3227
|
+
} & HeartbeatEvent | {
|
|
3228
|
+
kind: 'reasoning';
|
|
3229
|
+
} & ReasoningEvent | {
|
|
3230
|
+
kind: 'status';
|
|
3231
|
+
} & StatusEvent | {
|
|
3232
|
+
kind: 'stream_done';
|
|
3233
|
+
} & StreamDoneEvent | {
|
|
3234
|
+
kind: 'stream_reset';
|
|
3235
|
+
} & StreamResetEvent | {
|
|
3236
|
+
kind: 'subagent';
|
|
3237
|
+
} & SubagentEvent | {
|
|
3238
|
+
kind: 'text';
|
|
3239
|
+
} & TextEvent | {
|
|
3240
|
+
kind: 'tool_call';
|
|
3241
|
+
} & ToolCallEvent | {
|
|
3242
|
+
kind: 'tool_error';
|
|
3243
|
+
} & ToolErrorEvent | {
|
|
3244
|
+
kind: 'tool_result';
|
|
3245
|
+
} & ToolResultEvent | {
|
|
3246
|
+
kind: 'tool_retry';
|
|
3247
|
+
} & ToolRetryEvent;
|
|
3248
|
+
declare function BlockFromJSON(json: any): Block;
|
|
3249
|
+
declare function BlockFromJSONTyped(json: any, ignoreDiscriminator: boolean): Block;
|
|
3250
|
+
declare function BlockToJSON(json: any): any;
|
|
3251
|
+
declare function BlockToJSONTyped(value?: Block | null, ignoreDiscriminator?: boolean): any;
|
|
3252
|
+
|
|
3253
|
+
/**
|
|
3254
|
+
* Knowledge Search API
|
|
3255
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3256
|
+
*
|
|
3257
|
+
* The version of the OpenAPI document: 1.0.0
|
|
3258
|
+
*
|
|
3259
|
+
*
|
|
3260
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3261
|
+
* https://openapi-generator.tech
|
|
3262
|
+
* Do not edit the class manually.
|
|
3263
|
+
*/
|
|
3264
|
+
/**
|
|
3265
|
+
*
|
|
3266
|
+
* @export
|
|
3267
|
+
*/
|
|
3268
|
+
declare const StreamCategory: {
|
|
3269
|
+
readonly Content: "content";
|
|
3270
|
+
readonly Activity: "activity";
|
|
3271
|
+
readonly Control: "control";
|
|
3272
|
+
};
|
|
3273
|
+
type StreamCategory = typeof StreamCategory[keyof typeof StreamCategory];
|
|
3274
|
+
declare function instanceOfStreamCategory(value: any): boolean;
|
|
3275
|
+
declare function StreamCategoryFromJSON(json: any): StreamCategory;
|
|
3276
|
+
declare function StreamCategoryFromJSONTyped(json: any, ignoreDiscriminator: boolean): StreamCategory;
|
|
3277
|
+
declare function StreamCategoryToJSON(value?: StreamCategory | null): any;
|
|
3278
|
+
declare function StreamCategoryToJSONTyped(value: any, ignoreDiscriminator: boolean): StreamCategory;
|
|
3279
|
+
|
|
3280
|
+
/**
|
|
3281
|
+
* Knowledge Search API
|
|
3282
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3283
|
+
*
|
|
3284
|
+
* The version of the OpenAPI document: 1.0.0
|
|
3285
|
+
*
|
|
3286
|
+
*
|
|
3287
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3288
|
+
* https://openapi-generator.tech
|
|
3289
|
+
* Do not edit the class manually.
|
|
3290
|
+
*/
|
|
3291
|
+
|
|
3292
|
+
/**
|
|
3293
|
+
* Public SSE envelope for the Agent run stream. `run_id` is the run/task id
|
|
3294
|
+
* (renamed from the native envelope's `task_id` for resource consistency).
|
|
3295
|
+
*
|
|
3296
|
+
* `seq` is monotonically increasing but NOT contiguous: the public stream omits
|
|
3297
|
+
* internal block kinds, so gaps in `seq` are expected and do not indicate lost
|
|
3298
|
+
* events. Use `seq` only as the resume cursor (`starting_after` / `Last-Event-ID`),
|
|
3299
|
+
* not as a completeness check.
|
|
3300
|
+
* @export
|
|
3301
|
+
* @interface AgentStreamEnvelope
|
|
3302
|
+
*/
|
|
3303
|
+
interface AgentStreamEnvelope {
|
|
3304
|
+
/**
|
|
3305
|
+
* Monotonic event sequence number; use as the resume cursor. Values are NOT contiguous — the public stream filters internal block kinds, so gaps are expected and do not mean events were lost.
|
|
3306
|
+
* @type {number}
|
|
3307
|
+
* @memberof AgentStreamEnvelope
|
|
3308
|
+
*/
|
|
3309
|
+
seq: number;
|
|
3310
|
+
/**
|
|
3311
|
+
*
|
|
3312
|
+
* @type {string}
|
|
3313
|
+
* @memberof AgentStreamEnvelope
|
|
3314
|
+
*/
|
|
3315
|
+
run_id: string;
|
|
3316
|
+
/**
|
|
3317
|
+
*
|
|
3318
|
+
* @type {string}
|
|
3319
|
+
* @memberof AgentStreamEnvelope
|
|
3320
|
+
*/
|
|
3321
|
+
thread_id?: string | null;
|
|
3322
|
+
/**
|
|
3323
|
+
*
|
|
3324
|
+
* @type {StreamCategory}
|
|
3325
|
+
* @memberof AgentStreamEnvelope
|
|
3326
|
+
*/
|
|
3327
|
+
category: StreamCategory;
|
|
3328
|
+
/**
|
|
3329
|
+
*
|
|
3330
|
+
* @type {Block}
|
|
3331
|
+
* @memberof AgentStreamEnvelope
|
|
3332
|
+
*/
|
|
3333
|
+
block: Block;
|
|
3334
|
+
}
|
|
3335
|
+
/**
|
|
3336
|
+
* Check if a given object implements the AgentStreamEnvelope interface.
|
|
3337
|
+
*/
|
|
3338
|
+
declare function instanceOfAgentStreamEnvelope(value: object): value is AgentStreamEnvelope;
|
|
3339
|
+
declare function AgentStreamEnvelopeFromJSON(json: any): AgentStreamEnvelope;
|
|
3340
|
+
declare function AgentStreamEnvelopeFromJSONTyped(json: any, ignoreDiscriminator: boolean): AgentStreamEnvelope;
|
|
3341
|
+
declare function AgentStreamEnvelopeToJSON(json: any): AgentStreamEnvelope;
|
|
3342
|
+
declare function AgentStreamEnvelopeToJSONTyped(value?: AgentStreamEnvelope | null, ignoreDiscriminator?: boolean): any;
|
|
3343
|
+
|
|
3344
|
+
/**
|
|
3345
|
+
* Knowledge Search API
|
|
3346
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3347
|
+
*
|
|
3348
|
+
* The version of the OpenAPI document: 1.0.0
|
|
3349
|
+
*
|
|
3350
|
+
*
|
|
3351
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3352
|
+
* https://openapi-generator.tech
|
|
3353
|
+
* Do not edit the class manually.
|
|
3354
|
+
*/
|
|
3355
|
+
|
|
3356
|
+
/**
|
|
3357
|
+
*
|
|
3358
|
+
* @export
|
|
3359
|
+
* @interface BaseAPIError
|
|
3360
|
+
*/
|
|
3361
|
+
interface BaseAPIError {
|
|
3362
|
+
/**
|
|
3363
|
+
*
|
|
3364
|
+
* @type {string}
|
|
3365
|
+
* @memberof BaseAPIError
|
|
3366
|
+
*/
|
|
3367
|
+
error_message: string;
|
|
3368
|
+
/**
|
|
3369
|
+
*
|
|
3370
|
+
* @type {APIErrorType}
|
|
3371
|
+
* @memberof BaseAPIError
|
|
3372
|
+
*/
|
|
3373
|
+
error_type: APIErrorType;
|
|
3374
|
+
}
|
|
3375
|
+
/**
|
|
3376
|
+
* Check if a given object implements the BaseAPIError interface.
|
|
3377
|
+
*/
|
|
3378
|
+
declare function instanceOfBaseAPIError(value: object): value is BaseAPIError;
|
|
3379
|
+
declare function BaseAPIErrorFromJSON(json: any): BaseAPIError;
|
|
3380
|
+
declare function BaseAPIErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): BaseAPIError;
|
|
3381
|
+
declare function BaseAPIErrorToJSON(json: any): BaseAPIError;
|
|
3382
|
+
declare function BaseAPIErrorToJSONTyped(value?: BaseAPIError | null, ignoreDiscriminator?: boolean): any;
|
|
3383
|
+
|
|
3384
|
+
/**
|
|
3385
|
+
* Knowledge Search API
|
|
3386
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3387
|
+
*
|
|
3388
|
+
* The version of the OpenAPI document: 1.0.0
|
|
3389
|
+
*
|
|
3390
|
+
*
|
|
3391
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3392
|
+
* https://openapi-generator.tech
|
|
3393
|
+
* Do not edit the class manually.
|
|
3394
|
+
*/
|
|
3395
|
+
|
|
3396
|
+
/**
|
|
3397
|
+
* A segment of a source index. Within a source index, a segment is a subset of the data.
|
|
3398
|
+
* For connected data, a segment is a subset of connected files. A segment may be used for
|
|
3399
|
+
* multi-tenant data e.g. using a segment per customer.
|
|
3400
|
+
* @export
|
|
3401
|
+
* @interface CardSourceIndexSegment
|
|
3402
|
+
*/
|
|
3403
|
+
interface CardSourceIndexSegment {
|
|
3404
|
+
/**
|
|
3405
|
+
*
|
|
3406
|
+
* @type {CardSourceIndex}
|
|
3407
|
+
* @memberof CardSourceIndexSegment
|
|
3408
|
+
*/
|
|
3409
|
+
index_type: CardSourceIndex;
|
|
3410
|
+
/**
|
|
3411
|
+
* An ID for a segment of a source index
|
|
3412
|
+
* @type {string}
|
|
3413
|
+
* @memberof CardSourceIndexSegment
|
|
3414
|
+
*/
|
|
3415
|
+
segment_id: string;
|
|
3416
|
+
}
|
|
3417
|
+
/**
|
|
3418
|
+
* Check if a given object implements the CardSourceIndexSegment interface.
|
|
3419
|
+
*/
|
|
3420
|
+
declare function instanceOfCardSourceIndexSegment(value: object): value is CardSourceIndexSegment;
|
|
3421
|
+
declare function CardSourceIndexSegmentFromJSON(json: any): CardSourceIndexSegment;
|
|
3422
|
+
declare function CardSourceIndexSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): CardSourceIndexSegment;
|
|
3423
|
+
declare function CardSourceIndexSegmentToJSON(json: any): CardSourceIndexSegment;
|
|
3424
|
+
declare function CardSourceIndexSegmentToJSONTyped(value?: CardSourceIndexSegment | null, ignoreDiscriminator?: boolean): any;
|
|
3425
|
+
|
|
3426
|
+
/**
|
|
3427
|
+
* Knowledge Search API
|
|
3428
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3429
|
+
*
|
|
3430
|
+
* The version of the OpenAPI document: 1.0.0
|
|
3431
|
+
*
|
|
3432
|
+
*
|
|
3433
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3434
|
+
* https://openapi-generator.tech
|
|
3435
|
+
* Do not edit the class manually.
|
|
3436
|
+
*/
|
|
3437
|
+
|
|
3438
|
+
/**
|
|
3439
|
+
*
|
|
3440
|
+
* @export
|
|
3441
|
+
* @interface CardSourcePrivateIndex
|
|
3442
|
+
*/
|
|
3443
|
+
interface CardSourcePrivateIndex {
|
|
3444
|
+
/**
|
|
3445
|
+
*
|
|
3446
|
+
* @type {CardSourceIndex}
|
|
3447
|
+
* @memberof CardSourcePrivateIndex
|
|
3448
|
+
*/
|
|
3449
|
+
index_type: CardSourceIndex;
|
|
3450
|
+
/**
|
|
3451
|
+
* An ID for a segment of a source index (optional for private indexes)
|
|
3452
|
+
* @type {string}
|
|
3453
|
+
* @memberof CardSourcePrivateIndex
|
|
3454
|
+
*/
|
|
3455
|
+
segment_id?: string | null;
|
|
3456
|
+
/**
|
|
3457
|
+
* An ID for a private index
|
|
3458
|
+
* @type {string}
|
|
3459
|
+
* @memberof CardSourcePrivateIndex
|
|
3460
|
+
*/
|
|
3461
|
+
private_index_id: string;
|
|
3462
|
+
}
|
|
3463
|
+
/**
|
|
3464
|
+
* Check if a given object implements the CardSourcePrivateIndex interface.
|
|
3465
|
+
*/
|
|
3466
|
+
declare function instanceOfCardSourcePrivateIndex(value: object): value is CardSourcePrivateIndex;
|
|
3467
|
+
declare function CardSourcePrivateIndexFromJSON(json: any): CardSourcePrivateIndex;
|
|
3468
|
+
declare function CardSourcePrivateIndexFromJSONTyped(json: any, ignoreDiscriminator: boolean): CardSourcePrivateIndex;
|
|
3469
|
+
declare function CardSourcePrivateIndexToJSON(json: any): CardSourcePrivateIndex;
|
|
3470
|
+
declare function CardSourcePrivateIndexToJSONTyped(value?: CardSourcePrivateIndex | null, ignoreDiscriminator?: boolean): any;
|
|
3471
|
+
|
|
3472
|
+
/**
|
|
3473
|
+
* Knowledge Search API
|
|
3474
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3475
|
+
*
|
|
3476
|
+
* The version of the OpenAPI document: 1.0.0
|
|
3477
|
+
*
|
|
3478
|
+
*
|
|
3479
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3480
|
+
* https://openapi-generator.tech
|
|
3481
|
+
* Do not edit the class manually.
|
|
3482
|
+
*/
|
|
3483
|
+
/**
|
|
3484
|
+
*
|
|
3485
|
+
* @export
|
|
3486
|
+
* @interface CreateCard400Response
|
|
3487
|
+
*/
|
|
3488
|
+
interface CreateCard400Response {
|
|
3489
|
+
/**
|
|
3490
|
+
* The unique ID of the knowledge card
|
|
3491
|
+
* @type {string}
|
|
3492
|
+
* @memberof CreateCard400Response
|
|
3493
|
+
*/
|
|
3494
|
+
error: string | null;
|
|
3495
|
+
}
|
|
3496
|
+
/**
|
|
3497
|
+
* Check if a given object implements the CreateCard400Response interface.
|
|
3498
|
+
*/
|
|
3499
|
+
declare function instanceOfCreateCard400Response(value: object): value is CreateCard400Response;
|
|
3500
|
+
declare function CreateCard400ResponseFromJSON(json: any): CreateCard400Response;
|
|
3501
|
+
declare function CreateCard400ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateCard400Response;
|
|
3502
|
+
declare function CreateCard400ResponseToJSON(json: any): CreateCard400Response;
|
|
3503
|
+
declare function CreateCard400ResponseToJSONTyped(value?: CreateCard400Response | null, ignoreDiscriminator?: boolean): any;
|
|
3504
|
+
|
|
3505
|
+
interface AgentStreamOptions {
|
|
3506
|
+
/** Max reconnect attempts after a transient drop. Default 5. */
|
|
3507
|
+
maxRetries?: number;
|
|
3508
|
+
/** Idle read timeout (ms) before a connection is treated as dropped. Default 120000. */
|
|
3509
|
+
readTimeoutMs?: number;
|
|
3510
|
+
}
|
|
3511
|
+
/**
|
|
3512
|
+
* Auto-reconnecting SSE stream over an agent run. Async-iterates AgentStreamEnvelope.
|
|
3513
|
+
*
|
|
3514
|
+
* const stream = tako.agent.stream({ query: "..." });
|
|
3515
|
+
* try {
|
|
3516
|
+
* for await (const event of stream) { ... }
|
|
3517
|
+
* } finally {
|
|
3518
|
+
* await stream.close();
|
|
3519
|
+
* }
|
|
3520
|
+
*/
|
|
3521
|
+
declare class AgentStream implements AsyncIterable<AgentStreamEnvelope> {
|
|
3522
|
+
run_id: string | null;
|
|
3523
|
+
last_seq: number;
|
|
3524
|
+
result: AgentResult | null;
|
|
3525
|
+
private readonly base;
|
|
3526
|
+
private readonly request;
|
|
3527
|
+
private readonly maxRetries;
|
|
3528
|
+
private readonly readTimeoutMs;
|
|
3529
|
+
private readonly apiKeyFn?;
|
|
3530
|
+
private controller;
|
|
3531
|
+
private reader;
|
|
3532
|
+
private buffer;
|
|
3533
|
+
private closed;
|
|
3534
|
+
private decoder;
|
|
3535
|
+
constructor(config: Configuration, request: AgentRunRequest, options?: AgentStreamOptions);
|
|
3536
|
+
private headers;
|
|
3537
|
+
private open;
|
|
3538
|
+
private dispatch;
|
|
3539
|
+
private reconnect;
|
|
3540
|
+
private closeConnection;
|
|
3541
|
+
/** Read one chunk, racing an idle-timeout abort. Returns null at end of stream. */
|
|
3542
|
+
private readChunk;
|
|
3543
|
+
/** Pull the next complete SSE frame's data payload from the buffer, or null if none yet. */
|
|
3544
|
+
private nextFrameData;
|
|
3545
|
+
[Symbol.asyncIterator](): AsyncIterator<AgentStreamEnvelope>;
|
|
3546
|
+
/** Close the underlying connection. Always call this (or use try/finally). */
|
|
3547
|
+
close(): Promise<void>;
|
|
3548
|
+
}
|
|
3549
|
+
|
|
3550
|
+
/** Agent run operations: dispatch, poll, and live-stream. */
|
|
3551
|
+
declare class AgentResource {
|
|
3552
|
+
private readonly config;
|
|
3553
|
+
private readonly api;
|
|
3554
|
+
constructor(config: Configuration);
|
|
3555
|
+
/** Dispatch a new agent run (202). Returns the AgentRun handle. */
|
|
3556
|
+
run(request: AgentRunRequest): Promise<AgentRun>;
|
|
3557
|
+
/** Poll a run's status. `startingAfter` replays events after that seq (JSON mode). */
|
|
3558
|
+
get(runId: string, startingAfter?: number): Promise<AgentRun>;
|
|
3559
|
+
/** Open a live SSE stream over a new agent run. */
|
|
3560
|
+
stream(request: AgentRunRequest, options?: AgentStreamOptions): AgentStream;
|
|
3561
|
+
}
|
|
3562
|
+
|
|
3563
|
+
interface TakoOptions {
|
|
3564
|
+
/** Tako API key (sent as the X-API-Key header). */
|
|
3565
|
+
apiKey: string;
|
|
3566
|
+
/** API base path. Defaults to https://tako.com/api. */
|
|
3567
|
+
basePath?: string;
|
|
3568
|
+
}
|
|
3569
|
+
/** Ergonomic Tako client. Build once, then call operations directly. */
|
|
3570
|
+
declare class Tako {
|
|
3571
|
+
readonly config: Configuration;
|
|
3572
|
+
readonly agent: AgentResource;
|
|
3573
|
+
private readonly api;
|
|
3574
|
+
constructor(options: TakoOptions);
|
|
3575
|
+
search(request: SearchRequest): Promise<SearchResponse>;
|
|
3576
|
+
answer(request: SearchRequest): Promise<AnswerResponse>;
|
|
3577
|
+
contents(request: ContentsRequest): Promise<ContentsResponse>;
|
|
3578
|
+
createCard(request: CreateCardRequest): Promise<KnowledgeCard>;
|
|
3579
|
+
}
|
|
208
3580
|
|
|
209
|
-
export { KnowledgeCard, KnowledgeSearchInput, KnowledgeSearchRequest, KnowledgeSearchResponse, Methodology, Source, SourceIndex, TakoConfig, TakoError, TakoException, TakoRateLimitException, TakoUnauthorizedException, createTakoClient };
|
|
3581
|
+
export { APIErrorType, APIErrorTypeFromJSON, APIErrorTypeFromJSONTyped, APIErrorTypeToJSON, APIErrorTypeToJSONTyped, AgentApi, type AgentApiInterface, AgentEffortLevel, AgentEffortLevelFromJSON, AgentEffortLevelFromJSONTyped, AgentEffortLevelToJSON, AgentEffortLevelToJSONTyped, type AgentOutputSettings, AgentOutputSettingsFromJSON, AgentOutputSettingsFromJSONTyped, AgentOutputSettingsToJSON, AgentOutputSettingsToJSONTyped, AgentResource, type AgentResult, type AgentResultEvent, AgentResultEventFromJSON, AgentResultEventFromJSONTyped, AgentResultEventKindEnum, AgentResultEventToJSON, AgentResultEventToJSONTyped, AgentResultFromJSON, AgentResultFromJSONTyped, AgentResultToJSON, AgentResultToJSONTyped, type AgentRun, AgentRunFromJSON, AgentRunFromJSONTyped, AgentRunObjectEnum, type AgentRunRequest, AgentRunRequestFromJSON, AgentRunRequestFromJSONTyped, AgentRunRequestSourceIndexesEnum, AgentRunRequestToJSON, AgentRunRequestToJSONTyped, AgentRunStatus, AgentRunStatusFromJSON, AgentRunStatusFromJSONTyped, AgentRunStatusToJSON, AgentRunStatusToJSONTyped, AgentRunToJSON, AgentRunToJSONTyped, AgentStream, type AgentStreamEnvelope, AgentStreamEnvelopeFromJSON, AgentStreamEnvelopeFromJSONTyped, AgentStreamEnvelopeToJSON, AgentStreamEnvelopeToJSONTyped, type AgentStreamOptions, type AnswerRequest, type AnswerResponse, AnswerResponseFromJSON, AnswerResponseFromJSONTyped, AnswerResponseToJSON, AnswerResponseToJSONTyped, type ApiResponse, BASE_PATH, BaseAPI, type BaseAPIError, BaseAPIErrorFromJSON, BaseAPIErrorFromJSONTyped, BaseAPIErrorToJSON, BaseAPIErrorToJSONTyped, BlobApiResponse, type Block, BlockFromJSON, BlockFromJSONTyped, BlockToJSON, BlockToJSONTyped, COLLECTION_FORMATS, CardSourceIndex, CardSourceIndexFromJSON, CardSourceIndexFromJSONTyped, type CardSourceIndexSegment, CardSourceIndexSegmentFromJSON, CardSourceIndexSegmentFromJSONTyped, CardSourceIndexSegmentToJSON, CardSourceIndexSegmentToJSONTyped, CardSourceIndexToJSON, CardSourceIndexToJSONTyped, type CardSourcePrivateIndex, CardSourcePrivateIndexFromJSON, CardSourcePrivateIndexFromJSONTyped, CardSourcePrivateIndexToJSON, CardSourcePrivateIndexToJSONTyped, type ClassifyOperationRequest, type ClassifyRequest, ClassifyRequestFromJSON, ClassifyRequestFromJSONTyped, ClassifyRequestToJSON, ClassifyRequestToJSONTyped, type ClassifyResponse, ClassifyResponseFromJSON, ClassifyResponseFromJSONTyped, ClassifyResponseToJSON, ClassifyResponseToJSONTyped, type ComponentConfig, ComponentConfigFromJSON, ComponentConfigFromJSONTyped, ComponentConfigToJSON, ComponentConfigToJSONTyped, ComponentTypeEnum, ComponentTypeEnumFromJSON, ComponentTypeEnumFromJSONTyped, ComponentTypeEnumToJSON, ComponentTypeEnumToJSONTyped, Configuration, type ConfigurationParameters, type Consume, ContentFormat, ContentFormatFromJSON, ContentFormatFromJSONTyped, ContentFormatToJSON, ContentFormatToJSONTyped, type ContentItem, ContentItemFromJSON, ContentItemFromJSONTyped, ContentItemToJSON, ContentItemToJSONTyped, ContentsDeliveryMode, ContentsDeliveryModeFromJSON, ContentsDeliveryModeFromJSONTyped, ContentsDeliveryModeToJSON, ContentsDeliveryModeToJSONTyped, type ContentsOperationRequest, type ContentsRequest, ContentsRequestFromJSON, ContentsRequestFromJSONTyped, ContentsRequestToJSON, ContentsRequestToJSONTyped, type ContentsResponse, ContentsResponseFromJSON, ContentsResponseFromJSONTyped, ContentsResponseToJSON, ContentsResponseToJSONTyped, type CreateAgentRunRequest, type CreateCard400Response, CreateCard400ResponseFromJSON, CreateCard400ResponseFromJSONTyped, CreateCard400ResponseToJSON, CreateCard400ResponseToJSONTyped, type CreateCardOperationRequest, type CreateCardRequest, CreateCardRequestFromJSON, CreateCardRequestFromJSONTyped, CreateCardRequestToJSON, CreateCardRequestToJSONTyped, type DataPipelineAnswerEvent, DataPipelineAnswerEventFromJSON, DataPipelineAnswerEventFromJSONTyped, DataPipelineAnswerEventKindEnum, DataPipelineAnswerEventToJSON, DataPipelineAnswerEventToJSONTyped, DefaultConfig, type ErrorContext, type ErrorObject, ErrorObjectFromJSON, ErrorObjectFromJSONTyped, ErrorObjectToJSON, ErrorObjectToJSONTyped, type FetchAPI, FetchError, type FetchParams, type GetAgentRunRequest, type HTTPBody, type HTTPHeaders, type HTTPMethod, type HTTPQuery, type HTTPRequestInit, type HeartbeatEvent, HeartbeatEventFromJSON, HeartbeatEventFromJSONTyped, HeartbeatEventKindEnum, HeartbeatEventToJSON, HeartbeatEventToJSONTyped, type IdealVizDecision, IdealVizDecisionFromJSON, IdealVizDecisionFromJSONTyped, IdealVizDecisionToJSON, IdealVizDecisionToJSONTyped, type InitOverrideFunction, JSONApiResponse, type Json, type KnowledgeCard, KnowledgeCardFromJSON, KnowledgeCardFromJSONTyped, type KnowledgeCardMethodology, KnowledgeCardMethodologyFromJSON, KnowledgeCardMethodologyFromJSONTyped, KnowledgeCardMethodologyToJSON, KnowledgeCardMethodologyToJSONTyped, KnowledgeCardRelevance, KnowledgeCardRelevanceFromJSON, KnowledgeCardRelevanceFromJSONTyped, KnowledgeCardRelevanceToJSON, KnowledgeCardRelevanceToJSONTyped, type KnowledgeCardSource, KnowledgeCardSourceFromJSON, KnowledgeCardSourceFromJSONTyped, type KnowledgeCardSourceIndexesInner, KnowledgeCardSourceIndexesInnerFromJSON, KnowledgeCardSourceIndexesInnerFromJSONTyped, KnowledgeCardSourceIndexesInnerToJSON, KnowledgeCardSourceIndexesInnerToJSONTyped, KnowledgeCardSourceToJSON, KnowledgeCardSourceToJSONTyped, KnowledgeCardToJSON, KnowledgeCardToJSONTyped, type Middleware, type ModelPropertyNaming, type OutputSettings, OutputSettingsFromJSON, OutputSettingsFromJSONTyped, OutputSettingsToJSON, OutputSettingsToJSONTyped, type QueryClassification, QueryClassificationFromJSON, QueryClassificationFromJSONTyped, QueryClassificationToJSON, QueryClassificationToJSONTyped, type ReasoningEvent, ReasoningEventFromJSON, ReasoningEventFromJSONTyped, ReasoningEventKindEnum, ReasoningEventToJSON, ReasoningEventToJSONTyped, type RequestContext, type RequestOpts, RequiredError, type ResponseContext, ResponseError, type ResponseTransformer, type ResultContent, ResultContentFromJSON, ResultContentFromJSONTyped, ResultContentToJSON, ResultContentToJSONTyped, SearchEffortLevel, SearchEffortLevelFromJSON, SearchEffortLevelFromJSONTyped, SearchEffortLevelToJSON, SearchEffortLevelToJSONTyped, type SearchOperationRequest, type SearchRequest, SearchRequestFromJSON, SearchRequestFromJSONTyped, SearchRequestToJSON, SearchRequestToJSONTyped, type SearchResponse, SearchResponseFromJSON, SearchResponseFromJSONTyped, SearchResponseToJSON, SearchResponseToJSONTyped, type SourceIndex, SourceIndexFromJSON, SourceIndexFromJSONTyped, SourceIndexToJSON, SourceIndexToJSONTyped, type SourceSettings, SourceSettingsFromJSON, SourceSettingsFromJSONTyped, SourceSettingsToJSON, SourceSettingsToJSONTyped, type Sources, SourcesFromJSON, SourcesFromJSONTyped, SourcesToJSON, SourcesToJSONTyped, type StatusEvent, StatusEventFromJSON, StatusEventFromJSONTyped, StatusEventKindEnum, StatusEventToJSON, StatusEventToJSONTyped, StreamCategory, StreamCategoryFromJSON, StreamCategoryFromJSONTyped, StreamCategoryToJSON, StreamCategoryToJSONTyped, type StreamDoneEvent, StreamDoneEventFromJSON, StreamDoneEventFromJSONTyped, StreamDoneEventKindEnum, StreamDoneEventToJSON, StreamDoneEventToJSONTyped, type StreamResetEvent, StreamResetEventFromJSON, StreamResetEventFromJSONTyped, StreamResetEventKindEnum, StreamResetEventToJSON, StreamResetEventToJSONTyped, type SubagentEvent, SubagentEventEventEnum, SubagentEventFromJSON, SubagentEventFromJSONTyped, SubagentEventKindEnum, SubagentEventToJSON, SubagentEventToJSONTyped, Tako, TakoApi, type TakoApiInterface, type TakoCard, TakoCardFromJSON, TakoCardFromJSONTyped, TakoCardToJSON, TakoCardToJSONTyped, type TakoOptions, type TakoSourceSettings, TakoSourceSettingsFromJSON, TakoSourceSettingsFromJSONTyped, TakoSourceSettingsToJSON, TakoSourceSettingsToJSONTyped, TextApiResponse, type TextEvent, TextEventFromJSON, TextEventFromJSONTyped, TextEventKindEnum, TextEventToJSON, TextEventToJSONTyped, type ToolCallEvent, ToolCallEventFromJSON, ToolCallEventFromJSONTyped, ToolCallEventKindEnum, ToolCallEventToJSON, ToolCallEventToJSONTyped, type ToolErrorEvent, ToolErrorEventFromJSON, ToolErrorEventFromJSONTyped, ToolErrorEventKindEnum, ToolErrorEventToJSON, ToolErrorEventToJSONTyped, type ToolResultEvent, ToolResultEventFromJSON, ToolResultEventFromJSONTyped, ToolResultEventKindEnum, ToolResultEventToJSON, ToolResultEventToJSONTyped, type ToolRetryEvent, ToolRetryEventFromJSON, ToolRetryEventFromJSONTyped, ToolRetryEventKindEnum, ToolRetryEventToJSON, ToolRetryEventToJSONTyped, VoidApiResponse, type WebResult, WebResultFromJSON, WebResultFromJSONTyped, WebResultToJSON, WebResultToJSONTyped, canConsumeForm, exists, instanceOfAPIErrorType, instanceOfAgentEffortLevel, instanceOfAgentOutputSettings, instanceOfAgentResult, instanceOfAgentResultEvent, instanceOfAgentRun, instanceOfAgentRunRequest, instanceOfAgentRunStatus, instanceOfAgentStreamEnvelope, instanceOfAnswerResponse, instanceOfBaseAPIError, instanceOfCardSourceIndex, instanceOfCardSourceIndexSegment, instanceOfCardSourcePrivateIndex, instanceOfClassifyRequest, instanceOfClassifyResponse, instanceOfComponentConfig, instanceOfComponentTypeEnum, instanceOfContentFormat, instanceOfContentItem, instanceOfContentsDeliveryMode, instanceOfContentsRequest, instanceOfContentsResponse, instanceOfCreateCard400Response, instanceOfCreateCardRequest, instanceOfDataPipelineAnswerEvent, instanceOfErrorObject, instanceOfHeartbeatEvent, instanceOfIdealVizDecision, instanceOfKnowledgeCard, instanceOfKnowledgeCardMethodology, instanceOfKnowledgeCardRelevance, instanceOfKnowledgeCardSource, instanceOfKnowledgeCardSourceIndexesInner, instanceOfOutputSettings, instanceOfQueryClassification, instanceOfReasoningEvent, instanceOfResultContent, instanceOfSearchEffortLevel, instanceOfSearchRequest, instanceOfSearchResponse, instanceOfSourceIndex, instanceOfSourceSettings, instanceOfSources, instanceOfStatusEvent, instanceOfStreamCategory, instanceOfStreamDoneEvent, instanceOfStreamResetEvent, instanceOfSubagentEvent, instanceOfTakoCard, instanceOfTakoSourceSettings, instanceOfTextEvent, instanceOfToolCallEvent, instanceOfToolErrorEvent, instanceOfToolResultEvent, instanceOfToolRetryEvent, instanceOfWebResult, mapValues, querystring };
|