कस्टम मेटाडेटा स्कीमा प्राप्त करें

Use Case में Vision Events के across उपयोग किए जाने वाले custom metadata fields और types प्राप्त करें।

के बारे में

यह एंडपॉइंट उन कस्टम मेटाडेटा फ़ील्ड्स को लौटाता है जिनका उपयोग पूरे विजन इवेंट्स किसी दिए गए उपयोग केस. क्योंकि कस्टम मेटाडेटा किसी निश्चित स्कीमा के बजाय प्रति इवेंट परिभाषित होता है, इसलिए इसका उपयोग यह जानने के लिए करें कि कौन-से फ़ील्ड मौजूद हैं और उनके प्रकार क्या हैं, इससे पहले कि आप बनाएं इवेंट क्वेरीज़ या डैशबोर्ड फ़िल्टर।

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"]
    }
  }
}

में प्रत्येक फ़ील्ड फ़ील्ड्स ऑब्जेक्ट में शामिल है:

• प्रकार (स्ट्रिंग्स की array): इस फ़ील्ड के लिए देखे गए डेटा प्रकार, जिनमें से प्रत्येक स्ट्रिंग, संख्याया बूलियन. यदि अलग-अलग इवेंट्स ने एक ही कुंजी के लिए अलग-अलग प्रकारों का उपयोग किया हो, तो किसी फ़ील्ड के कई प्रकार हो सकते हैं।

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 reference.