> 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/reference/ja/inference/inference-sdk.md).

# Inference SDK

Roboflow Inference Server 用の HTTP クライアント。Python からローカル、ホスト型、非同期、バッチ推論を実行できます。

この `inference-sdk` Pythonパッケージは提供します `InferenceHTTPClient`、あるサーバーと通信するためのクライアント [Inference Server](https://docs.roboflow.com/deployment/self-hosted/inference-server) をHTTP経由で。互換性のあるHTTPメソッドについては、このクライアントはRoboflowの [Serverless Cloud API](https://docs.roboflow.com/deployment/roboflow-cloud/serverless-api)、 [Dedicated Deployment](https://docs.roboflow.com/deployment/roboflow-cloud/dedicated-deployments)、セルフホストされたサーバー、またはエッジデバイス上で動作するサーバーへ変更することで `api_url`。管理されたライブカメラ [クラウドストリーミング](https://docs.roboflow.com/deployment/roboflow-cloud/cloud-streaming) は別のソースとジョブのライフサイクルを使用します。このクライアントの `api_url`.

```bash
pip install inference-sdk
```

{% hint style="info" %}
`inference-sdk` は薄いHTTPクライアントであり、モデル自体は実行しません。自分のPythonプロセス内でモデルを読み込み実行するには、 [`inference` パッケージ](https://docs.roboflow.com/reference/ja/inference/inference-python.md).
{% endhint %}

## クイックスタート

URL、ファイルパス、PIL画像、NumPy配列からの画像に対して推論を実行できます。

{% tabs %}
{% tab title="URL" %}

```python
from inference_sdk import InferenceHTTPClient, InferenceConfiguration
import os

image_url = "https://media.roboflow.com/inference/soccer.jpg"

client = InferenceHTTPClient(
    api_url="https://serverless.roboflow.com",
    api_key=os.environ["API_KEY"],
).configure(InferenceConfiguration(api_key_transport="header"))

results = client.infer(image_url, model_id="soccer-players-5fuqs/1")
print(results)
```

{% endtab %}

{% tab title="NumPy配列" %}

```python
from inference_sdk import InferenceHTTPClient, InferenceConfiguration
import cv2
import os

client = InferenceHTTPClient(
    api_url="https://serverless.roboflow.com",
    api_key=os.environ["API_KEY"],
).configure(InferenceConfiguration(api_key_transport="header"))

numpy_image = cv2.imread("path/to/local/image.jpg")
results = client.infer(numpy_image, model_id="soccer-players-5fuqs/1")
print(results)
```

{% endtab %}

{% tab title="PIL画像" %}

```python
from inference_sdk import InferenceHTTPClient, InferenceConfiguration
from PIL import Image
import os

client = InferenceHTTPClient(
    api_url="https://serverless.roboflow.com",
    api_key=os.environ["API_KEY"],
).configure(InferenceConfiguration(api_key_transport="header"))

pil_image = Image.open("path/to/local/image.jpg")
results = client.infer(pil_image, model_id="soccer-players-5fuqs/1")
print(results)
```

{% endtab %}
{% endtabs %}

この `api_key_transport="header"` この設定では、APIキーを次の形式でのみ送信します： `Authorization: Bearer` ヘッダーとして送信し、URLやログに含めません。これにはリリース1.5.0以降の推論サーバーが必要です。以下を使用してください `"both"` 古いサーバーを引き続き呼び出す間は。参照： [APIキーの送信方法](https://docs.roboflow.com/reference/ja/inference/inference-sdk/configuration.md#api-key-transport) の3つのモードについて。

セルフホストサーバーへの最初のリクエストでは、モデルの重みがダウンロードされ、セットアップされます。このリクエストは、ネットワーク接続とモデルのサイズによっては時間がかかる場合があります。モデルのダウンロードが完了すると、以降のリクエストははるかに高速になります。また、 [モデルを事前読み込みし、読み込まれた重みを管理する](https://docs.roboflow.com/reference/ja/inference/inference-sdk/model-management.md) ことで、このプロセスを制御できます。

{% hint style="info" %}
モデルIDは次の文字列で構成されます `<project_id>/<version_id>`。参照： [ワークスペースIDとプロジェクトID](https://docs.roboflow.com/reference/ja/ren-zheng/authentication/workspace-and-project-ids.md) で、自分のものを確認してください。
{% endhint %}

### セルフホストサーバー

Inference Serverをセルフホストすることもできます（ [Inference CLI](https://docs.roboflow.com/reference/ja/inference/inference-cli.md)）を参照し、その後 `api_url` の中で `InferenceHTTPClient`:

```python
client = InferenceHTTPClient(
    api_url="http://localhost:9001",
    api_key=os.environ["API_KEY"],
)
```

### AsyncIOクライアント

```python
import asyncio
from inference_sdk import InferenceHTTPClient

CLIENT = InferenceHTTPClient(
    api_url="http://localhost:9001",
    api_key="ROBOFLOW_API_KEY"
)

image_url = "https://source.roboflow.com/pwYAXv9BTpqLyFfgQoPZ/u48G0UpWfk8giSw7wrU8/original.jpg"
loop = asyncio.get_event_loop()
result = loop.run_until_complete(
  CLIENT.infer_async(image_url, model_id="soccer-players-5fuqs/1")
)
```

## 並列およびバッチ推論

1回の呼び出しで複数の画像に対して予測したい場合があります。次の2つのパラメータは [`InferenceConfiguration`](https://docs.roboflow.com/reference/ja/inference/inference-sdk/configuration.md) バッチ処理と並列処理を制御します：

* `max_concurrent_requests` - 開始できる同時リクエストの最大数
* `max_batch_size` - 1つのリクエストに投入できる要素の最大数

これにより、次の改善が可能になります：

* 強力なオンプレミスのGPUマシンでinferenceコンテナを実行している場合、 `max_batch_size` を適切に設定するとスループットの向上が得られる場合があります
* ホストされたRoboflow APIに対して推論を実行している場合、 `max_concurrent_requests` を設定すると複数の画像が一度に処理され、スループットの向上につながります
* 両方を組み合わせると、マシンクラスター上でinferenceコンテナを実行するクライアントに有利です。単一ノードの負荷を最適化しつつ、別々のノードへの並列リクエストを同時に行えます

```python
from inference_sdk import InferenceHTTPClient

image_url = "https://source.roboflow.com/pwYAXv9BTpqLyFfgQoPZ/u48G0UpWfk8giSw7wrU8/original.jpg"

# ROBOFLOW_API_KEY を Roboflow API Key に置き換えてください
CLIENT = InferenceHTTPClient(
    api_url="http://localhost:9001",
    api_key="ROBOFLOW_API_KEY"
)
predictions = CLIENT.infer([image_url] * 5, model_id="soccer-players-5fuqs/1")

print(predictions)
```

バッチ処理と並列処理をサポートするメソッド：

* `infer(...)` および `infer_async(...)`
* `ocr_image(...)` および `ocr_image_async(...)` （強制的に `max_batch_size=1`)
* `detect_gazes(...)` および `detect_gazes_async(...)` - **非推奨**、常に次を発生させます `inference_sdk.http.errors.FeatureDeprecatedError`
* `get_clip_image_embeddings(...)` および `get_clip_image_embeddings_async(...)`

このクライアントは次もサポートしています [中核基盤モデル](https://docs.roboflow.com/reference/ja/inference/inference-sdk/core-models.md) (CLIP、DocTR)、 [Workflowの実行](https://docs.roboflow.com/reference/ja/inference/inference-sdk/workflows.md) 複数ステップのパイプライン向け、および [WebRTCストリーミング](https://docs.roboflow.com/reference/ja/inference/inference-sdk/webrtc.md) セルフホストのInference Server上で。新しい管理されたライブカメラ処理には、 [クラウドストリーミング](https://docs.roboflow.com/deployment/roboflow-cloud/cloud-streaming)。WebRTCリファレンスには、既存の統合向けに非推奨のホスト型APIの詳細が残されています。

## 実際に予測として返されるものは何ですか？

`InferenceHTTPClient` モデル配信APIからの応答である、通常のPython辞書を返します。変更が行われるのは次の文脈に限られます `visualization` キーです。これにより、サーバーで生成された予測の可視化が保持され、任意の形式に変換できます。クライアント側のリスケーリングは入力サイズを調整するだけです。

## 次のステップ

* [設定](https://docs.roboflow.com/reference/ja/inference/inference-sdk/configuration.md) - クライアントとモデルのパラメータ、コンテキストマネージャー、デフォルト。
* [モデル管理](https://docs.roboflow.com/reference/ja/inference/inference-sdk/model-management.md) - サーバー上でモデルの事前読み込み、一覧表示、アンロード。
* [コアモデル](https://docs.roboflow.com/reference/ja/inference/inference-sdk/core-models.md) - CLIPとDocTRのエンドポイント。
* [Workflow](https://docs.roboflow.com/reference/ja/inference/inference-sdk/workflows.md) - クライアント経由でWorkflowを実行。
* [クラウドストリーミング](https://docs.roboflow.com/deployment/roboflow-cloud/cloud-streaming)：管理されたライブカメラソース、Workflowジョブ、および結果。
* [WebRTCストリーミング](https://docs.roboflow.com/reference/ja/inference/inference-sdk/webrtc.md)：セルフホストサーバー上のモデルまたはWorkflowを通じて動画をストリーミングするか、既存のレガシー統合を維持します。
