@credal/sdk 0.1.13 → 0.1.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/BaseClient.d.ts +7 -7
- package/dist/cjs/BaseClient.js +7 -3
- package/dist/cjs/Client.d.ts +1 -2
- package/dist/cjs/api/resources/copilots/client/Client.d.ts +21 -2
- package/dist/cjs/api/resources/copilots/client/Client.js +62 -134
- package/dist/cjs/api/resources/copilots/client/requests/ExportCopilotsRequest.d.ts +21 -0
- package/dist/cjs/api/resources/copilots/client/requests/ExportCopilotsRequest.js +3 -0
- package/dist/cjs/api/resources/copilots/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/copilots/types/ExportCopilotsResponse.d.ts +9 -0
- package/dist/cjs/api/resources/copilots/types/ExportCopilotsResponse.js +3 -0
- package/dist/cjs/api/resources/copilots/types/ExportedCopilot.d.ts +24 -0
- package/dist/cjs/api/resources/copilots/types/ExportedCopilot.js +3 -0
- package/dist/cjs/api/resources/copilots/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/copilots/types/index.js +2 -0
- package/dist/cjs/api/resources/documentCatalog/client/Client.d.ts +1 -2
- package/dist/cjs/api/resources/documentCatalog/client/Client.js +5 -60
- package/dist/cjs/api/resources/documentCollections/client/Client.d.ts +1 -2
- package/dist/cjs/api/resources/documentCollections/client/Client.js +8 -105
- package/dist/cjs/api/resources/search/client/Client.d.ts +1 -2
- package/dist/cjs/api/resources/search/client/Client.js +2 -15
- package/dist/cjs/api/resources/users/client/Client.d.ts +1 -2
- package/dist/cjs/api/resources/users/client/Client.js +2 -15
- package/dist/cjs/auth/BearerAuthProvider.d.ts +4 -2
- package/dist/cjs/core/auth/NoOpAuthProvider.d.ts +5 -0
- package/dist/cjs/core/auth/NoOpAuthProvider.js +9 -0
- package/dist/cjs/core/auth/index.d.ts +1 -0
- package/dist/cjs/core/auth/index.js +3 -1
- package/dist/cjs/core/fetcher/BinaryResponse.d.ts +6 -7
- package/dist/cjs/core/fetcher/Fetcher.d.ts +5 -1
- package/dist/cjs/core/fetcher/Fetcher.js +2 -1
- package/dist/cjs/core/fetcher/getResponseBody.js +18 -4
- package/dist/cjs/core/fetcher/signals.d.ts +1 -1
- package/dist/cjs/core/runtime/runtime.js +11 -10
- package/dist/cjs/errors/CredalError.js +5 -1
- package/dist/cjs/errors/CredalTimeoutError.js +5 -1
- package/dist/cjs/errors/handleNonStatusCodeError.d.ts +2 -0
- package/dist/cjs/errors/handleNonStatusCodeError.js +65 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.d.mts +7 -7
- package/dist/esm/BaseClient.mjs +7 -3
- package/dist/esm/Client.d.mts +1 -2
- package/dist/esm/api/resources/copilots/client/Client.d.mts +21 -2
- package/dist/esm/api/resources/copilots/client/Client.mjs +62 -134
- package/dist/esm/api/resources/copilots/client/requests/ExportCopilotsRequest.d.mts +21 -0
- package/dist/esm/api/resources/copilots/client/requests/ExportCopilotsRequest.mjs +2 -0
- package/dist/esm/api/resources/copilots/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/copilots/types/ExportCopilotsResponse.d.mts +9 -0
- package/dist/esm/api/resources/copilots/types/ExportCopilotsResponse.mjs +2 -0
- package/dist/esm/api/resources/copilots/types/ExportedCopilot.d.mts +24 -0
- package/dist/esm/api/resources/copilots/types/ExportedCopilot.mjs +2 -0
- package/dist/esm/api/resources/copilots/types/index.d.mts +2 -0
- package/dist/esm/api/resources/copilots/types/index.mjs +2 -0
- package/dist/esm/api/resources/documentCatalog/client/Client.d.mts +1 -2
- package/dist/esm/api/resources/documentCatalog/client/Client.mjs +5 -60
- package/dist/esm/api/resources/documentCollections/client/Client.d.mts +1 -2
- package/dist/esm/api/resources/documentCollections/client/Client.mjs +8 -105
- package/dist/esm/api/resources/search/client/Client.d.mts +1 -2
- package/dist/esm/api/resources/search/client/Client.mjs +2 -15
- package/dist/esm/api/resources/users/client/Client.d.mts +1 -2
- package/dist/esm/api/resources/users/client/Client.mjs +2 -15
- package/dist/esm/auth/BearerAuthProvider.d.mts +4 -2
- package/dist/esm/core/auth/NoOpAuthProvider.d.mts +5 -0
- package/dist/esm/core/auth/NoOpAuthProvider.mjs +5 -0
- package/dist/esm/core/auth/index.d.mts +1 -0
- package/dist/esm/core/auth/index.mjs +1 -0
- package/dist/esm/core/fetcher/BinaryResponse.d.mts +6 -7
- package/dist/esm/core/fetcher/Fetcher.d.mts +5 -1
- package/dist/esm/core/fetcher/Fetcher.mjs +2 -1
- package/dist/esm/core/fetcher/getResponseBody.mjs +18 -4
- package/dist/esm/core/fetcher/signals.d.mts +1 -1
- package/dist/esm/core/runtime/runtime.mjs +11 -10
- package/dist/esm/errors/CredalError.mjs +5 -1
- package/dist/esm/errors/CredalTimeoutError.mjs +5 -1
- package/dist/esm/errors/handleNonStatusCodeError.d.mts +2 -0
- package/dist/esm/errors/handleNonStatusCodeError.mjs +29 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +5 -2
- package/reference.md +72 -0
- package/dist/cjs/core/fetcher/ResponseWithBody.d.ts +0 -4
- package/dist/cjs/core/fetcher/ResponseWithBody.js +0 -6
- package/dist/esm/core/fetcher/ResponseWithBody.d.mts +0 -4
- package/dist/esm/core/fetcher/ResponseWithBody.mjs +0 -3
package/dist/cjs/BaseClient.d.ts
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
+
import { BearerAuthProvider } from "./auth/BearerAuthProvider.js";
|
|
1
2
|
import * as core from "./core/index.js";
|
|
2
3
|
import type * as environments from "./environments.js";
|
|
3
|
-
export
|
|
4
|
+
export type BaseClientOptions = {
|
|
4
5
|
environment?: core.Supplier<environments.CredalEnvironment | string>;
|
|
5
6
|
/** Specify a custom URL to connect the client to. */
|
|
6
7
|
baseUrl?: core.Supplier<string>;
|
|
7
|
-
apiKey?: core.Supplier<core.BearerToken | undefined>;
|
|
8
8
|
/** Additional headers to include in requests. */
|
|
9
9
|
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
|
|
10
10
|
/** The default maximum time to wait for a response in seconds. */
|
|
@@ -16,7 +16,7 @@ export interface BaseClientOptions {
|
|
|
16
16
|
fetcher?: core.FetchFunction;
|
|
17
17
|
/** Configure logging for the client. */
|
|
18
18
|
logging?: core.logging.LogConfig | core.logging.Logger;
|
|
19
|
-
}
|
|
19
|
+
} & BearerAuthProvider.AuthOptions;
|
|
20
20
|
export interface BaseRequestOptions {
|
|
21
21
|
/** The maximum time to wait for a response in seconds. */
|
|
22
22
|
timeoutInSeconds?: number;
|
|
@@ -29,12 +29,12 @@ export interface BaseRequestOptions {
|
|
|
29
29
|
/** Additional headers to include in the request. */
|
|
30
30
|
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
|
|
31
31
|
}
|
|
32
|
-
export type NormalizedClientOptions<T extends BaseClientOptions> = T & {
|
|
32
|
+
export type NormalizedClientOptions<T extends BaseClientOptions = BaseClientOptions> = T & {
|
|
33
33
|
logging: core.logging.Logger;
|
|
34
34
|
authProvider?: core.AuthProvider;
|
|
35
35
|
};
|
|
36
|
-
export type NormalizedClientOptionsWithAuth<T extends BaseClientOptions> = NormalizedClientOptions<T> & {
|
|
36
|
+
export type NormalizedClientOptionsWithAuth<T extends BaseClientOptions = BaseClientOptions> = NormalizedClientOptions<T> & {
|
|
37
37
|
authProvider: core.AuthProvider;
|
|
38
38
|
};
|
|
39
|
-
export declare function normalizeClientOptions<T extends BaseClientOptions>(options: T): NormalizedClientOptions<T>;
|
|
40
|
-
export declare function normalizeClientOptionsWithAuth<T extends BaseClientOptions>(options: T): NormalizedClientOptionsWithAuth<T>;
|
|
39
|
+
export declare function normalizeClientOptions<T extends BaseClientOptions = BaseClientOptions>(options: T): NormalizedClientOptions<T>;
|
|
40
|
+
export declare function normalizeClientOptionsWithAuth<T extends BaseClientOptions = BaseClientOptions>(options: T): NormalizedClientOptionsWithAuth<T>;
|
package/dist/cjs/BaseClient.js
CHANGED
|
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
|
|
|
43
43
|
const headers = (0, headers_js_1.mergeHeaders)({
|
|
44
44
|
"X-Fern-Language": "JavaScript",
|
|
45
45
|
"X-Fern-SDK-Name": "@credal/sdk",
|
|
46
|
-
"X-Fern-SDK-Version": "0.1.
|
|
47
|
-
"User-Agent": "@credal/sdk/0.1.
|
|
46
|
+
"X-Fern-SDK-Version": "0.1.16",
|
|
47
|
+
"User-Agent": "@credal/sdk/0.1.16",
|
|
48
48
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
49
49
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
50
50
|
}, options === null || options === void 0 ? void 0 : options.headers);
|
|
@@ -53,6 +53,10 @@ function normalizeClientOptions(options) {
|
|
|
53
53
|
function normalizeClientOptionsWithAuth(options) {
|
|
54
54
|
var _a;
|
|
55
55
|
const normalized = normalizeClientOptions(options);
|
|
56
|
-
|
|
56
|
+
const normalizedWithNoOpAuthProvider = withNoOpAuthProvider(normalized);
|
|
57
|
+
(_a = normalized.authProvider) !== null && _a !== void 0 ? _a : (normalized.authProvider = new BearerAuthProvider_js_1.BearerAuthProvider(normalizedWithNoOpAuthProvider));
|
|
57
58
|
return normalized;
|
|
58
59
|
}
|
|
60
|
+
function withNoOpAuthProvider(options) {
|
|
61
|
+
return Object.assign(Object.assign({}, options), { authProvider: new core.NoOpAuthProvider() });
|
|
62
|
+
}
|
package/dist/cjs/Client.d.ts
CHANGED
|
@@ -6,8 +6,7 @@ import { UsersClient } from "./api/resources/users/client/Client.js";
|
|
|
6
6
|
import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
|
|
7
7
|
import { type NormalizedClientOptionsWithAuth } from "./BaseClient.js";
|
|
8
8
|
export declare namespace CredalClient {
|
|
9
|
-
|
|
10
|
-
}
|
|
9
|
+
type Options = BaseClientOptions;
|
|
11
10
|
interface RequestOptions extends BaseRequestOptions {
|
|
12
11
|
}
|
|
13
12
|
}
|
|
@@ -3,8 +3,7 @@ import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js"
|
|
|
3
3
|
import * as core from "../../../../core/index.js";
|
|
4
4
|
import type * as Credal from "../../../index.js";
|
|
5
5
|
export declare namespace CopilotsClient {
|
|
6
|
-
|
|
7
|
-
}
|
|
6
|
+
type Options = BaseClientOptions;
|
|
8
7
|
interface RequestOptions extends BaseRequestOptions {
|
|
9
8
|
}
|
|
10
9
|
}
|
|
@@ -147,4 +146,24 @@ export declare class CopilotsClient {
|
|
|
147
146
|
*/
|
|
148
147
|
deleteCopilot(request: Credal.DeleteCopilotRequest, requestOptions?: CopilotsClient.RequestOptions): core.HttpResponsePromise<Credal.DeleteCopilotResponse>;
|
|
149
148
|
private __deleteCopilot;
|
|
149
|
+
/**
|
|
150
|
+
* Export copilot configurations for backup or migration purposes.
|
|
151
|
+
*
|
|
152
|
+
* **IMPORTANT**: This endpoint requires:
|
|
153
|
+
* - Admin privileges
|
|
154
|
+
* - The 'ai-usage-analytics-log.export' scope on the API key
|
|
155
|
+
*
|
|
156
|
+
* Returns all deployed copilots with their full configuration including model settings, tools, and deployment details. Optional date filters can be applied to narrow down results.
|
|
157
|
+
*
|
|
158
|
+
* @param {Credal.ExportCopilotsRequest} request
|
|
159
|
+
* @param {CopilotsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
160
|
+
*
|
|
161
|
+
* @example
|
|
162
|
+
* await client.copilots.export({
|
|
163
|
+
* agentCreatedFrom: "2024-01-01T00:00:00Z",
|
|
164
|
+
* agentCreatedTo: "2024-12-31T23:59:59Z"
|
|
165
|
+
* })
|
|
166
|
+
*/
|
|
167
|
+
export(request?: Credal.ExportCopilotsRequest, requestOptions?: CopilotsClient.RequestOptions): core.HttpResponsePromise<Credal.ExportCopilotsResponse>;
|
|
168
|
+
private __export;
|
|
150
169
|
}
|
|
@@ -48,6 +48,7 @@ const BaseClient_js_1 = require("../../../../BaseClient.js");
|
|
|
48
48
|
const headers_js_1 = require("../../../../core/headers.js");
|
|
49
49
|
const core = __importStar(require("../../../../core/index.js"));
|
|
50
50
|
const environments = __importStar(require("../../../../environments.js"));
|
|
51
|
+
const handleNonStatusCodeError_js_1 = require("../../../../errors/handleNonStatusCodeError.js");
|
|
51
52
|
const errors = __importStar(require("../../../../errors/index.js"));
|
|
52
53
|
class CopilotsClient {
|
|
53
54
|
constructor(options = {}) {
|
|
@@ -101,21 +102,7 @@ class CopilotsClient {
|
|
|
101
102
|
rawResponse: _response.rawResponse,
|
|
102
103
|
});
|
|
103
104
|
}
|
|
104
|
-
|
|
105
|
-
case "non-json":
|
|
106
|
-
throw new errors.CredalError({
|
|
107
|
-
statusCode: _response.error.statusCode,
|
|
108
|
-
body: _response.error.rawBody,
|
|
109
|
-
rawResponse: _response.rawResponse,
|
|
110
|
-
});
|
|
111
|
-
case "timeout":
|
|
112
|
-
throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/copilots/createCopilot.");
|
|
113
|
-
case "unknown":
|
|
114
|
-
throw new errors.CredalError({
|
|
115
|
-
message: _response.error.errorMessage,
|
|
116
|
-
rawResponse: _response.rawResponse,
|
|
117
|
-
});
|
|
118
|
-
}
|
|
105
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v0/copilots/createCopilot");
|
|
119
106
|
});
|
|
120
107
|
}
|
|
121
108
|
/**
|
|
@@ -162,21 +149,7 @@ class CopilotsClient {
|
|
|
162
149
|
rawResponse: _response.rawResponse,
|
|
163
150
|
});
|
|
164
151
|
}
|
|
165
|
-
|
|
166
|
-
case "non-json":
|
|
167
|
-
throw new errors.CredalError({
|
|
168
|
-
statusCode: _response.error.statusCode,
|
|
169
|
-
body: _response.error.rawBody,
|
|
170
|
-
rawResponse: _response.rawResponse,
|
|
171
|
-
});
|
|
172
|
-
case "timeout":
|
|
173
|
-
throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/copilots/createConversation.");
|
|
174
|
-
case "unknown":
|
|
175
|
-
throw new errors.CredalError({
|
|
176
|
-
message: _response.error.errorMessage,
|
|
177
|
-
rawResponse: _response.rawResponse,
|
|
178
|
-
});
|
|
179
|
-
}
|
|
152
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v0/copilots/createConversation");
|
|
180
153
|
});
|
|
181
154
|
}
|
|
182
155
|
/**
|
|
@@ -227,21 +200,7 @@ class CopilotsClient {
|
|
|
227
200
|
rawResponse: _response.rawResponse,
|
|
228
201
|
});
|
|
229
202
|
}
|
|
230
|
-
|
|
231
|
-
case "non-json":
|
|
232
|
-
throw new errors.CredalError({
|
|
233
|
-
statusCode: _response.error.statusCode,
|
|
234
|
-
body: _response.error.rawBody,
|
|
235
|
-
rawResponse: _response.rawResponse,
|
|
236
|
-
});
|
|
237
|
-
case "timeout":
|
|
238
|
-
throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/copilots/provideMessageFeedback.");
|
|
239
|
-
case "unknown":
|
|
240
|
-
throw new errors.CredalError({
|
|
241
|
-
message: _response.error.errorMessage,
|
|
242
|
-
rawResponse: _response.rawResponse,
|
|
243
|
-
});
|
|
244
|
-
}
|
|
203
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v0/copilots/provideMessageFeedback");
|
|
245
204
|
});
|
|
246
205
|
}
|
|
247
206
|
/**
|
|
@@ -294,21 +253,7 @@ class CopilotsClient {
|
|
|
294
253
|
rawResponse: _response.rawResponse,
|
|
295
254
|
});
|
|
296
255
|
}
|
|
297
|
-
|
|
298
|
-
case "non-json":
|
|
299
|
-
throw new errors.CredalError({
|
|
300
|
-
statusCode: _response.error.statusCode,
|
|
301
|
-
body: _response.error.rawBody,
|
|
302
|
-
rawResponse: _response.rawResponse,
|
|
303
|
-
});
|
|
304
|
-
case "timeout":
|
|
305
|
-
throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/copilots/sendMessage.");
|
|
306
|
-
case "unknown":
|
|
307
|
-
throw new errors.CredalError({
|
|
308
|
-
message: _response.error.errorMessage,
|
|
309
|
-
rawResponse: _response.rawResponse,
|
|
310
|
-
});
|
|
311
|
-
}
|
|
256
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v0/copilots/sendMessage");
|
|
312
257
|
});
|
|
313
258
|
}
|
|
314
259
|
/**
|
|
@@ -358,21 +303,7 @@ class CopilotsClient {
|
|
|
358
303
|
rawResponse: _response.rawResponse,
|
|
359
304
|
});
|
|
360
305
|
}
|
|
361
|
-
|
|
362
|
-
case "non-json":
|
|
363
|
-
throw new errors.CredalError({
|
|
364
|
-
statusCode: _response.error.statusCode,
|
|
365
|
-
body: _response.error.rawBody,
|
|
366
|
-
rawResponse: _response.rawResponse,
|
|
367
|
-
});
|
|
368
|
-
case "timeout":
|
|
369
|
-
throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/copilots/streamMessage.");
|
|
370
|
-
case "unknown":
|
|
371
|
-
throw new errors.CredalError({
|
|
372
|
-
message: _response.error.errorMessage,
|
|
373
|
-
rawResponse: _response.rawResponse,
|
|
374
|
-
});
|
|
375
|
-
}
|
|
306
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v0/copilots/streamMessage");
|
|
376
307
|
});
|
|
377
308
|
}
|
|
378
309
|
/**
|
|
@@ -419,21 +350,7 @@ class CopilotsClient {
|
|
|
419
350
|
rawResponse: _response.rawResponse,
|
|
420
351
|
});
|
|
421
352
|
}
|
|
422
|
-
|
|
423
|
-
case "non-json":
|
|
424
|
-
throw new errors.CredalError({
|
|
425
|
-
statusCode: _response.error.statusCode,
|
|
426
|
-
body: _response.error.rawBody,
|
|
427
|
-
rawResponse: _response.rawResponse,
|
|
428
|
-
});
|
|
429
|
-
case "timeout":
|
|
430
|
-
throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/copilots/addCollectionToCopilot.");
|
|
431
|
-
case "unknown":
|
|
432
|
-
throw new errors.CredalError({
|
|
433
|
-
message: _response.error.errorMessage,
|
|
434
|
-
rawResponse: _response.rawResponse,
|
|
435
|
-
});
|
|
436
|
-
}
|
|
353
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v0/copilots/addCollectionToCopilot");
|
|
437
354
|
});
|
|
438
355
|
}
|
|
439
356
|
/**
|
|
@@ -480,21 +397,7 @@ class CopilotsClient {
|
|
|
480
397
|
rawResponse: _response.rawResponse,
|
|
481
398
|
});
|
|
482
399
|
}
|
|
483
|
-
|
|
484
|
-
case "non-json":
|
|
485
|
-
throw new errors.CredalError({
|
|
486
|
-
statusCode: _response.error.statusCode,
|
|
487
|
-
body: _response.error.rawBody,
|
|
488
|
-
rawResponse: _response.rawResponse,
|
|
489
|
-
});
|
|
490
|
-
case "timeout":
|
|
491
|
-
throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/copilots/removeCollectionFromCopilot.");
|
|
492
|
-
case "unknown":
|
|
493
|
-
throw new errors.CredalError({
|
|
494
|
-
message: _response.error.errorMessage,
|
|
495
|
-
rawResponse: _response.rawResponse,
|
|
496
|
-
});
|
|
497
|
-
}
|
|
400
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v0/copilots/removeCollectionFromCopilot");
|
|
498
401
|
});
|
|
499
402
|
}
|
|
500
403
|
/**
|
|
@@ -549,21 +452,7 @@ class CopilotsClient {
|
|
|
549
452
|
rawResponse: _response.rawResponse,
|
|
550
453
|
});
|
|
551
454
|
}
|
|
552
|
-
|
|
553
|
-
case "non-json":
|
|
554
|
-
throw new errors.CredalError({
|
|
555
|
-
statusCode: _response.error.statusCode,
|
|
556
|
-
body: _response.error.rawBody,
|
|
557
|
-
rawResponse: _response.rawResponse,
|
|
558
|
-
});
|
|
559
|
-
case "timeout":
|
|
560
|
-
throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/copilots/updateConfiguration.");
|
|
561
|
-
case "unknown":
|
|
562
|
-
throw new errors.CredalError({
|
|
563
|
-
message: _response.error.errorMessage,
|
|
564
|
-
rawResponse: _response.rawResponse,
|
|
565
|
-
});
|
|
566
|
-
}
|
|
455
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v0/copilots/updateConfiguration");
|
|
567
456
|
});
|
|
568
457
|
}
|
|
569
458
|
/**
|
|
@@ -607,21 +496,60 @@ class CopilotsClient {
|
|
|
607
496
|
rawResponse: _response.rawResponse,
|
|
608
497
|
});
|
|
609
498
|
}
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
499
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "DELETE", "/v0/copilots/deleteCopilot");
|
|
500
|
+
});
|
|
501
|
+
}
|
|
502
|
+
/**
|
|
503
|
+
* Export copilot configurations for backup or migration purposes.
|
|
504
|
+
*
|
|
505
|
+
* **IMPORTANT**: This endpoint requires:
|
|
506
|
+
* - Admin privileges
|
|
507
|
+
* - The 'ai-usage-analytics-log.export' scope on the API key
|
|
508
|
+
*
|
|
509
|
+
* Returns all deployed copilots with their full configuration including model settings, tools, and deployment details. Optional date filters can be applied to narrow down results.
|
|
510
|
+
*
|
|
511
|
+
* @param {Credal.ExportCopilotsRequest} request
|
|
512
|
+
* @param {CopilotsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
513
|
+
*
|
|
514
|
+
* @example
|
|
515
|
+
* await client.copilots.export({
|
|
516
|
+
* agentCreatedFrom: "2024-01-01T00:00:00Z",
|
|
517
|
+
* agentCreatedTo: "2024-12-31T23:59:59Z"
|
|
518
|
+
* })
|
|
519
|
+
*/
|
|
520
|
+
export(request = {}, requestOptions) {
|
|
521
|
+
return core.HttpResponsePromise.fromPromise(this.__export(request, requestOptions));
|
|
522
|
+
}
|
|
523
|
+
__export() {
|
|
524
|
+
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
525
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
526
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
527
|
+
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
528
|
+
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
529
|
+
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.CredalEnvironment.Production, "/v0/copilots/export"),
|
|
530
|
+
method: "POST",
|
|
531
|
+
headers: _headers,
|
|
532
|
+
contentType: "application/json",
|
|
533
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
534
|
+
requestType: "json",
|
|
535
|
+
body: request,
|
|
536
|
+
timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
|
|
537
|
+
maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
|
|
538
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
539
|
+
fetchFn: (_k = this._options) === null || _k === void 0 ? void 0 : _k.fetch,
|
|
540
|
+
logging: this._options.logging,
|
|
541
|
+
});
|
|
542
|
+
if (_response.ok) {
|
|
543
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
544
|
+
}
|
|
545
|
+
if (_response.error.reason === "status-code") {
|
|
546
|
+
throw new errors.CredalError({
|
|
547
|
+
statusCode: _response.error.statusCode,
|
|
548
|
+
body: _response.error.body,
|
|
549
|
+
rawResponse: _response.rawResponse,
|
|
550
|
+
});
|
|
624
551
|
}
|
|
552
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v0/copilots/export");
|
|
625
553
|
});
|
|
626
554
|
}
|
|
627
555
|
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* agentCreatedFrom: "2024-01-01T00:00:00Z",
|
|
5
|
+
* agentCreatedTo: "2024-12-31T23:59:59Z"
|
|
6
|
+
* }
|
|
7
|
+
*/
|
|
8
|
+
export interface ExportCopilotsRequest {
|
|
9
|
+
/** Filter copilots created on or after this datetime (ISO 8601 format). */
|
|
10
|
+
agentCreatedFrom?: string;
|
|
11
|
+
/** Filter copilots created before or on this datetime (ISO 8601 format). */
|
|
12
|
+
agentCreatedTo?: string;
|
|
13
|
+
/** Filter copilot versions created on or after this datetime (ISO 8601 format). */
|
|
14
|
+
versionCreatedFrom?: string;
|
|
15
|
+
/** Filter copilot versions created before or on this datetime (ISO 8601 format). */
|
|
16
|
+
versionCreatedTo?: string;
|
|
17
|
+
/** Maximum number of copilots to return. Must be a positive integer with a maximum value of 1000. Defaults to 100. */
|
|
18
|
+
limit?: number;
|
|
19
|
+
/** Cursor for pagination. Use the cursor returned in the previous response to fetch the next page of results. If not provided, returns the first page. */
|
|
20
|
+
cursor?: string;
|
|
21
|
+
}
|
|
@@ -2,6 +2,7 @@ export type { AddCollectionToCopilotRequest } from "./AddCollectionToCopilotRequ
|
|
|
2
2
|
export type { CreateConversationRequest } from "./CreateConversationRequest.js";
|
|
3
3
|
export type { CreateCopilotRequest } from "./CreateCopilotRequest.js";
|
|
4
4
|
export type { DeleteCopilotRequest } from "./DeleteCopilotRequest.js";
|
|
5
|
+
export type { ExportCopilotsRequest } from "./ExportCopilotsRequest.js";
|
|
5
6
|
export type { ProvideMessageFeedbackRequest } from "./ProvideMessageFeedbackRequest.js";
|
|
6
7
|
export type { RemoveCollectionFromCopilotRequest } from "./RemoveCollectionFromCopilotRequest.js";
|
|
7
8
|
export type { SendMessageRequest } from "./SendMessageRequest.js";
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type * as Credal from "../../../index.js";
|
|
2
|
+
export interface ExportCopilotsResponse {
|
|
3
|
+
/** List of exported copilots matching the query filters. */
|
|
4
|
+
data: Credal.ExportedCopilot[];
|
|
5
|
+
/** Indicates whether there are more results available for pagination. */
|
|
6
|
+
hasMore: boolean;
|
|
7
|
+
/** Cursor to use for fetching the next page of results. This is a UUID string. If null or not present, there are no more results. */
|
|
8
|
+
nextCursor?: string;
|
|
9
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
export interface ExportedCopilot {
|
|
2
|
+
/** The unique identifier of the copilot. */
|
|
3
|
+
id: string;
|
|
4
|
+
/** The name of the deployed copilot version. */
|
|
5
|
+
name: string;
|
|
6
|
+
/** The description of the deployed copilot version. */
|
|
7
|
+
description: string;
|
|
8
|
+
/** Model configuration including provider, model name, temperature, and other settings. */
|
|
9
|
+
modelConfiguration?: unknown;
|
|
10
|
+
/** AI endpoint configuration including base URL and authentication details. */
|
|
11
|
+
aiEndpointConfiguration?: unknown;
|
|
12
|
+
/** List of tool configurations available to the copilot. */
|
|
13
|
+
toolConfigurations?: unknown;
|
|
14
|
+
/** Input variable configurations for the copilot. */
|
|
15
|
+
inputs?: unknown;
|
|
16
|
+
/** Deployment settings and configuration. */
|
|
17
|
+
deploymentConfiguration?: unknown;
|
|
18
|
+
/** ISO 8601 timestamp when the copilot was originally created. */
|
|
19
|
+
agentCreatedDatetime: string;
|
|
20
|
+
/** ISO 8601 timestamp when the deployed version was created. */
|
|
21
|
+
versionCreatedDatetime: string;
|
|
22
|
+
/** Indicates if the copilot is currently deployed (always true for export results). */
|
|
23
|
+
isDeployed: boolean;
|
|
24
|
+
}
|
|
@@ -12,6 +12,8 @@ export * from "./DeleteCopilotResponse.js";
|
|
|
12
12
|
export * from "./EndOfMessageChunk.js";
|
|
13
13
|
export * from "./ErrorChunk.js";
|
|
14
14
|
export * from "./ErrorChunkData.js";
|
|
15
|
+
export * from "./ExportCopilotsResponse.js";
|
|
16
|
+
export * from "./ExportedCopilot.js";
|
|
15
17
|
export * from "./FeedbackEnum.js";
|
|
16
18
|
export * from "./Filter.js";
|
|
17
19
|
export * from "./FinalChunk.js";
|
|
@@ -28,6 +28,8 @@ __exportStar(require("./DeleteCopilotResponse.js"), exports);
|
|
|
28
28
|
__exportStar(require("./EndOfMessageChunk.js"), exports);
|
|
29
29
|
__exportStar(require("./ErrorChunk.js"), exports);
|
|
30
30
|
__exportStar(require("./ErrorChunkData.js"), exports);
|
|
31
|
+
__exportStar(require("./ExportCopilotsResponse.js"), exports);
|
|
32
|
+
__exportStar(require("./ExportedCopilot.js"), exports);
|
|
31
33
|
__exportStar(require("./FeedbackEnum.js"), exports);
|
|
32
34
|
__exportStar(require("./Filter.js"), exports);
|
|
33
35
|
__exportStar(require("./FinalChunk.js"), exports);
|
|
@@ -3,8 +3,7 @@ import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js"
|
|
|
3
3
|
import * as core from "../../../../core/index.js";
|
|
4
4
|
import type * as Credal from "../../../index.js";
|
|
5
5
|
export declare namespace DocumentCatalogClient {
|
|
6
|
-
|
|
7
|
-
}
|
|
6
|
+
type Options = BaseClientOptions;
|
|
8
7
|
interface RequestOptions extends BaseRequestOptions {
|
|
9
8
|
}
|
|
10
9
|
}
|
|
@@ -48,6 +48,7 @@ const BaseClient_js_1 = require("../../../../BaseClient.js");
|
|
|
48
48
|
const headers_js_1 = require("../../../../core/headers.js");
|
|
49
49
|
const core = __importStar(require("../../../../core/index.js"));
|
|
50
50
|
const environments = __importStar(require("../../../../environments.js"));
|
|
51
|
+
const handleNonStatusCodeError_js_1 = require("../../../../errors/handleNonStatusCodeError.js");
|
|
51
52
|
const errors = __importStar(require("../../../../errors/index.js"));
|
|
52
53
|
class DocumentCatalogClient {
|
|
53
54
|
constructor(options = {}) {
|
|
@@ -98,21 +99,7 @@ class DocumentCatalogClient {
|
|
|
98
99
|
rawResponse: _response.rawResponse,
|
|
99
100
|
});
|
|
100
101
|
}
|
|
101
|
-
|
|
102
|
-
case "non-json":
|
|
103
|
-
throw new errors.CredalError({
|
|
104
|
-
statusCode: _response.error.statusCode,
|
|
105
|
-
body: _response.error.rawBody,
|
|
106
|
-
rawResponse: _response.rawResponse,
|
|
107
|
-
});
|
|
108
|
-
case "timeout":
|
|
109
|
-
throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/catalog/uploadDocumentContents.");
|
|
110
|
-
case "unknown":
|
|
111
|
-
throw new errors.CredalError({
|
|
112
|
-
message: _response.error.errorMessage,
|
|
113
|
-
rawResponse: _response.rawResponse,
|
|
114
|
-
});
|
|
115
|
-
}
|
|
102
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v0/catalog/uploadDocumentContents");
|
|
116
103
|
});
|
|
117
104
|
}
|
|
118
105
|
/**
|
|
@@ -185,21 +172,7 @@ class DocumentCatalogClient {
|
|
|
185
172
|
rawResponse: _response.rawResponse,
|
|
186
173
|
});
|
|
187
174
|
}
|
|
188
|
-
|
|
189
|
-
case "non-json":
|
|
190
|
-
throw new errors.CredalError({
|
|
191
|
-
statusCode: _response.error.statusCode,
|
|
192
|
-
body: _response.error.rawBody,
|
|
193
|
-
rawResponse: _response.rawResponse,
|
|
194
|
-
});
|
|
195
|
-
case "timeout":
|
|
196
|
-
throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/catalog/uploadFile.");
|
|
197
|
-
case "unknown":
|
|
198
|
-
throw new errors.CredalError({
|
|
199
|
-
message: _response.error.errorMessage,
|
|
200
|
-
rawResponse: _response.rawResponse,
|
|
201
|
-
});
|
|
202
|
-
}
|
|
175
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v0/catalog/uploadFile");
|
|
203
176
|
});
|
|
204
177
|
}
|
|
205
178
|
/**
|
|
@@ -246,21 +219,7 @@ class DocumentCatalogClient {
|
|
|
246
219
|
rawResponse: _response.rawResponse,
|
|
247
220
|
});
|
|
248
221
|
}
|
|
249
|
-
|
|
250
|
-
case "non-json":
|
|
251
|
-
throw new errors.CredalError({
|
|
252
|
-
statusCode: _response.error.statusCode,
|
|
253
|
-
body: _response.error.rawBody,
|
|
254
|
-
rawResponse: _response.rawResponse,
|
|
255
|
-
});
|
|
256
|
-
case "timeout":
|
|
257
|
-
throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/catalog/syncSourceByUrl.");
|
|
258
|
-
case "unknown":
|
|
259
|
-
throw new errors.CredalError({
|
|
260
|
-
message: _response.error.errorMessage,
|
|
261
|
-
rawResponse: _response.rawResponse,
|
|
262
|
-
});
|
|
263
|
-
}
|
|
222
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v0/catalog/syncSourceByUrl");
|
|
264
223
|
});
|
|
265
224
|
}
|
|
266
225
|
/**
|
|
@@ -327,21 +286,7 @@ class DocumentCatalogClient {
|
|
|
327
286
|
rawResponse: _response.rawResponse,
|
|
328
287
|
});
|
|
329
288
|
}
|
|
330
|
-
|
|
331
|
-
case "non-json":
|
|
332
|
-
throw new errors.CredalError({
|
|
333
|
-
statusCode: _response.error.statusCode,
|
|
334
|
-
body: _response.error.rawBody,
|
|
335
|
-
rawResponse: _response.rawResponse,
|
|
336
|
-
});
|
|
337
|
-
case "timeout":
|
|
338
|
-
throw new errors.CredalTimeoutError("Timeout exceeded when calling PATCH /v0/catalog/metadata.");
|
|
339
|
-
case "unknown":
|
|
340
|
-
throw new errors.CredalError({
|
|
341
|
-
message: _response.error.errorMessage,
|
|
342
|
-
rawResponse: _response.rawResponse,
|
|
343
|
-
});
|
|
344
|
-
}
|
|
289
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "PATCH", "/v0/catalog/metadata");
|
|
345
290
|
});
|
|
346
291
|
}
|
|
347
292
|
}
|
|
@@ -3,8 +3,7 @@ import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js"
|
|
|
3
3
|
import * as core from "../../../../core/index.js";
|
|
4
4
|
import type * as Credal from "../../../index.js";
|
|
5
5
|
export declare namespace DocumentCollectionsClient {
|
|
6
|
-
|
|
7
|
-
}
|
|
6
|
+
type Options = BaseClientOptions;
|
|
8
7
|
interface RequestOptions extends BaseRequestOptions {
|
|
9
8
|
}
|
|
10
9
|
}
|