@orq-ai/node 2.4.0 → 2.6.0
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 +4 -6
- package/package.json +1 -1
- package/src/lib/api/deployments.d.ts +2 -1
- package/src/lib/api/deployments.js +9 -9
- package/src/lib/api/deployments.js.map +1 -1
- package/src/lib/client.d.ts +1 -2
- package/src/lib/client.js +2 -1
- package/src/lib/client.js.map +1 -1
- package/src/lib/utils/index.d.ts +1 -1
package/README.md
CHANGED
|
@@ -6,8 +6,6 @@
|
|
|
6
6
|
|
|
7
7
|
Build AI Applications from Playground to Production
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
9
|
# orq.ai Node SDK
|
|
12
10
|
|
|
13
11
|
The orq.ai Node library enables easy orq.ai REST API integration in NodeJS 16+ apps.
|
|
@@ -28,12 +26,12 @@ yarn add @orq-ai/node
|
|
|
28
26
|
|
|
29
27
|
## Usage
|
|
30
28
|
|
|
31
|
-
_You can get your workspace API key from the settings section in your
|
|
29
|
+
_You can get your workspace API key from the settings section in your orq.ai workspace. `https://my.orq.ai/<workspace>/settings/developers`_
|
|
32
30
|
|
|
33
|
-
Initialize the
|
|
31
|
+
Initialize the orq.ai client with your API key:
|
|
34
32
|
|
|
35
33
|
```ts
|
|
36
|
-
import { createClient } from '@
|
|
34
|
+
import { createClient } from '@orq-ai/node';
|
|
37
35
|
|
|
38
36
|
const client = createClient({
|
|
39
37
|
apiKey: 'orquesta-api-key',
|
|
@@ -50,7 +48,7 @@ generation = await client.deployments.invoke(
|
|
|
50
48
|
|
|
51
49
|
## Deployments
|
|
52
50
|
|
|
53
|
-
The Deployments API delivers text outputs, images or tool calls based on the configuration established within
|
|
51
|
+
The Deployments API delivers text outputs, images or tool calls based on the configuration established within orq.ai for your deployments. Additionally, this API supports streaming. To ensure ease of use and minimize errors, using the code snippets from the orq.ai Admin panel is highly recommended.
|
|
54
52
|
|
|
55
53
|
### Invoke a deployment
|
|
56
54
|
|
package/package.json
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
|
-
import { DeplomentToolCall, DeploymentChoice, DeploymentCommon, DeploymentConfiguration, DeploymentEvent, DeploymentMessage, DeploymentModelType, DeploymentParameter, DeploymentProvider, DeploymentResponse } from
|
|
1
|
+
import { DeplomentToolCall, DeploymentChoice, DeploymentCommon, DeploymentConfiguration, DeploymentEvent, DeploymentMessage, DeploymentModelType, DeploymentParameter, DeploymentProvider, DeploymentResponse } from "../models";
|
|
2
2
|
export type InvokeDeploymentParams = DeploymentCommon & {
|
|
3
3
|
key: string;
|
|
4
4
|
context?: Record<string, unknown>;
|
|
5
5
|
metadata?: Record<string, unknown>;
|
|
6
6
|
inputs?: Record<string, string>;
|
|
7
7
|
messages?: DeploymentMessage[];
|
|
8
|
+
extra_params?: Record<string, unknown>;
|
|
8
9
|
};
|
|
9
10
|
export declare abstract class BaseDeployment {
|
|
10
11
|
id: string;
|
|
@@ -5,17 +5,17 @@ const tslib_1 = require("tslib");
|
|
|
5
5
|
const exceptions_1 = require("../exceptions");
|
|
6
6
|
const http_1 = require("../http");
|
|
7
7
|
const utils_1 = require("../utils");
|
|
8
|
-
const DEPLOYMENTS_GET_CONFIG =
|
|
9
|
-
const DEPLOYMENTS_INVOKE =
|
|
8
|
+
const DEPLOYMENTS_GET_CONFIG = "deployments/get_config";
|
|
9
|
+
const DEPLOYMENTS_INVOKE = "deployments/invoke";
|
|
10
10
|
const buildAddMetricsUrl = (id) => `deployments/${id}/metrics`;
|
|
11
11
|
function buildDeploymentRequestBody(params) {
|
|
12
|
-
return Object.assign(Object.assign(Object.assign({ key: params.key }, (params.context && { context: params.context })), (params.metadata && { metadata: params.metadata })), (params.inputs && { inputs: params.inputs }));
|
|
12
|
+
return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({ key: params.key }, (params.context && { context: params.context })), (params.metadata && { metadata: params.metadata })), (params.inputs && { inputs: params.inputs })), (params.messages && { messages: params.messages })), (params.extra_params && { extra_params: params.extra_params }));
|
|
13
13
|
}
|
|
14
14
|
class BaseDeployment {
|
|
15
15
|
constructor(id) {
|
|
16
16
|
this.id = id;
|
|
17
17
|
if (!id) {
|
|
18
|
-
throw new Error(
|
|
18
|
+
throw new Error("Something went wrong while fetching the deployment. Please try again.");
|
|
19
19
|
}
|
|
20
20
|
}
|
|
21
21
|
addMetrics(metrics) {
|
|
@@ -27,7 +27,7 @@ class BaseDeployment {
|
|
|
27
27
|
}
|
|
28
28
|
try {
|
|
29
29
|
const response = yield (0, http_1.createHttpRequest)({
|
|
30
|
-
method:
|
|
30
|
+
method: "POST",
|
|
31
31
|
apiKey: utils_1.Store.apiKey,
|
|
32
32
|
url,
|
|
33
33
|
data: metrics,
|
|
@@ -74,7 +74,7 @@ class Deployment {
|
|
|
74
74
|
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
75
75
|
try {
|
|
76
76
|
const response = yield (0, http_1.createHttpRequest)({
|
|
77
|
-
method:
|
|
77
|
+
method: "POST",
|
|
78
78
|
apiKey: utils_1.Store.apiKey,
|
|
79
79
|
url: DEPLOYMENTS_GET_CONFIG,
|
|
80
80
|
data: buildDeploymentRequestBody(params),
|
|
@@ -91,7 +91,7 @@ class Deployment {
|
|
|
91
91
|
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
92
92
|
try {
|
|
93
93
|
const response = yield (0, http_1.createHttpRequest)({
|
|
94
|
-
method:
|
|
94
|
+
method: "POST",
|
|
95
95
|
apiKey: utils_1.Store.apiKey,
|
|
96
96
|
url: DEPLOYMENTS_INVOKE,
|
|
97
97
|
data: buildDeploymentRequestBody(params),
|
|
@@ -109,7 +109,7 @@ class Deployment {
|
|
|
109
109
|
var _a, e_1, _b, _c;
|
|
110
110
|
try {
|
|
111
111
|
const response = yield tslib_1.__await((0, http_1.createHttpRequest)({
|
|
112
|
-
method:
|
|
112
|
+
method: "POST",
|
|
113
113
|
apiKey: utils_1.Store.apiKey,
|
|
114
114
|
url: DEPLOYMENTS_INVOKE,
|
|
115
115
|
data: Object.assign(Object.assign({}, buildDeploymentRequestBody(params)), { stream: true }),
|
|
@@ -120,7 +120,7 @@ class Deployment {
|
|
|
120
120
|
_c = stream_1_1.value;
|
|
121
121
|
_d = false;
|
|
122
122
|
const chunk = _c;
|
|
123
|
-
const jsonValue = (0, utils_1.extractSSEData)(chunk.toString(
|
|
123
|
+
const jsonValue = (0, utils_1.extractSSEData)(chunk.toString("utf8"));
|
|
124
124
|
const parsedObjects = (0, utils_1.safeJSONParse)(jsonValue);
|
|
125
125
|
for (const parsedObject of parsedObjects) {
|
|
126
126
|
yield yield tslib_1.__await(new DeploymentGeneration(parsedObject));
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"deployments.js","sourceRoot":"","sources":["../../../../../orq-ai-sdk/src/lib/api/deployments.ts"],"names":[],"mappings":";;;;AACA,8CAAmD;AACnD,kCAA4C;AAa5C,oCAAgE;AAEhE,MAAM,sBAAsB,GAAG,wBAAwB,CAAC;AACxD,MAAM,kBAAkB,GAAG,oBAAoB,CAAC;AAEhD,MAAM,kBAAkB,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,eAAe,EAAE,UAAU,CAAC;
|
|
1
|
+
{"version":3,"file":"deployments.js","sourceRoot":"","sources":["../../../../../orq-ai-sdk/src/lib/api/deployments.ts"],"names":[],"mappings":";;;;AACA,8CAAmD;AACnD,kCAA4C;AAa5C,oCAAgE;AAEhE,MAAM,sBAAsB,GAAG,wBAAwB,CAAC;AACxD,MAAM,kBAAkB,GAAG,oBAAoB,CAAC;AAEhD,MAAM,kBAAkB,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,eAAe,EAAE,UAAU,CAAC;AAWvE,SAAS,0BAA0B,CAAC,MAA8B;IACjE,+EACC,GAAG,EAAE,MAAM,CAAC,GAAG,IACZ,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC,GAC/C,CAAC,MAAM,CAAC,QAAQ,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC,GAClD,CAAC,MAAM,CAAC,MAAM,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,GAC5C,CAAC,MAAM,CAAC,QAAQ,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC,GAClD,CAAC,MAAM,CAAC,YAAY,IAAI,EAAE,YAAY,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,EAChE;AACH,CAAC;AAED,MAAsB,cAAc;IACnC,YAAmB,EAAU;QAAV,OAAE,GAAF,EAAE,CAAQ;QAC5B,IAAI,CAAC,EAAE,EAAE;YACR,MAAM,IAAI,KAAK,CACd,uEAAuE,CACvE,CAAC;SACF;IACF,CAAC;IAEY,UAAU,CACtB,OAAwB;;;YAExB,MAAM,GAAG,GAAG,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAExC,IAAI,CAAC,OAAO,CAAC,OAAO,KAAI,MAAA,aAAK,CAAC,QAAQ,0CAAE,EAAE,CAAA,EAAE;gBAC3C,OAAO,CAAC,OAAO,GAAG,aAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;aACpC;YAED,IAAI;gBACH,MAAM,QAAQ,GAAG,MAAM,IAAA,wBAAiB,EAAC;oBACxC,MAAM,EAAE,MAAM;oBACd,MAAM,EAAE,aAAK,CAAC,MAAM;oBACpB,GAAG;oBACH,IAAI,EAAE,OAAO;iBACb,CAAC,CAAC;gBAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;aACrB;YAAC,OAAO,GAAG,EAAE;gBACb,IAAA,+BAAkB,EAAC,GAAG,CAAC,CAAC;gBACxB,OAAO;aACP;;KACD;CACD;AAhCD,wCAgCC;AAED,MAAa,sBACZ,SAAQ,cAAc;IAUtB,YAAoB,MAA8B;QACjD,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QADE,WAAM,GAAN,MAAM,CAAwB;QAGjD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QACrC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QACrC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;QACzC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QAC7B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAChC,CAAC;CACD;AArBD,wDAqBC;AAED,MAAa,oBACZ,SAAQ,cAAc;IAYtB,YAAY,IAAwB;QACnC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC9B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAAC;IACnD,CAAC;CACD;AAxBD,oDAwBC;AAED,MAAa,UAAU;IACT,SAAS,CACrB,MAA8B;;YAE9B,IAAI;gBACH,MAAM,QAAQ,GAAG,MAAM,IAAA,wBAAiB,EAAC;oBACxC,MAAM,EAAE,MAAM;oBACd,MAAM,EAAE,aAAK,CAAC,MAAM;oBACpB,GAAG,EAAE,sBAAsB;oBAC3B,IAAI,EAAE,0BAA0B,CAAC,MAAM,CAAC;iBACxC,CAAC,CAAC;gBAEH,OAAO,IAAI,sBAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;aACjD;YAAC,OAAO,GAAG,EAAE;gBACb,IAAA,+BAAkB,EAAC,GAAG,CAAC,CAAC;gBACxB,OAAO;aACP;QACF,CAAC;KAAA;IAEY,MAAM,CAClB,MAA8B;;YAE9B,IAAI;gBACH,MAAM,QAAQ,GAAG,MAAM,IAAA,wBAAiB,EAAC;oBACxC,MAAM,EAAE,MAAM;oBACd,MAAM,EAAE,aAAK,CAAC,MAAM;oBACpB,GAAG,EAAE,kBAAkB;oBACvB,IAAI,EAAE,0BAA0B,CAAC,MAAM,CAAC;iBACxC,CAAC,CAAC;gBAEH,OAAO,IAAI,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;aAC/C;YAAC,OAAO,GAAG,EAAE;gBACb,IAAA,+BAAkB,EAAC,GAAG,CAAC,CAAC;gBACxB,OAAO;aACP;QACF,CAAC;KAAA;IAEa,gBAAgB,CAC7B,MAA8B;;;YAE9B,IAAI;gBACH,MAAM,QAAQ,GAAG,sBAAM,IAAA,wBAAiB,EAAC;oBACxC,MAAM,EAAE,MAAM;oBACd,MAAM,EAAE,aAAK,CAAC,MAAM;oBACpB,GAAG,EAAE,kBAAkB;oBACvB,IAAI,kCACA,0BAA0B,CAAC,MAAM,CAAC,KACrC,MAAM,EAAE,IAAI,GACZ;iBACD,CAAC,CAAA,CAAC;gBAEH,MAAM,MAAM,GAAa,QAAQ,CAAC,IAAI,CAAC;;oBAEvC,KAA0B,eAAA,WAAA,sBAAA,MAAM,CAAA,YAAA,6FAAE;wBAAR,sBAAM;wBAAN,WAAM;wBAArB,MAAM,KAAK,KAAA,CAAA;wBACrB,MAAM,SAAS,GAAG,IAAA,sBAAc,EAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;wBACzD,MAAM,aAAa,GAAG,IAAA,qBAAa,EAAC,SAAS,CAAC,CAAC;wBAC/C,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE;4BACzC,4BAAM,IAAI,oBAAoB,CAAC,YAAY,CAAC,CAAA,CAAC;yBAC7C;qBACD;;;;;;;;;aACD;YAAC,OAAO,GAAG,EAAE;gBACb,IAAA,+BAAkB,EAAC,GAAG,CAAC,CAAC;aACxB;QACF,CAAC;KAAA;CACD;AAhED,gCAgEC"}
|
package/src/lib/client.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Deployment } from "./api";
|
|
2
2
|
import type { OrqAIClientOptions, UserInfo } from "./models";
|
|
3
3
|
export declare function createClient(options: OrqAIClientOptions): Client;
|
|
4
|
-
declare class Client {
|
|
4
|
+
export declare class Client {
|
|
5
5
|
#private;
|
|
6
6
|
protected apiKey: string;
|
|
7
7
|
protected environment?: string | undefined;
|
|
@@ -9,4 +9,3 @@ declare class Client {
|
|
|
9
9
|
setUser(info: UserInfo): void;
|
|
10
10
|
get deployments(): Deployment;
|
|
11
11
|
}
|
|
12
|
-
export {};
|
package/src/lib/client.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
var _Client_deployments;
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
exports.createClient = void 0;
|
|
4
|
+
exports.Client = exports.createClient = void 0;
|
|
5
5
|
const tslib_1 = require("tslib");
|
|
6
6
|
const api_1 = require("./api");
|
|
7
7
|
const utils_1 = require("./utils");
|
|
@@ -27,5 +27,6 @@ class Client {
|
|
|
27
27
|
return tslib_1.__classPrivateFieldGet(this, _Client_deployments, "f");
|
|
28
28
|
}
|
|
29
29
|
}
|
|
30
|
+
exports.Client = Client;
|
|
30
31
|
_Client_deployments = new WeakMap();
|
|
31
32
|
//# sourceMappingURL=client.js.map
|
package/src/lib/client.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../orq-ai-sdk/src/lib/client.ts"],"names":[],"mappings":";;;;;AAAA,+BAAmC;AAEnC,mCAAgC;AAEhC,SAAgB,YAAY,CAAC,OAA2B;IACvD,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;AACxD,CAAC;AAFD,oCAEC;AAED,
|
|
1
|
+
{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../orq-ai-sdk/src/lib/client.ts"],"names":[],"mappings":";;;;;AAAA,+BAAmC;AAEnC,mCAAgC;AAEhC,SAAgB,YAAY,CAAC,OAA2B;IACvD,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;AACxD,CAAC;AAFD,oCAEC;AAED,MAAa,MAAM;IAGlB,YACW,MAAc,EACd,WAAoB;QADpB,WAAM,GAAN,MAAM,CAAQ;QACd,gBAAW,GAAX,WAAW,CAAS;QAJ/B,8BAAkC,IAAI,EAAC;QAMtC,aAAK,CAAC,MAAM,GAAG,MAAM,CAAC;QACtB,aAAK,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAEM,OAAO,CAAC,IAAc;QAC5B,aAAK,CAAC,QAAQ,GAAG,IAAI,CAAC;IACvB,CAAC;IAED,IAAI,WAAW;QACd,IAAI,CAAC,+BAAA,IAAI,2BAAa,EAAE;YACvB,+BAAA,IAAI,uBAAgB,IAAI,gBAAU,EAAE,MAAA,CAAC;SACrC;QAED,OAAO,+BAAA,IAAI,2BAAa,CAAC;IAC1B,CAAC;CACD;AAtBD,wBAsBC"}
|
package/src/lib/utils/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { OrqAIClientOptions, UserInfo } from "../models";
|
|
1
|
+
import type { OrqAIClientOptions, UserInfo } from "../models";
|
|
2
2
|
export declare function extractSSEData(input: string): string;
|
|
3
3
|
export declare function safeJSONParse(input: string): any[];
|
|
4
4
|
export declare function parseJson(input: string): any[];
|