@credal/sdk 0.0.26 → 0.0.28
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/api/resources/copilots/client/Client.d.ts +18 -9
- package/api/resources/copilots/client/Client.js +121 -52
- package/api/resources/documentCatalog/client/Client.d.ts +6 -3
- package/api/resources/documentCatalog/client/Client.js +40 -16
- package/api/resources/documentCollections/client/Client.d.ts +12 -6
- package/api/resources/documentCollections/client/Client.js +80 -32
- package/api/resources/permissionsService/client/Client.d.ts +6 -3
- package/api/resources/permissionsService/client/Client.js +48 -21
- package/api/resources/search/client/Client.d.ts +2 -1
- package/api/resources/search/client/Client.js +16 -7
- package/api/resources/users/client/Client.d.ts +2 -1
- package/api/resources/users/client/Client.js +8 -2
- package/core/fetcher/APIResponse.d.ts +10 -0
- package/core/fetcher/Fetcher.js +7 -0
- package/core/fetcher/Headers.d.ts +2 -0
- package/core/fetcher/Headers.js +84 -0
- package/core/fetcher/HttpResponsePromise.d.ts +58 -0
- package/core/fetcher/HttpResponsePromise.js +103 -0
- package/core/fetcher/RawResponse.d.ts +29 -0
- package/core/fetcher/RawResponse.js +44 -0
- package/core/fetcher/index.d.ts +3 -0
- package/core/fetcher/index.js +7 -1
- package/core/index.d.ts +1 -1
- package/core/index.js +1 -1
- package/dist/api/resources/copilots/client/Client.d.ts +18 -9
- package/dist/api/resources/copilots/client/Client.js +121 -52
- package/dist/api/resources/documentCatalog/client/Client.d.ts +6 -3
- package/dist/api/resources/documentCatalog/client/Client.js +40 -16
- package/dist/api/resources/documentCollections/client/Client.d.ts +12 -6
- package/dist/api/resources/documentCollections/client/Client.js +80 -32
- package/dist/api/resources/permissionsService/client/Client.d.ts +6 -3
- package/dist/api/resources/permissionsService/client/Client.js +48 -21
- package/dist/api/resources/search/client/Client.d.ts +2 -1
- package/dist/api/resources/search/client/Client.js +16 -7
- package/dist/api/resources/users/client/Client.d.ts +2 -1
- package/dist/api/resources/users/client/Client.js +8 -2
- package/dist/core/fetcher/APIResponse.d.ts +10 -0
- package/dist/core/fetcher/Fetcher.js +7 -0
- package/dist/core/fetcher/Headers.d.ts +2 -0
- package/dist/core/fetcher/Headers.js +84 -0
- package/dist/core/fetcher/HttpResponsePromise.d.ts +58 -0
- package/dist/core/fetcher/HttpResponsePromise.js +103 -0
- package/dist/core/fetcher/RawResponse.d.ts +29 -0
- package/dist/core/fetcher/RawResponse.js +44 -0
- package/dist/core/fetcher/index.d.ts +3 -0
- package/dist/core/fetcher/index.js +7 -1
- package/dist/core/index.d.ts +1 -1
- package/dist/core/index.js +1 -1
- package/dist/errors/CredalError.d.ts +4 -1
- package/dist/errors/CredalError.js +4 -7
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/errors/CredalError.d.ts +4 -1
- package/errors/CredalError.js +4 -7
- package/package.json +3 -2
- package/version.d.ts +1 -1
- package/version.js +1 -1
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The raw response from the fetch call excluding the body.
|
|
3
|
+
*/
|
|
4
|
+
export type RawResponse = Omit<{
|
|
5
|
+
[K in keyof Response as Response[K] extends Function ? never : K]: Response[K];
|
|
6
|
+
}, "ok" | "body" | "bodyUsed">;
|
|
7
|
+
/**
|
|
8
|
+
* A raw response indicating that the request was aborted.
|
|
9
|
+
*/
|
|
10
|
+
export declare const abortRawResponse: RawResponse;
|
|
11
|
+
/**
|
|
12
|
+
* A raw response indicating an unknown error.
|
|
13
|
+
*/
|
|
14
|
+
export declare const unknownRawResponse: RawResponse;
|
|
15
|
+
/**
|
|
16
|
+
* Converts a `RawResponse` object into a `RawResponse` by extracting its properties,
|
|
17
|
+
* excluding the `body` and `bodyUsed` fields.
|
|
18
|
+
*
|
|
19
|
+
* @param response - The `RawResponse` object to convert.
|
|
20
|
+
* @returns A `RawResponse` object containing the extracted properties of the input response.
|
|
21
|
+
*/
|
|
22
|
+
export declare function toRawResponse(response: Response): RawResponse;
|
|
23
|
+
/**
|
|
24
|
+
* Creates a `RawResponse` from a standard `Response` object.
|
|
25
|
+
*/
|
|
26
|
+
export interface WithRawResponse<T> {
|
|
27
|
+
readonly data: T;
|
|
28
|
+
readonly rawResponse: RawResponse;
|
|
29
|
+
}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.unknownRawResponse = exports.abortRawResponse = void 0;
|
|
4
|
+
exports.toRawResponse = toRawResponse;
|
|
5
|
+
const Headers_1 = require("./Headers");
|
|
6
|
+
/**
|
|
7
|
+
* A raw response indicating that the request was aborted.
|
|
8
|
+
*/
|
|
9
|
+
exports.abortRawResponse = {
|
|
10
|
+
headers: new Headers_1.Headers(),
|
|
11
|
+
redirected: false,
|
|
12
|
+
status: 499,
|
|
13
|
+
statusText: "Client Closed Request",
|
|
14
|
+
type: "error",
|
|
15
|
+
url: "",
|
|
16
|
+
};
|
|
17
|
+
/**
|
|
18
|
+
* A raw response indicating an unknown error.
|
|
19
|
+
*/
|
|
20
|
+
exports.unknownRawResponse = {
|
|
21
|
+
headers: new Headers_1.Headers(),
|
|
22
|
+
redirected: false,
|
|
23
|
+
status: 0,
|
|
24
|
+
statusText: "Unknown Error",
|
|
25
|
+
type: "error",
|
|
26
|
+
url: "",
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* Converts a `RawResponse` object into a `RawResponse` by extracting its properties,
|
|
30
|
+
* excluding the `body` and `bodyUsed` fields.
|
|
31
|
+
*
|
|
32
|
+
* @param response - The `RawResponse` object to convert.
|
|
33
|
+
* @returns A `RawResponse` object containing the extracted properties of the input response.
|
|
34
|
+
*/
|
|
35
|
+
function toRawResponse(response) {
|
|
36
|
+
return {
|
|
37
|
+
headers: response.headers,
|
|
38
|
+
redirected: response.redirected,
|
|
39
|
+
status: response.status,
|
|
40
|
+
statusText: response.statusText,
|
|
41
|
+
type: response.type,
|
|
42
|
+
url: response.url,
|
|
43
|
+
};
|
|
44
|
+
}
|
package/core/fetcher/index.d.ts
CHANGED
|
@@ -3,3 +3,6 @@ export { fetcher } from "./Fetcher";
|
|
|
3
3
|
export type { Fetcher, FetchFunction } from "./Fetcher";
|
|
4
4
|
export { getHeader } from "./getHeader";
|
|
5
5
|
export { Supplier } from "./Supplier";
|
|
6
|
+
export { abortRawResponse, toRawResponse, unknownRawResponse } from "./RawResponse";
|
|
7
|
+
export type { RawResponse, WithRawResponse } from "./RawResponse";
|
|
8
|
+
export { HttpResponsePromise } from "./HttpResponsePromise";
|
package/core/fetcher/index.js
CHANGED
|
@@ -1,9 +1,15 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.Supplier = exports.getHeader = exports.fetcher = void 0;
|
|
3
|
+
exports.HttpResponsePromise = exports.unknownRawResponse = exports.toRawResponse = exports.abortRawResponse = exports.Supplier = exports.getHeader = exports.fetcher = void 0;
|
|
4
4
|
var Fetcher_1 = require("./Fetcher");
|
|
5
5
|
Object.defineProperty(exports, "fetcher", { enumerable: true, get: function () { return Fetcher_1.fetcher; } });
|
|
6
6
|
var getHeader_1 = require("./getHeader");
|
|
7
7
|
Object.defineProperty(exports, "getHeader", { enumerable: true, get: function () { return getHeader_1.getHeader; } });
|
|
8
8
|
var Supplier_1 = require("./Supplier");
|
|
9
9
|
Object.defineProperty(exports, "Supplier", { enumerable: true, get: function () { return Supplier_1.Supplier; } });
|
|
10
|
+
var RawResponse_1 = require("./RawResponse");
|
|
11
|
+
Object.defineProperty(exports, "abortRawResponse", { enumerable: true, get: function () { return RawResponse_1.abortRawResponse; } });
|
|
12
|
+
Object.defineProperty(exports, "toRawResponse", { enumerable: true, get: function () { return RawResponse_1.toRawResponse; } });
|
|
13
|
+
Object.defineProperty(exports, "unknownRawResponse", { enumerable: true, get: function () { return RawResponse_1.unknownRawResponse; } });
|
|
14
|
+
var HttpResponsePromise_1 = require("./HttpResponsePromise");
|
|
15
|
+
Object.defineProperty(exports, "HttpResponsePromise", { enumerable: true, get: function () { return HttpResponsePromise_1.HttpResponsePromise; } });
|
package/core/index.d.ts
CHANGED
package/core/index.js
CHANGED
|
@@ -38,7 +38,7 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
38
38
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
39
|
exports.serialization = void 0;
|
|
40
40
|
__exportStar(require("./fetcher"), exports);
|
|
41
|
-
__exportStar(require("./auth"), exports);
|
|
42
41
|
__exportStar(require("./runtime"), exports);
|
|
42
|
+
__exportStar(require("./auth"), exports);
|
|
43
43
|
__exportStar(require("./streaming-fetcher"), exports);
|
|
44
44
|
exports.serialization = __importStar(require("./schemas"));
|
|
@@ -42,7 +42,8 @@ export declare class Copilots {
|
|
|
42
42
|
* }]
|
|
43
43
|
* })
|
|
44
44
|
*/
|
|
45
|
-
createCopilot(request: Credal.CreateCopilotRequest, requestOptions?: Copilots.RequestOptions):
|
|
45
|
+
createCopilot(request: Credal.CreateCopilotRequest, requestOptions?: Copilots.RequestOptions): core.HttpResponsePromise<Credal.CreateCopilotResponse>;
|
|
46
|
+
private __createCopilot;
|
|
46
47
|
/**
|
|
47
48
|
* OPTIONAL. Create a new conversation with the Agent. The conversation ID can be used in the `sendMessage` endpoint. The `sendMessage` endpoint automatically creates new conversations upon first request, but calling this endpoint can simplify certain use cases where it is helpful for the application to have the conversation ID before the first message is sent.
|
|
48
49
|
*
|
|
@@ -55,7 +56,8 @@ export declare class Copilots {
|
|
|
55
56
|
* userEmail: "ravin@credal.ai"
|
|
56
57
|
* })
|
|
57
58
|
*/
|
|
58
|
-
createConversation(request: Credal.CreateConversationRequest, requestOptions?: Copilots.RequestOptions):
|
|
59
|
+
createConversation(request: Credal.CreateConversationRequest, requestOptions?: Copilots.RequestOptions): core.HttpResponsePromise<Credal.CreateConversationResponse>;
|
|
60
|
+
private __createConversation;
|
|
59
61
|
/**
|
|
60
62
|
* @param {Credal.ProvideMessageFeedbackRequest} request
|
|
61
63
|
* @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -72,7 +74,8 @@ export declare class Copilots {
|
|
|
72
74
|
* }
|
|
73
75
|
* })
|
|
74
76
|
*/
|
|
75
|
-
provideMessageFeedback(request: Credal.ProvideMessageFeedbackRequest, requestOptions?: Copilots.RequestOptions):
|
|
77
|
+
provideMessageFeedback(request: Credal.ProvideMessageFeedbackRequest, requestOptions?: Copilots.RequestOptions): core.HttpResponsePromise<void>;
|
|
78
|
+
private __provideMessageFeedback;
|
|
76
79
|
/**
|
|
77
80
|
* @param {Credal.SendMessageRequest} request
|
|
78
81
|
* @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -91,11 +94,13 @@ export declare class Copilots {
|
|
|
91
94
|
* }]
|
|
92
95
|
* })
|
|
93
96
|
*/
|
|
94
|
-
sendMessage(request: Credal.SendMessageRequest, requestOptions?: Copilots.RequestOptions):
|
|
97
|
+
sendMessage(request: Credal.SendMessageRequest, requestOptions?: Copilots.RequestOptions): core.HttpResponsePromise<Credal.SendAgentMessageResponse>;
|
|
98
|
+
private __sendMessage;
|
|
95
99
|
/**
|
|
96
100
|
* This endpoint allows you to send a message to a specific agent and get the response back as a streamed set of Server-Sent Events.
|
|
97
101
|
*/
|
|
98
|
-
streamMessage(request: Credal.StreamMessageRequest, requestOptions?: Copilots.RequestOptions):
|
|
102
|
+
streamMessage(request: Credal.StreamMessageRequest, requestOptions?: Copilots.RequestOptions): core.HttpResponsePromise<core.Stream<Credal.StreamingChunk>>;
|
|
103
|
+
private __streamMessage;
|
|
99
104
|
/**
|
|
100
105
|
* Link a collection with a agent. The API Key used must be added to both the collection and the agent beforehand.
|
|
101
106
|
*
|
|
@@ -108,7 +113,8 @@ export declare class Copilots {
|
|
|
108
113
|
* collectionId: "def1055f-83c5-43d6-b558-f7a38e7b299e"
|
|
109
114
|
* })
|
|
110
115
|
*/
|
|
111
|
-
addCollectionToCopilot(request: Credal.AddCollectionToCopilotRequest, requestOptions?: Copilots.RequestOptions):
|
|
116
|
+
addCollectionToCopilot(request: Credal.AddCollectionToCopilotRequest, requestOptions?: Copilots.RequestOptions): core.HttpResponsePromise<void>;
|
|
117
|
+
private __addCollectionToCopilot;
|
|
112
118
|
/**
|
|
113
119
|
* Unlink a collection with a agent. The API Key used must be added to both the collection and the agent beforehand.
|
|
114
120
|
*
|
|
@@ -121,7 +127,8 @@ export declare class Copilots {
|
|
|
121
127
|
* collectionId: "def1055f-83c5-43d6-b558-f7a38e7b299e"
|
|
122
128
|
* })
|
|
123
129
|
*/
|
|
124
|
-
removeCollectionFromCopilot(request: Credal.RemoveCollectionFromCopilotRequest, requestOptions?: Copilots.RequestOptions):
|
|
130
|
+
removeCollectionFromCopilot(request: Credal.RemoveCollectionFromCopilotRequest, requestOptions?: Copilots.RequestOptions): core.HttpResponsePromise<void>;
|
|
131
|
+
private __removeCollectionFromCopilot;
|
|
125
132
|
/**
|
|
126
133
|
* Update the configuration for a agent
|
|
127
134
|
*
|
|
@@ -142,7 +149,8 @@ export declare class Copilots {
|
|
|
142
149
|
* }
|
|
143
150
|
* })
|
|
144
151
|
*/
|
|
145
|
-
updateConfiguration(request: Credal.UpdateConfigurationRequest, requestOptions?: Copilots.RequestOptions):
|
|
152
|
+
updateConfiguration(request: Credal.UpdateConfigurationRequest, requestOptions?: Copilots.RequestOptions): core.HttpResponsePromise<void>;
|
|
153
|
+
private __updateConfiguration;
|
|
146
154
|
/**
|
|
147
155
|
* @param {Credal.DeleteCopilotRequest} request
|
|
148
156
|
* @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -152,6 +160,7 @@ export declare class Copilots {
|
|
|
152
160
|
* id: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a"
|
|
153
161
|
* })
|
|
154
162
|
*/
|
|
155
|
-
deleteCopilot(request: Credal.DeleteCopilotRequest, requestOptions?: Copilots.RequestOptions):
|
|
163
|
+
deleteCopilot(request: Credal.DeleteCopilotRequest, requestOptions?: Copilots.RequestOptions): core.HttpResponsePromise<Credal.DeleteCopilotResponse>;
|
|
164
|
+
private __deleteCopilot;
|
|
156
165
|
protected _getAuthorizationHeader(): Promise<string>;
|
|
157
166
|
}
|