Skip to content

Commit 84505af

Browse files
fern-api[bot]fern-api[bot]
committed
SDK regeneration
1 parent 6119139 commit 84505af

34 files changed

+249
-324
lines changed

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@credal/sdk",
3-
"version": "0.0.24",
3+
"version": "0.0.25",
44
"private": false,
55
"repository": "https://github.com/credal-ai/credal-typescript-sdk",
66
"main": "./index.js",

‎src/api/resources/copilots/client/Client.ts

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ export class Copilots {
6060
Authorization: await this._getAuthorizationHeader(),
6161
"X-Fern-Language": "JavaScript",
6262
"X-Fern-SDK-Name": "@credal/sdk",
63-
"X-Fern-SDK-Version": "0.0.24",
64-
"User-Agent": "@credal/sdk/0.0.24",
63+
"X-Fern-SDK-Version": "0.0.25",
64+
"User-Agent": "@credal/sdk/0.0.25",
6565
"X-Fern-Runtime": core.RUNTIME.type,
6666
"X-Fern-Runtime-Version": core.RUNTIME.version,
6767
},
@@ -129,8 +129,8 @@ export class Copilots {
129129
Authorization: await this._getAuthorizationHeader(),
130130
"X-Fern-Language": "JavaScript",
131131
"X-Fern-SDK-Name": "@credal/sdk",
132-
"X-Fern-SDK-Version": "0.0.24",
133-
"User-Agent": "@credal/sdk/0.0.24",
132+
"X-Fern-SDK-Version": "0.0.25",
133+
"User-Agent": "@credal/sdk/0.0.25",
134134
"X-Fern-Runtime": core.RUNTIME.type,
135135
"X-Fern-Runtime-Version": core.RUNTIME.version,
136136
},
@@ -202,8 +202,8 @@ export class Copilots {
202202
Authorization: await this._getAuthorizationHeader(),
203203
"X-Fern-Language": "JavaScript",
204204
"X-Fern-SDK-Name": "@credal/sdk",
205-
"X-Fern-SDK-Version": "0.0.24",
206-
"User-Agent": "@credal/sdk/0.0.24",
205+
"X-Fern-SDK-Version": "0.0.25",
206+
"User-Agent": "@credal/sdk/0.0.25",
207207
"X-Fern-Runtime": core.RUNTIME.type,
208208
"X-Fern-Runtime-Version": core.RUNTIME.version,
209209
},
@@ -272,8 +272,8 @@ export class Copilots {
272272
Authorization: await this._getAuthorizationHeader(),
273273
"X-Fern-Language": "JavaScript",
274274
"X-Fern-SDK-Name": "@credal/sdk",
275-
"X-Fern-SDK-Version": "0.0.24",
276-
"User-Agent": "@credal/sdk/0.0.24",
275+
"X-Fern-SDK-Version": "0.0.25",
276+
"User-Agent": "@credal/sdk/0.0.25",
277277
"X-Fern-Runtime": core.RUNTIME.type,
278278
"X-Fern-Runtime-Version": core.RUNTIME.version,
279279
},
@@ -332,8 +332,8 @@ export class Copilots {
332332
Authorization: await this._getAuthorizationHeader(),
333333
"X-Fern-Language": "JavaScript",
334334
"X-Fern-SDK-Name": "@credal/sdk",
335-
"X-Fern-SDK-Version": "0.0.24",
336-
"User-Agent": "@credal/sdk/0.0.24",
335+
"X-Fern-SDK-Version": "0.0.25",
336+
"User-Agent": "@credal/sdk/0.0.25",
337337
"X-Fern-Runtime": core.RUNTIME.type,
338338
"X-Fern-Runtime-Version": core.RUNTIME.version,
339339
},
@@ -412,8 +412,8 @@ export class Copilots {
412412
Authorization: await this._getAuthorizationHeader(),
413413
"X-Fern-Language": "JavaScript",
414414
"X-Fern-SDK-Name": "@credal/sdk",
415-
"X-Fern-SDK-Version": "0.0.24",
416-
"User-Agent": "@credal/sdk/0.0.24",
415+
"X-Fern-SDK-Version": "0.0.25",
416+
"User-Agent": "@credal/sdk/0.0.25",
417417
"X-Fern-Runtime": core.RUNTIME.type,
418418
"X-Fern-Runtime-Version": core.RUNTIME.version,
419419
},
@@ -476,8 +476,8 @@ export class Copilots {
476476
Authorization: await this._getAuthorizationHeader(),
477477
"X-Fern-Language": "JavaScript",
478478
"X-Fern-SDK-Name": "@credal/sdk",
479-
"X-Fern-SDK-Version": "0.0.24",
480-
"User-Agent": "@credal/sdk/0.0.24",
479+
"X-Fern-SDK-Version": "0.0.25",
480+
"User-Agent": "@credal/sdk/0.0.25",
481481
"X-Fern-Runtime": core.RUNTIME.type,
482482
"X-Fern-Runtime-Version": core.RUNTIME.version,
483483
},
@@ -550,8 +550,8 @@ export class Copilots {
550550
Authorization: await this._getAuthorizationHeader(),
551551
"X-Fern-Language": "JavaScript",
552552
"X-Fern-SDK-Name": "@credal/sdk",
553-
"X-Fern-SDK-Version": "0.0.24",
554-
"User-Agent": "@credal/sdk/0.0.24",
553+
"X-Fern-SDK-Version": "0.0.25",
554+
"User-Agent": "@credal/sdk/0.0.25",
555555
"X-Fern-Runtime": core.RUNTIME.type,
556556
"X-Fern-Runtime-Version": core.RUNTIME.version,
557557
},
@@ -611,8 +611,8 @@ export class Copilots {
611611
Authorization: await this._getAuthorizationHeader(),
612612
"X-Fern-Language": "JavaScript",
613613
"X-Fern-SDK-Name": "@credal/sdk",
614-
"X-Fern-SDK-Version": "0.0.24",
615-
"User-Agent": "@credal/sdk/0.0.24",
614+
"X-Fern-SDK-Version": "0.0.25",
615+
"User-Agent": "@credal/sdk/0.0.25",
616616
"X-Fern-Runtime": core.RUNTIME.type,
617617
"X-Fern-Runtime-Version": core.RUNTIME.version,
618618
},

‎src/api/resources/copilots/client/requests/AddCollectionToCopilotRequest.ts

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,8 @@
1010
* }
1111
*/
1212
export interface AddCollectionToCopilotRequest {
13-
/**
14-
* Credal-generated copilot ID to add the collection to.
15-
*
16-
*/
13+
/** Credal-generated copilot ID to add the collection to. */
1714
copilotId: string;
18-
/**
19-
* Credal-generated collection ID to add.
20-
*
21-
*/
15+
/** Credal-generated collection ID to add. */
2216
collectionId: string;
2317
}

‎src/api/resources/copilots/client/requests/CreateConversationRequest.ts

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,8 @@
1010
* }
1111
*/
1212
export interface CreateConversationRequest {
13-
/**
14-
* Credal-generated Copilot ID to specify which agent to route the request to.
15-
*
16-
*/
13+
/** Credal-generated Copilot ID to specify which agent to route the request to. */
1714
agentId: string;
18-
/**
19-
* End-user for the conversation.
20-
*
21-
*/
15+
/** End-user for the conversation. */
2216
userEmail: string;
2317
}

‎src/api/resources/copilots/client/requests/CreateCopilotRequest.ts

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,10 @@ import * as Credal from "../../../../index";
1616
* }
1717
*/
1818
export interface CreateCopilotRequest {
19-
/**
20-
* A descriptive name for the copilot.
21-
*
22-
*/
19+
/** A descriptive name for the copilot. */
2320
name: string;
24-
/**
25-
* An in depth name for the copilot's function. Useful for routing requests to the right copilot.
26-
*
27-
*/
21+
/** An in depth name for the copilot's function. Useful for routing requests to the right copilot. */
2822
description: string;
29-
/**
30-
* A list of collaborator emails and roles that will have access to the copilot.
31-
*
32-
*/
23+
/** A list of collaborator emails and roles that will have access to the copilot. */
3324
collaborators: Credal.Collaborator[];
3425
}

‎src/api/resources/copilots/client/requests/ProvideMessageFeedbackRequest.ts

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -18,24 +18,12 @@ import * as Credal from "../../../../index";
1818
* }
1919
*/
2020
export interface ProvideMessageFeedbackRequest {
21-
/**
22-
* Credal-generated Copilot ID to specify which agent to route the request to.
23-
*
24-
*/
21+
/** Credal-generated Copilot ID to specify which agent to route the request to. */
2522
agentId: string;
26-
/**
27-
* The user profile you want to use when providing feedback.
28-
*
29-
*/
23+
/** The user profile you want to use when providing feedback. */
3024
userEmail: string;
31-
/**
32-
* The message ID for which feedback is being provided.
33-
*
34-
*/
25+
/** The message ID for which feedback is being provided. */
3526
messageId: string;
36-
/**
37-
* The feedback provided by the user.
38-
*
39-
*/
27+
/** The feedback provided by the user. */
4028
messageFeedback: Credal.MessageFeedback;
4129
}

‎src/api/resources/copilots/client/requests/RemoveCollectionFromCopilotRequest.ts

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,8 @@
1010
* }
1111
*/
1212
export interface RemoveCollectionFromCopilotRequest {
13-
/**
14-
* Credal-generated copilot ID to add the collection to.
15-
*
16-
*/
13+
/** Credal-generated copilot ID to add the collection to. */
1714
copilotId: string;
18-
/**
19-
* Credal-generated collection ID to add.
20-
*
21-
*/
15+
/** Credal-generated collection ID to add. */
2216
collectionId: string;
2317
}

‎src/api/resources/copilots/client/requests/SendMessageRequest.ts

Lines changed: 5 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -20,29 +20,14 @@ import * as Credal from "../../../../index";
2020
* }
2121
*/
2222
export interface SendMessageRequest {
23-
/**
24-
* Credal-generated Copilot ID to specify which agent to route the request to.
25-
*
26-
*/
23+
/** Credal-generated Copilot ID to specify which agent to route the request to. */
2724
agentId: string;
28-
/**
29-
* The message you want to send to your copilot.
30-
*
31-
*/
25+
/** The message you want to send to your copilot. */
3226
message: string;
33-
/**
34-
* The user profile you want to use when sending the message.
35-
*
36-
*/
27+
/** The user profile you want to use when sending the message. */
3728
userEmail: string;
38-
/**
39-
* Credal-generated conversation ID for sending follow up messages. Conversation ID is returned after initial message. Optional, to be left off for first messages on new conversations.
40-
*
41-
*/
29+
/** Credal-generated conversation ID for sending follow up messages. Conversation ID is returned after initial message. Optional, to be left off for first messages on new conversations. */
4230
conversationId?: string;
43-
/**
44-
* Optional input variables to be used in the message. Map the name of the variable to a list of urls.
45-
*
46-
*/
31+
/** Optional input variables to be used in the message. Map the name of the variable to a list of urls. */
4732
inputVariables?: Credal.InputVariable[];
4833
}

‎src/api/resources/copilots/client/requests/StreamMessageRequest.ts

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -32,31 +32,30 @@ import * as Credal from "../../../../index";
3232
* ids: ["82e4b12a-6990-45d4-8ebd-85c00e030c25", "82e4b12a-6990-45d4-8ebd-85c00e030c24"]
3333
* }]
3434
* }
35+
*
36+
* @example
37+
* {
38+
* copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c25",
39+
* message: "Is Credal SOC 2 compliant?",
40+
* email: "ravin@credal.ai",
41+
* inputVariables: [{
42+
* name: "input1",
43+
* ids: ["82e4b12a-6990-45d4-8ebd-85c00e030c24"]
44+
* }, {
45+
* name: "input2",
46+
* ids: ["82e4b12a-6990-45d4-8ebd-85c00e030c25", "82e4b12a-6990-45d4-8ebd-85c00e030c26"]
47+
* }]
48+
* }
3549
*/
3650
export interface StreamMessageRequest {
37-
/**
38-
* Credal-generated Copilot ID to specify which agent to route the request to.
39-
*
40-
*/
51+
/** Credal-generated Copilot ID to specify which agent to route the request to. */
4152
copilotId: string;
42-
/**
43-
* The message you want to send to your copilot.
44-
*
45-
*/
53+
/** The message you want to send to your copilot. */
4654
message: string;
47-
/**
48-
* The user profile you want to use when sending the message.
49-
*
50-
*/
55+
/** The user profile you want to use when sending the message. */
5156
email: string;
52-
/**
53-
* Credal-generated conversation ID for sending follow up messages. Conversation ID is returned after initial message. Optional, to be left off for first messages on new conversations.
54-
*
55-
*/
57+
/** Credal-generated conversation ID for sending follow up messages. Conversation ID is returned after initial message. Optional, to be left off for first messages on new conversations. */
5658
conversationId?: string;
57-
/**
58-
* Optional input variables to be used in the message. Map the name of the variable to a list of urls.
59-
*
60-
*/
59+
/** Optional input variables to be used in the message. Map the name of the variable to a list of urls. */
6160
inputVariables?: Credal.InputVariable[];
6261
}

‎src/api/resources/copilots/client/requests/UpdateConfigurationRequest.ts

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,7 @@ import * as Credal from "../../../../index";
2020
* }
2121
*/
2222
export interface UpdateConfigurationRequest {
23-
/**
24-
* Credal-generated copilot ID to add the collection to.
25-
*
26-
*/
23+
/** Credal-generated copilot ID to add the collection to. */
2724
copilotId: string;
2825
configuration: Credal.Configuration;
2926
}

‎src/api/resources/copilots/types/ErrorChunk.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/**
2+
* This file was auto-generated by Fern from our API Definition.
3+
*/
4+
5+
import * as Credal from "../../../index";
6+
7+
export interface ErrorChunk {
8+
error: Credal.ErrorChunkData;
9+
}

‎src/api/resources/copilots/types/ErrorChunkData.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
/**
2+
* This file was auto-generated by Fern from our API Definition.
3+
*/
4+
5+
export interface ErrorChunkData {
6+
message: string;
7+
}

‎src/api/resources/copilots/types/SendMessageResponse.ts

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,11 @@ import * as Credal from "../../../index";
77
export type SendMessageResponse =
88
/**
99
* Returned when there is a reply
10-
* fetched from the copilot.
11-
* */
10+
* fetched from the copilot. */
1211
| Credal.SendMessageResponse.AiResponseResult
1312
/**
1413
* Returned when Credal detects possible
15-
* infosec violations and blocks the message.
16-
* */
14+
* infosec violations and blocks the message. */
1715
| Credal.SendMessageResponse.BlockedResult;
1816

1917
export declare namespace SendMessageResponse {

‎src/api/resources/copilots/types/StreamingChunk.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ export type StreamingChunk =
99
| Credal.StreamingChunk.DataChunk
1010
| Credal.StreamingChunk.EndOfMessage
1111
| Credal.StreamingChunk.FinalChunk
12-
| Credal.StreamingChunk.Blocked;
12+
| Credal.StreamingChunk.Blocked
13+
| Credal.StreamingChunk.ErrorChunk;
1314

1415
export declare namespace StreamingChunk {
1516
interface Initial extends Credal.InitialChunk {
@@ -31,4 +32,8 @@ export declare namespace StreamingChunk {
3132
interface Blocked extends Credal.BlockedChunk {
3233
event: "blocked";
3334
}
35+
36+
interface ErrorChunk extends Credal.ErrorChunk {
37+
event: "error_chunk";
38+
}
3439
}

‎src/api/resources/copilots/types/index.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,6 @@ export * from "./DataChunk";
2727
export * from "./FinalChunk";
2828
export * from "./EndOfMessageChunk";
2929
export * from "./BlockedChunk";
30+
export * from "./ErrorChunkData";
31+
export * from "./ErrorChunk";
3032
export * from "./StreamingChunk";

0 commit comments

Comments
 (0)