Vision Eventの画像をアップロード

ワークスペースレベルの画像をアップロードし、Vision Event を作成する際に sourceId を参照します。

概要

このエンドポイントは、ワークスペースに画像をアップロードし、 Vision Events。アップロードはワークスペース単位で行われ、特定のプロジェクトには紐づきません。返される sourceId は、 images 配列で、あなたが イベントを作成する際に。これを使って、モデルが処理した元のフレームまたは出力フレームを添付し、イベントと一緒に表示できるようにします。

HTTP API

Vision Events で使用する画像をアップロードします。これはワークスペース単位のアップロードで、特定のプロジェクトには関連付けられません。返される sourceId は、 images イベント作成時の配列で参照できます。

必要なスコープ: vision-events:write または device:update

Upload a Vision Event Image

post

Upload an image for use in vision events.

認可

bearerAuth

Authorizationstring必須

Roboflow API key passed as a Bearer token.

本文

multipart/form-data

filestring · binary必須

The image file to upload.

namestringオプション

Custom name for the image.

metadatastringオプション

JSON string of custom metadata.

レスポンス

201

Image uploaded successfully.

application/json

successbooleanオプション

sourceIdstringオプション

Reference ID for use in event images.

urlstringオプション

Public URL of the uploaded image.

400

Missing file or invalid metadata.

application/json

403

Insufficient permissions for this resource.

application/json

post/vision-events/upload

HTTPcURLJavaScriptPython

POST /vision-events/upload HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 49

{
  "file": "binary",
  "name": "text",
  "metadata": "text"
}

{
  "success": true,
  "sourceId": "text",
  "url": "text"
}

リクエスト例

curl -X POST "https://api.roboflow.com/vision-events/upload" \\
  -H "Authorization: Bearer YOUR_API_KEY" \\
  -F "file=@inspection-photo.jpg" \\
  -F "name=inspection-photo.jpg"

リクエストパラメータ

送信形式 multipart/form-data:

• file (バイナリ、必須): アップロードする画像ファイル。対応形式: JPEG、PNG、WebP、GIF、TIFF、BMP、HEIC、AVIF。

• name (文字列、任意): 画像のカスタム名。

• metadata (JSON 文字列、任意): 画像に添付するカスタムメタデータ。イベントのカスタムメタデータと同じ制約に従う有効な JSON オブジェクトである必要があります: 最大100キー、キー名は一致する必要があります [a-zA-Z0-9_ -]+ (最大100文字)。文字列値は最大1000文字で、数値および真偽値もサポートされています。で始まるキーは _rf_internal_ は Roboflow 専用に予約されており、拒否されます。

レスポンス例

201

{
  "success": true,
  "sourceId": "ve-img-abc123def456",
  "url": "https://storage.roboflow.com/vision-events/images/ve-img-abc123def456.jpg"
}

次を使用してください sourceId の値を images[].sourceId フィールドは、 Vision Event を作成するときに:

{
  "eventId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "eventType": "quality_check",
  "useCaseId": "a1b3c8e1",
  "timestamp": "2024-01-15T10:30:00Z",
  "images": [
    {
      "sourceId": "ve-img-abc123def456",
      "objectDetections": [
        {
          "class": "defect",
          "x": 100,
          "y": 200,
          "width": 50,
          "height": 30,
          "confidence": 0.95
        }
      ]
    }
  ],
  "eventData": {
    "result": "fail"
  }
}

400

{
  "error": "No file provided"
}

403

{
  "error": "Insufficient permissions for this resource."
}

Python SDK

ローカルの画像をアップロードして、Vision Events で使用できるようにします。返される sourceId は、 images イベント作成時の配列で参照できます。

import roboflow

roboflow.login()

rf = roboflow.Roboflow()
ws = rf.workspace()

# 画像をアップロード
result = ws.upload_vision_event_image("inspection-photo.jpg")
source_id = result["sourceId"]

# 任意の名前とメタデータも指定できます
result = ws.upload_vision_event_image(
    "inspection-photo.jpg",
    name="line-a-check-001",
    metadata={"camera": "cam-1", "shift": "morning"},
)

この sourceId レスポンスの値は、 images 配列で Vision Event を作成するときに:

ws.write_vision_event({
    "eventId": "d4e5f6a7-b2c3-4d4e-9f6a-7b8c9d0e1f2a",
    "eventType": "quality_check",
    "useCaseId": "a1b3c8e1",
    "timestamp": "2024-01-15T10:30:00Z",
    "images": [
        {
            "sourceId": source_id,
            "label": "inspection-photo",
            "objectDetections": [
                {"class": "defect", "x": 100, "y": 200, "width": 50, "height": 30, "confidence": 0.95}
            ],
        }
    ],
    "eventData": {"result": "fail"},
})

対応している画像形式とメタデータの制約については、 REST API リファレンス.