@orq-ai/node 3.2.11 → 3.2.13
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/bin/mcp-server.js +32 -32
- package/bin/mcp-server.js.map +17 -17
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/mcp-server/mcp-server.js +1 -1
- package/mcp-server/server.js +1 -1
- package/models/operations/bulkcreatedatapoints.js +2 -2
- package/models/operations/createcontact.js +2 -2
- package/models/operations/createdataset.js +2 -2
- package/models/operations/createdatasetitem.js +2 -2
- package/models/operations/fileget.js +2 -2
- package/models/operations/filelist.js +2 -2
- package/models/operations/fileupload.js +2 -2
- package/models/operations/listdatasetdatapoints.js +2 -2
- package/models/operations/listdatasets.js +2 -2
- package/models/operations/retrievedatapoint.js +2 -2
- package/models/operations/retrievedataset.js +2 -2
- package/models/operations/updatedatapoint.js +2 -2
- package/models/operations/updatedataset.js +2 -2
- package/package.json +1 -1
- package/packages/orq-rc/README.md +4 -2
- package/packages/orq-rc/docs/sdks/datasets/README.md +6 -0
- package/packages/orq-rc/docs/sdks/knowledge/README.md +140 -58
- package/packages/orq-rc/docs/sdks/prompts/README.md +6 -0
- package/packages/orq-rc/jsr.json +1 -1
- package/packages/orq-rc/package-lock.json +2 -2
- package/packages/orq-rc/package.json +1 -1
- package/packages/orq-rc/src/funcs/contactsCreate.ts +1 -1
- package/packages/orq-rc/src/funcs/datasetsClear.ts +1 -1
- package/packages/orq-rc/src/funcs/datasetsCreate.ts +1 -1
- package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +1 -1
- package/packages/orq-rc/src/funcs/datasetsCreateDatapoints.ts +1 -1
- package/packages/orq-rc/src/funcs/datasetsDelete.ts +1 -1
- package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +1 -1
- package/packages/orq-rc/src/funcs/datasetsList.ts +1 -1
- package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +1 -1
- package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +1 -1
- package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +1 -1
- package/packages/orq-rc/src/funcs/datasetsUpdate.ts +1 -1
- package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +1 -1
- package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +1 -1
- package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +1 -1
- package/packages/orq-rc/src/funcs/deploymentsList.ts +1 -1
- package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +1 -1
- package/packages/orq-rc/src/funcs/deploymentsStream.ts +1 -1
- package/packages/orq-rc/src/funcs/feedbackCreate.ts +1 -1
- package/packages/orq-rc/src/funcs/filesCreate.ts +1 -1
- package/packages/orq-rc/src/funcs/filesDelete.ts +1 -1
- package/packages/orq-rc/src/funcs/filesGet.ts +1 -1
- package/packages/orq-rc/src/funcs/filesList.ts +1 -1
- package/packages/orq-rc/src/funcs/knowledgeCreate.ts +1 -1
- package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +1 -1
- package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +1 -1
- package/packages/orq-rc/src/funcs/knowledgeDelete.ts +1 -1
- package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +1 -1
- package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +1 -1
- package/packages/orq-rc/src/funcs/knowledgeList.ts +1 -1
- package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +1 -1
- package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +1 -1
- package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +1 -1
- package/packages/orq-rc/src/funcs/{knowledgeRetrieveFileUrl.ts → knowledgeRetrieveChunk.ts} +25 -34
- package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +1 -1
- package/packages/orq-rc/src/funcs/knowledgeSearch.ts +1 -1
- package/packages/orq-rc/src/funcs/knowledgeUpdate.ts +1 -1
- package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +1 -1
- package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +164 -0
- package/packages/orq-rc/src/funcs/promptsCreate.ts +1 -1
- package/packages/orq-rc/src/funcs/promptsDelete.ts +1 -1
- package/packages/orq-rc/src/funcs/promptsGetVersion.ts +1 -1
- package/packages/orq-rc/src/funcs/promptsList.ts +1 -1
- package/packages/orq-rc/src/funcs/promptsListVersions.ts +1 -1
- package/packages/orq-rc/src/funcs/promptsRetrieve.ts +1 -1
- package/packages/orq-rc/src/funcs/promptsUpdate.ts +1 -1
- package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +1 -1
- package/packages/orq-rc/src/lib/config.ts +3 -3
- package/packages/orq-rc/src/mcp-server/mcp-server.ts +1 -1
- package/packages/orq-rc/src/mcp-server/server.ts +5 -3
- package/packages/orq-rc/src/mcp-server/tools/{knowledgeRetrieveFileUrl.ts → knowledgeRetrieveChunk.ts} +6 -6
- package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateDatasource.ts +35 -0
- package/packages/orq-rc/src/models/operations/bulkcreatedatapoints.ts +2 -2
- package/packages/orq-rc/src/models/operations/createchunk.ts +2 -2
- package/packages/orq-rc/src/models/operations/createcontact.ts +2 -2
- package/packages/orq-rc/src/models/operations/createdataset.ts +2 -2
- package/packages/orq-rc/src/models/operations/createdatasetitem.ts +2 -2
- package/packages/orq-rc/src/models/operations/createdatasource.ts +2 -2
- package/packages/orq-rc/src/models/operations/createknowledge.ts +324 -2562
- package/packages/orq-rc/src/models/operations/fileget.ts +2 -2
- package/packages/orq-rc/src/models/operations/filelist.ts +2 -2
- package/packages/orq-rc/src/models/operations/fileupload.ts +2 -2
- package/packages/orq-rc/src/models/operations/getonechunk.ts +265 -0
- package/packages/orq-rc/src/models/operations/getoneknowledge.ts +101 -1282
- package/packages/orq-rc/src/models/operations/index.ts +2 -1
- package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +2 -2
- package/packages/orq-rc/src/models/operations/listdatasets.ts +2 -2
- package/packages/orq-rc/src/models/operations/listdatasources.ts +2 -2
- package/packages/orq-rc/src/models/operations/listknowledgebases.ts +101 -1309
- package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +2 -2
- package/packages/orq-rc/src/models/operations/retrievedataset.ts +2 -2
- package/packages/orq-rc/src/models/operations/retrievedatasource.ts +2 -2
- package/packages/orq-rc/src/models/operations/updatedatapoint.ts +2 -2
- package/packages/orq-rc/src/models/operations/updatedataset.ts +25 -6
- package/packages/orq-rc/src/models/operations/updatedatasource.ts +345 -0
- package/packages/orq-rc/src/models/operations/updateknowledge.ts +383 -2710
- package/packages/orq-rc/src/models/operations/updateprompt.ts +7 -0
- package/packages/orq-rc/src/sdk/knowledge.ts +30 -15
- package/src/lib/config.ts +3 -3
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +1 -1
- package/src/models/operations/bulkcreatedatapoints.ts +2 -2
- package/src/models/operations/createcontact.ts +2 -2
- package/src/models/operations/createdataset.ts +2 -2
- package/src/models/operations/createdatasetitem.ts +2 -2
- package/src/models/operations/fileget.ts +2 -2
- package/src/models/operations/filelist.ts +2 -2
- package/src/models/operations/fileupload.ts +2 -2
- package/src/models/operations/listdatasetdatapoints.ts +2 -2
- package/src/models/operations/listdatasets.ts +2 -2
- package/src/models/operations/retrievedatapoint.ts +2 -2
- package/src/models/operations/retrievedataset.ts +2 -2
- package/src/models/operations/updatedatapoint.ts +2 -2
- package/src/models/operations/updatedataset.ts +2 -2
- package/packages/orq-rc/src/models/operations/getonefileuploadurl.ts +0 -157
|
@@ -11,15 +11,16 @@
|
|
|
11
11
|
* [update](#update) - Updates a knowledge
|
|
12
12
|
* [delete](#delete) - Deletes a knowledge
|
|
13
13
|
* [search](#search) - Retrieves the documents used for retrieval
|
|
14
|
-
* [retrieveFileUrl](#retrievefileurl) - Retrieves the file upload url
|
|
15
14
|
* [listDatasources](#listdatasources) - List all datasources
|
|
16
15
|
* [createDatasource](#createdatasource) - Create a new datasource
|
|
17
16
|
* [retrieveDatasource](#retrievedatasource) - Retrieve a datasource
|
|
18
17
|
* [deleteDatasource](#deletedatasource) - Deletes a datasource
|
|
18
|
+
* [updateDatasource](#updatedatasource) - Update a datasource
|
|
19
19
|
* [createChunks](#createchunks) - Create chunks for a datasource
|
|
20
20
|
* [listChunks](#listchunks) - List all chunks for a datasource
|
|
21
21
|
* [updateChunk](#updatechunk) - Update a chunk
|
|
22
22
|
* [deleteChunk](#deletechunk) - Delete a chunk
|
|
23
|
+
* [retrieveChunk](#retrievechunk) - Retrieve a chunk
|
|
23
24
|
|
|
24
25
|
## list
|
|
25
26
|
|
|
@@ -109,7 +110,7 @@ const orq = new Orq({
|
|
|
109
110
|
async function run() {
|
|
110
111
|
const result = await orq.knowledge.create({
|
|
111
112
|
key: "<key>",
|
|
112
|
-
|
|
113
|
+
embeddingModel: "<value>",
|
|
113
114
|
path: "Customer Service/Billing/Refund",
|
|
114
115
|
});
|
|
115
116
|
|
|
@@ -137,7 +138,7 @@ const orq = new OrqCore({
|
|
|
137
138
|
async function run() {
|
|
138
139
|
const res = await knowledgeCreate(orq, {
|
|
139
140
|
key: "<key>",
|
|
140
|
-
|
|
141
|
+
embeddingModel: "<value>",
|
|
141
142
|
path: "Customer Service/Billing/Refund",
|
|
142
143
|
});
|
|
143
144
|
|
|
@@ -487,9 +488,9 @@ run();
|
|
|
487
488
|
| --------------- | --------------- | --------------- |
|
|
488
489
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
489
490
|
|
|
490
|
-
##
|
|
491
|
+
## listDatasources
|
|
491
492
|
|
|
492
|
-
|
|
493
|
+
List all datasources
|
|
493
494
|
|
|
494
495
|
### Example Usage
|
|
495
496
|
|
|
@@ -501,11 +502,9 @@ const orq = new Orq({
|
|
|
501
502
|
});
|
|
502
503
|
|
|
503
504
|
async function run() {
|
|
504
|
-
const result = await orq.knowledge.
|
|
505
|
+
const result = await orq.knowledge.listDatasources({
|
|
505
506
|
knowledgeId: "<id>",
|
|
506
|
-
|
|
507
|
-
contentType: "<value>",
|
|
508
|
-
datasourceId: "<id>",
|
|
507
|
+
status: "completed",
|
|
509
508
|
});
|
|
510
509
|
|
|
511
510
|
// Handle the result
|
|
@@ -521,7 +520,7 @@ The standalone function version of this method:
|
|
|
521
520
|
|
|
522
521
|
```typescript
|
|
523
522
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
524
|
-
import {
|
|
523
|
+
import { knowledgeListDatasources } from "@orq-ai/node/funcs/knowledgeListDatasources.js";
|
|
525
524
|
|
|
526
525
|
// Use `OrqCore` for best tree-shaking performance.
|
|
527
526
|
// You can create one instance of it to use across an application.
|
|
@@ -530,11 +529,9 @@ const orq = new OrqCore({
|
|
|
530
529
|
});
|
|
531
530
|
|
|
532
531
|
async function run() {
|
|
533
|
-
const res = await
|
|
532
|
+
const res = await knowledgeListDatasources(orq, {
|
|
534
533
|
knowledgeId: "<id>",
|
|
535
|
-
|
|
536
|
-
contentType: "<value>",
|
|
537
|
-
datasourceId: "<id>",
|
|
534
|
+
status: "completed",
|
|
538
535
|
});
|
|
539
536
|
|
|
540
537
|
if (!res.ok) {
|
|
@@ -554,25 +551,24 @@ run();
|
|
|
554
551
|
|
|
555
552
|
| Parameter | Type | Required | Description |
|
|
556
553
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
557
|
-
| `request` | [operations.
|
|
554
|
+
| `request` | [operations.ListDatasourcesRequest](../../models/operations/listdatasourcesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
558
555
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
559
556
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
560
557
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
561
558
|
|
|
562
559
|
### Response
|
|
563
560
|
|
|
564
|
-
**Promise\<[operations.
|
|
561
|
+
**Promise\<[operations.ListDatasourcesResponseBody](../../models/operations/listdatasourcesresponsebody.md)\>**
|
|
565
562
|
|
|
566
563
|
### Errors
|
|
567
564
|
|
|
568
|
-
| Error Type
|
|
569
|
-
|
|
|
570
|
-
| errors.
|
|
571
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
565
|
+
| Error Type | Status Code | Content Type |
|
|
566
|
+
| --------------- | --------------- | --------------- |
|
|
567
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
572
568
|
|
|
573
|
-
##
|
|
569
|
+
## createDatasource
|
|
574
570
|
|
|
575
|
-
|
|
571
|
+
Create a new datasource
|
|
576
572
|
|
|
577
573
|
### Example Usage
|
|
578
574
|
|
|
@@ -584,9 +580,9 @@ const orq = new Orq({
|
|
|
584
580
|
});
|
|
585
581
|
|
|
586
582
|
async function run() {
|
|
587
|
-
const result = await orq.knowledge.
|
|
583
|
+
const result = await orq.knowledge.createDatasource({
|
|
588
584
|
knowledgeId: "<id>",
|
|
589
|
-
|
|
585
|
+
requestBody: {},
|
|
590
586
|
});
|
|
591
587
|
|
|
592
588
|
// Handle the result
|
|
@@ -602,7 +598,7 @@ The standalone function version of this method:
|
|
|
602
598
|
|
|
603
599
|
```typescript
|
|
604
600
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
605
|
-
import {
|
|
601
|
+
import { knowledgeCreateDatasource } from "@orq-ai/node/funcs/knowledgeCreateDatasource.js";
|
|
606
602
|
|
|
607
603
|
// Use `OrqCore` for best tree-shaking performance.
|
|
608
604
|
// You can create one instance of it to use across an application.
|
|
@@ -611,9 +607,9 @@ const orq = new OrqCore({
|
|
|
611
607
|
});
|
|
612
608
|
|
|
613
609
|
async function run() {
|
|
614
|
-
const res = await
|
|
610
|
+
const res = await knowledgeCreateDatasource(orq, {
|
|
615
611
|
knowledgeId: "<id>",
|
|
616
|
-
|
|
612
|
+
requestBody: {},
|
|
617
613
|
});
|
|
618
614
|
|
|
619
615
|
if (!res.ok) {
|
|
@@ -633,14 +629,14 @@ run();
|
|
|
633
629
|
|
|
634
630
|
| Parameter | Type | Required | Description |
|
|
635
631
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
636
|
-
| `request` | [operations.
|
|
632
|
+
| `request` | [operations.CreateDatasourceRequest](../../models/operations/createdatasourcerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
637
633
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
638
634
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
639
635
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
640
636
|
|
|
641
637
|
### Response
|
|
642
638
|
|
|
643
|
-
**Promise\<[operations.
|
|
639
|
+
**Promise\<[operations.CreateDatasourceResponseBody](../../models/operations/createdatasourceresponsebody.md)\>**
|
|
644
640
|
|
|
645
641
|
### Errors
|
|
646
642
|
|
|
@@ -648,9 +644,9 @@ run();
|
|
|
648
644
|
| --------------- | --------------- | --------------- |
|
|
649
645
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
650
646
|
|
|
651
|
-
##
|
|
647
|
+
## retrieveDatasource
|
|
652
648
|
|
|
653
|
-
|
|
649
|
+
Retrieve a datasource
|
|
654
650
|
|
|
655
651
|
### Example Usage
|
|
656
652
|
|
|
@@ -662,9 +658,9 @@ const orq = new Orq({
|
|
|
662
658
|
});
|
|
663
659
|
|
|
664
660
|
async function run() {
|
|
665
|
-
const result = await orq.knowledge.
|
|
661
|
+
const result = await orq.knowledge.retrieveDatasource({
|
|
666
662
|
knowledgeId: "<id>",
|
|
667
|
-
|
|
663
|
+
datasourceId: "<id>",
|
|
668
664
|
});
|
|
669
665
|
|
|
670
666
|
// Handle the result
|
|
@@ -680,7 +676,7 @@ The standalone function version of this method:
|
|
|
680
676
|
|
|
681
677
|
```typescript
|
|
682
678
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
683
|
-
import {
|
|
679
|
+
import { knowledgeRetrieveDatasource } from "@orq-ai/node/funcs/knowledgeRetrieveDatasource.js";
|
|
684
680
|
|
|
685
681
|
// Use `OrqCore` for best tree-shaking performance.
|
|
686
682
|
// You can create one instance of it to use across an application.
|
|
@@ -689,9 +685,9 @@ const orq = new OrqCore({
|
|
|
689
685
|
});
|
|
690
686
|
|
|
691
687
|
async function run() {
|
|
692
|
-
const res = await
|
|
688
|
+
const res = await knowledgeRetrieveDatasource(orq, {
|
|
693
689
|
knowledgeId: "<id>",
|
|
694
|
-
|
|
690
|
+
datasourceId: "<id>",
|
|
695
691
|
});
|
|
696
692
|
|
|
697
693
|
if (!res.ok) {
|
|
@@ -711,14 +707,14 @@ run();
|
|
|
711
707
|
|
|
712
708
|
| Parameter | Type | Required | Description |
|
|
713
709
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
714
|
-
| `request` | [operations.
|
|
710
|
+
| `request` | [operations.RetrieveDatasourceRequest](../../models/operations/retrievedatasourcerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
715
711
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
716
712
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
717
713
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
718
714
|
|
|
719
715
|
### Response
|
|
720
716
|
|
|
721
|
-
**Promise\<[operations.
|
|
717
|
+
**Promise\<[operations.RetrieveDatasourceResponseBody](../../models/operations/retrievedatasourceresponsebody.md)\>**
|
|
722
718
|
|
|
723
719
|
### Errors
|
|
724
720
|
|
|
@@ -726,9 +722,9 @@ run();
|
|
|
726
722
|
| --------------- | --------------- | --------------- |
|
|
727
723
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
728
724
|
|
|
729
|
-
##
|
|
725
|
+
## deleteDatasource
|
|
730
726
|
|
|
731
|
-
|
|
727
|
+
Deletes a datasource from a knowledge base. Deleting a datasource will remove it from the knowledge base and all associated chunks. This action is irreversible and cannot be undone.
|
|
732
728
|
|
|
733
729
|
### Example Usage
|
|
734
730
|
|
|
@@ -740,13 +736,12 @@ const orq = new Orq({
|
|
|
740
736
|
});
|
|
741
737
|
|
|
742
738
|
async function run() {
|
|
743
|
-
|
|
739
|
+
await orq.knowledge.deleteDatasource({
|
|
744
740
|
knowledgeId: "<id>",
|
|
745
741
|
datasourceId: "<id>",
|
|
746
742
|
});
|
|
747
743
|
|
|
748
|
-
|
|
749
|
-
console.log(result);
|
|
744
|
+
|
|
750
745
|
}
|
|
751
746
|
|
|
752
747
|
run();
|
|
@@ -758,7 +753,7 @@ The standalone function version of this method:
|
|
|
758
753
|
|
|
759
754
|
```typescript
|
|
760
755
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
761
|
-
import {
|
|
756
|
+
import { knowledgeDeleteDatasource } from "@orq-ai/node/funcs/knowledgeDeleteDatasource.js";
|
|
762
757
|
|
|
763
758
|
// Use `OrqCore` for best tree-shaking performance.
|
|
764
759
|
// You can create one instance of it to use across an application.
|
|
@@ -767,7 +762,7 @@ const orq = new OrqCore({
|
|
|
767
762
|
});
|
|
768
763
|
|
|
769
764
|
async function run() {
|
|
770
|
-
const res = await
|
|
765
|
+
const res = await knowledgeDeleteDatasource(orq, {
|
|
771
766
|
knowledgeId: "<id>",
|
|
772
767
|
datasourceId: "<id>",
|
|
773
768
|
});
|
|
@@ -778,8 +773,7 @@ async function run() {
|
|
|
778
773
|
|
|
779
774
|
const { value: result } = res;
|
|
780
775
|
|
|
781
|
-
|
|
782
|
-
console.log(result);
|
|
776
|
+
|
|
783
777
|
}
|
|
784
778
|
|
|
785
779
|
run();
|
|
@@ -789,14 +783,14 @@ run();
|
|
|
789
783
|
|
|
790
784
|
| Parameter | Type | Required | Description |
|
|
791
785
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
792
|
-
| `request` | [operations.
|
|
786
|
+
| `request` | [operations.DeleteDatasourceRequest](../../models/operations/deletedatasourcerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
793
787
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
794
788
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
795
789
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
796
790
|
|
|
797
791
|
### Response
|
|
798
792
|
|
|
799
|
-
**Promise\<
|
|
793
|
+
**Promise\<void\>**
|
|
800
794
|
|
|
801
795
|
### Errors
|
|
802
796
|
|
|
@@ -804,9 +798,9 @@ run();
|
|
|
804
798
|
| --------------- | --------------- | --------------- |
|
|
805
799
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
806
800
|
|
|
807
|
-
##
|
|
801
|
+
## updateDatasource
|
|
808
802
|
|
|
809
|
-
|
|
803
|
+
Update a datasource
|
|
810
804
|
|
|
811
805
|
### Example Usage
|
|
812
806
|
|
|
@@ -818,12 +812,16 @@ const orq = new Orq({
|
|
|
818
812
|
});
|
|
819
813
|
|
|
820
814
|
async function run() {
|
|
821
|
-
await orq.knowledge.
|
|
815
|
+
const result = await orq.knowledge.updateDatasource({
|
|
822
816
|
knowledgeId: "<id>",
|
|
823
817
|
datasourceId: "<id>",
|
|
818
|
+
requestBody: {
|
|
819
|
+
displayName: "Haylee_Braun",
|
|
820
|
+
},
|
|
824
821
|
});
|
|
825
822
|
|
|
826
|
-
|
|
823
|
+
// Handle the result
|
|
824
|
+
console.log(result);
|
|
827
825
|
}
|
|
828
826
|
|
|
829
827
|
run();
|
|
@@ -835,7 +833,7 @@ The standalone function version of this method:
|
|
|
835
833
|
|
|
836
834
|
```typescript
|
|
837
835
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
838
|
-
import {
|
|
836
|
+
import { knowledgeUpdateDatasource } from "@orq-ai/node/funcs/knowledgeUpdateDatasource.js";
|
|
839
837
|
|
|
840
838
|
// Use `OrqCore` for best tree-shaking performance.
|
|
841
839
|
// You can create one instance of it to use across an application.
|
|
@@ -844,9 +842,12 @@ const orq = new OrqCore({
|
|
|
844
842
|
});
|
|
845
843
|
|
|
846
844
|
async function run() {
|
|
847
|
-
const res = await
|
|
845
|
+
const res = await knowledgeUpdateDatasource(orq, {
|
|
848
846
|
knowledgeId: "<id>",
|
|
849
847
|
datasourceId: "<id>",
|
|
848
|
+
requestBody: {
|
|
849
|
+
displayName: "Haylee_Braun",
|
|
850
|
+
},
|
|
850
851
|
});
|
|
851
852
|
|
|
852
853
|
if (!res.ok) {
|
|
@@ -855,7 +856,8 @@ async function run() {
|
|
|
855
856
|
|
|
856
857
|
const { value: result } = res;
|
|
857
858
|
|
|
858
|
-
|
|
859
|
+
// Handle the result
|
|
860
|
+
console.log(result);
|
|
859
861
|
}
|
|
860
862
|
|
|
861
863
|
run();
|
|
@@ -865,14 +867,14 @@ run();
|
|
|
865
867
|
|
|
866
868
|
| Parameter | Type | Required | Description |
|
|
867
869
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
868
|
-
| `request` | [operations.
|
|
870
|
+
| `request` | [operations.UpdateDatasourceRequest](../../models/operations/updatedatasourcerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
869
871
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
870
872
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
871
873
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
872
874
|
|
|
873
875
|
### Response
|
|
874
876
|
|
|
875
|
-
**Promise\<
|
|
877
|
+
**Promise\<[operations.UpdateDatasourceResponseBody](../../models/operations/updatedatasourceresponsebody.md)\>**
|
|
876
878
|
|
|
877
879
|
### Errors
|
|
878
880
|
|
|
@@ -1192,6 +1194,86 @@ run();
|
|
|
1192
1194
|
|
|
1193
1195
|
### Errors
|
|
1194
1196
|
|
|
1197
|
+
| Error Type | Status Code | Content Type |
|
|
1198
|
+
| --------------- | --------------- | --------------- |
|
|
1199
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
1200
|
+
|
|
1201
|
+
## retrieveChunk
|
|
1202
|
+
|
|
1203
|
+
Retrieve a chunk
|
|
1204
|
+
|
|
1205
|
+
### Example Usage
|
|
1206
|
+
|
|
1207
|
+
```typescript
|
|
1208
|
+
import { Orq } from "@orq-ai/node";
|
|
1209
|
+
|
|
1210
|
+
const orq = new Orq({
|
|
1211
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
1212
|
+
});
|
|
1213
|
+
|
|
1214
|
+
async function run() {
|
|
1215
|
+
const result = await orq.knowledge.retrieveChunk({
|
|
1216
|
+
chunkId: "<id>",
|
|
1217
|
+
datasourceId: "<id>",
|
|
1218
|
+
knowledgeId: "<id>",
|
|
1219
|
+
});
|
|
1220
|
+
|
|
1221
|
+
// Handle the result
|
|
1222
|
+
console.log(result);
|
|
1223
|
+
}
|
|
1224
|
+
|
|
1225
|
+
run();
|
|
1226
|
+
```
|
|
1227
|
+
|
|
1228
|
+
### Standalone function
|
|
1229
|
+
|
|
1230
|
+
The standalone function version of this method:
|
|
1231
|
+
|
|
1232
|
+
```typescript
|
|
1233
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
1234
|
+
import { knowledgeRetrieveChunk } from "@orq-ai/node/funcs/knowledgeRetrieveChunk.js";
|
|
1235
|
+
|
|
1236
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
1237
|
+
// You can create one instance of it to use across an application.
|
|
1238
|
+
const orq = new OrqCore({
|
|
1239
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
1240
|
+
});
|
|
1241
|
+
|
|
1242
|
+
async function run() {
|
|
1243
|
+
const res = await knowledgeRetrieveChunk(orq, {
|
|
1244
|
+
chunkId: "<id>",
|
|
1245
|
+
datasourceId: "<id>",
|
|
1246
|
+
knowledgeId: "<id>",
|
|
1247
|
+
});
|
|
1248
|
+
|
|
1249
|
+
if (!res.ok) {
|
|
1250
|
+
throw res.error;
|
|
1251
|
+
}
|
|
1252
|
+
|
|
1253
|
+
const { value: result } = res;
|
|
1254
|
+
|
|
1255
|
+
// Handle the result
|
|
1256
|
+
console.log(result);
|
|
1257
|
+
}
|
|
1258
|
+
|
|
1259
|
+
run();
|
|
1260
|
+
```
|
|
1261
|
+
|
|
1262
|
+
### Parameters
|
|
1263
|
+
|
|
1264
|
+
| Parameter | Type | Required | Description |
|
|
1265
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1266
|
+
| `request` | [operations.GetOneChunkRequest](../../models/operations/getonechunkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1267
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1268
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1269
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1270
|
+
|
|
1271
|
+
### Response
|
|
1272
|
+
|
|
1273
|
+
**Promise\<[operations.GetOneChunkResponseBody](../../models/operations/getonechunkresponsebody.md)\>**
|
|
1274
|
+
|
|
1275
|
+
### Errors
|
|
1276
|
+
|
|
1195
1277
|
| Error Type | Status Code | Content Type |
|
|
1196
1278
|
| --------------- | --------------- | --------------- |
|
|
1197
1279
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
@@ -317,6 +317,9 @@ const orq = new Orq({
|
|
|
317
317
|
async function run() {
|
|
318
318
|
const result = await orq.prompts.update({
|
|
319
319
|
id: "<id>",
|
|
320
|
+
requestBody: {
|
|
321
|
+
path: "Customer Service/Billing/Refund",
|
|
322
|
+
},
|
|
320
323
|
});
|
|
321
324
|
|
|
322
325
|
// Handle the result
|
|
@@ -343,6 +346,9 @@ const orq = new OrqCore({
|
|
|
343
346
|
async function run() {
|
|
344
347
|
const res = await promptsUpdate(orq, {
|
|
345
348
|
id: "<id>",
|
|
349
|
+
requestBody: {
|
|
350
|
+
path: "Customer Service/Billing/Refund",
|
|
351
|
+
},
|
|
346
352
|
});
|
|
347
353
|
|
|
348
354
|
if (!res.ok) {
|
package/packages/orq-rc/jsr.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orq-ai/node",
|
|
3
|
-
"version": "3.3.0-rc.
|
|
3
|
+
"version": "3.3.0-rc.19",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "@orq-ai/node",
|
|
9
|
-
"version": "3.3.0-rc.
|
|
9
|
+
"version": "3.3.0-rc.19",
|
|
10
10
|
"bin": {
|
|
11
11
|
"mcp": "bin/mcp-server.js"
|
|
12
12
|
},
|