사용자 지정 메타데이터 스키마 가져오기

사용 사례 전반에서 Vision Events에 사용되는 사용자 지정 메타데이터 필드와 유형을 가져옵니다.

소개

이 엔드포인트는 다음 전반에서 사용된 사용자 지정 메타데이터 필드를 반환합니다 Vision Events 주어진 사용 사례. 사용자 지정 메타데이터는 고정 스키마가 아니라 이벤트별로 정의되므로, 빌드하기 전에 어떤 필드가 존재하는지와 그 유형을 알아내는 데 이를 사용하세요 이벤트 쿼리 또는 대시보드 필터.

HTTP API

특정 사용 사례에 대해 이벤트에서 사용된 사용자 지정 메타데이터 필드의 스키마를 검색합니다. 이는 다음에서 필터링에 사용할 수 있는 메타데이터 필드가 무엇인지 알아내는 데 유용합니다 쿼리 요청.

필수 스코프: vision-events:read 또는 device:read

Get Custom Metadata Schema

get

Retrieve the schema of custom metadata fields for a given use case.

Authorizations

bearerAuth

AuthorizationstringRequired

Roboflow API key passed as a Bearer token.

Path parameters

useCaseIdstringRequired

The use case ID.

Responses

200

Metadata schema.

application/json

solutionstringOptional

403

Insufficient permissions for this resource.

application/json

get/vision-events/custom-metadata-schema/{useCaseId}

HTTPcURLJavaScriptPython

GET /vision-events/custom-metadata-schema/{useCaseId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "solution": "text",
  "fields": {
    "ANY_ADDITIONAL_PROPERTY": {
      "types": [
        "string"
      ]
    }
  }
}

경로 매개변수

• :useCaseId (문자열, 필수): 사용 사례 ID.

예시 요청

curl "https://api.roboflow.com/vision-events/custom-metadata-schema/a1b3c8e1" \
  -H "Authorization: Bearer YOUR_API_KEY"

예시 응답

200

{
  "fields": {
    "production_line": {
      "types": ["string"]
    },
    "temperature": {
      "types": ["number"]
    },
    "is_overtime": {
      "types": ["boolean"]
    }
  }
}

다음의 각 필드는 필드 객체에는 다음이 포함됩니다:

• 유형 (문자열 배열): 이 필드에 대해 관찰된 데이터 유형이며, 각각은 다음 중 하나입니다 문자열, 숫자, 또는 boolean. 필드는 서로 다른 이벤트에서 동일한 키에 서로 다른 유형을 사용한 경우 여러 유형을 가질 수 있습니다.

403

{
  "error": "이 리소스에 대한 권한이 충분하지 않습니다."
}

Python SDK

특정 사용 사례에 대해 이벤트에서 사용된 사용자 지정 메타데이터 필드를 확인합니다. 이는 다음을 사용해 쿼리를 작성할 때 유용합니다 customMetadataFilters.

import roboflow

roboflow.login()

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

schema = ws.get_vision_event_metadata_schema("a1b3c8e1")

for field, info in schema["fields"].items():
    print(f"{field}: {info['types']}")

응답에는 다음이 포함됩니다. 필드 발견된 각 필드 이름을 관찰된 유형에 매핑하는 dict(예: ["string"], ["number"]). 이 정보를 사용하면 다음을 수행할 때 유형이 지정된 필터를 구성할 수 있습니다 이벤트를 쿼리할 때:

page = ws.query_vision_events(
    "a1b3c8e1",
    customMetadataFilters=[
        {"field": "temperature", "operator": "gt", "value": 70, "type": "number"}
    ],
)

자세한 내용은 다음을 참조하세요 REST API 참조.