Vision Event बनाएँ

अपने deployed model से एक observation log करने के लिए HTTP API के माध्यम से एक single Vision Event रिकॉर्ड करें।

के बारे में

एक विजन इवेंट आपके तैनात कंप्यूटर विज़न मॉडल ने जो कुछ देखा उसका एक टाइमस्टैम्पयुक्त रिकॉर्ड है - उदाहरण के लिए एक पहचाना गया दोष या इन्वेंटरी गिनती - साथ में वैकल्पिक छवियाँ, पूर्वानुमान, और कस्टम मेटाडेटा। यह पृष्ठ दिखाता है कि एकल इवेंट को कैसे रिकॉर्ड किया जाए ताकि वह आपके खोजने योग्य, फ़िल्टर करने योग्य उत्पादन इतिहास का हिस्सा बन जाए। एक साथ कई इवेंट ingest करने के लिए, उपयोग करें बैच में विज़न इवेंट बनाएं.

HTTP API

अपने कंप्यूटर विज़न डिप्लॉयमेंट से एक अवलोकन रिकॉर्ड करने के लिए एकल विज़न इवेंट बनाएं।

आवश्यक स्कोप: vision-events:write या device:update

Create a Vision Event

post

Create a single vision event.

Authorizations

bearerAuth

AuthorizationstringRequired

Roboflow API key passed as a Bearer token.

Body

application/json

eventIdstring · max: 256Required

Globally unique identifier. Use a UUID (v4).

eventTypestring · enumRequiredPossible values:

useCaseIdstring · max: 256Required

The use case this event belongs to.

timestampstring · date-timeRequired

ISO 8601 timestamp. Must be between one year ago and tomorrow.

deviceIdstring · max: 256Optional

streamIdstring · max: 256Optional

workflowIdstring · max: 256Optional

workflowVersionstring · max: 64Optional

displayImagePositioninteger · max: 999Optional

eventDataobjectRequired

Type-specific event data. Structure depends on eventType.

Responses

201

Event created successfully.

application/json

eventIdstringOptional

createdbooleanOptional

deprecationsstring[]Optional

400

Validation error.

application/json

403

Insufficient permissions for this resource.

application/json

post/vision-events

HTTPcURLJavaScriptPython

POST /vision-events HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 720

{
  "eventId": "text",
  "eventType": "quality_check",
  "useCaseId": "text",
  "timestamp": "2026-08-12T11:04:44.206Z",
  "deviceId": "text",
  "streamId": "text",
  "workflowId": "text",
  "workflowVersion": "text",
  "images": [
    {
      "label": "text",
      "sourceId": "text",
      "inputSourceId": "text",
      "objectDetections": [
        {
          "class": "text",
          "x": 1,
          "y": 1,
          "width": 1,
          "height": 1,
          "confidence": 1
        }
      ],
      "classifications": [
        {
          "class": "text",
          "confidence": 1
        }
      ],
      "instanceSegmentations": [
        {
          "class": "text",
          "x": 1,
          "y": 1,
          "width": 1,
          "height": 1,
          "confidence": 1,
          "points": [
            [
              1
            ]
          ]
        }
      ],
      "keypoints": [
        {
          "class": "text",
          "x": 1,
          "y": 1,
          "width": 1,
          "height": 1,
          "confidence": 1,
          "keypoints": [
            {
              "id": 1,
              "x": 1,
              "y": 1,
              "occluded": true
            }
          ]
        }
      ]
    }
  ],
  "displayImagePosition": 1,
  "eventData": {},
  "customMetadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "eventId": "text",
  "created": true,
  "warnings": [
    {
      "type": "text",
      "path": "text",
      "value": "text",
      "valueType": "text"
    }
  ],
  "deprecations": [
    "text"
  ]
}

उदाहरण अनुरोध

curl -X POST "https://api.roboflow.com/vision-events" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "eventId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "eventType": "quality_check",
    "useCaseId": "a1b3c8e1",
    "timestamp": "2024-01-15T10:30:00Z",
    "eventData": {
      "result": "fail",
      "externalId": "batch-001"
    },
    "customMetadata": {
      "line": "A1",
      "operator": "John Doe",
      "temperature": 72.5
    }
  }'

रिक्वेस्ट बॉडी पैरामीटर

हर इवेंट में एक वैश्विक रूप से अद्वितीय eventId. हम टकराव से बचने के लिए UUID (v4) का उपयोग करने की अनुशंसा करते हैं। डुप्लिकेट event IDs पहले से ingest किए गए इवेंट्स को ओवरराइट कर देंगे.

आवश्यक फ़ील्ड:

• eventId (स्ट्रिंग, अधिकतम 256 वर्ण): इवेंट के लिए वैश्विक रूप से अद्वितीय पहचानकर्ता। UUID (v4) का उपयोग करें।

• eventType (स्ट्रिंग): इनमें से एक quality_check, inventory_count, safety_alert, custom, या operator_feedback.

• useCaseId (स्ट्रिंग, अधिकतम 256 वर्ण): वह use case जिससे यह इवेंट संबंधित है। देखें उपयोग मामले use case बनाने और प्रबंधित करने का तरीका।

• timestamp (स्ट्रिंग, ISO 8601): जब इवेंट हुआ। यह एक साल पहले से लेकर कल तक के बीच होना चाहिए।

• eventData (ऑब्जेक्ट): प्रकार-विशिष्ट इवेंट डेटा। देखें इवेंट डेटा स्कीमाएँ नीचे प्रत्येक इवेंट प्रकार के लिए आवश्यक संरचना।

वैकल्पिक फ़ील्ड:

• deviceId (स्ट्रिंग, अधिकतम 256): उस डिवाइस का पहचानकर्ता जिसने इवेंट बनाया।

• streamId (स्ट्रिंग, अधिकतम 256): वीडियो स्ट्रीम का पहचानकर्ता।

• workflowId (स्ट्रिंग, अधिकतम 256): उस वर्कफ़्लो का पहचानकर्ता जिसने इवेंट बनाया।

• workflowVersion (स्ट्रिंग, अधिकतम 64): वर्कफ़्लो का संस्करण।

• images (ऐरे, अधिकतम 1000): एनोटेशन सहित छवि ऑब्जेक्ट्स की ऐरे। देखें छवि ऑब्जेक्ट्स नीचे।

• displayImagePosition (संख्या, 0-999): छवि की सूचकांक स्थिति images ऐरे में, जिसे प्राथमिक प्रदर्शन छवि के रूप में उपयोग किया जाएगा। उदाहरण के लिए, 0 पहली छवि के लिए, 1 दूसरी के लिए, और इसी तरह।

• customMetadata (ऑब्जेक्ट, अधिकतम 100 keys): कस्टम मेटाडेटा के लिए key-value जोड़े। देखें कस्टम मेटाडेटा नीचे।

• comment (स्ट्रिंग, अधिकतम 1000): इवेंट के बारे में एक नोट। इसके साथ operator_feedback, इसमें समीक्षक का नोट होता है।

इवेंट डेटा स्कीमाएँ

की संरचना eventData इस पर निर्भर करती है eventType:

quality_check

{
  "result": "pass",
  "externalId": "batch-001"
}

• result (स्ट्रिंग, वैकल्पिक): "pass" या "fail".

• externalId (स्ट्रिंग, अधिकतम 1000, वैकल्पिक): बाहरी संदर्भ ID।

inventory_count

{
  "location": "warehouse-a",
  "itemCount": 42,
  "itemType": "pallets",
  "externalId": "inv-2024-001"
}

• location (स्ट्रिंग, अधिकतम 1000, वैकल्पिक): गिनती कहाँ ली गई थी।

• itemCount (पूर्णांक, >= 0, वैकल्पिक): गिने गए आइटमों की संख्या।

• itemType (स्ट्रिंग, अधिकतम 1000, वैकल्पिक): गिने गए आइटम का प्रकार।

• externalId (स्ट्रिंग, अधिकतम 1000, वैकल्पिक): बाहरी संदर्भ ID।

safety_alert

{
  "alertType": "no_hardhat",
  "severity": "high",
  "description": "ज़ोन B3 में आवश्यक PPE के बिना श्रमिक का पता चला।",
  "externalId": "alert-2024-001"
}

• alertType (स्ट्रिंग, अधिकतम 256, वैकल्पिक): अलर्ट का प्रकार (अल्फ़ान्यूमेरिक, अंडरस्कोर, और डैश)।

• severity (स्ट्रिंग, वैकल्पिक): "low", "medium", या "high".

• description (स्ट्रिंग, अधिकतम 10000, वैकल्पिक): अलर्ट का विवरण।

• externalId (स्ट्रिंग, अधिकतम 1000, वैकल्पिक): बाहरी संदर्भ ID।

custom

{
  "value": "कस्टम इवेंट डेटा एक स्ट्रिंग के रूप में",
  "externalId": "custom-2024-001"
}

• value (स्ट्रिंग, अधिकतम 10000, वैकल्पिक): मुक्त-रूप इवेंट डेटा।

• externalId (स्ट्रिंग, अधिकतम 1000, वैकल्पिक): बाहरी संदर्भ ID।

operator_feedback

{
  "relatedEventId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "feedback": "incorrect"
}

• relatedEventId (स्ट्रिंग, आवश्यक): उस इवेंट का event ID (UUID) जिसका यह feedback है।

• feedback (स्ट्रिंग, आवश्यक): "correct", "incorrect", या "inconclusive".

समीक्षक का नोट शीर्ष-स्तरीय comment फ़ील्ड में जाता है, इसमें नहीं eventData.

छवि ऑब्जेक्ट्स

किसी इवेंट में छवियाँ जोड़ने के लिए, आपको पहले प्रत्येक छवि को विजन इवेंट छवि अपलोड करें endpoint का उपयोग करके एक sourceId. ऐरे में प्रत्येक छवि ऑब्जेक्ट images एक एनोटेटेड (output) छवि का प्रतिनिधित्व करती है। यदि आप मूल बिना-एनोटेशन वाली (input) छवि को भी जोड़ना चाहते हैं, तो उसे अलग से अपलोड करें और उसका sourceId को inputSourceId.

{
  "label": "inspection-photo",
  "sourceId": "img-source-123",
  "inputSourceId": "camera-1",
  "objectDetections": [
    {
      "class": "defect",
      "x": 100,
      "y": 200,
      "width": 50,
      "height": 30,
      "confidence": 0.95
    }
  ],
  "classifications": [
    {
      "class": "damaged",
      "confidence": 0.87
    }
  ],
  "instanceSegmentations": [
    {
      "class": "crack",
      "x": 100,
      "y": 200,
      "width": 50,
      "height": 30,
      "confidence": 0.92,
      "points": [[100, 200], [120, 210], [110, 230]]
    }
  ],
  "keypoints": [
    {
      "class": "joint",
      "x": 100,
      "y": 200,
      "width": 50,
      "height": 30,
      "confidence": 0.88,
      "keypoints": [
        { "id": 0, "x": 105, "y": 205, "occluded": false },
        { "id": 1, "x": 115, "y": 215 }
      ]
    }
  ]
}

छवि फ़ील्ड:

• label (स्ट्रिंग, वैकल्पिक): छवि के लिए एक लेबल।

• sourceId (स्ट्रिंग, वैकल्पिक): वह sourceId से प्राप्त एनोटेटेड छवि अपलोड करने पर.

• inputSourceId (स्ट्रिंग, वैकल्पिक): वह sourceId मूल बिना-एनोटेशन (input) छवि अपलोड करने पर प्राप्त।

• objectDetections (ऐरे, अधिकतम 1000, वैकल्पिक): निम्नलिखित के साथ बॉउंडिंग बॉक्स डिटेक्शन class, x, y, width, height, और confidence (0-1).

• classifications (ऐरे, अधिकतम 1000, वैकल्पिक): निम्नलिखित के साथ वर्गीकरण परिणाम class और confidence (0-1).

• instanceSegmentations (ऐरे, अधिकतम 1000, वैकल्पिक): बॉउंडिंग बॉक्स फ़ील्ड्स के साथ सेगमेंटेशन परिणाम plus points (का ऐरे [x, y] जोड़े, न्यूनतम 3).

• keypoints (ऐरे, अधिकतम 1000, वैकल्पिक): बॉउंडिंग बॉक्स फ़ील्ड्स के साथ keypoint डिटेक्शन plus keypoints (ऐसे ऑब्जेक्ट्स का ऐरे जिनमें id, x, yऔर वैकल्पिक occludedशामिल हैं, प्रति डिटेक्शन न्यूनतम 1 keypoint).

कस्टम मेटाडेटा

आप प्रत्येक इवेंट में अधिकतम 100 key-value जोड़े कस्टम मेटाडेटा के रूप में जोड़ सकते हैं। कस्टम मेटाडेटा को विजन इवेंट्स क्वेरी करें endpoint के माध्यम से क्वेरी किया जा सकता है।

प्रतिबंध:

• Keys को इस पैटर्न से मेल खाना चाहिए [a-zA-Z0-9_ -]+ (अक्षर, अंक, अंडरस्कोर, हाइफ़न, और स्पेस), अधिकतम 100 वर्ण।

• स्ट्रिंग मान 1000 वर्णों तक सीमित हैं।

• संख्या मान 6 दशमलव स्थानों तक समर्थित हैं।

• बूलियन मान समर्थित हैं।

{
  "customMetadata": {
    "production_line": "A1",
    "shift": "morning",
    "temperature": 72.5,
    "is_overtime": false
  }
}

उदाहरण प्रतिक्रिया

201

{
  "eventId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "created": true
}

400

{
  "error": "eventType is required"
}

403

{
  "error": "Insufficient permissions for this resource."
}

मान्यता और चेतावनियाँ

Vision Events API eager ingestion का उपयोग करती है। केवल चार आवश्यक फ़ील्ड (eventId, eventType, useCaseId, timestamp) को सख्ती से सत्यापित किया जाता है। यदि ये पास हो जाते हैं, तो इवेंट हमेशा स्वीकार और संग्रहीत किया जाता है, भले ही अन्य फ़ील्ड में त्रुटियाँ हों।

गैर-आवश्यक फ़ील्ड से जुड़ी किसी भी समस्या को एक warnings ऐरे के रूप में प्रतिक्रिया में लौटाया जाता है, बजाय इसे अस्वीकृति का कारण बनाने के। इसमें शामिल हैं:

• के भीतर आवश्यक फ़ील्ड का गायब होना eventData (उदा., relatedEventId के लिए operator_feedback)

• के लिए अमान्य मान eventData फ़ील्ड (उदा., गलत enum मान severity)

• ऐसे अपरिचित फ़ील्ड जो स्कीमा का हिस्सा नहीं हैं

जब चेतावनियाँ मौजूद हों, तब अमान्य eventData को एक खाली ऑब्जेक्ट के रूप में संग्रहीत किया जाता है {}, लेकिन स्वयं इवेंट फिर भी बनाया जाता है।

{
  "eventId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "created": true,
  "warnings": [
    {
      "type": "any.required",
      "path": "eventData.relatedEventId",
      "value": null,
      "valueType": "object"
    }
  ]
}

प्रतिक्रिया में एक deprecations ऐरे भी शामिल हो सकता है यदि अप्रचलित फ़ील्ड नाम उपयोग किए गए हों।

Python SDK

अपने कंप्यूटर विज़न डिप्लॉयमेंट से एक अवलोकन रिकॉर्ड करने के लिए एकल विज़न इवेंट बनाएं।

import roboflow

roboflow.login()

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

ws.write_vision_event({
    "eventId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "eventType": "quality_check",
    "useCaseId": "a1b3c8e1",
    "timestamp": "2024-01-15T10:30:00Z",
    "eventData": {
        "result": "fail",
        "externalId": "batch-001",
    },
    "customMetadata": {
        "line": "A1",
        "operator": "John Doe",
        "temperature": 72.5,
    },
})

इवेंट पेलोड बिना किसी क्लाइंट-साइड सत्यापन के सीधे सर्वर को पास किया जाता है, इसलिए नए इवेंट प्रकार और फ़ील्ड SDK अपडेट के बिना काम करते हैं।

आवश्यक फ़ील्ड:

• eventId (स्ट्रिंग, अधिकतम 256 वर्ण): वैश्विक रूप से अद्वितीय पहचानकर्ता। UUID (v4) का उपयोग करें।

• eventType (स्ट्रिंग): इनमें से एक quality_check, inventory_count, safety_alert, custom, या operator_feedback.

• useCaseId (स्ट्रिंग): वह use case जिससे यह इवेंट संबंधित है।

• timestamp (स्ट्रिंग, ISO 8601): जब इवेंट हुआ।

वैकल्पिक फ़ील्ड:

• eventData (डिक्ट): प्रकार-विशिष्ट इवेंट डेटा।

• deviceId, streamId, workflowId (स्ट्रिंग): संदर्भ पहचानकर्ता।

• images (सूची): एनोटेशन सहित छवि ऑब्जेक्ट्स। देखें विजन इवेंट छवि अपलोड करें.

• customMetadata (डिक्ट): कस्टम मेटाडेटा के अधिकतम 100 key-value जोड़े।

• comment (स्ट्रिंग): इवेंट के बारे में एक नोट, मुख्यतः इसके साथ उपयोग किया जाता है operator_feedback.

पूर्ण इवेंट स्कीमा, प्रति प्रकार इवेंट डेटा संरचनाएँ, और छवि एनोटेशन प्रारूपों के लिए, देखें REST API संदर्भ.