Skip to content

Commit 3a4ba61

Browse files
fern-api[bot]fern-api[bot]
committed
SDK regeneration
1 parent 114b97f commit 3a4ba61

20 files changed

+132
-132
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.25",
3+
"version": "0.0.26",
44
"private": false,
55
"repository": "https://github.com/credal-ai/credal-typescript-sdk",
66
"main": "./index.js",

‎reference.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<dl>
1515
<dd>
1616

17-
Create a new copilot. The API key used will be added to the copilot for future Requests
17+
Create a new agent. The API key used will be added to the agent for future Requests
1818

1919
</dd>
2020
</dl>
@@ -31,8 +31,8 @@ Create a new copilot. The API key used will be added to the copilot for future R
3131

3232
```typescript
3333
await client.copilots.createCopilot({
34-
name: "Customer Copilot",
35-
description: "This copilot is used to answer customer requests based on internal documentation.",
34+
name: "Customer Agent",
35+
description: "This agent is used to answer customer requests based on internal documentation.",
3636
collaborators: [
3737
{
3838
email: "[email protected]",
@@ -86,7 +86,7 @@ await client.copilots.createCopilot({
8686
<dl>
8787
<dd>
8888

89-
OPTIONAL. Create a new conversation with the Copilot. 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.
89+
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.
9090

9191
</dd>
9292
</dl>
@@ -271,7 +271,7 @@ await client.copilots.sendMessage({
271271
<dl>
272272
<dd>
273273

274-
This endpoint allows you to send a message to a specific copilot and get the response back as a streamed set of Server-Sent Events.
274+
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.
275275

276276
</dd>
277277
</dl>
@@ -351,7 +351,7 @@ for await (const item of response) {
351351
<dl>
352352
<dd>
353353

354-
Link a collection with a copilot. The API Key used must be added to both the collection and the copilot beforehand.
354+
Link a collection with a agent. The API Key used must be added to both the collection and the agent beforehand.
355355

356356
</dd>
357357
</dl>
@@ -417,7 +417,7 @@ await client.copilots.addCollectionToCopilot({
417417
<dl>
418418
<dd>
419419

420-
Unlink a collection with a copilot. The API Key used must be added to both the collection and the copilot beforehand.
420+
Unlink a collection with a agent. The API Key used must be added to both the collection and the agent beforehand.
421421

422422
</dd>
423423
</dl>
@@ -483,7 +483,7 @@ await client.copilots.removeCollectionFromCopilot({
483483
<dl>
484484
<dd>
485485

486-
Update the configuration for a copilot
486+
Update the configuration for a agent
487487

488488
</dd>
489489
</dl>
@@ -502,8 +502,8 @@ Update the configuration for a copilot
502502
await client.copilots.updateConfiguration({
503503
copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
504504
configuration: {
505-
name: "Customer Copilot",
506-
description: "This copilot is used to answer customer requests based on internal documentation.",
505+
name: "Customer Agent",
506+
description: "This agent is used to answer customer requests based on internal documentation.",
507507
prompt: "You are a polite, helpful assistant used to answer customer requests.",
508508
aiEndpointConfiguration: {
509509
baseUrl: "https://api.openai.com/v1/",
@@ -975,7 +975,7 @@ await client.documentCollections.removeDocumentsFromCollection({
975975
<dl>
976976
<dd>
977977

978-
Create a new copilot. The API key used will be added to the copilot for future Requests
978+
Create a new collection. The API key used will be added to the collection for future Requests
979979

980980
</dd>
981981
</dl>
@@ -1112,7 +1112,7 @@ await client.documentCollections.deleteCollection({
11121112
<dl>
11131113
<dd>
11141114

1115-
Credal lets you easily sync your MongoDB data for use in Collections and Copilots. Create a new sync from a MongoDB collection to a Credal collection.
1115+
Credal lets you easily sync your MongoDB data for use in Collections and Agents. Create a new sync from a MongoDB collection to a Credal collection.
11161116

11171117
</dd>
11181118
</dl>
@@ -1193,7 +1193,7 @@ await client.documentCollections.createMongoCollectionSync({
11931193
<dl>
11941194
<dd>
11951195

1196-
Credal lets you easily sync your MongoDB data for use in Collections and Copilots. Update an existing sync from a MongoDB collection to a Credal collection via the `mongoCredentialId`, to disambiguate between multiple potential syncs to a given collection.
1196+
Credal lets you easily sync your MongoDB data for use in Collections and Agents. Update an existing sync from a MongoDB collection to a Credal collection via the `mongoCredentialId`, to disambiguate between multiple potential syncs to a given collection.
11971197

11981198
</dd>
11991199
</dl>

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

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,15 @@ export class Copilots {
3535
constructor(protected readonly _options: Copilots.Options = {}) {}
3636

3737
/**
38-
* Create a new copilot. The API key used will be added to the copilot for future Requests
38+
* Create a new agent. The API key used will be added to the agent for future Requests
3939
*
4040
* @param {Credal.CreateCopilotRequest} request
4141
* @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
4242
*
4343
* @example
4444
* await client.copilots.createCopilot({
45-
* name: "Customer Copilot",
46-
* description: "This copilot is used to answer customer requests based on internal documentation.",
45+
* name: "Customer Agent",
46+
* description: "This agent is used to answer customer requests based on internal documentation.",
4747
* collaborators: [{
4848
* email: "test@gmail.com",
4949
* role: "editor"
@@ -66,8 +66,8 @@ export class Copilots {
6666
Authorization: await this._getAuthorizationHeader(),
6767
"X-Fern-Language": "JavaScript",
6868
"X-Fern-SDK-Name": "@credal/sdk",
69-
"X-Fern-SDK-Version": "0.0.25",
70-
"User-Agent": "@credal/sdk/0.0.25",
69+
"X-Fern-SDK-Version": "0.0.26",
70+
"User-Agent": "@credal/sdk/0.0.26",
7171
"X-Fern-Runtime": core.RUNTIME.type,
7272
"X-Fern-Runtime-Version": core.RUNTIME.version,
7373
...requestOptions?.headers,
@@ -111,7 +111,7 @@ export class Copilots {
111111
}
112112

113113
/**
114-
* OPTIONAL. Create a new conversation with the Copilot. 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.
114+
* 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.
115115
*
116116
* @param {Credal.CreateConversationRequest} request
117117
* @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
@@ -138,8 +138,8 @@ export class Copilots {
138138
Authorization: await this._getAuthorizationHeader(),
139139
"X-Fern-Language": "JavaScript",
140140
"X-Fern-SDK-Name": "@credal/sdk",
141-
"X-Fern-SDK-Version": "0.0.25",
142-
"User-Agent": "@credal/sdk/0.0.25",
141+
"X-Fern-SDK-Version": "0.0.26",
142+
"User-Agent": "@credal/sdk/0.0.26",
143143
"X-Fern-Runtime": core.RUNTIME.type,
144144
"X-Fern-Runtime-Version": core.RUNTIME.version,
145145
...requestOptions?.headers,
@@ -216,8 +216,8 @@ export class Copilots {
216216
Authorization: await this._getAuthorizationHeader(),
217217
"X-Fern-Language": "JavaScript",
218218
"X-Fern-SDK-Name": "@credal/sdk",
219-
"X-Fern-SDK-Version": "0.0.25",
220-
"User-Agent": "@credal/sdk/0.0.25",
219+
"X-Fern-SDK-Version": "0.0.26",
220+
"User-Agent": "@credal/sdk/0.0.26",
221221
"X-Fern-Runtime": core.RUNTIME.type,
222222
"X-Fern-Runtime-Version": core.RUNTIME.version,
223223
...requestOptions?.headers,
@@ -291,8 +291,8 @@ export class Copilots {
291291
Authorization: await this._getAuthorizationHeader(),
292292
"X-Fern-Language": "JavaScript",
293293
"X-Fern-SDK-Name": "@credal/sdk",
294-
"X-Fern-SDK-Version": "0.0.25",
295-
"User-Agent": "@credal/sdk/0.0.25",
294+
"X-Fern-SDK-Version": "0.0.26",
295+
"User-Agent": "@credal/sdk/0.0.26",
296296
"X-Fern-Runtime": core.RUNTIME.type,
297297
"X-Fern-Runtime-Version": core.RUNTIME.version,
298298
...requestOptions?.headers,
@@ -336,7 +336,7 @@ export class Copilots {
336336
}
337337

338338
/**
339-
* This endpoint allows you to send a message to a specific copilot and get the response back as a streamed set of Server-Sent Events.
339+
* 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.
340340
*/
341341
public async streamMessage(
342342
request: Credal.StreamMessageRequest,
@@ -354,8 +354,8 @@ export class Copilots {
354354
Authorization: await this._getAuthorizationHeader(),
355355
"X-Fern-Language": "JavaScript",
356356
"X-Fern-SDK-Name": "@credal/sdk",
357-
"X-Fern-SDK-Version": "0.0.25",
358-
"User-Agent": "@credal/sdk/0.0.25",
357+
"X-Fern-SDK-Version": "0.0.26",
358+
"User-Agent": "@credal/sdk/0.0.26",
359359
"X-Fern-Runtime": core.RUNTIME.type,
360360
"X-Fern-Runtime-Version": core.RUNTIME.version,
361361
...requestOptions?.headers,
@@ -410,7 +410,7 @@ export class Copilots {
410410
}
411411

412412
/**
413-
* Link a collection with a copilot. The API Key used must be added to both the collection and the copilot beforehand.
413+
* Link a collection with a agent. The API Key used must be added to both the collection and the agent beforehand.
414414
*
415415
* @param {Credal.AddCollectionToCopilotRequest} request
416416
* @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
@@ -437,8 +437,8 @@ export class Copilots {
437437
Authorization: await this._getAuthorizationHeader(),
438438
"X-Fern-Language": "JavaScript",
439439
"X-Fern-SDK-Name": "@credal/sdk",
440-
"X-Fern-SDK-Version": "0.0.25",
441-
"User-Agent": "@credal/sdk/0.0.25",
440+
"X-Fern-SDK-Version": "0.0.26",
441+
"User-Agent": "@credal/sdk/0.0.26",
442442
"X-Fern-Runtime": core.RUNTIME.type,
443443
"X-Fern-Runtime-Version": core.RUNTIME.version,
444444
...requestOptions?.headers,
@@ -479,7 +479,7 @@ export class Copilots {
479479
}
480480

481481
/**
482-
* Unlink a collection with a copilot. The API Key used must be added to both the collection and the copilot beforehand.
482+
* Unlink a collection with a agent. The API Key used must be added to both the collection and the agent beforehand.
483483
*
484484
* @param {Credal.RemoveCollectionFromCopilotRequest} request
485485
* @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
@@ -506,8 +506,8 @@ export class Copilots {
506506
Authorization: await this._getAuthorizationHeader(),
507507
"X-Fern-Language": "JavaScript",
508508
"X-Fern-SDK-Name": "@credal/sdk",
509-
"X-Fern-SDK-Version": "0.0.25",
510-
"User-Agent": "@credal/sdk/0.0.25",
509+
"X-Fern-SDK-Version": "0.0.26",
510+
"User-Agent": "@credal/sdk/0.0.26",
511511
"X-Fern-Runtime": core.RUNTIME.type,
512512
"X-Fern-Runtime-Version": core.RUNTIME.version,
513513
...requestOptions?.headers,
@@ -550,7 +550,7 @@ export class Copilots {
550550
}
551551

552552
/**
553-
* Update the configuration for a copilot
553+
* Update the configuration for a agent
554554
*
555555
* @param {Credal.UpdateConfigurationRequest} request
556556
* @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
@@ -559,8 +559,8 @@ export class Copilots {
559559
* await client.copilots.updateConfiguration({
560560
* copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
561561
* configuration: {
562-
* name: "Customer Copilot",
563-
* description: "This copilot is used to answer customer requests based on internal documentation.",
562+
* name: "Customer Agent",
563+
* description: "This agent is used to answer customer requests based on internal documentation.",
564564
* prompt: "You are a polite, helpful assistant used to answer customer requests.",
565565
* aiEndpointConfiguration: {
566566
* baseUrl: "https://api.openai.com/v1/",
@@ -585,8 +585,8 @@ export class Copilots {
585585
Authorization: await this._getAuthorizationHeader(),
586586
"X-Fern-Language": "JavaScript",
587587
"X-Fern-SDK-Name": "@credal/sdk",
588-
"X-Fern-SDK-Version": "0.0.25",
589-
"User-Agent": "@credal/sdk/0.0.25",
588+
"X-Fern-SDK-Version": "0.0.26",
589+
"User-Agent": "@credal/sdk/0.0.26",
590590
"X-Fern-Runtime": core.RUNTIME.type,
591591
"X-Fern-Runtime-Version": core.RUNTIME.version,
592592
...requestOptions?.headers,
@@ -651,8 +651,8 @@ export class Copilots {
651651
Authorization: await this._getAuthorizationHeader(),
652652
"X-Fern-Language": "JavaScript",
653653
"X-Fern-SDK-Name": "@credal/sdk",
654-
"X-Fern-SDK-Version": "0.0.25",
655-
"User-Agent": "@credal/sdk/0.0.25",
654+
"X-Fern-SDK-Version": "0.0.26",
655+
"User-Agent": "@credal/sdk/0.0.26",
656656
"X-Fern-Runtime": core.RUNTIME.type,
657657
"X-Fern-Runtime-Version": core.RUNTIME.version,
658658
...requestOptions?.headers,

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
* }
1111
*/
1212
export interface AddCollectionToCopilotRequest {
13-
/** Credal-generated copilot ID to add the collection to. */
13+
/** Credal-generated Agent ID to add the collection to. */
1414
copilotId: string;
1515
/** Credal-generated collection ID to add. */
1616
collectionId: string;

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
* }
1111
*/
1212
export interface CreateConversationRequest {
13-
/** Credal-generated Copilot ID to specify which agent to route the request to. */
13+
/** Credal-generated Agent ID to specify which agent to route the request to. */
1414
agentId: string;
1515
/** End-user for the conversation. */
1616
userEmail: string;

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,19 @@ import * as Credal from "../../../../index";
77
/**
88
* @example
99
* {
10-
* name: "Customer Copilot",
11-
* description: "This copilot is used to answer customer requests based on internal documentation.",
10+
* name: "Customer Agent",
11+
* description: "This agent is used to answer customer requests based on internal documentation.",
1212
* collaborators: [{
1313
* email: "test@gmail.com",
1414
* role: "editor"
1515
* }]
1616
* }
1717
*/
1818
export interface CreateCopilotRequest {
19-
/** A descriptive name for the copilot. */
19+
/** A descriptive name for the agent. */
2020
name: string;
21-
/** An in depth name for the copilot's function. Useful for routing requests to the right copilot. */
21+
/** An in depth name for the agent's function. Useful for routing requests to the right agent. */
2222
description: string;
23-
/** A list of collaborator emails and roles that will have access to the copilot. */
23+
/** A list of collaborator emails and roles that will have access to the agent. */
2424
collaborators: Credal.Collaborator[];
2525
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import * as Credal from "../../../../index";
1818
* }
1919
*/
2020
export interface ProvideMessageFeedbackRequest {
21-
/** Credal-generated Copilot ID to specify which agent to route the request to. */
21+
/** Credal-generated Agent ID to specify which agent to route the request to. */
2222
agentId: string;
2323
/** The user profile you want to use when providing feedback. */
2424
userEmail: string;

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
* }
1111
*/
1212
export interface RemoveCollectionFromCopilotRequest {
13-
/** Credal-generated copilot ID to add the collection to. */
13+
/** Credal-generated agent ID to add the collection to. */
1414
copilotId: string;
1515
/** Credal-generated collection ID to add. */
1616
collectionId: string;

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ import * as Credal from "../../../../index";
2020
* }
2121
*/
2222
export interface SendMessageRequest {
23-
/** Credal-generated Copilot ID to specify which agent to route the request to. */
23+
/** Credal-generated Agent ID to specify which agent to route the request to. */
2424
agentId: string;
25-
/** The message you want to send to your copilot. */
25+
/** The message you want to send to your agent. */
2626
message: string;
2727
/** The user profile you want to use when sending the message. */
2828
userEmail: string;

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,9 @@ import * as Credal from "../../../../index";
4848
* }
4949
*/
5050
export interface StreamMessageRequest {
51-
/** Credal-generated Copilot ID to specify which agent to route the request to. */
51+
/** Credal-generated Agent ID to specify which agent to route the request to. */
5252
copilotId: string;
53-
/** The message you want to send to your copilot. */
53+
/** The message you want to send to your agent. */
5454
message: string;
5555
/** The user profile you want to use when sending the message. */
5656
email: string;

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ import * as Credal from "../../../../index";
99
* {
1010
* copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
1111
* configuration: {
12-
* name: "Customer Copilot",
13-
* description: "This copilot is used to answer customer requests based on internal documentation.",
12+
* name: "Customer Agent",
13+
* description: "This agent is used to answer customer requests based on internal documentation.",
1414
* prompt: "You are a polite, helpful assistant used to answer customer requests.",
1515
* aiEndpointConfiguration: {
1616
* baseUrl: "https://api.openai.com/v1/",
@@ -20,7 +20,7 @@ import * as Credal from "../../../../index";
2020
* }
2121
*/
2222
export interface UpdateConfigurationRequest {
23-
/** Credal-generated copilot ID to add the collection to. */
23+
/** Credal-generated agent ID to add the collection to. */
2424
copilotId: string;
2525
configuration: Credal.Configuration;
2626
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import * as Credal from "../../../index";
77
export type SendMessageResponse =
88
/**
99
* Returned when there is a reply
10-
* fetched from the copilot. */
10+
* fetched from the agent. */
1111
| Credal.SendMessageResponse.AiResponseResult
1212
/**
1313
* Returned when Credal detects possible

0 commit comments

Comments
 (0)