@credal/sdk 0.0.25 → 0.0.26
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 +10 -10
- package/api/resources/copilots/client/Client.js +19 -19
- package/api/resources/copilots/client/requests/AddCollectionToCopilotRequest.d.ts +1 -1
- package/api/resources/copilots/client/requests/CreateConversationRequest.d.ts +1 -1
- package/api/resources/copilots/client/requests/CreateCopilotRequest.d.ts +5 -5
- package/api/resources/copilots/client/requests/ProvideMessageFeedbackRequest.d.ts +1 -1
- package/api/resources/copilots/client/requests/RemoveCollectionFromCopilotRequest.d.ts +1 -1
- package/api/resources/copilots/client/requests/SendMessageRequest.d.ts +2 -2
- package/api/resources/copilots/client/requests/StreamMessageRequest.d.ts +2 -2
- package/api/resources/copilots/client/requests/UpdateConfigurationRequest.d.ts +3 -3
- package/api/resources/copilots/types/SendMessageResponse.d.ts +1 -1
- package/api/resources/documentCatalog/client/Client.js +3 -3
- package/api/resources/documentCollections/client/Client.d.ts +3 -3
- package/api/resources/documentCollections/client/Client.js +9 -9
- package/api/resources/documentCollections/client/requests/CreateCollectionRequest.d.ts +2 -2
- package/api/resources/permissionsService/client/Client.js +3 -3
- package/api/resources/search/client/Client.js +1 -1
- package/api/resources/users/client/Client.js +1 -1
- package/dist/api/resources/copilots/client/Client.d.ts +10 -10
- package/dist/api/resources/copilots/client/Client.js +19 -19
- package/dist/api/resources/copilots/client/requests/AddCollectionToCopilotRequest.d.ts +1 -1
- package/dist/api/resources/copilots/client/requests/CreateConversationRequest.d.ts +1 -1
- package/dist/api/resources/copilots/client/requests/CreateCopilotRequest.d.ts +5 -5
- package/dist/api/resources/copilots/client/requests/ProvideMessageFeedbackRequest.d.ts +1 -1
- package/dist/api/resources/copilots/client/requests/RemoveCollectionFromCopilotRequest.d.ts +1 -1
- package/dist/api/resources/copilots/client/requests/SendMessageRequest.d.ts +2 -2
- package/dist/api/resources/copilots/client/requests/StreamMessageRequest.d.ts +2 -2
- package/dist/api/resources/copilots/client/requests/UpdateConfigurationRequest.d.ts +3 -3
- package/dist/api/resources/copilots/types/SendMessageResponse.d.ts +1 -1
- package/dist/api/resources/documentCatalog/client/Client.js +3 -3
- package/dist/api/resources/documentCollections/client/Client.d.ts +3 -3
- package/dist/api/resources/documentCollections/client/Client.js +9 -9
- package/dist/api/resources/documentCollections/client/requests/CreateCollectionRequest.d.ts +2 -2
- package/dist/api/resources/permissionsService/client/Client.js +3 -3
- package/dist/api/resources/search/client/Client.js +1 -1
- package/dist/api/resources/users/client/Client.js +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/reference.md +13 -13
- package/version.d.ts +1 -1
- package/version.js +1 -1
package/reference.md
CHANGED
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
<dl>
|
|
15
15
|
<dd>
|
|
16
16
|
|
|
17
|
-
Create a new
|
|
17
|
+
Create a new agent. The API key used will be added to the agent for future Requests
|
|
18
18
|
|
|
19
19
|
</dd>
|
|
20
20
|
</dl>
|
|
@@ -31,8 +31,8 @@ Create a new copilot. The API key used will be added to the copilot for future R
|
|
|
31
31
|
|
|
32
32
|
```typescript
|
|
33
33
|
await client.copilots.createCopilot({
|
|
34
|
-
name: "Customer
|
|
35
|
-
description: "This
|
|
34
|
+
name: "Customer Agent",
|
|
35
|
+
description: "This agent is used to answer customer requests based on internal documentation.",
|
|
36
36
|
collaborators: [
|
|
37
37
|
{
|
|
38
38
|
email: "test@gmail.com",
|
|
@@ -86,7 +86,7 @@ await client.copilots.createCopilot({
|
|
|
86
86
|
<dl>
|
|
87
87
|
<dd>
|
|
88
88
|
|
|
89
|
-
OPTIONAL. Create a new conversation with the
|
|
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.
|
|
90
90
|
|
|
91
91
|
</dd>
|
|
92
92
|
</dl>
|
|
@@ -271,7 +271,7 @@ await client.copilots.sendMessage({
|
|
|
271
271
|
<dl>
|
|
272
272
|
<dd>
|
|
273
273
|
|
|
274
|
-
This endpoint allows you to send a message to a specific
|
|
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.
|
|
275
275
|
|
|
276
276
|
</dd>
|
|
277
277
|
</dl>
|
|
@@ -351,7 +351,7 @@ for await (const item of response) {
|
|
|
351
351
|
<dl>
|
|
352
352
|
<dd>
|
|
353
353
|
|
|
354
|
-
Link a collection with a
|
|
354
|
+
Link a collection with a agent. The API Key used must be added to both the collection and the agent beforehand.
|
|
355
355
|
|
|
356
356
|
</dd>
|
|
357
357
|
</dl>
|
|
@@ -417,7 +417,7 @@ await client.copilots.addCollectionToCopilot({
|
|
|
417
417
|
<dl>
|
|
418
418
|
<dd>
|
|
419
419
|
|
|
420
|
-
Unlink a collection with a
|
|
420
|
+
Unlink a collection with a agent. The API Key used must be added to both the collection and the agent beforehand.
|
|
421
421
|
|
|
422
422
|
</dd>
|
|
423
423
|
</dl>
|
|
@@ -483,7 +483,7 @@ await client.copilots.removeCollectionFromCopilot({
|
|
|
483
483
|
<dl>
|
|
484
484
|
<dd>
|
|
485
485
|
|
|
486
|
-
Update the configuration for a
|
|
486
|
+
Update the configuration for a agent
|
|
487
487
|
|
|
488
488
|
</dd>
|
|
489
489
|
</dl>
|
|
@@ -502,8 +502,8 @@ Update the configuration for a copilot
|
|
|
502
502
|
await client.copilots.updateConfiguration({
|
|
503
503
|
copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
|
|
504
504
|
configuration: {
|
|
505
|
-
name: "Customer
|
|
506
|
-
description: "This
|
|
505
|
+
name: "Customer Agent",
|
|
506
|
+
description: "This agent is used to answer customer requests based on internal documentation.",
|
|
507
507
|
prompt: "You are a polite, helpful assistant used to answer customer requests.",
|
|
508
508
|
aiEndpointConfiguration: {
|
|
509
509
|
baseUrl: "https://api.openai.com/v1/",
|
|
@@ -975,7 +975,7 @@ await client.documentCollections.removeDocumentsFromCollection({
|
|
|
975
975
|
<dl>
|
|
976
976
|
<dd>
|
|
977
977
|
|
|
978
|
-
Create a new
|
|
978
|
+
Create a new collection. The API key used will be added to the collection for future Requests
|
|
979
979
|
|
|
980
980
|
</dd>
|
|
981
981
|
</dl>
|
|
@@ -1112,7 +1112,7 @@ await client.documentCollections.deleteCollection({
|
|
|
1112
1112
|
<dl>
|
|
1113
1113
|
<dd>
|
|
1114
1114
|
|
|
1115
|
-
Credal lets you easily sync your MongoDB data for use in Collections and
|
|
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.
|
|
1116
1116
|
|
|
1117
1117
|
</dd>
|
|
1118
1118
|
</dl>
|
|
@@ -1193,7 +1193,7 @@ await client.documentCollections.createMongoCollectionSync({
|
|
|
1193
1193
|
<dl>
|
|
1194
1194
|
<dd>
|
|
1195
1195
|
|
|
1196
|
-
Credal lets you easily sync your MongoDB data for use in Collections and
|
|
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.
|
|
1197
1197
|
|
|
1198
1198
|
</dd>
|
|
1199
1199
|
</dl>
|
package/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "0.0.
|
|
1
|
+
export declare const SDK_VERSION = "0.0.26";
|
package/version.js
CHANGED