@orq-ai/node 3.1.7 → 3.2.0-rc.3
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 +0 -38
- package/docs/sdks/deployments/README.md +0 -81
- package/jsr.json +1 -2
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/config.js.map +1 -1
- package/lib/matchers.d.ts.map +1 -1
- package/lib/matchers.js +1 -4
- package/lib/matchers.js.map +1 -1
- package/models/operations/createcontact.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/index.d.ts +0 -1
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +0 -1
- package/models/operations/index.js.map +1 -1
- package/package.json +3 -2
- package/sdk/deployments.d.ts +0 -8
- package/sdk/deployments.d.ts.map +1 -1
- package/sdk/deployments.js +0 -10
- package/sdk/deployments.js.map +1 -1
- package/src/lib/config.ts +3 -3
- package/src/lib/matchers.ts +1 -4
- package/src/models/operations/createcontact.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/index.ts +0 -1
- package/src/sdk/deployments.ts +0 -19
- package/funcs/deploymentsStream.d.ts +0 -16
- package/funcs/deploymentsStream.d.ts.map +0 -1
- package/funcs/deploymentsStream.js +0 -126
- package/funcs/deploymentsStream.js.map +0 -1
- package/lib/event-streams.d.ts +0 -17
- package/lib/event-streams.d.ts.map +0 -1
- package/lib/event-streams.js +0 -220
- package/lib/event-streams.js.map +0 -1
- package/models/operations/deploymentstream.d.ts +0 -1622
- package/models/operations/deploymentstream.d.ts.map +0 -1
- package/models/operations/deploymentstream.js +0 -1571
- package/models/operations/deploymentstream.js.map +0 -1
- package/packages/orq-rc/FUNCTIONS.md +0 -106
- package/packages/orq-rc/README.md +0 -506
- package/packages/orq-rc/RUNTIMES.md +0 -48
- package/packages/orq-rc/docs/sdks/contacts/README.md +0 -84
- package/packages/orq-rc/docs/sdks/deployments/README.md +0 -235
- package/packages/orq-rc/docs/sdks/feedback/README.md +0 -92
- package/packages/orq-rc/docs/sdks/files/README.md +0 -305
- package/packages/orq-rc/docs/sdks/metrics/README.md +0 -86
- package/packages/orq-rc/docs/sdks/orq/README.md +0 -10
- package/packages/orq-rc/docs/sdks/prompts/README.md +0 -608
- package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +0 -80
- package/packages/orq-rc/jsr.json +0 -27
- package/packages/orq-rc/package-lock.json +0 -1861
- package/packages/orq-rc/package.json +0 -31
- package/packages/orq-rc/src/core.ts +0 -13
- package/packages/orq-rc/src/funcs/contactsCreate.ts +0 -127
- package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +0 -135
- package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +0 -143
- package/packages/orq-rc/src/funcs/deploymentsList.ts +0 -142
- package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +0 -135
- package/packages/orq-rc/src/funcs/feedbackCreate.ts +0 -127
- package/packages/orq-rc/src/funcs/filesCreate.ts +0 -150
- package/packages/orq-rc/src/funcs/filesDelete.ts +0 -131
- package/packages/orq-rc/src/funcs/filesGet.ts +0 -133
- package/packages/orq-rc/src/funcs/filesList.ts +0 -134
- package/packages/orq-rc/src/funcs/promptsCreate.ts +0 -127
- package/packages/orq-rc/src/funcs/promptsDelete.ts +0 -131
- package/packages/orq-rc/src/funcs/promptsGetVersion.ts +0 -147
- package/packages/orq-rc/src/funcs/promptsList.ts +0 -134
- package/packages/orq-rc/src/funcs/promptsListVersions.ts +0 -140
- package/packages/orq-rc/src/funcs/promptsRetrieve.ts +0 -133
- package/packages/orq-rc/src/funcs/promptsUpdate.ts +0 -139
- package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +0 -128
- package/packages/orq-rc/src/hooks/global.ts +0 -44
- package/packages/orq-rc/src/hooks/hooks.ts +0 -132
- package/packages/orq-rc/src/hooks/index.ts +0 -6
- package/packages/orq-rc/src/hooks/registration.ts +0 -15
- package/packages/orq-rc/src/hooks/types.ts +0 -110
- package/packages/orq-rc/src/index.ts +0 -7
- package/packages/orq-rc/src/lib/base64.ts +0 -37
- package/packages/orq-rc/src/lib/config.ts +0 -70
- package/packages/orq-rc/src/lib/dlv.ts +0 -53
- package/packages/orq-rc/src/lib/encodings.ts +0 -483
- package/packages/orq-rc/src/lib/env.ts +0 -73
- package/packages/orq-rc/src/lib/files.ts +0 -40
- package/packages/orq-rc/src/lib/http.ts +0 -323
- package/packages/orq-rc/src/lib/is-plain-object.ts +0 -43
- package/packages/orq-rc/src/lib/logger.ts +0 -9
- package/packages/orq-rc/src/lib/matchers.ts +0 -322
- package/packages/orq-rc/src/lib/primitives.ts +0 -136
- package/packages/orq-rc/src/lib/retries.ts +0 -218
- package/packages/orq-rc/src/lib/schemas.ts +0 -91
- package/packages/orq-rc/src/lib/sdks.ts +0 -400
- package/packages/orq-rc/src/lib/security.ts +0 -253
- package/packages/orq-rc/src/lib/url.ts +0 -33
- package/packages/orq-rc/src/models/components/deployments.ts +0 -1666
- package/packages/orq-rc/src/models/components/index.ts +0 -6
- package/packages/orq-rc/src/models/components/security.ts +0 -71
- package/packages/orq-rc/src/models/errors/apierror.ts +0 -27
- package/packages/orq-rc/src/models/errors/getpromptversion.ts +0 -71
- package/packages/orq-rc/src/models/errors/honoapierror.ts +0 -82
- package/packages/orq-rc/src/models/errors/httpclienterrors.ts +0 -62
- package/packages/orq-rc/src/models/errors/index.ts +0 -10
- package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +0 -97
- package/packages/orq-rc/src/models/errors/updateprompt.ts +0 -71
- package/packages/orq-rc/src/models/operations/createcontact.ts +0 -256
- package/packages/orq-rc/src/models/operations/createfeedback.ts +0 -286
- package/packages/orq-rc/src/models/operations/createprompt.ts +0 -3717
- package/packages/orq-rc/src/models/operations/deleteprompt.ts +0 -69
- package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +0 -1790
- package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +0 -3527
- package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +0 -1144
- package/packages/orq-rc/src/models/operations/deployments.ts +0 -2148
- package/packages/orq-rc/src/models/operations/filedelete.ts +0 -78
- package/packages/orq-rc/src/models/operations/fileget.ts +0 -222
- package/packages/orq-rc/src/models/operations/filelist.ts +0 -336
- package/packages/orq-rc/src/models/operations/fileupload.ts +0 -322
- package/packages/orq-rc/src/models/operations/getallprompts.ts +0 -2116
- package/packages/orq-rc/src/models/operations/getoneprompt.ts +0 -1982
- package/packages/orq-rc/src/models/operations/getpromptversion.ts +0 -2012
- package/packages/orq-rc/src/models/operations/index.ts +0 -22
- package/packages/orq-rc/src/models/operations/listpromptversions.ts +0 -2146
- package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +0 -190
- package/packages/orq-rc/src/models/operations/updateprompt.ts +0 -3900
- package/packages/orq-rc/src/sdk/contacts.ts +0 -27
- package/packages/orq-rc/src/sdk/deployments.ts +0 -70
- package/packages/orq-rc/src/sdk/feedback.ts +0 -27
- package/packages/orq-rc/src/sdk/files.ts +0 -78
- package/packages/orq-rc/src/sdk/index.ts +0 -5
- package/packages/orq-rc/src/sdk/metrics.ts +0 -27
- package/packages/orq-rc/src/sdk/prompts.ts +0 -126
- package/packages/orq-rc/src/sdk/remoteconfigs.ts +0 -24
- package/packages/orq-rc/src/sdk/sdk.ts +0 -43
- package/packages/orq-rc/src/types/blobs.ts +0 -31
- package/packages/orq-rc/src/types/constdatetime.ts +0 -15
- package/packages/orq-rc/src/types/enums.ts +0 -16
- package/packages/orq-rc/src/types/fp.ts +0 -50
- package/packages/orq-rc/src/types/index.ts +0 -11
- package/packages/orq-rc/src/types/operations.ts +0 -105
- package/packages/orq-rc/src/types/rfcdate.ts +0 -54
- package/packages/orq-rc/src/types/streams.ts +0 -21
- package/packages/orq-rc/tsconfig.json +0 -41
- package/src/funcs/deploymentsStream.ts +0 -151
- package/src/lib/event-streams.ts +0 -264
- package/src/models/operations/deploymentstream.ts +0 -3062
|
@@ -1,86 +0,0 @@
|
|
|
1
|
-
# Metrics
|
|
2
|
-
(*deployments.metrics*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [create](#create) - Add metrics
|
|
9
|
-
|
|
10
|
-
## create
|
|
11
|
-
|
|
12
|
-
Add metrics to a deployment
|
|
13
|
-
|
|
14
|
-
### Example Usage
|
|
15
|
-
|
|
16
|
-
```typescript
|
|
17
|
-
import { Orq } from "@orq-ai/node";
|
|
18
|
-
|
|
19
|
-
const orq = new Orq({
|
|
20
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
21
|
-
});
|
|
22
|
-
|
|
23
|
-
async function run() {
|
|
24
|
-
const result = await orq.deployments.metrics.create({
|
|
25
|
-
id: "<id>",
|
|
26
|
-
requestBody: {},
|
|
27
|
-
});
|
|
28
|
-
|
|
29
|
-
// Handle the result
|
|
30
|
-
console.log(result);
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
run();
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
### Standalone function
|
|
37
|
-
|
|
38
|
-
The standalone function version of this method:
|
|
39
|
-
|
|
40
|
-
```typescript
|
|
41
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
42
|
-
import { deploymentsMetricsCreate } from "@orq-ai/node/funcs/deploymentsMetricsCreate.js";
|
|
43
|
-
|
|
44
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
45
|
-
// You can create one instance of it to use across an application.
|
|
46
|
-
const orq = new OrqCore({
|
|
47
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
48
|
-
});
|
|
49
|
-
|
|
50
|
-
async function run() {
|
|
51
|
-
const res = await deploymentsMetricsCreate(orq, {
|
|
52
|
-
id: "<id>",
|
|
53
|
-
requestBody: {},
|
|
54
|
-
});
|
|
55
|
-
|
|
56
|
-
if (!res.ok) {
|
|
57
|
-
throw res.error;
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
const { value: result } = res;
|
|
61
|
-
|
|
62
|
-
// Handle the result
|
|
63
|
-
console.log(result);
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
run();
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
### Parameters
|
|
70
|
-
|
|
71
|
-
| Parameter | Type | Required | Description |
|
|
72
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
73
|
-
| `request` | [operations.DeploymentCreateMetricRequest](../../models/operations/deploymentcreatemetricrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
74
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
75
|
-
| `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. |
|
|
76
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
77
|
-
|
|
78
|
-
### Response
|
|
79
|
-
|
|
80
|
-
**Promise\<[operations.DeploymentCreateMetricResponseBody](../../models/operations/deploymentcreatemetricresponsebody.md)\>**
|
|
81
|
-
|
|
82
|
-
### Errors
|
|
83
|
-
|
|
84
|
-
| Error Type | Status Code | Content Type |
|
|
85
|
-
| --------------- | --------------- | --------------- |
|
|
86
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|