@credal/sdk 0.0.9 → 0.0.11

package/reference.md

@@ -1,5 +1,97 @@
 ## Copilots
 
+<details><summary> <code>credal.copilots.<a href="./src/api/resources/copilots/client/Client.ts">createCopilot</a>({ ...params }) -> Credal.CreateCopilotResponse</code> </summary>
+
+<dl>
+
+<dd>
+
+#### 📝 Description
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+Create a new copilot. The API key used will be added to the copilot for future Requests
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+```ts
+await credal.copilots.createCopilot({
+    name: "Customer Copilot",
+    description: "This copilot is used to answer customer requests based on internal documentation.",
+    collaborators: [
+        {
+            email: "test@gmail.com",
+            role: Credal.Role.Editor,
+        },
+    ],
+});
+```
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+**request: `Credal.CreateCopilotRequest`**
+
+</dd>
+
+</dl>
+
+<dl>
+
+<dd>
+
+**requestOptions: `Copilots.RequestOptions`**
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+</details>
+
 <details><summary> <code>credal.copilots.<a href="./src/api/resources/copilots/client/Client.ts">createConversation</a>({ ...params }) -> Credal.CreateConversationResponse</code> </summary>
 
 <dl>
@@ -16,7 +108,7 @@
 
 <dd>
 
-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.
+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.
 
 </dd>
 
@@ -224,14 +316,32 @@ await credal.copilots.sendMessage({
 </dl>
 </details>
 
-## DocumentCatalog
+<details><summary> <code>credal.copilots.<a href="./src/api/resources/copilots/client/Client.ts">addCollectionToCopilot</a>({ ...params }) -> void</code> </summary>
 
-<details><summary> <code>credal.documentCatalog.<a href="./src/api/resources/documentCatalog/client/Client.ts">uploadDocumentContents</a>({ ...params }) -> Credal.UploadDocumentResponse</code> </summary>
+<dl>
+
+<dd>
+
+#### 📝 Description
+
+<dl>
+
+<dd>
 
 <dl>
 
 <dd>
 
+Link a collection with a copilot. The API Key used must be added to both the collection and the copilot beforehand.
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -243,13 +353,9 @@ await credal.copilots.sendMessage({
 <dd>
 
 ```ts
-await credal.documentCatalog.uploadDocumentContents({
-    documentName: "My Document",
-    documentContents:
-        "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
-    documentExternalId: "73eead26-d124-4940-b329-5f068a0a8db9",
-    allowedUsersEmailAddresses: ["jack@credal.ai", "ravin@credal.ai"],
-    uploadAsUserEmail: "jack@credal.ai",
+await credal.copilots.addCollectionToCopilot({
+    copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+    collectionId: "def1055f-83c5-43d6-b558-f7a38e7b299e",
 });
 ```
 
@@ -271,7 +377,7 @@ await credal.documentCatalog.uploadDocumentContents({
 
 <dd>
 
-**request: `Credal.UploadDocumentContentsRequest`**
+**request: `Credal.AddCollectionToCopilotRequest`**
 
 </dd>
 
@@ -281,7 +387,7 @@ await credal.documentCatalog.uploadDocumentContents({
 
 <dd>
 
-**requestOptions: `DocumentCatalog.RequestOptions`**
+**requestOptions: `Copilots.RequestOptions`**
 
 </dd>
 
@@ -296,7 +402,7 @@ await credal.documentCatalog.uploadDocumentContents({
 </dl>
 </details>
 
-<details><summary> <code>credal.documentCatalog.<a href="./src/api/resources/documentCatalog/client/Client.ts">metadata</a>({ ...params }) -> void</code> </summary>
+<details><summary> <code>credal.copilots.<a href="./src/api/resources/copilots/client/Client.ts">removeCollectionFromCopilot</a>({ ...params }) -> void</code> </summary>
 
 <dl>
 
@@ -312,7 +418,7 @@ await credal.documentCatalog.uploadDocumentContents({
 
 <dd>
 
-Bulk patch metadata for documents, synced natively by Credal or manual API uploads
+Unlink a collection with a copilot. The API Key used must be added to both the collection and the copilot beforehand.
 
 </dd>
 
@@ -333,32 +439,9 @@ Bulk patch metadata for documents, synced natively by Credal or manual API uploa
 <dd>
 
 ```ts
-await credal.documentCatalog.metadata({
-    sources: [
-        {
-            metadata: {
-                Department: "HR",
-                Country: "United States",
-            },
-            resourceIdentifier: {
-                type: "external-resource-id",
-                externalResourceId: "170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
-                resourceType: Credal.ResourceType.GoogleDriveItem,
-            },
-        },
-        {
-            metadata: {
-                Department: "Sales",
-                Vertical: "Healthcare",
-            },
-            resourceIdentifier: {
-                type: "external-resource-id",
-                externalResourceId: "123456",
-                resourceType: Credal.ResourceType.ZendeskTicket,
-            },
-        },
-    ],
-    uploadAsUserEmail: "ben@credal.ai",
+await credal.copilots.removeCollectionFromCopilot({
+    copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+    collectionId: "def1055f-83c5-43d6-b558-f7a38e7b299e",
 });
 ```
 
@@ -380,7 +463,7 @@ await credal.documentCatalog.metadata({
 
 <dd>
 
-**request: `Credal.DocumentMetadataPatchRequest`**
+**request: `Credal.RemoveCollectionFromCopilotRequest`**
 
 </dd>
 
@@ -390,7 +473,7 @@ await credal.documentCatalog.metadata({
 
 <dd>
 
-**requestOptions: `DocumentCatalog.RequestOptions`**
+**requestOptions: `Copilots.RequestOptions`**
 
 </dd>
 
@@ -405,9 +488,7 @@ await credal.documentCatalog.metadata({
 </dl>
 </details>
 
-## DocumentCollections
-
-<details><summary> <code>credal.documentCollections.<a href="./src/api/resources/documentCollections/client/Client.ts">addDocumentsToCollection</a>({ ...params }) -> void</code> </summary>
+<details><summary> <code>credal.copilots.<a href="./src/api/resources/copilots/client/Client.ts">updateConfiguration</a>({ ...params }) -> void</code> </summary>
 
 <dl>
 
@@ -423,7 +504,7 @@ await credal.documentCatalog.metadata({
 
 <dd>
 
-Add documents to a document collection. Note that the documents must already exist in the document catalog to use this endpoint. If you want to upload a new document to a collection, use the uploadDocumentContents endpoint.
+Update the configuration for a copilot
 
 </dd>
 
@@ -444,20 +525,17 @@ Add documents to a document collection. Note that the documents must already exi
 <dd>
 
 ```ts
-await credal.documentCollections.addDocumentsToCollection({
-    collectionId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
-    resourceIdentifiers: [
-        {
-            type: "external-resource-id",
-            externalResourceId: "170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
-            resourceType: Credal.ResourceType.GoogleDriveItem,
-        },
-        {
-            type: "external-resource-id",
-            externalResourceId: "398KAHdfkjsdf09r54UvyslPVWkQFOA0lOiu34in923",
-            resourceType: Credal.ResourceType.GoogleDriveItem,
+await credal.copilots.updateConfiguration({
+    copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+    configuration: {
+        name: "Customer Copilot",
+        description: "This copilot is used to answer customer requests based on internal documentation.",
+        prompt: "You are a polite, helpful assistant used to answer customer requests.",
+        aiEndpointConfiguration: {
+            baseUrl: "https://api.openai.com/v1/",
+            apiKey: "<YOUR_API_KEY_HERE>",
         },
-    ],
+    },
 });
 ```
 
@@ -479,7 +557,626 @@ await credal.documentCollections.addDocumentsToCollection({
 
 <dd>
 
-**request: `Credal.AddDocumentsToCollectionRequest`**
+**request: `Credal.UpdateConfigurationRequest`**
+
+</dd>
+
+</dl>
+
+<dl>
+
+<dd>
+
+**requestOptions: `Copilots.RequestOptions`**
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+</details>
+
+<details><summary> <code>credal.copilots.<a href="./src/api/resources/copilots/client/Client.ts">deleteCopilot</a>({ ...params }) -> Credal.DeleteCopilotResponse</code> </summary>
+
+<dl>
+
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+```ts
+await credal.copilots.deleteCopilot({
+    id: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a",
+});
+```
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+**request: `Credal.DeleteCopilotRequest`**
+
+</dd>
+
+</dl>
+
+<dl>
+
+<dd>
+
+**requestOptions: `Copilots.RequestOptions`**
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+</details>
+
+## DocumentCatalog
+
+<details><summary> <code>credal.documentCatalog.<a href="./src/api/resources/documentCatalog/client/Client.ts">uploadDocumentContents</a>({ ...params }) -> Credal.UploadDocumentResponse</code> </summary>
+
+<dl>
+
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+```ts
+await credal.documentCatalog.uploadDocumentContents({
+    documentName: "My Document",
+    documentContents:
+        "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
+    documentExternalId: "73eead26-d124-4940-b329-5f068a0a8db9",
+    allowedUsersEmailAddresses: ["jack@credal.ai", "ravin@credal.ai"],
+    uploadAsUserEmail: "jack@credal.ai",
+});
+```
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+**request: `Credal.UploadDocumentContentsRequest`**
+
+</dd>
+
+</dl>
+
+<dl>
+
+<dd>
+
+**requestOptions: `DocumentCatalog.RequestOptions`**
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+</details>
+
+<details><summary> <code>credal.documentCatalog.<a href="./src/api/resources/documentCatalog/client/Client.ts">metadata</a>({ ...params }) -> void</code> </summary>
+
+<dl>
+
+<dd>
+
+#### 📝 Description
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+Bulk patch metadata for documents, synced natively by Credal or manual API uploads
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+```ts
+await credal.documentCatalog.metadata({
+    sources: [
+        {
+            metadata: {
+                Department: "HR",
+                Country: "United States",
+            },
+            resourceIdentifier: {
+                type: "external-resource-id",
+                externalResourceId: "170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
+                resourceType: Credal.ResourceType.GoogleDriveItem,
+            },
+        },
+        {
+            metadata: {
+                Department: "Sales",
+                Vertical: "Healthcare",
+            },
+            resourceIdentifier: {
+                type: "external-resource-id",
+                externalResourceId: "123456",
+                resourceType: Credal.ResourceType.ZendeskTicket,
+            },
+        },
+    ],
+    uploadAsUserEmail: "ben@credal.ai",
+});
+```
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+**request: `Credal.DocumentMetadataPatchRequest`**
+
+</dd>
+
+</dl>
+
+<dl>
+
+<dd>
+
+**requestOptions: `DocumentCatalog.RequestOptions`**
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+</details>
+
+## DocumentCollections
+
+<details><summary> <code>credal.documentCollections.<a href="./src/api/resources/documentCollections/client/Client.ts">addDocumentsToCollection</a>({ ...params }) -> void</code> </summary>
+
+<dl>
+
+<dd>
+
+#### 📝 Description
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+Add documents to a document collection. Note that the documents must already exist in the document catalog to use this endpoint. If you want to upload a new document to a collection, use the `uploadDocumentContents` endpoint.
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+```ts
+await credal.documentCollections.addDocumentsToCollection({
+    collectionId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+    resourceIdentifiers: [
+        {
+            type: "external-resource-id",
+            externalResourceId: "170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
+            resourceType: Credal.ResourceType.GoogleDriveItem,
+        },
+        {
+            type: "external-resource-id",
+            externalResourceId: "398KAHdfkjsdf09r54UvyslPVWkQFOA0lOiu34in923",
+            resourceType: Credal.ResourceType.GoogleDriveItem,
+        },
+    ],
+});
+```
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+**request: `Credal.AddDocumentsToCollectionRequest`**
+
+</dd>
+
+</dl>
+
+<dl>
+
+<dd>
+
+**requestOptions: `DocumentCollections.RequestOptions`**
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+</details>
+
+<details><summary> <code>credal.documentCollections.<a href="./src/api/resources/documentCollections/client/Client.ts">removeDocumentsFromCollection</a>({ ...params }) -> void</code> </summary>
+
+<dl>
+
+<dd>
+
+#### 📝 Description
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+Remove documents from a collection
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+```ts
+await credal.documentCollections.removeDocumentsFromCollection({
+    collectionId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+    resourceIdentifiers: [
+        {
+            type: "external-resource-id",
+            externalResourceId: "170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
+            resourceType: Credal.ResourceType.GoogleDriveItem,
+        },
+        {
+            type: "external-resource-id",
+            externalResourceId: "398KAHdfkjsdf09r54UvyslPVWkQFOA0lOiu34in923",
+            resourceType: Credal.ResourceType.GoogleDriveItem,
+        },
+    ],
+});
+```
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+**request: `Credal.RemoveDocumentsFromCollectionRequest`**
+
+</dd>
+
+</dl>
+
+<dl>
+
+<dd>
+
+**requestOptions: `DocumentCollections.RequestOptions`**
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+</details>
+
+<details><summary> <code>credal.documentCollections.<a href="./src/api/resources/documentCollections/client/Client.ts">createCollection</a>({ ...params }) -> Credal.CreateCollectionResponse</code> </summary>
+
+<dl>
+
+<dd>
+
+#### 📝 Description
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+Create a new copilot. The API key used will be added to the copilot for future Requests
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+```ts
+await credal.documentCollections.createCollection({
+    name: "Customer Collection",
+    description: "This collection is used to answer customer requests based on internal documentation.",
+    collaborators: [
+        {
+            email: "test@gmail.com",
+            role: Credal.Role.Editor,
+        },
+    ],
+});
+```
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+**request: `Credal.CreateCollectionRequest`**
+
+</dd>
+
+</dl>
+
+<dl>
+
+<dd>
+
+**requestOptions: `DocumentCollections.RequestOptions`**
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+</details>
+
+<details><summary> <code>credal.documentCollections.<a href="./src/api/resources/documentCollections/client/Client.ts">deleteCollection</a>({ ...params }) -> Credal.DeleteCollectionResponse</code> </summary>
+
+<dl>
+
+<dd>
+
+#### 📝 Description
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+Delete the collection.
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+```ts
+await credal.documentCollections.deleteCollection({
+    collectionId: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a",
+});
+```
+
+</dd>
+
+</dl>
+
+</dd>
+
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+
+<dd>
+
+<dl>
+
+<dd>
+
+**request: `Credal.DeleteCollectionRequest`**
 
 </dd>