@orq-ai/node 2.4.0 → 2.5.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.
Files changed (5) hide show
  1. package/README.md +4 -6
  2. package/package.json +1 -1
  3. package/src/lib/client.d.ts +1 -2
  4. package/src/lib/client.js +2 -1
  5. package/src/lib/client.js.map +1 -1
package/README.md CHANGED
@@ -6,8 +6,6 @@
6
6
 
7
7
  Build AI Applications from Playground to Production
8
8
 
9
- ![npm](https://img.shields.io/pypi/v/orq-ai-node)
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 Orquesta workspace. `https://my.orquesta.dev/<workspace>/settings/developers`_
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 Orquesta client with your API key:
31
+ Initialize the orq.ai client with your API key:
34
32
 
35
33
  ```ts
36
- import { createClient } from '@orquesta/node';
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 Orquesta for your deployments. Additionally, this API supports streaming. To ensure ease of use and minimize errors, using the code snippets from the Orquesta Admin panel is highly recommended.
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,6 +1,6 @@
1
1
  {
2
2
  "name": "@orq-ai/node",
3
- "version": "2.4.0",
3
+ "version": "2.5.0",
4
4
  "description": "orq.ai Typescript SDK",
5
5
  "author": "orq.ai",
6
6
  "homepage": "https://orq.ai",
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,MAAM,MAAM;IAGX,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"}
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"}