fix(misc): SDK upgrade, docs (#36)

Signed-off-by: Tomas Pilar <tomas.pilar@ibm.com>
IBM · Mar 18, 2024 · 1b110e5 · 1b110e5
1 parent 2ac57af
commit 1b110e5
Show file tree

Hide file tree

Showing 19 changed files with 87 additions and 67 deletions.
diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml
@@ -15,9 +15,9 @@ jobs:
         node-version: [18.x, 20.x]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
           cache: "yarn"
@@ -31,9 +31,9 @@ jobs:
         node-version: [18.x, 20.x]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
           cache: "yarn"

diff --git a/.github/workflows/npm-publish.yml b/.github/workflows/npm-publish.yml
@@ -9,8 +9,8 @@ jobs:
     runs-on: ubuntu-latest
     environment: production
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
           node-version: 16
           registry-url: https://registry.npmjs.org/

diff --git a/README.md b/README.md
@@ -81,7 +81,19 @@ source ~/.zshrc
 
 ### Output format
 
-You can choose default output format during `genai config` or set it via `--output-format` flag. Choices are `yaml` and `json`. Former is ideal for direct viewing, latter for piping into [jq](https://jqlang.github.io/jq/).
+You can choose default output format during `genai config` or set it via `--output-format` flag. Choices are `json` and `yaml`. Former can be piped into [jq](https://jqlang.github.io/jq/) for further processing. Default is `json`.
+
+### Many inputs
+
+Certain commands (e.g. `text generation create` or `text tokenization create`) accept inputs from `stdin` if positional arguments are omitted. The content of `stdin` MUST follow [JSONL](https://jsonlines.org/) format.
+
+```bash
+cat inputs.jsonl
+# "foo"
+# "bar"
+# "baz"
+cat inputs.jsonl moreInputs.jsonl | genai text generation create -m google/flan-ul2 | jq '.results[0].generated_text'
+```
 
 ## Commands
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ibm-generative-ai/cli",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "CLI for IBM Generative AI (Tech Preview)",
   "keywords": [
     "ai",
@@ -44,7 +44,7 @@
     ]
   },
   "dependencies": {
-    "@ibm-generative-ai/node-sdk": "^2.0.0",
+    "@ibm-generative-ai/node-sdk": "^2.0.2",
     "dayjs": "^1.11.9",
     "lodash": "^4.17.21",
     "stream-json": "^1.7.5",

diff --git a/src/commands/files/create.js → src/commands/file/create.js b/src/commands/files/create.js → src/commands/file/create.js
diff --git a/src/commands/files/delete.js → src/commands/file/delete.js b/src/commands/files/delete.js → src/commands/file/delete.js
diff --git a/src/commands/files/index.js → src/commands/file/index.js b/src/commands/files/index.js → src/commands/file/index.js
diff --git a/src/commands/files/list.js → src/commands/file/list.js b/src/commands/files/list.js → src/commands/file/list.js
diff --git a/src/commands/file/read.js b/src/commands/file/read.js
@@ -0,0 +1,23 @@
+import { stdout } from "node:process";
+import { pipeline } from "node:stream/promises";
+import { Readable } from "node:stream";
+
+export const readCommandDefinition = [
+  "read <id>",
+  "Read file contents",
+  (yargs) =>
+    yargs.positional("id", {
+      type: "string",
+      description: "Identifier of the file to read",
+    }),
+  async (args) => {
+    const blob = await args.client.file.read(
+      {
+        id: args.id,
+      },
+      { signal: args.timeout }
+    );
+    const readable = Readable.fromWeb(blob.stream());
+    await pipeline(readable, stdout);
+  },
+];
diff --git a/src/commands/files/retrieve.js → src/commands/file/retrieve.js b/src/commands/files/retrieve.js → src/commands/file/retrieve.js
diff --git a/src/commands/files/read.js b/src/commands/files/read.js
diff --git a/src/commands/models/index.js → src/commands/model/index.js b/src/commands/models/index.js → src/commands/model/index.js
diff --git a/src/commands/models/list.js → src/commands/model/list.js b/src/commands/models/list.js → src/commands/model/list.js
diff --git a/src/commands/models/retrieve.js → src/commands/model/retrieve.js b/src/commands/models/retrieve.js → src/commands/model/retrieve.js
diff --git a/src/errors.js b/src/errors.js
@@ -1,4 +1,11 @@
-import { BaseError, InvalidInputError } from "@ibm-generative-ai/node-sdk";
+import {
+  BaseError,
+  InvalidInputError as InvalidInputSDKError,
+} from "@ibm-generative-ai/node-sdk";
+
+export class InvalidInputError extends Error {}
 
 export const isUsageError = (err) =>
-  !(err instanceof BaseError) || err instanceof InvalidInputError;
+  !(err instanceof BaseError) ||
+  err instanceof InvalidInputSDKError ||
+  err instanceof InvalidInputError;
diff --git a/src/parser.js b/src/parser.js
@@ -3,8 +3,8 @@ import { hideBin } from "yargs/helpers";
 
 import { profileMiddleware } from "./middleware/profile.js";
 import { textCommandDefinition } from "./commands/text/index.js";
-import { modelsCommandDefinition } from "./commands/models/index.js";
-import { filesCommandDefinition } from "./commands/files/index.js";
+import { modelsCommandDefinition } from "./commands/model/index.js";
+import { filesCommandDefinition } from "./commands/file/index.js";
 import { requestCommandDefinition } from "./commands/request/index.js";
 import { tuneCommandDefinition } from "./commands/tune/index.js";
 import { configCommandDefinition } from "./commands/config/index.js";

diff --git a/src/utils/formatters.js b/src/utils/formatters.js
@@ -10,7 +10,7 @@ export function format(data, format) {
   if (!isValidFormat(format)) new Error("Invalid format");
   switch (format) {
     case "json":
-      return JSON.stringify(data);
+      return JSON.stringify(data, null, 2);
     case "yaml":
       return YAML.stringify(data);
   }

diff --git a/src/utils/streams.js b/src/utils/streams.js
@@ -3,17 +3,26 @@ import { pipeline } from "stream/promises";
 import Parser from "stream-json/Parser.js";
 import StreamValues from "stream-json/streamers/StreamValues.js";
 
+import { InvalidInputError } from "../errors.js";
+
 export const readJSONStream = async (stream) => {
   const values = [];
-  await pipeline(
-    stream,
-    new Parser({ jsonStreaming: true }),
-    new StreamValues(),
-    async function (source) {
-      for await (const value of source) {
-        values.push(value.value);
+  try {
+    await pipeline(
+      stream,
+      new Parser({ jsonStreaming: true }),
+      new StreamValues(),
+      async function (source) {
+        for await (const value of source) {
+          values.push(value.value);
+        }
       }
-    }
-  );
+    );
+  } catch (err) {
+    throw new InvalidInputError(
+      "Failed to parse JSON stream, please check your input",
+      { cause: err }
+    );
+  }
   return values;
 };
diff --git a/yarn.lock b/yarn.lock
@@ -92,7 +92,7 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@ibm-generative-ai/cli@workspace:."
   dependencies:
-    "@ibm-generative-ai/node-sdk": ^2.0.0
+    "@ibm-generative-ai/node-sdk": ^2.0.2
     dayjs: ^1.11.9
     eslint: ^8.56.0
     eslint-config-prettier: ^8.8.0
@@ -109,18 +109,19 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@ibm-generative-ai/node-sdk@npm:^2.0.0":
-  version: 2.0.0
-  resolution: "@ibm-generative-ai/node-sdk@npm:2.0.0"
+"@ibm-generative-ai/node-sdk@npm:^2.0.2":
+  version: 2.0.2
+  resolution: "@ibm-generative-ai/node-sdk@npm:2.0.2"
   dependencies:
     "@ai-zen/node-fetch-event-source": ^2.1.2
     fetch-retry: ^5.0.6
+    http-status-codes: ^2.3.0
     openapi-fetch: ^0.8.2
     p-queue: ^8.0.1
     yaml: ^2.3.3
   peerDependencies:
     "@langchain/core": ">=0.1.0"
-  checksum: 70064b43855ddc5923f71d7e2b17d9421b06b4a99b1d6c11e11c590d5d9cf419094a1406326ab4b2f5858b95bbf8e5f69d73a98d769cb5c1bbd5d3766dc7e5ec
+  checksum: 0dc17c082764b162234785f6b1f476feb895b7d42c1d063a20bb0ac3d6c94e8be23b8e93fd3ce02f285061082716f57bb69fb33f7b8d95720767cb4d6746f16a
   languageName: node
   linkType: hard
 
@@ -1049,6 +1050,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"http-status-codes@npm:^2.3.0":
+  version: 2.3.0
+  resolution: "http-status-codes@npm:2.3.0"
+  checksum: dae3b99e0155441b6df28e8265ff27c56a45f82c6092f736414233e9ccf063d5ea93c1e1279e8b499c4642e2538b37995c76b1640ed3f615d0e2883d3a1dcfd5
+  languageName: node
+  linkType: hard
+
 "husky@npm:^8.0.0":
   version: 8.0.3
   resolution: "husky@npm:8.0.3"