@orq-ai/node 2.14.0 → 2.14.2
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/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orq-ai/node",
|
|
3
|
-
"version": "2.14.
|
|
3
|
+
"version": "2.14.2",
|
|
4
4
|
"description": "orq.ai Typescript SDK",
|
|
5
5
|
"author": "orq.ai",
|
|
6
6
|
"homepage": "https://orq.ai",
|
|
@@ -10,7 +10,6 @@
|
|
|
10
10
|
"url": "git+https://github.com/orq-ai/orq-node.git"
|
|
11
11
|
},
|
|
12
12
|
"dependencies": {
|
|
13
|
-
"axios": "^1.5.1",
|
|
14
13
|
"eventsource-parser": "^1.1.2",
|
|
15
14
|
"tslib": "^2.3.0"
|
|
16
15
|
},
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { DeplomentToolCall, DeploymentChoice, DeploymentCommon, DeploymentConfiguration, DeploymentEvent, DeploymentMessage, DeploymentModelType, DeploymentParameter, DeploymentProvider, DeploymentResponse } from "../models";
|
|
1
|
+
import type { DeplomentToolCall, DeploymentChoice, DeploymentCommon, DeploymentConfiguration, DeploymentEvent, DeploymentInvokeOptions, DeploymentMessage, DeploymentModelType, DeploymentParameter, DeploymentProvider, DeploymentResponse, DeploymentRetrieval } from "../models";
|
|
2
2
|
export type InvokeDeploymentParams = DeploymentCommon & {
|
|
3
3
|
key: string;
|
|
4
4
|
context?: Record<string, unknown>;
|
|
@@ -7,6 +7,7 @@ export type InvokeDeploymentParams = DeploymentCommon & {
|
|
|
7
7
|
prefix_messages?: DeploymentMessage[];
|
|
8
8
|
messages?: DeploymentMessage[];
|
|
9
9
|
extra_params?: Record<string, unknown>;
|
|
10
|
+
invoke_options?: DeploymentInvokeOptions;
|
|
10
11
|
};
|
|
11
12
|
export declare abstract class BaseDeployment {
|
|
12
13
|
id: string;
|
|
@@ -34,6 +35,7 @@ export declare class DeploymentGeneration extends BaseDeployment implements Depl
|
|
|
34
35
|
is_final: boolean;
|
|
35
36
|
provider: DeploymentProvider;
|
|
36
37
|
system_fingerprint: string | undefined;
|
|
38
|
+
retrievals?: DeploymentRetrieval[];
|
|
37
39
|
constructor(data: DeploymentResponse);
|
|
38
40
|
}
|
|
39
41
|
export declare class Deployment {
|
|
@@ -10,7 +10,7 @@ const DEPLOYMENTS_GET_CONFIG = "v2/deployments/get_config";
|
|
|
10
10
|
const DEPLOYMENTS_INVOKE = "v2/deployments/invoke";
|
|
11
11
|
const buildAddMetricsUrl = (id) => `v2/deployments/${id}/metrics`;
|
|
12
12
|
function buildDeploymentRequestBody(params) {
|
|
13
|
-
return Object.assign(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.prefix_messages && { prefix_messages: params.prefix_messages })), (params.messages && { messages: params.messages })), (params.extra_params && { extra_params: params.extra_params }));
|
|
13
|
+
return Object.assign(Object.assign(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.prefix_messages && { prefix_messages: params.prefix_messages })), (params.messages && { messages: params.messages })), (params.extra_params && { extra_params: params.extra_params })), (params.invoke_options && { invoke_options: params.invoke_options }));
|
|
14
14
|
}
|
|
15
15
|
class BaseDeployment {
|
|
16
16
|
constructor(id) {
|
|
@@ -65,6 +65,7 @@ class DeploymentGeneration extends BaseDeployment {
|
|
|
65
65
|
this.finalized = data.finalized;
|
|
66
66
|
this.is_final = data.is_final;
|
|
67
67
|
this.choices = data.choices;
|
|
68
|
+
this.retrievals = data.retrievals;
|
|
68
69
|
this.system_fingerprint = data.system_fingerprint;
|
|
69
70
|
}
|
|
70
71
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"deployments.js","sourceRoot":"","sources":["../../../../../orq-ai-sdk/src/lib/api/deployments.ts"],"names":[],"mappings":";;;;AAAA,2DAAkD;AAClD,8CAAmD;AACnD,kCAA4C;
|
|
1
|
+
{"version":3,"file":"deployments.js","sourceRoot":"","sources":["../../../../../orq-ai-sdk/src/lib/api/deployments.ts"],"names":[],"mappings":";;;;AAAA,2DAAkD;AAClD,8CAAmD;AACnD,kCAA4C;AAe5C,oCAAgD;AAEhD,MAAM,sBAAsB,GAAG,2BAA2B,CAAC;AAC3D,MAAM,kBAAkB,GAAG,uBAAuB,CAAC;AAEnD,MAAM,kBAAkB,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,kBAAkB,EAAE,UAAU,CAAC;AAa1E,SAAS,0BAA0B,CAAC,MAA8B;IACjE,2GACC,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,eAAe,IAAI,EAAE,eAAe,EAAE,MAAM,CAAC,eAAe,EAAE,CAAC,GACvE,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,GAC9D,CAAC,MAAM,CAAC,cAAc,IAAI,EAAE,cAAc,EAAE,MAAM,CAAC,cAAc,EAAE,CAAC,EACtE;AACH,CAAC;AAED,MAAsB,cAAc;IACnC,YAAmB,EAAU;QAAV,OAAE,GAAF,EAAE,CAAQ;QAC5B,IAAI,CAAC,EAAE,EAAE,CAAC;YACT,MAAM,IAAI,KAAK,CACd,uEAAuE,CACvE,CAAC;QACH,CAAC;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,CAAC;gBAC5C,OAAO,CAAC,OAAO,GAAG,aAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;YACrC,CAAC;YAED,IAAI,CAAC;gBACJ,MAAM,QAAQ,GAAG,MAAM,IAAA,wBAAiB,EAAC;oBACxC,MAAM,EAAE,MAAM;oBACd,GAAG;oBACH,IAAI,EAAE,OAAO;iBACb,CAAC,CAAC;gBAEH,OAAO,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC9B,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACd,IAAA,+BAAkB,EAAC,GAAG,CAAC,CAAC;gBACxB,OAAO;YACR,CAAC;QACF,CAAC;KAAA;CACD;AA/BD,wCA+BC;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;IAatB,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,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAClC,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAAC;IACnD,CAAC;CACD;AA1BD,oDA0BC;AAED,MAAa,UAAU;IACT,SAAS,CACrB,MAA8B;;YAE9B,IAAI,CAAC;gBACJ,MAAM,QAAQ,GAAG,MAAM,IAAA,wBAAiB,EAAC;oBACxC,MAAM,EAAE,MAAM;oBACd,GAAG,EAAE,sBAAsB;oBAC3B,IAAI,EAAE,0BAA0B,CAAC,MAAM,CAAC;iBACxC,CAAC,CAAC;gBAEH,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;gBAErC,OAAO,IAAI,sBAAsB,CAAC,MAAM,CAAC,CAAC;YAC3C,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACd,IAAA,+BAAkB,EAAC,GAAG,CAAC,CAAC;gBACxB,OAAO;YACR,CAAC;QACF,CAAC;KAAA;IAEY,MAAM,CAClB,MAA8B;;YAE9B,IAAI,CAAC;gBACJ,MAAM,QAAQ,GAAG,MAAM,IAAA,wBAAiB,EAAC;oBACxC,MAAM,EAAE,MAAM;oBACd,GAAG,EAAE,kBAAkB;oBACvB,IAAI,EAAE,0BAA0B,CAAC,MAAM,CAAC;iBACxC,CAAC,CAAC;gBAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;oBAClB,MAAM,aAAa,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;oBAC5C,IAAA,+BAAkB,EAAC,aAAa,CAAC,CAAC;gBACnC,CAAC;gBAED,MAAM,UAAU,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;gBAEzC,OAAO,IAAI,oBAAoB,CAAC,UAAU,CAAC,CAAC;YAC7C,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACd,IAAA,+BAAkB,EAAC,GAAG,CAAC,CAAC;gBACxB,OAAO;YACR,CAAC;QACF,CAAC;KAAA;IAEa,gBAAgB,CAC7B,MAA8B;;;YAE9B,MAAM,QAAQ,GAAG,sBAAM,IAAA,wBAAiB,EAAC;gBACxC,MAAM,EAAE,MAAM;gBACd,GAAG,EAAE,kBAAkB;gBACvB,IAAI,kCACA,0BAA0B,CAAC,MAAM,CAAC,KACrC,MAAM,EAAE,IAAI,GACZ;aACD,CAAC,CAAA,CAAC;YAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBAClB,MAAM,aAAa,GAAG,sBAAM,QAAQ,CAAC,IAAI,EAAE,CAAA,CAAC;gBAC5C,IAAA,+BAAkB,EAAC,aAAa,CAAC,CAAC;YACnC,CAAC;YAED,MAAM,MAAM,GAAG,MAAA,QAAQ,CAAC,IAAI,0CAAE,SAAS,EAAE,CAAC;YAC1C,MAAM,KAAK,GAAyB,EAAE,CAAC;YACvC,IAAI,WAAW,GAAG,KAAK,CAAC;YAExB,MAAM,MAAM,GAAG,IAAA,iCAAY,EAAC,CAAC,KAAK,EAAE,EAAE;gBACrC,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;oBAC5B,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC;oBAC7B,MAAM,YAAY,GAAG,IAAA,qBAAa,EAAC,SAAS,CAAC,CAAC;oBAC9C,IAAI,YAAY,EAAE,CAAC;wBAClB,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;oBAC1B,CAAC;gBACF,CAAC;YACF,CAAC,CAAC,CAAC;YAEH,SAAe,UAAU;;oBACxB,IAAI,CAAC,MAAM,EAAE,CAAC;wBACb,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;oBACxD,CAAC;oBAED,OAAO,IAAI,EAAE,CAAC;wBACb,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;wBAE5C,IAAI,IAAI,EAAE,CAAC;4BACV,WAAW,GAAG,IAAI,CAAC;4BACnB,MAAM;wBACP,CAAC;wBAED,MAAM,IAAI,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;wBAC7C,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBACnB,CAAC;gBACF,CAAC;aAAA;YAED,0CAA0C;YAC1C,UAAU,EAAE,CAAC;YAEb,wDAAwD;YACxD,OAAO,IAAI,EAAE,CAAC;gBACb,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACzB,MAAM,YAAY,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC;oBACnC,IAAI,YAAY,EAAE,CAAC;wBAClB,4BAAM,IAAI,oBAAoB,CAAC,YAAY,CAAC,CAAA,CAAC;oBAC9C,CAAC;gBACF,CAAC;gBAED,IAAI,WAAW,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACvC,MAAM;gBACP,CAAC;gBAED,8DAA8D;gBAC9D,sBAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAA,CAAC;YACzD,CAAC;QACF,CAAC;KAAA;CACD;AAjHD,gCAiHC"}
|
package/src/lib/http/index.js
CHANGED
|
@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.createHttpRequest = createHttpRequest;
|
|
4
4
|
const tslib_1 = require("tslib");
|
|
5
5
|
const utils_1 = require("../utils");
|
|
6
|
-
// Create a function that allow to create an http request with axios
|
|
7
6
|
function createHttpRequest(_a) {
|
|
8
7
|
return tslib_1.__awaiter(this, arguments, void 0, function* ({ method = "POST", url, data, }) {
|
|
9
8
|
return fetch(`https://api.orq.ai/${url}`, {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../orq-ai-sdk/src/lib/http/index.ts"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../orq-ai-sdk/src/lib/http/index.ts"],"names":[],"mappings":";;AAEA,8CAoBC;;AAtBD,oCAAiC;AAEjC,SAAsB,iBAAiB;iEAAmC,EACxE,MAAM,GAAG,MAAM,EACf,GAAG,EACH,IAAI,GAKL;QACC,OAAO,KAAK,CAAC,sBAAsB,GAAG,EAAE,EAAE;YACxC,MAAM;YACN,OAAO,gCACL,cAAc,EAAE,kBAAkB,EAClC,MAAM,EAAE,kBAAkB,EAC1B,aAAa,EAAE,UAAU,aAAK,CAAC,MAAM,EAAE,IACpC,CAAC,aAAK,CAAC,SAAS,IAAI,EAAE,kBAAkB,EAAE,aAAK,CAAC,SAAS,EAAE,CAAC,GAC5D,CAAC,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAG,QAAQ,CAAC,KAAI,EAAE,MAAM,EAAE,mBAAmB,EAAE,CAAC,CACzD;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,CAAC,CAAC;IACL,CAAC;CAAA"}
|
|
@@ -118,6 +118,10 @@ export type DeploymentResponse = Omit<DeploymentConfiguration, "tools" | "parame
|
|
|
118
118
|
* The system fingerprint returned by the provider
|
|
119
119
|
*/
|
|
120
120
|
system_fingerprint?: string;
|
|
121
|
+
/**
|
|
122
|
+
* The retrieval documents chunks returned by the knowledge base upon request
|
|
123
|
+
*/
|
|
124
|
+
retrievals?: DeploymentRetrieval[];
|
|
121
125
|
};
|
|
122
126
|
export type DeploymentCommon = {
|
|
123
127
|
user_id?: string;
|
|
@@ -139,3 +143,25 @@ export type DeploymentEvent = DeploymentCommon & {
|
|
|
139
143
|
choices?: DeploymentChoice[];
|
|
140
144
|
messages?: DeploymentMessage[];
|
|
141
145
|
};
|
|
146
|
+
export interface DeploymentInvokeOptions {
|
|
147
|
+
/** When using knowledge bases, indicates on the request the retrieval documents should be returned in the response */
|
|
148
|
+
include_retrievals?: boolean;
|
|
149
|
+
}
|
|
150
|
+
export interface DeploymentRetrievalMetadata {
|
|
151
|
+
/** Name of the retrieved document chunk */
|
|
152
|
+
file_name: string;
|
|
153
|
+
/** Type of the retrieved document chunk */
|
|
154
|
+
file_type: string;
|
|
155
|
+
/** Page number of the retrieved document chunk. Only available for PDF files */
|
|
156
|
+
page_number?: number | null;
|
|
157
|
+
/** Search score of the retrieved document chunk */
|
|
158
|
+
search_score: number;
|
|
159
|
+
/** Rerank score of the retrieved document chunk */
|
|
160
|
+
rerank_score?: number | null;
|
|
161
|
+
}
|
|
162
|
+
export interface DeploymentRetrieval {
|
|
163
|
+
/** Retrieved document chunk from the knowledge base */
|
|
164
|
+
document: string;
|
|
165
|
+
/** Metadata of the retrieved document chunk */
|
|
166
|
+
metadata: DeploymentRetrievalMetadata;
|
|
167
|
+
}
|