@orq-ai/node 3.3.10 → 3.3.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 +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
|
@@ -0,0 +1,425 @@
|
|
|
1
|
+
# Tools
|
|
2
|
+
(*tools*)
|
|
3
|
+
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
6
|
+
### Available Operations
|
|
7
|
+
|
|
8
|
+
* [list](#list) - List tools
|
|
9
|
+
* [create](#create) - Create tool
|
|
10
|
+
* [update](#update) - Update tool
|
|
11
|
+
* [delete](#delete) - Delete tool
|
|
12
|
+
* [retrieve](#retrieve) - Retrieve tool
|
|
13
|
+
|
|
14
|
+
## list
|
|
15
|
+
|
|
16
|
+
Retrieves a paginated list of tools in the workspace. Use cursor-based pagination parameters to navigate through the results.
|
|
17
|
+
|
|
18
|
+
### Example Usage
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { Orq } from "@orq-ai/node";
|
|
22
|
+
|
|
23
|
+
const orq = new Orq({
|
|
24
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
25
|
+
});
|
|
26
|
+
|
|
27
|
+
async function run() {
|
|
28
|
+
const result = await orq.tools.list({});
|
|
29
|
+
|
|
30
|
+
// Handle the result
|
|
31
|
+
console.log(result);
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
run();
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Standalone function
|
|
38
|
+
|
|
39
|
+
The standalone function version of this method:
|
|
40
|
+
|
|
41
|
+
```typescript
|
|
42
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
43
|
+
import { toolsList } from "@orq-ai/node/funcs/toolsList.js";
|
|
44
|
+
|
|
45
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
46
|
+
// You can create one instance of it to use across an application.
|
|
47
|
+
const orq = new OrqCore({
|
|
48
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
49
|
+
});
|
|
50
|
+
|
|
51
|
+
async function run() {
|
|
52
|
+
const res = await toolsList(orq, {});
|
|
53
|
+
|
|
54
|
+
if (!res.ok) {
|
|
55
|
+
throw res.error;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
const { value: result } = res;
|
|
59
|
+
|
|
60
|
+
// Handle the result
|
|
61
|
+
console.log(result);
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
run();
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Parameters
|
|
68
|
+
|
|
69
|
+
| Parameter | Type | Required | Description |
|
|
70
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
71
|
+
| `request` | [operations.GetAllToolsRequest](../../models/operations/getalltoolsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
72
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
73
|
+
| `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. |
|
|
74
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
75
|
+
|
|
76
|
+
### Response
|
|
77
|
+
|
|
78
|
+
**Promise\<[operations.GetAllToolsResponseBody](../../models/operations/getalltoolsresponsebody.md)\>**
|
|
79
|
+
|
|
80
|
+
### Errors
|
|
81
|
+
|
|
82
|
+
| Error Type | Status Code | Content Type |
|
|
83
|
+
| ------------------- | ------------------- | ------------------- |
|
|
84
|
+
| errors.HonoApiError | 401 | application/json |
|
|
85
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
86
|
+
|
|
87
|
+
## create
|
|
88
|
+
|
|
89
|
+
Creates a new tool in the workspace.
|
|
90
|
+
|
|
91
|
+
### Example Usage
|
|
92
|
+
|
|
93
|
+
```typescript
|
|
94
|
+
import { Orq } from "@orq-ai/node";
|
|
95
|
+
|
|
96
|
+
const orq = new Orq({
|
|
97
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
98
|
+
});
|
|
99
|
+
|
|
100
|
+
async function run() {
|
|
101
|
+
const result = await orq.tools.create({
|
|
102
|
+
path: "Customer Service/Billing/Refund",
|
|
103
|
+
key: "<key>",
|
|
104
|
+
description: "delightfully fumigate convection though zowie up bulky electronics",
|
|
105
|
+
status: "pending",
|
|
106
|
+
versionHash: "<value>",
|
|
107
|
+
type: "json_schema",
|
|
108
|
+
jsonSchema: {
|
|
109
|
+
name: "<value>",
|
|
110
|
+
schema: {
|
|
111
|
+
"key": "<value>",
|
|
112
|
+
"key1": "<value>",
|
|
113
|
+
},
|
|
114
|
+
strict: false,
|
|
115
|
+
},
|
|
116
|
+
});
|
|
117
|
+
|
|
118
|
+
// Handle the result
|
|
119
|
+
console.log(result);
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
run();
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
### Standalone function
|
|
126
|
+
|
|
127
|
+
The standalone function version of this method:
|
|
128
|
+
|
|
129
|
+
```typescript
|
|
130
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
131
|
+
import { toolsCreate } from "@orq-ai/node/funcs/toolsCreate.js";
|
|
132
|
+
|
|
133
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
134
|
+
// You can create one instance of it to use across an application.
|
|
135
|
+
const orq = new OrqCore({
|
|
136
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
137
|
+
});
|
|
138
|
+
|
|
139
|
+
async function run() {
|
|
140
|
+
const res = await toolsCreate(orq, {
|
|
141
|
+
path: "Customer Service/Billing/Refund",
|
|
142
|
+
key: "<key>",
|
|
143
|
+
description: "delightfully fumigate convection though zowie up bulky electronics",
|
|
144
|
+
status: "pending",
|
|
145
|
+
versionHash: "<value>",
|
|
146
|
+
type: "json_schema",
|
|
147
|
+
jsonSchema: {
|
|
148
|
+
name: "<value>",
|
|
149
|
+
schema: {
|
|
150
|
+
"key": "<value>",
|
|
151
|
+
"key1": "<value>",
|
|
152
|
+
},
|
|
153
|
+
strict: false,
|
|
154
|
+
},
|
|
155
|
+
});
|
|
156
|
+
|
|
157
|
+
if (!res.ok) {
|
|
158
|
+
throw res.error;
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
const { value: result } = res;
|
|
162
|
+
|
|
163
|
+
// Handle the result
|
|
164
|
+
console.log(result);
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
run();
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
### Parameters
|
|
171
|
+
|
|
172
|
+
| Parameter | Type | Required | Description |
|
|
173
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
174
|
+
| `request` | [operations.CreateToolRequestBody](../../models/operations/createtoolrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
175
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
176
|
+
| `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. |
|
|
177
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
178
|
+
|
|
179
|
+
### Response
|
|
180
|
+
|
|
181
|
+
**Promise\<[operations.CreateToolResponseBody](../../models/operations/createtoolresponsebody.md)\>**
|
|
182
|
+
|
|
183
|
+
### Errors
|
|
184
|
+
|
|
185
|
+
| Error Type | Status Code | Content Type |
|
|
186
|
+
| --------------- | --------------- | --------------- |
|
|
187
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
188
|
+
|
|
189
|
+
## update
|
|
190
|
+
|
|
191
|
+
Updates a tool in the workspace.
|
|
192
|
+
|
|
193
|
+
### Example Usage
|
|
194
|
+
|
|
195
|
+
```typescript
|
|
196
|
+
import { Orq } from "@orq-ai/node";
|
|
197
|
+
|
|
198
|
+
const orq = new Orq({
|
|
199
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
200
|
+
});
|
|
201
|
+
|
|
202
|
+
async function run() {
|
|
203
|
+
const result = await orq.tools.update({
|
|
204
|
+
toolKey: "<value>",
|
|
205
|
+
requestBody: {
|
|
206
|
+
path: "Customer Service/Billing/Refund",
|
|
207
|
+
status: "pending",
|
|
208
|
+
versionHash: "<value>",
|
|
209
|
+
type: "orq_http",
|
|
210
|
+
},
|
|
211
|
+
});
|
|
212
|
+
|
|
213
|
+
// Handle the result
|
|
214
|
+
console.log(result);
|
|
215
|
+
}
|
|
216
|
+
|
|
217
|
+
run();
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
### Standalone function
|
|
221
|
+
|
|
222
|
+
The standalone function version of this method:
|
|
223
|
+
|
|
224
|
+
```typescript
|
|
225
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
226
|
+
import { toolsUpdate } from "@orq-ai/node/funcs/toolsUpdate.js";
|
|
227
|
+
|
|
228
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
229
|
+
// You can create one instance of it to use across an application.
|
|
230
|
+
const orq = new OrqCore({
|
|
231
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
232
|
+
});
|
|
233
|
+
|
|
234
|
+
async function run() {
|
|
235
|
+
const res = await toolsUpdate(orq, {
|
|
236
|
+
toolKey: "<value>",
|
|
237
|
+
requestBody: {
|
|
238
|
+
path: "Customer Service/Billing/Refund",
|
|
239
|
+
status: "pending",
|
|
240
|
+
versionHash: "<value>",
|
|
241
|
+
type: "orq_http",
|
|
242
|
+
},
|
|
243
|
+
});
|
|
244
|
+
|
|
245
|
+
if (!res.ok) {
|
|
246
|
+
throw res.error;
|
|
247
|
+
}
|
|
248
|
+
|
|
249
|
+
const { value: result } = res;
|
|
250
|
+
|
|
251
|
+
// Handle the result
|
|
252
|
+
console.log(result);
|
|
253
|
+
}
|
|
254
|
+
|
|
255
|
+
run();
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
### Parameters
|
|
259
|
+
|
|
260
|
+
| Parameter | Type | Required | Description |
|
|
261
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
262
|
+
| `request` | [operations.UpdateToolRequest](../../models/operations/updatetoolrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
263
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
264
|
+
| `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. |
|
|
265
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
266
|
+
|
|
267
|
+
### Response
|
|
268
|
+
|
|
269
|
+
**Promise\<[operations.UpdateToolResponseBody](../../models/operations/updatetoolresponsebody.md)\>**
|
|
270
|
+
|
|
271
|
+
### Errors
|
|
272
|
+
|
|
273
|
+
| Error Type | Status Code | Content Type |
|
|
274
|
+
| --------------- | --------------- | --------------- |
|
|
275
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
276
|
+
|
|
277
|
+
## delete
|
|
278
|
+
|
|
279
|
+
Deletes a tool by key.
|
|
280
|
+
|
|
281
|
+
### Example Usage
|
|
282
|
+
|
|
283
|
+
```typescript
|
|
284
|
+
import { Orq } from "@orq-ai/node";
|
|
285
|
+
|
|
286
|
+
const orq = new Orq({
|
|
287
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
288
|
+
});
|
|
289
|
+
|
|
290
|
+
async function run() {
|
|
291
|
+
await orq.tools.delete({
|
|
292
|
+
toolKey: "<value>",
|
|
293
|
+
});
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
}
|
|
297
|
+
|
|
298
|
+
run();
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
### Standalone function
|
|
302
|
+
|
|
303
|
+
The standalone function version of this method:
|
|
304
|
+
|
|
305
|
+
```typescript
|
|
306
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
307
|
+
import { toolsDelete } from "@orq-ai/node/funcs/toolsDelete.js";
|
|
308
|
+
|
|
309
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
310
|
+
// You can create one instance of it to use across an application.
|
|
311
|
+
const orq = new OrqCore({
|
|
312
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
313
|
+
});
|
|
314
|
+
|
|
315
|
+
async function run() {
|
|
316
|
+
const res = await toolsDelete(orq, {
|
|
317
|
+
toolKey: "<value>",
|
|
318
|
+
});
|
|
319
|
+
|
|
320
|
+
if (!res.ok) {
|
|
321
|
+
throw res.error;
|
|
322
|
+
}
|
|
323
|
+
|
|
324
|
+
const { value: result } = res;
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
run();
|
|
330
|
+
```
|
|
331
|
+
|
|
332
|
+
### Parameters
|
|
333
|
+
|
|
334
|
+
| Parameter | Type | Required | Description |
|
|
335
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
336
|
+
| `request` | [operations.DeleteToolRequest](../../models/operations/deletetoolrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
337
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
338
|
+
| `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. |
|
|
339
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
340
|
+
|
|
341
|
+
### Response
|
|
342
|
+
|
|
343
|
+
**Promise\<void\>**
|
|
344
|
+
|
|
345
|
+
### Errors
|
|
346
|
+
|
|
347
|
+
| Error Type | Status Code | Content Type |
|
|
348
|
+
| --------------- | --------------- | --------------- |
|
|
349
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
350
|
+
|
|
351
|
+
## retrieve
|
|
352
|
+
|
|
353
|
+
Retrieves a tool by key.
|
|
354
|
+
|
|
355
|
+
### Example Usage
|
|
356
|
+
|
|
357
|
+
```typescript
|
|
358
|
+
import { Orq } from "@orq-ai/node";
|
|
359
|
+
|
|
360
|
+
const orq = new Orq({
|
|
361
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
362
|
+
});
|
|
363
|
+
|
|
364
|
+
async function run() {
|
|
365
|
+
const result = await orq.tools.retrieve({
|
|
366
|
+
toolKey: "<value>",
|
|
367
|
+
});
|
|
368
|
+
|
|
369
|
+
// Handle the result
|
|
370
|
+
console.log(result);
|
|
371
|
+
}
|
|
372
|
+
|
|
373
|
+
run();
|
|
374
|
+
```
|
|
375
|
+
|
|
376
|
+
### Standalone function
|
|
377
|
+
|
|
378
|
+
The standalone function version of this method:
|
|
379
|
+
|
|
380
|
+
```typescript
|
|
381
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
382
|
+
import { toolsRetrieve } from "@orq-ai/node/funcs/toolsRetrieve.js";
|
|
383
|
+
|
|
384
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
385
|
+
// You can create one instance of it to use across an application.
|
|
386
|
+
const orq = new OrqCore({
|
|
387
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
388
|
+
});
|
|
389
|
+
|
|
390
|
+
async function run() {
|
|
391
|
+
const res = await toolsRetrieve(orq, {
|
|
392
|
+
toolKey: "<value>",
|
|
393
|
+
});
|
|
394
|
+
|
|
395
|
+
if (!res.ok) {
|
|
396
|
+
throw res.error;
|
|
397
|
+
}
|
|
398
|
+
|
|
399
|
+
const { value: result } = res;
|
|
400
|
+
|
|
401
|
+
// Handle the result
|
|
402
|
+
console.log(result);
|
|
403
|
+
}
|
|
404
|
+
|
|
405
|
+
run();
|
|
406
|
+
```
|
|
407
|
+
|
|
408
|
+
### Parameters
|
|
409
|
+
|
|
410
|
+
| Parameter | Type | Required | Description |
|
|
411
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
412
|
+
| `request` | [operations.RetrieveToolRequest](../../models/operations/retrievetoolrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
413
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
414
|
+
| `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. |
|
|
415
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
416
|
+
|
|
417
|
+
### Response
|
|
418
|
+
|
|
419
|
+
**Promise\<[operations.RetrieveToolResponseBody](../../models/operations/retrievetoolresponsebody.md)\>**
|
|
420
|
+
|
|
421
|
+
### Errors
|
|
422
|
+
|
|
423
|
+
| Error Type | Status Code | Content Type |
|
|
424
|
+
| --------------- | --------------- | --------------- |
|
|
425
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
package/packages/orq-rc/jsr.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orq-ai/node",
|
|
3
|
-
"version": "3.4.0-rc.
|
|
3
|
+
"version": "3.4.0-rc.21",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "@orq-ai/node",
|
|
9
|
-
"version": "3.4.0-rc.
|
|
9
|
+
"version": "3.4.0-rc.21",
|
|
10
10
|
"bin": {
|
|
11
11
|
"mcp": "bin/mcp-server.js"
|
|
12
12
|
},
|
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import { OrqCore } from "../core.js";
|
|
6
|
+
import { encodeJSON } from "../lib/encodings.js";
|
|
7
|
+
import * as M from "../lib/matchers.js";
|
|
8
|
+
import { compactMap } from "../lib/primitives.js";
|
|
9
|
+
import { safeParse } from "../lib/schemas.js";
|
|
10
|
+
import { RequestOptions } from "../lib/sdks.js";
|
|
11
|
+
import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
|
|
12
|
+
import { pathToFunc } from "../lib/url.js";
|
|
13
|
+
import { APIError } from "../models/errors/apierror.js";
|
|
14
|
+
import {
|
|
15
|
+
ConnectionError,
|
|
16
|
+
InvalidRequestError,
|
|
17
|
+
RequestAbortedError,
|
|
18
|
+
RequestTimeoutError,
|
|
19
|
+
UnexpectedClientError,
|
|
20
|
+
} from "../models/errors/httpclienterrors.js";
|
|
21
|
+
import * as errors from "../models/errors/index.js";
|
|
22
|
+
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
|
|
23
|
+
import * as operations from "../models/operations/index.js";
|
|
24
|
+
import { APICall, APIPromise } from "../types/async.js";
|
|
25
|
+
import { Result } from "../types/fp.js";
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Create memory store
|
|
29
|
+
*/
|
|
30
|
+
export function memoryStoresCreate(
|
|
31
|
+
client: OrqCore,
|
|
32
|
+
request?: operations.CreateMemoryStoreRequestBody | undefined,
|
|
33
|
+
options?: RequestOptions,
|
|
34
|
+
): APIPromise<
|
|
35
|
+
Result<
|
|
36
|
+
operations.CreateMemoryStoreResponseBody,
|
|
37
|
+
| errors.HonoApiError
|
|
38
|
+
| APIError
|
|
39
|
+
| SDKValidationError
|
|
40
|
+
| UnexpectedClientError
|
|
41
|
+
| InvalidRequestError
|
|
42
|
+
| RequestAbortedError
|
|
43
|
+
| RequestTimeoutError
|
|
44
|
+
| ConnectionError
|
|
45
|
+
>
|
|
46
|
+
> {
|
|
47
|
+
return new APIPromise($do(
|
|
48
|
+
client,
|
|
49
|
+
request,
|
|
50
|
+
options,
|
|
51
|
+
));
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
async function $do(
|
|
55
|
+
client: OrqCore,
|
|
56
|
+
request?: operations.CreateMemoryStoreRequestBody | undefined,
|
|
57
|
+
options?: RequestOptions,
|
|
58
|
+
): Promise<
|
|
59
|
+
[
|
|
60
|
+
Result<
|
|
61
|
+
operations.CreateMemoryStoreResponseBody,
|
|
62
|
+
| errors.HonoApiError
|
|
63
|
+
| APIError
|
|
64
|
+
| SDKValidationError
|
|
65
|
+
| UnexpectedClientError
|
|
66
|
+
| InvalidRequestError
|
|
67
|
+
| RequestAbortedError
|
|
68
|
+
| RequestTimeoutError
|
|
69
|
+
| ConnectionError
|
|
70
|
+
>,
|
|
71
|
+
APICall,
|
|
72
|
+
]
|
|
73
|
+
> {
|
|
74
|
+
const parsed = safeParse(
|
|
75
|
+
request,
|
|
76
|
+
(value) =>
|
|
77
|
+
operations.CreateMemoryStoreRequestBody$outboundSchema.optional().parse(
|
|
78
|
+
value,
|
|
79
|
+
),
|
|
80
|
+
"Input validation failed",
|
|
81
|
+
);
|
|
82
|
+
if (!parsed.ok) {
|
|
83
|
+
return [parsed, { status: "invalid" }];
|
|
84
|
+
}
|
|
85
|
+
const payload = parsed.value;
|
|
86
|
+
const body = payload === undefined
|
|
87
|
+
? null
|
|
88
|
+
: encodeJSON("body", payload, { explode: true });
|
|
89
|
+
|
|
90
|
+
const path = pathToFunc("/v2/memory-stores")();
|
|
91
|
+
|
|
92
|
+
const headers = new Headers(compactMap({
|
|
93
|
+
"Content-Type": "application/json",
|
|
94
|
+
Accept: "application/json",
|
|
95
|
+
}));
|
|
96
|
+
|
|
97
|
+
const secConfig = await extractSecurity(client._options.apiKey);
|
|
98
|
+
const securityInput = secConfig == null ? {} : { apiKey: secConfig };
|
|
99
|
+
const requestSecurity = resolveGlobalSecurity(securityInput);
|
|
100
|
+
|
|
101
|
+
const context = {
|
|
102
|
+
baseURL: options?.serverURL ?? client._baseURL ?? "",
|
|
103
|
+
operationID: "CreateMemoryStore",
|
|
104
|
+
oAuth2Scopes: [],
|
|
105
|
+
|
|
106
|
+
resolvedSecurity: requestSecurity,
|
|
107
|
+
|
|
108
|
+
securitySource: client._options.apiKey,
|
|
109
|
+
retryConfig: options?.retries
|
|
110
|
+
|| client._options.retryConfig
|
|
111
|
+
|| { strategy: "none" },
|
|
112
|
+
retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
|
|
113
|
+
};
|
|
114
|
+
|
|
115
|
+
const requestRes = client._createRequest(context, {
|
|
116
|
+
security: requestSecurity,
|
|
117
|
+
method: "POST",
|
|
118
|
+
baseURL: options?.serverURL,
|
|
119
|
+
path: path,
|
|
120
|
+
headers: headers,
|
|
121
|
+
body: body,
|
|
122
|
+
timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
|
|
123
|
+
}, options);
|
|
124
|
+
if (!requestRes.ok) {
|
|
125
|
+
return [requestRes, { status: "invalid" }];
|
|
126
|
+
}
|
|
127
|
+
const req = requestRes.value;
|
|
128
|
+
|
|
129
|
+
const doResult = await client._do(req, {
|
|
130
|
+
context,
|
|
131
|
+
errorCodes: ["400", "4XX", "5XX"],
|
|
132
|
+
retryConfig: context.retryConfig,
|
|
133
|
+
retryCodes: context.retryCodes,
|
|
134
|
+
});
|
|
135
|
+
if (!doResult.ok) {
|
|
136
|
+
return [doResult, { status: "request-error", request: req }];
|
|
137
|
+
}
|
|
138
|
+
const response = doResult.value;
|
|
139
|
+
|
|
140
|
+
const responseFields = {
|
|
141
|
+
HttpMeta: { Response: response, Request: req },
|
|
142
|
+
};
|
|
143
|
+
|
|
144
|
+
const [result] = await M.match<
|
|
145
|
+
operations.CreateMemoryStoreResponseBody,
|
|
146
|
+
| errors.HonoApiError
|
|
147
|
+
| APIError
|
|
148
|
+
| SDKValidationError
|
|
149
|
+
| UnexpectedClientError
|
|
150
|
+
| InvalidRequestError
|
|
151
|
+
| RequestAbortedError
|
|
152
|
+
| RequestTimeoutError
|
|
153
|
+
| ConnectionError
|
|
154
|
+
>(
|
|
155
|
+
M.json(201, operations.CreateMemoryStoreResponseBody$inboundSchema),
|
|
156
|
+
M.jsonErr(400, errors.HonoApiError$inboundSchema),
|
|
157
|
+
M.fail("4XX"),
|
|
158
|
+
M.fail("5XX"),
|
|
159
|
+
)(response, { extraFields: responseFields });
|
|
160
|
+
if (!result.ok) {
|
|
161
|
+
return [result, { status: "complete", request: req, response }];
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
return [result, { status: "complete", request: req, response }];
|
|
165
|
+
}
|