Workflows Schema API

प्रोग्रामेटिक रूप से Workflow के inputs, outputs, typing hints, और kind schemas का वर्णन करें।

वर्कफ़्लोज़ स्कीमा 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"]

इनपुट और आउटपुट

यह इनपुट और आउटपुट कुंजियाँ वर्कफ़्लो के चलने और वापस आने के लिए अपेक्षित सभी इनपुट और आउटपुट दिखाती हैं।

टाइपिंग संकेत

यह typing_hints कुंजी इनपुट और आउटपुट के डेटा प्रकार दिखाती है।

काइंड्स स्कीमाएँ

यह kinds_schemas कुंजी एक OpenAPI विनिर्देश लौटाती है जिसमें लौटाए जा रहे डेटा प्रकारों और उन्हें कैसे पार्स करना है, इसकी अधिक विस्तृत जानकारी होती है। उदाहरण के लिए, object_detection_prediction में उस नेस्टेड डेटा की जानकारी होती है जो मौजूद होगा।