> For the complete documentation index, see [llms.txt](https://docs.roboflow.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roboflow.com/deployment/ja/self-hosted/sdks/web-browser/inferencejs-reference.md).

# inferencejs リファレンス

Roboflow で構築したコンピュータビジョンアプリを Web/JavaScript 環境にデプロイするためのエッジライブラリ \`inferencejs\` のリファレンス

{% hint style="info" %}
詳しくは、 `inferencejs` （ウェブ SDK）について、 [こちら](https://docs.roboflow.com/deployment/ja/self-hosted/sdks/web-browser.md)
{% endhint %}

### インストール

このライブラリは、vite、webpack、parcel などのバンドラーを使用してブラウザー内で利用するように設計されています。バンドラーの設定が済んでいることを前提に、次のコマンドを実行してインストールできます。

`npm install inferencejs`

### はじめに

まず、 `InferenceEngine`を初期化します。これにより、ユーザーインターフェースをブロックせずにモデルをダウンロードして実行できるバックグラウンドワーカーが起動します。

```typescript
import { InferenceEngine } from "inferencejs";

const PUBLISHABLE_KEY = "rf_a6cd..."; // replace with your own publishable key from Roboflow

const inferEngine = new InferenceEngine();

// Load a model by its model id, copied from the model's page on Roboflow.
const workerId = await inferEngine.startWorkerByModelId("[MODEL ID]", PUBLISHABLE_KEY);

//make inferences against the model
const result = await inferEngine.infer(workerId, img);
```

モデル ID はモデルのページに表示され、次の形式です。 `workspace/model-slug` （例： `my-workspace/hard-hat-abc-1-yolov8n-t1`）。従来のプロジェクトとバージョンで指定するモデルは、プロジェクトのスラッグとバージョン番号を使用して `startWorker` で読み込めます。複数の学習済みモデルがあるバージョンの場合、従来の `{project}/{version}` IDは、バージョンにエイリアスがある場合はそのエイリアスを通じて解決されます。エイリアスがない場合、バージョンにモデルが1つだけあれば機能しますが、それ以外では ID が曖昧になるため、モデル自体のモデル ID を指定して読み込んでください。詳しくは、 [従来の ID の解決方法](https://docs.roboflow.com/models/model-ids).

## API

### InferenceEngine

**`new InferenceEngine()`**

新しい InferenceEngine インスタンスを作成します。

**`startWorkerByModelId(modelId: string, publishableKey: string): Promise<number>`**

指定されたモデル ID の新しいワーカーを起動し、 `workerId`を返します。モデルの読み込みには、この方法を推奨します。 `modelId` は、モデルのページに表示される完全な `workspace/model-slug` 形式の ID です。バージョン指定のないバージョンと、複数のモデルを含むバージョンで使用できます。 `publishableKey` は必須です。Roboflow のプロジェクト設定で取得できます。

**`startWorker(modelName: string, modelVersion: number, publishableKey: string): Promise<number>`**

プロジェクトの URL スラッグと整数のバージョンで指定された従来のモデルを読み込み、 `workerId`を返します。新しい連携では、 `startWorkerByModelId` を使用してください。 `publishableKey` は必須です。Roboflow のプロジェクト設定で取得できます。

**`infer(workerId: number, img: CVImage | ImageBitmap): Promise<Inference>`**

指定された `workerId`. `img` 次の方法で作成できます。 `new CVImage(HTMLImageElement | HTMLVideoElement | ImageBitmap | TFJS.Tensor)` または [`createImageBitmap`](https://developer.mozilla.org/en-US/docs/Web/API/createImageBitmap)

**`stopWorker(workerId: number): Promise<void>`**

指定されたワーカーを停止します。 `workerId`.

### `YOLO Lite` `YOLOv8` `YOLOv5`

次を使用して推論を実行した結果、 `InferenceEngine` YOLO Lite、YOLOv8、またはYOLOv5の物体検出モデルでは、次の型の配列が返されます。

```typescript
type RFObjectDetectionPrediction = {
    class?: string;
    confidence?: number;
    bbox?: {
        x: number;
        y: number;
        width: number;
        height: number;
    };
    color?: string;
};
```

### `GazeDetections`

次を使用して推論を実行した結果、 `InferenceEngine` Gazeモデルでは、次の型の配列が返されます。

```typescript
type GazeDetections = {
    leftEye: { x: number; y: number };
    rightEye: { x: number; y: number };
    yaw: number;
    pitch: number;
}[];
```

**`leftEye.x`**

入力画像の幅に対する割合で測定した、左目のx位置を表す0～1の浮動小数点数です。

**`leftEye.y`**

入力画像の高さに対する割合で測定した、左目のy位置を表す0～1の浮動小数点数です。

**`rightEye.x`**

入力画像の幅に対する割合で測定した、右目のx位置を表す0～1の浮動小数点数です。

**`rightEye.y`**

入力画像の高さに対する割合で測定した、右目のy位置を表す0～1の浮動小数点数です。

**`yaw`**

視線のヨー角をラジアン単位で表します。

**`pitch`**

視線のピッチ角をラジアン単位で表します。

### `CVImage`

コンピュータービジョンのタスクで使用できる画像を表すクラスです。画像を操作および変換するためのさまざまなメソッドを提供します。

#### **コンストラクター**

この `CVImage(image)` クラスコンストラクターは、クラスの新しいインスタンスを初期化します。次のいずれかの型の画像を1つ受け取ります。

* `ImageBitmap`：画像の任意の `ImageBitmap` 表現。
* `HTMLImageElement`：画像の任意の `HTMLImageElement` 表現。
* `tf.Tensor`：画像の任意の `tf.Tensor` 表現。
* `tf.Tensor4D`：任意の4D `tf.Tensor` 形式の画像表現。

#### **メソッド**

**`bitmap()`**

画像を表す `ImageBitmap` を返すPromiseです。画像がすでにビットマップの場合は、キャッシュされたビットマップを返します。

**`tensor()`**

画像を表す `tf.Tensor` を返します。画像がすでにテンソルの場合は、キャッシュされたテンソルを返します。

**`tensor4D()`**

画像を表す4D `tf.Tensor` を返すPromiseです。画像がすでに4Dテンソルの場合は、キャッシュされた4Dテンソルを返します。

**`array()`**

画像を表すJavaScript配列を返すPromiseです。画像がすでにテンソルの場合は、そのテンソルを配列に変換します。

**`dims()`**

画像の次元を含む配列を返します。画像がビットマップの場合は、 `[width, height]`を返します。画像がテンソルの場合は、そのテンソルの形状を返します。画像がHTML画像要素の場合は、 `[width, height]`.

**`dispose()`**

画像のテンソル表現を破棄して、メモリを解放します。

**`static fromArray(array: tf.TensorLike)`**

指定したテンソル形式の配列から、新しい `CVImage` インスタンスを作成します。
