@orq-ai/node 3.14.35 → 3.14.37
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/README.md +1 -1
- package/bin/mcp-server.js +529 -517
- package/bin/mcp-server.js.map +52 -52
- package/docs/sdks/deployments/README.md +43 -43
- package/examples/package-lock.json +2 -8
- package/funcs/deploymentsInvoke.d.ts +1 -1
- package/funcs/deploymentsInvoke.d.ts.map +1 -1
- package/funcs/deploymentsInvoke.js +1 -1
- package/funcs/deploymentsInvoke.js.map +1 -1
- 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 +2 -2
- package/mcp-server/server.js.map +1 -1
- package/mcp-server/tools/deploymentsInvoke.d.ts +1 -1
- package/mcp-server/tools/deploymentsInvoke.js +1 -1
- package/mcp-server/tools/deploymentsInvoke.js.map +1 -1
- package/models/components/index.d.ts +1 -1
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +1 -1
- package/models/components/index.js.map +1 -1
- package/models/components/{deployments.d.ts → invokedeploymentrequest.d.ts} +280 -266
- package/models/components/invokedeploymentrequest.d.ts.map +1 -0
- package/models/components/{deployments.js → invokedeploymentrequest.js} +377 -363
- package/models/components/invokedeploymentrequest.js.map +1 -0
- package/models/operations/createbudget.js +2 -2
- package/models/operations/createcontact.js +2 -2
- package/models/operations/createdataset.js +2 -2
- package/models/operations/createdatasetitem.js +8 -8
- package/models/operations/createdatasource.js +2 -2
- package/models/operations/createeval.js +28 -28
- package/models/operations/createprompt.d.ts +2 -0
- package/models/operations/createprompt.d.ts.map +1 -1
- package/models/operations/createprompt.js +2 -0
- package/models/operations/createprompt.js.map +1 -1
- package/models/operations/createtool.js +10 -10
- package/models/operations/deploymentgetconfig.d.ts +42 -32
- package/models/operations/deploymentgetconfig.d.ts.map +1 -1
- package/models/operations/deploymentgetconfig.js +42 -42
- package/models/operations/deploymentgetconfig.js.map +1 -1
- package/models/operations/deploymentinvoke.d.ts +15 -15
- package/models/operations/deploymentinvoke.d.ts.map +1 -1
- package/models/operations/deploymentinvoke.js +17 -17
- package/models/operations/deploymentinvoke.js.map +1 -1
- package/models/operations/deployments.d.ts +1 -0
- package/models/operations/deployments.d.ts.map +1 -1
- package/models/operations/deployments.js +1 -0
- package/models/operations/deployments.js.map +1 -1
- package/models/operations/deploymentstream.d.ts +41 -32
- package/models/operations/deploymentstream.d.ts.map +1 -1
- package/models/operations/deploymentstream.js +42 -41
- package/models/operations/deploymentstream.js.map +1 -1
- package/models/operations/duplicatetool.js +10 -10
- package/models/operations/fileget.js +2 -2
- package/models/operations/filelist.js +2 -2
- package/models/operations/fileupload.js +2 -2
- package/models/operations/getallprompts.d.ts +1 -0
- package/models/operations/getallprompts.d.ts.map +1 -1
- package/models/operations/getallprompts.js +1 -0
- package/models/operations/getallprompts.js.map +1 -1
- package/models/operations/getalltools.js +10 -10
- package/models/operations/getbudget.js +2 -2
- package/models/operations/getevals.js +28 -28
- package/models/operations/getoneprompt.d.ts +1 -0
- package/models/operations/getoneprompt.d.ts.map +1 -1
- package/models/operations/getoneprompt.js +1 -0
- package/models/operations/getoneprompt.js.map +1 -1
- package/models/operations/getpromptversion.d.ts +1 -0
- package/models/operations/getpromptversion.d.ts.map +1 -1
- package/models/operations/getpromptversion.js +1 -0
- package/models/operations/getpromptversion.js.map +1 -1
- package/models/operations/listbudgets.js +2 -2
- package/models/operations/listcontacts.js +2 -2
- package/models/operations/listdatasetdatapoints.js +8 -8
- package/models/operations/listdatasets.js +2 -2
- package/models/operations/listdatasources.js +2 -2
- package/models/operations/listpromptversions.d.ts +1 -0
- package/models/operations/listpromptversions.d.ts.map +1 -1
- package/models/operations/listpromptversions.js +1 -0
- package/models/operations/listpromptversions.js.map +1 -1
- package/models/operations/retrievecontact.js +2 -2
- package/models/operations/retrievedatapoint.js +8 -8
- package/models/operations/retrievedataset.js +2 -2
- package/models/operations/retrievedatasource.js +2 -2
- package/models/operations/retrievetool.js +10 -10
- package/models/operations/searchknowledge.d.ts +41 -32
- package/models/operations/searchknowledge.d.ts.map +1 -1
- package/models/operations/searchknowledge.js +40 -40
- package/models/operations/searchknowledge.js.map +1 -1
- package/models/operations/updatebudget.js +2 -2
- package/models/operations/updatecontact.js +2 -2
- package/models/operations/updatedatapoint.js +8 -8
- package/models/operations/updatedataset.js +2 -2
- package/models/operations/updatedatasource.js +2 -2
- package/models/operations/updateeval.js +28 -28
- package/models/operations/updateprompt.d.ts +2 -0
- package/models/operations/updateprompt.d.ts.map +1 -1
- package/models/operations/updateprompt.js +2 -0
- package/models/operations/updateprompt.js.map +1 -1
- package/models/operations/updatetool.js +10 -10
- package/package.json +2 -6
- package/packages/orq-rc/README.md +25 -23
- package/packages/orq-rc/docs/sdks/deployments/README.md +43 -43
- package/packages/orq-rc/docs/sdks/tools/README.md +93 -12
- package/packages/orq-rc/examples/package-lock.json +1 -1
- 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/deploymentsInvoke.ts +3 -3
- package/packages/orq-rc/src/funcs/toolsCreate.ts +11 -2
- package/packages/orq-rc/src/funcs/toolsSync.ts +176 -0
- 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 +4 -2
- package/packages/orq-rc/src/mcp-server/tools/deploymentsInvoke.ts +1 -1
- package/packages/orq-rc/src/mcp-server/tools/toolsSync.ts +37 -0
- package/packages/orq-rc/src/models/components/index.ts +1 -1
- package/packages/orq-rc/src/models/components/{deployments.ts → invokedeploymentrequest.ts} +822 -728
- package/packages/orq-rc/src/models/operations/createagent.ts +114 -40
- package/packages/orq-rc/src/models/operations/createbudget.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 +8 -8
- package/packages/orq-rc/src/models/operations/createdatasource.ts +2 -2
- package/packages/orq-rc/src/models/operations/createeval.ts +28 -28
- package/packages/orq-rc/src/models/operations/createprompt.ts +2 -0
- package/packages/orq-rc/src/models/operations/createtool.ts +873 -277
- package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +107 -86
- package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +35 -35
- package/packages/orq-rc/src/models/operations/deployments.ts +1 -0
- package/packages/orq-rc/src/models/operations/deploymentstream.ts +80 -78
- package/packages/orq-rc/src/models/operations/duplicateagent.ts +0 -37
- package/packages/orq-rc/src/models/operations/duplicatetool.ts +466 -87
- 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/getagent.ts +0 -38
- package/packages/orq-rc/src/models/operations/getallprompts.ts +1 -0
- package/packages/orq-rc/src/models/operations/getalltools.ts +447 -96
- package/packages/orq-rc/src/models/operations/getbudget.ts +2 -2
- package/packages/orq-rc/src/models/operations/getevals.ts +28 -28
- package/packages/orq-rc/src/models/operations/getoneprompt.ts +1 -0
- package/packages/orq-rc/src/models/operations/getpromptversion.ts +1 -0
- package/packages/orq-rc/src/models/operations/index.ts +1 -0
- package/packages/orq-rc/src/models/operations/listagents.ts +0 -37
- package/packages/orq-rc/src/models/operations/listbudgets.ts +2 -2
- package/packages/orq-rc/src/models/operations/listcontacts.ts +2 -2
- package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +8 -8
- 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/listpromptversions.ts +1 -0
- package/packages/orq-rc/src/models/operations/retrievecontact.ts +2 -2
- package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +8 -8
- 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/retrievetool.ts +466 -85
- package/packages/orq-rc/src/models/operations/runagent.ts +656 -25
- package/packages/orq-rc/src/models/operations/searchknowledge.ts +79 -70
- package/packages/orq-rc/src/models/operations/streamrunagent.ts +749 -34
- package/packages/orq-rc/src/models/operations/syncmcptool.ts +2599 -0
- package/packages/orq-rc/src/models/operations/updateagent.ts +121 -77
- package/packages/orq-rc/src/models/operations/updatebudget.ts +2 -2
- package/packages/orq-rc/src/models/operations/updatecontact.ts +2 -2
- package/packages/orq-rc/src/models/operations/updatedatapoint.ts +8 -8
- package/packages/orq-rc/src/models/operations/updatedataset.ts +2 -2
- package/packages/orq-rc/src/models/operations/updatedatasource.ts +2 -2
- package/packages/orq-rc/src/models/operations/updateeval.ts +28 -28
- package/packages/orq-rc/src/models/operations/updateprompt.ts +2 -0
- package/packages/orq-rc/src/models/operations/updatetool.ts +910 -190
- package/packages/orq-rc/src/sdk/deployments.ts +17 -17
- package/packages/orq-rc/src/sdk/tools.ts +18 -0
- package/sdk/deployments.d.ts +7 -7
- package/sdk/deployments.d.ts.map +1 -1
- package/sdk/deployments.js +9 -9
- package/sdk/deployments.js.map +1 -1
- package/src/funcs/deploymentsInvoke.ts +3 -3
- package/src/lib/config.ts +3 -3
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +2 -2
- package/src/mcp-server/tools/deploymentsInvoke.ts +1 -1
- package/src/models/components/index.ts +1 -1
- package/src/models/components/{deployments.ts → invokedeploymentrequest.ts} +822 -728
- package/src/models/operations/createbudget.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 +8 -8
- package/src/models/operations/createdatasource.ts +2 -2
- package/src/models/operations/createeval.ts +28 -28
- package/src/models/operations/createprompt.ts +2 -0
- package/src/models/operations/createtool.ts +10 -10
- package/src/models/operations/deploymentgetconfig.ts +78 -66
- package/src/models/operations/deploymentinvoke.ts +35 -35
- package/src/models/operations/deployments.ts +1 -0
- package/src/models/operations/deploymentstream.ts +80 -78
- package/src/models/operations/duplicatetool.ts +10 -10
- 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/getallprompts.ts +1 -0
- package/src/models/operations/getalltools.ts +10 -10
- package/src/models/operations/getbudget.ts +2 -2
- package/src/models/operations/getevals.ts +28 -28
- package/src/models/operations/getoneprompt.ts +1 -0
- package/src/models/operations/getpromptversion.ts +1 -0
- package/src/models/operations/listbudgets.ts +2 -2
- package/src/models/operations/listcontacts.ts +2 -2
- package/src/models/operations/listdatasetdatapoints.ts +8 -8
- package/src/models/operations/listdatasets.ts +2 -2
- package/src/models/operations/listdatasources.ts +2 -2
- package/src/models/operations/listpromptversions.ts +1 -0
- package/src/models/operations/retrievecontact.ts +2 -2
- package/src/models/operations/retrievedatapoint.ts +8 -8
- package/src/models/operations/retrievedataset.ts +2 -2
- package/src/models/operations/retrievedatasource.ts +2 -2
- package/src/models/operations/retrievetool.ts +10 -10
- package/src/models/operations/searchknowledge.ts +79 -70
- package/src/models/operations/updatebudget.ts +2 -2
- package/src/models/operations/updatecontact.ts +2 -2
- package/src/models/operations/updatedatapoint.ts +8 -8
- package/src/models/operations/updatedataset.ts +2 -2
- package/src/models/operations/updatedatasource.ts +2 -2
- package/src/models/operations/updateeval.ts +28 -28
- package/src/models/operations/updateprompt.ts +2 -0
- package/src/models/operations/updatetool.ts +10 -10
- package/src/sdk/deployments.ts +17 -17
- package/models/components/deployments.d.ts.map +0 -1
- package/models/components/deployments.js.map +0 -1
|
@@ -5,27 +5,31 @@
|
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
+
* [invoke](#invoke) - Invoke
|
|
8
9
|
* [list](#list) - List all deployments
|
|
9
10
|
* [getConfig](#getconfig) - Get config
|
|
10
|
-
* [invoke](#invoke) - Invoke
|
|
11
11
|
* [stream](#stream) - Stream
|
|
12
12
|
|
|
13
|
-
##
|
|
13
|
+
## invoke
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Invoke a deployment with a given payload
|
|
16
16
|
|
|
17
17
|
### Example Usage
|
|
18
18
|
|
|
19
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
19
|
+
<!-- UsageSnippet language="typescript" operationID="DeploymentInvoke" method="post" path="/v2/deployments/invoke" -->
|
|
20
20
|
```typescript
|
|
21
21
|
import { Orq } from "@orq-ai/node";
|
|
22
22
|
|
|
23
23
|
const orq = new Orq({
|
|
24
|
+
environment: "<value>",
|
|
25
|
+
contactId: "<id>",
|
|
24
26
|
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
25
27
|
});
|
|
26
28
|
|
|
27
29
|
async function run() {
|
|
28
|
-
const result = await orq.deployments.
|
|
30
|
+
const result = await orq.deployments.invoke({
|
|
31
|
+
key: "<key>",
|
|
32
|
+
});
|
|
29
33
|
|
|
30
34
|
console.log(result);
|
|
31
35
|
}
|
|
@@ -39,21 +43,25 @@ The standalone function version of this method:
|
|
|
39
43
|
|
|
40
44
|
```typescript
|
|
41
45
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
42
|
-
import {
|
|
46
|
+
import { deploymentsInvoke } from "@orq-ai/node/funcs/deploymentsInvoke.js";
|
|
43
47
|
|
|
44
48
|
// Use `OrqCore` for best tree-shaking performance.
|
|
45
49
|
// You can create one instance of it to use across an application.
|
|
46
50
|
const orq = new OrqCore({
|
|
51
|
+
environment: "<value>",
|
|
52
|
+
contactId: "<id>",
|
|
47
53
|
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
48
54
|
});
|
|
49
55
|
|
|
50
56
|
async function run() {
|
|
51
|
-
const res = await
|
|
57
|
+
const res = await deploymentsInvoke(orq, {
|
|
58
|
+
key: "<key>",
|
|
59
|
+
});
|
|
52
60
|
if (res.ok) {
|
|
53
61
|
const { value: result } = res;
|
|
54
62
|
console.log(result);
|
|
55
63
|
} else {
|
|
56
|
-
console.log("
|
|
64
|
+
console.log("deploymentsInvoke failed:", res.error);
|
|
57
65
|
}
|
|
58
66
|
}
|
|
59
67
|
|
|
@@ -64,29 +72,28 @@ run();
|
|
|
64
72
|
|
|
65
73
|
| Parameter | Type | Required | Description |
|
|
66
74
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
67
|
-
| `request` | [
|
|
75
|
+
| `request` | [components.InvokeDeploymentRequest](../../models/components/invokedeploymentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
68
76
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
69
77
|
| `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. |
|
|
70
78
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
71
79
|
|
|
72
80
|
### Response
|
|
73
81
|
|
|
74
|
-
**Promise\<[operations.
|
|
82
|
+
**Promise\<[operations.DeploymentInvokeResponseBody](../../models/operations/deploymentinvokeresponsebody.md)\>**
|
|
75
83
|
|
|
76
84
|
### Errors
|
|
77
85
|
|
|
78
|
-
| Error Type
|
|
79
|
-
|
|
|
80
|
-
| errors.
|
|
81
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
86
|
+
| Error Type | Status Code | Content Type |
|
|
87
|
+
| --------------- | --------------- | --------------- |
|
|
88
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
82
89
|
|
|
83
|
-
##
|
|
90
|
+
## list
|
|
84
91
|
|
|
85
|
-
|
|
92
|
+
Returns a list of your deployments. The deployments are returned sorted by creation date, with the most recent deployments appearing first.
|
|
86
93
|
|
|
87
94
|
### Example Usage
|
|
88
95
|
|
|
89
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
96
|
+
<!-- UsageSnippet language="typescript" operationID="Deployments" method="get" path="/v2/deployments" -->
|
|
90
97
|
```typescript
|
|
91
98
|
import { Orq } from "@orq-ai/node";
|
|
92
99
|
|
|
@@ -95,9 +102,7 @@ const orq = new Orq({
|
|
|
95
102
|
});
|
|
96
103
|
|
|
97
104
|
async function run() {
|
|
98
|
-
const result = await orq.deployments.
|
|
99
|
-
key: "<key>",
|
|
100
|
-
});
|
|
105
|
+
const result = await orq.deployments.list({});
|
|
101
106
|
|
|
102
107
|
console.log(result);
|
|
103
108
|
}
|
|
@@ -111,7 +116,7 @@ The standalone function version of this method:
|
|
|
111
116
|
|
|
112
117
|
```typescript
|
|
113
118
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
114
|
-
import {
|
|
119
|
+
import { deploymentsList } from "@orq-ai/node/funcs/deploymentsList.js";
|
|
115
120
|
|
|
116
121
|
// Use `OrqCore` for best tree-shaking performance.
|
|
117
122
|
// You can create one instance of it to use across an application.
|
|
@@ -120,14 +125,12 @@ const orq = new OrqCore({
|
|
|
120
125
|
});
|
|
121
126
|
|
|
122
127
|
async function run() {
|
|
123
|
-
const res = await
|
|
124
|
-
key: "<key>",
|
|
125
|
-
});
|
|
128
|
+
const res = await deploymentsList(orq, {});
|
|
126
129
|
if (res.ok) {
|
|
127
130
|
const { value: result } = res;
|
|
128
131
|
console.log(result);
|
|
129
132
|
} else {
|
|
130
|
-
console.log("
|
|
133
|
+
console.log("deploymentsList failed:", res.error);
|
|
131
134
|
}
|
|
132
135
|
}
|
|
133
136
|
|
|
@@ -138,39 +141,38 @@ run();
|
|
|
138
141
|
|
|
139
142
|
| Parameter | Type | Required | Description |
|
|
140
143
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
141
|
-
| `request` | [operations.
|
|
144
|
+
| `request` | [operations.DeploymentsRequest](../../models/operations/deploymentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
142
145
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
143
146
|
| `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. |
|
|
144
147
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
145
148
|
|
|
146
149
|
### Response
|
|
147
150
|
|
|
148
|
-
**Promise\<[operations.
|
|
151
|
+
**Promise\<[operations.DeploymentsResponseBody](../../models/operations/deploymentsresponsebody.md)\>**
|
|
149
152
|
|
|
150
153
|
### Errors
|
|
151
154
|
|
|
152
|
-
| Error Type
|
|
153
|
-
|
|
|
154
|
-
| errors.
|
|
155
|
+
| Error Type | Status Code | Content Type |
|
|
156
|
+
| ------------------- | ------------------- | ------------------- |
|
|
157
|
+
| errors.HonoApiError | 500 | application/json |
|
|
158
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
155
159
|
|
|
156
|
-
##
|
|
160
|
+
## getConfig
|
|
157
161
|
|
|
158
|
-
|
|
162
|
+
Retrieve the deployment configuration
|
|
159
163
|
|
|
160
164
|
### Example Usage
|
|
161
165
|
|
|
162
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
166
|
+
<!-- UsageSnippet language="typescript" operationID="DeploymentGetConfig" method="post" path="/v2/deployments/get_config" -->
|
|
163
167
|
```typescript
|
|
164
168
|
import { Orq } from "@orq-ai/node";
|
|
165
169
|
|
|
166
170
|
const orq = new Orq({
|
|
167
|
-
environment: "<value>",
|
|
168
|
-
contactId: "<id>",
|
|
169
171
|
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
170
172
|
});
|
|
171
173
|
|
|
172
174
|
async function run() {
|
|
173
|
-
const result = await orq.deployments.
|
|
175
|
+
const result = await orq.deployments.getConfig({
|
|
174
176
|
key: "<key>",
|
|
175
177
|
});
|
|
176
178
|
|
|
@@ -186,25 +188,23 @@ The standalone function version of this method:
|
|
|
186
188
|
|
|
187
189
|
```typescript
|
|
188
190
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
189
|
-
import {
|
|
191
|
+
import { deploymentsGetConfig } from "@orq-ai/node/funcs/deploymentsGetConfig.js";
|
|
190
192
|
|
|
191
193
|
// Use `OrqCore` for best tree-shaking performance.
|
|
192
194
|
// You can create one instance of it to use across an application.
|
|
193
195
|
const orq = new OrqCore({
|
|
194
|
-
environment: "<value>",
|
|
195
|
-
contactId: "<id>",
|
|
196
196
|
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
197
197
|
});
|
|
198
198
|
|
|
199
199
|
async function run() {
|
|
200
|
-
const res = await
|
|
200
|
+
const res = await deploymentsGetConfig(orq, {
|
|
201
201
|
key: "<key>",
|
|
202
202
|
});
|
|
203
203
|
if (res.ok) {
|
|
204
204
|
const { value: result } = res;
|
|
205
205
|
console.log(result);
|
|
206
206
|
} else {
|
|
207
|
-
console.log("
|
|
207
|
+
console.log("deploymentsGetConfig failed:", res.error);
|
|
208
208
|
}
|
|
209
209
|
}
|
|
210
210
|
|
|
@@ -215,14 +215,14 @@ run();
|
|
|
215
215
|
|
|
216
216
|
| Parameter | Type | Required | Description |
|
|
217
217
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
218
|
-
| `request` | [
|
|
218
|
+
| `request` | [operations.DeploymentGetConfigRequestBody](../../models/operations/deploymentgetconfigrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
219
219
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
220
220
|
| `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. |
|
|
221
221
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
222
222
|
|
|
223
223
|
### Response
|
|
224
224
|
|
|
225
|
-
**Promise\<[operations.
|
|
225
|
+
**Promise\<[operations.DeploymentGetConfigResponseBody](../../models/operations/deploymentgetconfigresponsebody.md)\>**
|
|
226
226
|
|
|
227
227
|
### Errors
|
|
228
228
|
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
* [delete](#delete) - Delete tool
|
|
12
12
|
* [retrieve](#retrieve) - Retrieve tool
|
|
13
13
|
* [duplicate](#duplicate) - Duplicate tool
|
|
14
|
+
* [sync](#sync) - Sync MCP tool
|
|
14
15
|
|
|
15
16
|
## list
|
|
16
17
|
|
|
@@ -104,17 +105,19 @@ async function run() {
|
|
|
104
105
|
const result = await orq.tools.create({
|
|
105
106
|
path: "Default",
|
|
106
107
|
key: "<key>",
|
|
107
|
-
displayName: "Ellie78",
|
|
108
108
|
description: "runway border pro mortally recount accredit promptly",
|
|
109
109
|
status: "live",
|
|
110
110
|
type: "json_schema",
|
|
111
111
|
jsonSchema: {
|
|
112
112
|
name: "<value>",
|
|
113
|
+
description: "lovable past madly uh-huh by",
|
|
113
114
|
schema: {
|
|
114
|
-
|
|
115
|
-
|
|
115
|
+
type: "<value>",
|
|
116
|
+
properties: {
|
|
117
|
+
"key": "<value>",
|
|
118
|
+
},
|
|
119
|
+
required: [],
|
|
116
120
|
},
|
|
117
|
-
strict: false,
|
|
118
121
|
},
|
|
119
122
|
});
|
|
120
123
|
|
|
@@ -142,17 +145,19 @@ async function run() {
|
|
|
142
145
|
const res = await toolsCreate(orq, {
|
|
143
146
|
path: "Default",
|
|
144
147
|
key: "<key>",
|
|
145
|
-
displayName: "Ellie78",
|
|
146
148
|
description: "runway border pro mortally recount accredit promptly",
|
|
147
149
|
status: "live",
|
|
148
150
|
type: "json_schema",
|
|
149
151
|
jsonSchema: {
|
|
150
152
|
name: "<value>",
|
|
153
|
+
description: "lovable past madly uh-huh by",
|
|
151
154
|
schema: {
|
|
152
|
-
|
|
153
|
-
|
|
155
|
+
type: "<value>",
|
|
156
|
+
properties: {
|
|
157
|
+
"key": "<value>",
|
|
158
|
+
},
|
|
159
|
+
required: [],
|
|
154
160
|
},
|
|
155
|
-
strict: false,
|
|
156
161
|
},
|
|
157
162
|
});
|
|
158
163
|
if (res.ok) {
|
|
@@ -181,9 +186,10 @@ run();
|
|
|
181
186
|
|
|
182
187
|
### Errors
|
|
183
188
|
|
|
184
|
-
| Error Type
|
|
185
|
-
|
|
|
186
|
-
| errors.
|
|
189
|
+
| Error Type | Status Code | Content Type |
|
|
190
|
+
| ------------------- | ------------------- | ------------------- |
|
|
191
|
+
| errors.HonoApiError | 400, 404 | application/json |
|
|
192
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
187
193
|
|
|
188
194
|
## update
|
|
189
195
|
|
|
@@ -487,4 +493,79 @@ run();
|
|
|
487
493
|
| Error Type | Status Code | Content Type |
|
|
488
494
|
| -------------------------------- | -------------------------------- | -------------------------------- |
|
|
489
495
|
| errors.DuplicateToolResponseBody | 404 | application/json |
|
|
490
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
496
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
497
|
+
|
|
498
|
+
## sync
|
|
499
|
+
|
|
500
|
+
Manually triggers tool discovery and synchronization from the MCP server. Fetches the latest tools and updates the tool configuration.
|
|
501
|
+
|
|
502
|
+
### Example Usage
|
|
503
|
+
|
|
504
|
+
<!-- UsageSnippet language="typescript" operationID="SyncMcpTool" method="post" path="/v2/tools/{tool_id}/sync" -->
|
|
505
|
+
```typescript
|
|
506
|
+
import { Orq } from "@orq-ai/node";
|
|
507
|
+
|
|
508
|
+
const orq = new Orq({
|
|
509
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
510
|
+
});
|
|
511
|
+
|
|
512
|
+
async function run() {
|
|
513
|
+
const result = await orq.tools.sync({
|
|
514
|
+
toolId: "<id>",
|
|
515
|
+
});
|
|
516
|
+
|
|
517
|
+
console.log(result);
|
|
518
|
+
}
|
|
519
|
+
|
|
520
|
+
run();
|
|
521
|
+
```
|
|
522
|
+
|
|
523
|
+
### Standalone function
|
|
524
|
+
|
|
525
|
+
The standalone function version of this method:
|
|
526
|
+
|
|
527
|
+
```typescript
|
|
528
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
529
|
+
import { toolsSync } from "@orq-ai/node/funcs/toolsSync.js";
|
|
530
|
+
|
|
531
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
532
|
+
// You can create one instance of it to use across an application.
|
|
533
|
+
const orq = new OrqCore({
|
|
534
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
535
|
+
});
|
|
536
|
+
|
|
537
|
+
async function run() {
|
|
538
|
+
const res = await toolsSync(orq, {
|
|
539
|
+
toolId: "<id>",
|
|
540
|
+
});
|
|
541
|
+
if (res.ok) {
|
|
542
|
+
const { value: result } = res;
|
|
543
|
+
console.log(result);
|
|
544
|
+
} else {
|
|
545
|
+
console.log("toolsSync failed:", res.error);
|
|
546
|
+
}
|
|
547
|
+
}
|
|
548
|
+
|
|
549
|
+
run();
|
|
550
|
+
```
|
|
551
|
+
|
|
552
|
+
### Parameters
|
|
553
|
+
|
|
554
|
+
| Parameter | Type | Required | Description |
|
|
555
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
556
|
+
| `request` | [operations.SyncMcpToolRequest](../../models/operations/syncmcptoolrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
557
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
558
|
+
| `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. |
|
|
559
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
560
|
+
|
|
561
|
+
### Response
|
|
562
|
+
|
|
563
|
+
**Promise\<[operations.SyncMcpToolResponseBody](../../models/operations/syncmcptoolresponsebody.md)\>**
|
|
564
|
+
|
|
565
|
+
### Errors
|
|
566
|
+
|
|
567
|
+
| Error Type | Status Code | Content Type |
|
|
568
|
+
| ------------------- | ------------------- | ------------------- |
|
|
569
|
+
| errors.HonoApiError | 400, 404 | application/json |
|
|
570
|
+
| errors.HonoApiError | 500 | application/json |
|
|
571
|
+
| 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": "4.0.0-rc.
|
|
3
|
+
"version": "4.0.0-rc.33",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "@orq-ai/node",
|
|
9
|
-
"version": "4.0.0-rc.
|
|
9
|
+
"version": "4.0.0-rc.33",
|
|
10
10
|
"dependencies": {
|
|
11
11
|
"zod": "^3.25.0 || ^4.0.0"
|
|
12
12
|
},
|
|
@@ -33,7 +33,7 @@ import { Result } from "../types/fp.js";
|
|
|
33
33
|
*/
|
|
34
34
|
export function deploymentsInvoke(
|
|
35
35
|
client: OrqCore,
|
|
36
|
-
request: components.
|
|
36
|
+
request: components.InvokeDeploymentRequest,
|
|
37
37
|
options?: RequestOptions,
|
|
38
38
|
): APIPromise<
|
|
39
39
|
Result<
|
|
@@ -57,7 +57,7 @@ export function deploymentsInvoke(
|
|
|
57
57
|
|
|
58
58
|
async function $do(
|
|
59
59
|
client: OrqCore,
|
|
60
|
-
request: components.
|
|
60
|
+
request: components.InvokeDeploymentRequest,
|
|
61
61
|
options?: RequestOptions,
|
|
62
62
|
): Promise<
|
|
63
63
|
[
|
|
@@ -77,7 +77,7 @@ async function $do(
|
|
|
77
77
|
> {
|
|
78
78
|
const parsed = safeParse(
|
|
79
79
|
request,
|
|
80
|
-
(value) => components.
|
|
80
|
+
(value) => components.InvokeDeploymentRequest$outboundSchema.parse(value),
|
|
81
81
|
"Input validation failed",
|
|
82
82
|
);
|
|
83
83
|
if (!parsed.ok) {
|
|
@@ -17,6 +17,7 @@ import {
|
|
|
17
17
|
RequestTimeoutError,
|
|
18
18
|
UnexpectedClientError,
|
|
19
19
|
} from "../models/errors/httpclienterrors.js";
|
|
20
|
+
import * as errors from "../models/errors/index.js";
|
|
20
21
|
import { OrqError } from "../models/errors/orqerror.js";
|
|
21
22
|
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
|
|
22
23
|
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
|
|
@@ -37,6 +38,7 @@ export function toolsCreate(
|
|
|
37
38
|
): APIPromise<
|
|
38
39
|
Result<
|
|
39
40
|
operations.CreateToolResponseBody,
|
|
41
|
+
| errors.HonoApiError
|
|
40
42
|
| OrqError
|
|
41
43
|
| ResponseValidationError
|
|
42
44
|
| ConnectionError
|
|
@@ -62,6 +64,7 @@ async function $do(
|
|
|
62
64
|
[
|
|
63
65
|
Result<
|
|
64
66
|
operations.CreateToolResponseBody,
|
|
67
|
+
| errors.HonoApiError
|
|
65
68
|
| OrqError
|
|
66
69
|
| ResponseValidationError
|
|
67
70
|
| ConnectionError
|
|
@@ -131,7 +134,7 @@ async function $do(
|
|
|
131
134
|
|
|
132
135
|
const doResult = await client._do(req, {
|
|
133
136
|
context,
|
|
134
|
-
errorCodes: ["4XX", "5XX"],
|
|
137
|
+
errorCodes: ["400", "404", "4XX", "5XX"],
|
|
135
138
|
retryConfig: context.retryConfig,
|
|
136
139
|
retryCodes: context.retryCodes,
|
|
137
140
|
});
|
|
@@ -140,8 +143,13 @@ async function $do(
|
|
|
140
143
|
}
|
|
141
144
|
const response = doResult.value;
|
|
142
145
|
|
|
146
|
+
const responseFields = {
|
|
147
|
+
HttpMeta: { Response: response, Request: req },
|
|
148
|
+
};
|
|
149
|
+
|
|
143
150
|
const [result] = await M.match<
|
|
144
151
|
operations.CreateToolResponseBody,
|
|
152
|
+
| errors.HonoApiError
|
|
145
153
|
| OrqError
|
|
146
154
|
| ResponseValidationError
|
|
147
155
|
| ConnectionError
|
|
@@ -152,9 +160,10 @@ async function $do(
|
|
|
152
160
|
| SDKValidationError
|
|
153
161
|
>(
|
|
154
162
|
M.json(200, operations.CreateToolResponseBody$inboundSchema),
|
|
163
|
+
M.jsonErr([400, 404], errors.HonoApiError$inboundSchema),
|
|
155
164
|
M.fail("4XX"),
|
|
156
165
|
M.fail("5XX"),
|
|
157
|
-
)(response, req);
|
|
166
|
+
)(response, req, { extraFields: responseFields });
|
|
158
167
|
if (!result.ok) {
|
|
159
168
|
return [result, { status: "complete", request: req, response }];
|
|
160
169
|
}
|