Workflows 스키마 API

Workflow의 입력, 출력, 타입 힌트, 유형 스키마를 프로그램적으로 설명합니다.

Workflows Schema API는 개발자에게 워크플로의 구조, 입력, 출력을 명확하고 프로그래밍 방식으로 이해할 수 있게 해줍니다. 이는 워크플로의 입력 요구사항과 출력 유형을 프로그래밍 방식으로 결정하는 문제를 해결합니다.

목적 및 이점

이 API는 다음에 대한 구조화된 접근을 제공합니다:

1. 입력 매개변수: 필수 워크플로 입력입니다.

2. 출력 구조: 반환된 데이터의 세부 정보입니다.

3. 타입 힌트: 입력과 출력에 대해 예상되는 데이터 유형입니다.

4. 종류의 스키마: 복잡한 데이터 유형에 대한 상세 스키마입니다.

이를 통해 개발자는 다음을 할 수 있습니다:

• 입력을 프로그래밍 방식으로 검증하기

• 출력 데이터 구조 이해하기

• 워크플로를 더 큰 시스템에 통합하기

• 워크플로 요구사항을 기반으로 문서나 UI 생성하기

API 사용하기

import requests

WORKSPACE_NAME = "workspace-name"
WORKFLOW_ID = "workflow-id"
INFERENCE_SERVER_URL = "https://serverless.roboflow.com"

WORKFLOW_SCHEMA_ENDPOINT = f"{INFERENCE_SERVER_URL}/{WORKSPACE_NAME}/workflows/{WORKFLOW_ID}/describe_interface"
ROBOFLOW_API_KEY = "Roboflow API 키"

headers = {
    "Content-Type": "application/json",
}

data = {
    "api_key": ROBOFLOW_API_KEY,
}

res = requests.post(WORKFLOW_SCHEMA_ENDPOINT, headers=headers, json=data)

schema = res.json()

inputs = schema["inputs"]
outputs = schema["outputs"]
kinds_schemas = schema["kinds_schemas"]
typing_hints = schema["typing_hints"]

입력과 출력

이 inputs 및 outputs keys는 워크플로가 실행되고 반환할 것으로 예상하는 모든 입력과 출력을 보여줍니다.

타입 힌트

이 typing_hints 키는 입력과 출력의 데이터 유형을 보여줍니다.

종류 스키마

이 kinds_schemas 키는 반환되는 데이터 유형과 이를 파싱하는 방법에 대한 더 자세한 정보를 담은 OpenAPI 사양을 반환합니다. 예를 들어, object_detection_prediction 는 존재할 중첩 데이터에 대한 정보를 포함합니다.