@orq-ai/node 3.3.12 → 3.3.14
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 +39 -39
- package/bin/mcp-server.js.map +21 -21
- package/jsr.json +1 -1
- package/lib/config.d.ts +2 -2
- package/lib/config.js +2 -2
- 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/createdatasource.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/listdatasources.js +2 -2
- package/models/operations/retrievedatapoint.js +2 -2
- package/models/operations/retrievedataset.js +2 -2
- package/models/operations/retrievedatasource.js +2 -2
- package/models/operations/updatedatapoint.js +2 -2
- package/models/operations/updatedataset.js +2 -2
- package/models/operations/updatedatasource.js +2 -2
- package/package.json +1 -1
- package/packages/orq-rc/FUNCTIONS.md +2 -4
- package/packages/orq-rc/README.md +68 -17
- package/packages/orq-rc/docs/sdks/knowledge/README.md +0 -83
- package/packages/orq-rc/docs/sdks/memorystores/README.md +1211 -0
- package/packages/orq-rc/docs/sdks/orq/README.md +74 -0
- package/packages/orq-rc/docs/sdks/sessions/README.md +385 -0
- package/packages/orq-rc/docs/sdks/tools/README.md +425 -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/memoryStoresCreate.ts +165 -0
- package/packages/orq-rc/src/funcs/memoryStoresCreateDocument.ts +169 -0
- package/packages/orq-rc/src/funcs/memoryStoresCreateMemory.ts +164 -0
- package/packages/orq-rc/src/funcs/memoryStoresDelete.ts +162 -0
- package/packages/orq-rc/src/funcs/memoryStoresDeleteDocument.ts +178 -0
- package/packages/orq-rc/src/funcs/memoryStoresDeleteMemory.ts +173 -0
- package/packages/orq-rc/src/funcs/memoryStoresList.ts +172 -0
- package/packages/orq-rc/src/funcs/memoryStoresListDocuments.ts +175 -0
- package/packages/orq-rc/src/funcs/memoryStoresListMemories.ts +170 -0
- package/packages/orq-rc/src/funcs/memoryStoresRetrieve.ts +171 -0
- package/packages/orq-rc/src/funcs/memoryStoresRetrieveDocument.ts +172 -0
- package/packages/orq-rc/src/funcs/memoryStoresRetrieveMemory.ts +167 -0
- package/packages/orq-rc/src/funcs/memoryStoresUpdate.ts +162 -0
- package/packages/orq-rc/src/funcs/memoryStoresUpdateDocument.ts +173 -0
- package/packages/orq-rc/src/funcs/memoryStoresUpdateMemory.ts +168 -0
- package/packages/orq-rc/src/funcs/postV2TracesSessionsCount.ts +155 -0
- package/packages/orq-rc/src/funcs/sessionsCreate.ts +159 -0
- package/packages/orq-rc/src/funcs/sessionsDelete.ts +170 -0
- package/packages/orq-rc/src/funcs/sessionsGet.ts +169 -0
- package/packages/orq-rc/src/funcs/sessionsList.ts +157 -0
- package/packages/orq-rc/src/funcs/sessionsUpdate.ts +170 -0
- package/packages/orq-rc/src/funcs/toolsCreate.ts +157 -0
- package/packages/orq-rc/src/funcs/toolsDelete.ts +161 -0
- package/packages/orq-rc/src/funcs/toolsList.ts +170 -0
- package/packages/orq-rc/src/funcs/toolsRetrieve.ts +160 -0
- package/packages/orq-rc/src/funcs/{knowledgeSearch.ts → toolsUpdate.ts} +18 -15
- 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/prompts.ts +8 -1
- package/packages/orq-rc/src/mcp-server/resources.ts +16 -2
- package/packages/orq-rc/src/mcp-server/server.ts +55 -5
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresCreate.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresCreateDocument.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresCreateMemory.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresDelete.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresDeleteDocument.ts +40 -0
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresDeleteMemory.ts +40 -0
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresList.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresListDocuments.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresListMemories.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresRetrieve.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresRetrieveDocument.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresRetrieveMemory.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresUpdate.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresUpdateDocument.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/memoryStoresUpdateMemory.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/postV2TracesSessionsCount.ts +36 -0
- package/packages/orq-rc/src/mcp-server/tools/sessionsCreate.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/sessionsDelete.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/{knowledgeSearch.ts → sessionsGet.ts} +8 -6
- package/packages/orq-rc/src/mcp-server/tools/sessionsList.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/sessionsUpdate.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/toolsCreate.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/toolsDelete.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/toolsList.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/toolsRetrieve.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/toolsUpdate.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools.ts +6 -3
- package/packages/orq-rc/src/models/components/deployments.ts +124 -29
- package/packages/orq-rc/src/models/operations/bulkcreatedatapoints.ts +2 -2
- package/packages/orq-rc/src/models/operations/createchunk.ts +99 -41
- 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 +10 -10
- package/packages/orq-rc/src/models/operations/createknowledge.ts +175 -14
- package/packages/orq-rc/src/models/operations/creatememory.ts +265 -0
- package/packages/orq-rc/src/models/operations/creatememorydocument.ts +284 -0
- package/packages/orq-rc/src/models/operations/creatememorystore.ts +1619 -0
- package/packages/orq-rc/src/models/operations/createprompt.ts +6 -6
- package/packages/orq-rc/src/models/operations/createsession.ts +632 -0
- package/packages/orq-rc/src/models/operations/createtool.ts +2297 -0
- package/packages/orq-rc/src/models/operations/deletememory.ts +87 -0
- package/packages/orq-rc/src/models/operations/deletememorydocument.ts +98 -0
- package/packages/orq-rc/src/models/operations/deletememorystore.ts +78 -0
- package/packages/orq-rc/src/models/operations/deletesession.ts +78 -0
- package/packages/orq-rc/src/models/operations/deletetool.ts +75 -0
- package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +57 -35
- package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +124 -29
- package/packages/orq-rc/src/models/operations/deployments.ts +3 -3
- package/packages/orq-rc/src/models/operations/deploymentstream.ts +135 -30
- 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/getallmemories.ts +315 -0
- package/packages/orq-rc/src/models/operations/getallmemorydocuments.ts +335 -0
- package/packages/orq-rc/src/models/operations/getallmemorystores.ts +1061 -0
- package/packages/orq-rc/src/models/operations/getallprompts.ts +3 -3
- package/packages/orq-rc/src/models/operations/getalltools.ts +1382 -0
- package/packages/orq-rc/src/models/operations/getonechunk.ts +8 -8
- package/packages/orq-rc/src/models/operations/getoneknowledge.ts +92 -8
- package/packages/orq-rc/src/models/operations/getoneprompt.ts +3 -3
- package/packages/orq-rc/src/models/operations/getpromptversion.ts +3 -3
- package/packages/orq-rc/src/models/operations/getsession.ts +400 -0
- package/packages/orq-rc/src/models/operations/index.ts +26 -1
- package/packages/orq-rc/src/models/operations/listchunks.ts +8 -8
- 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 +10 -10
- package/packages/orq-rc/src/models/operations/listknowledgebases.ts +94 -8
- package/packages/orq-rc/src/models/operations/listpromptversions.ts +3 -3
- package/packages/orq-rc/src/models/operations/listsessions.ts +6732 -0
- package/packages/orq-rc/src/models/operations/postv2tracessessionscount.ts +7043 -0
- 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 +10 -10
- package/packages/orq-rc/src/models/operations/retrievememory.ts +198 -0
- package/packages/orq-rc/src/models/operations/retrievememorydocument.ts +217 -0
- package/packages/orq-rc/src/models/operations/retrievememorystore.ts +944 -0
- package/packages/orq-rc/src/models/operations/retrievetool.ts +1350 -0
- package/packages/orq-rc/src/models/operations/updatechunk.ts +10 -10
- package/packages/orq-rc/src/models/operations/updatedatapoint.ts +2 -2
- package/packages/orq-rc/src/models/operations/updatedataset.ts +2 -2
- package/packages/orq-rc/src/models/operations/updatedatasource.ts +10 -10
- package/packages/orq-rc/src/models/operations/updateknowledge.ts +201 -20
- package/packages/orq-rc/src/models/operations/updatememory.ts +274 -0
- package/packages/orq-rc/src/models/operations/updatememorydocument.ts +293 -0
- package/packages/orq-rc/src/models/operations/updatememorystore.ts +1148 -0
- package/packages/orq-rc/src/models/operations/updateprompt.ts +6 -6
- package/packages/orq-rc/src/models/operations/updatesession.ts +731 -0
- package/packages/orq-rc/src/models/operations/updatetool.ts +2464 -0
- package/packages/orq-rc/src/sdk/knowledge.ts +0 -15
- package/packages/orq-rc/src/sdk/memorystores.ts +286 -0
- package/packages/orq-rc/src/sdk/sdk.ts +36 -1
- package/packages/orq-rc/src/sdk/sessions.ts +99 -0
- package/packages/orq-rc/src/sdk/tools.ts +99 -0
- package/src/lib/config.ts +2 -2
- 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/createdatasource.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/listdatasources.ts +2 -2
- package/src/models/operations/retrievedatapoint.ts +2 -2
- package/src/models/operations/retrievedataset.ts +2 -2
- package/src/models/operations/retrievedatasource.ts +2 -2
- package/src/models/operations/updatedatapoint.ts +2 -2
- package/src/models/operations/updatedataset.ts +2 -2
- package/src/models/operations/updatedatasource.ts +2 -2
- package/packages/orq-rc/src/models/operations/searchknowledge.ts +0 -1673
|
@@ -10,7 +10,6 @@
|
|
|
10
10
|
* [retrieve](#retrieve) - Retrieves a knowledge base
|
|
11
11
|
* [update](#update) - Updates a knowledge
|
|
12
12
|
* [delete](#delete) - Deletes a knowledge
|
|
13
|
-
* [search](#search) - Retrieves the documents used for retrieval
|
|
14
13
|
* [listDatasources](#listdatasources) - List all datasources
|
|
15
14
|
* [createDatasource](#createdatasource) - Create a new datasource
|
|
16
15
|
* [retrieveDatasource](#retrievedatasource) - Retrieve a datasource
|
|
@@ -406,88 +405,6 @@ run();
|
|
|
406
405
|
| --------------- | --------------- | --------------- |
|
|
407
406
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
408
407
|
|
|
409
|
-
## search
|
|
410
|
-
|
|
411
|
-
Retrieves the documents used for retrieval
|
|
412
|
-
|
|
413
|
-
### Example Usage
|
|
414
|
-
|
|
415
|
-
```typescript
|
|
416
|
-
import { Orq } from "@orq-ai/node";
|
|
417
|
-
|
|
418
|
-
const orq = new Orq({
|
|
419
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
420
|
-
});
|
|
421
|
-
|
|
422
|
-
async function run() {
|
|
423
|
-
const result = await orq.knowledge.search({
|
|
424
|
-
knowledgeId: "<id>",
|
|
425
|
-
requestBody: {
|
|
426
|
-
query: "<value>",
|
|
427
|
-
},
|
|
428
|
-
});
|
|
429
|
-
|
|
430
|
-
// Handle the result
|
|
431
|
-
console.log(result);
|
|
432
|
-
}
|
|
433
|
-
|
|
434
|
-
run();
|
|
435
|
-
```
|
|
436
|
-
|
|
437
|
-
### Standalone function
|
|
438
|
-
|
|
439
|
-
The standalone function version of this method:
|
|
440
|
-
|
|
441
|
-
```typescript
|
|
442
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
443
|
-
import { knowledgeSearch } from "@orq-ai/node/funcs/knowledgeSearch.js";
|
|
444
|
-
|
|
445
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
446
|
-
// You can create one instance of it to use across an application.
|
|
447
|
-
const orq = new OrqCore({
|
|
448
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
449
|
-
});
|
|
450
|
-
|
|
451
|
-
async function run() {
|
|
452
|
-
const res = await knowledgeSearch(orq, {
|
|
453
|
-
knowledgeId: "<id>",
|
|
454
|
-
requestBody: {
|
|
455
|
-
query: "<value>",
|
|
456
|
-
},
|
|
457
|
-
});
|
|
458
|
-
|
|
459
|
-
if (!res.ok) {
|
|
460
|
-
throw res.error;
|
|
461
|
-
}
|
|
462
|
-
|
|
463
|
-
const { value: result } = res;
|
|
464
|
-
|
|
465
|
-
// Handle the result
|
|
466
|
-
console.log(result);
|
|
467
|
-
}
|
|
468
|
-
|
|
469
|
-
run();
|
|
470
|
-
```
|
|
471
|
-
|
|
472
|
-
### Parameters
|
|
473
|
-
|
|
474
|
-
| Parameter | Type | Required | Description |
|
|
475
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
476
|
-
| `request` | [operations.SearchKnowledgeRequest](../../models/operations/searchknowledgerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
477
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
478
|
-
| `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. |
|
|
479
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
480
|
-
|
|
481
|
-
### Response
|
|
482
|
-
|
|
483
|
-
**Promise\<[operations.SearchKnowledgeResponseBody](../../models/operations/searchknowledgeresponsebody.md)\>**
|
|
484
|
-
|
|
485
|
-
### Errors
|
|
486
|
-
|
|
487
|
-
| Error Type | Status Code | Content Type |
|
|
488
|
-
| --------------- | --------------- | --------------- |
|
|
489
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
490
|
-
|
|
491
408
|
## listDatasources
|
|
492
409
|
|
|
493
410
|
List all datasources
|