Vision Event 이미지 업로드

워크스페이스 수준 이미지를 업로드하고 Vision Event를 만들 때 해당 sourceId를 참조합니다.

소개

이 엔드포인트는 워크스페이스에 이미지를 업로드하여 다음에서 사용할 수 있게 합니다 비전 이벤트. 업로드는 워크스페이스 수준이며 어떤 프로젝트에도 연결되지 않습니다. 반환된 sourceId 그런 다음 참조할 수 있습니다 images 배열에 이벤트를 생성할 때. 이를 사용해 모델이 처리한 원본 또는 출력 프레임을 첨부하여 이벤트와 함께 볼 수 있게 합니다.

HTTP API

비전 이벤트에서 사용할 이미지를 업로드합니다. 이는 특정 프로젝트와 연결되지 않는 워크스페이스 수준의 업로드이며, 반환된 sourceId 다음에서 참조할 수 있습니다 images 이벤트를 생성할 때 배열에 사용할 수 있습니다.

필요한 범위: vision-events:write 또는 device:update

Upload a Vision Event Image

post

Upload an image for use in vision events.

Authorizations

bearerAuth

AuthorizationstringRequired

Roboflow API key passed as a Bearer token.

Body

multipart/form-data

filestring · binaryRequired

The image file to upload.

namestringOptional

Custom name for the image.

metadatastringOptional

JSON string of custom metadata.

Responses

201

Image uploaded successfully.

application/json

successbooleanOptional

sourceIdstringOptional

Reference ID for use in event images.

urlstringOptional

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 필드를 사용할 때 비전 이벤트를 생성할 때:

{
  "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."
}

파이썬 SDK

로컬 이미지를 업로드하여 비전 이벤트에서 사용할 수 있습니다. 반환된 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 배열에 비전 이벤트를 생성할 때:

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 참조 문서.