For the complete documentation index, see llms.txt. This page is also available as Markdown.

वर्कस्पेसेज़ और प्रोजेक्ट्स की सूची बनाएँ

REST API, Python SDK, और CLI का उपयोग करके वर्कस्पेसेज़, प्रोजेक्ट्स, वर्ज़न, और प्रशिक्षित मॉडल्स की सूची बनाएँ।

के बारे में

वर्कस्पेस एंडपॉइंट एक वर्कस्पेस और उसमें मौजूद हर प्रोजेक्ट के बारे में मेटाडेटा लौटाता है - जिसमें प्रत्येक प्रोजेक्ट का प्रकार, इमेज और एनोटेशन की संख्या, संस्करण, और डेटासेट विभाजन शामिल हैं। इसका उपयोग उन प्रोजेक्ट्स की सूची बनाने के लिए करें जिन्हें आपका API key एक्सेस कर सकता है (उदाहरण के लिए, डेटा अपलोड करने या किसी संस्करण को एक्सपोर्ट करने से पहले प्रोजेक्ट IDs खोजने के लिए) और किसी प्रोजेक्ट के जनरेट किए गए संस्करणों, प्रशिक्षित मॉडलों, और डेटासेट एक्सपोर्ट्स में गहराई से जाने के लिए करें। यही डेटा REST API, Python SDK, और CLI के माध्यम से भी उपलब्ध है।

HTTP API

यह /:workspace एंडपॉइंट आपको आपके वर्कस्पेस और उसके प्रोजेक्ट्स के बारे में जानकारी देता है। यह एंडपॉइंट उस वर्कस्पेस के सभी प्रोजेक्ट्स की सूची देता है जिसके विरुद्ध आपका API key प्रमाणित होता है, और आप किसी भी प्रोजेक्ट में और गहराई तक जाकर उसके जनरेट किए गए संस्करणों, मॉडलों, और डेटासेट एक्सपोर्ट्स की जानकारी प्राप्त कर सकते हैं।

एंडपॉइंट URL है:

curl "https://api.roboflow.com/roboflow?api_key=$ROBOFLOW_API_KEY"

एंडपॉइंट से प्राप्त प्रतिक्रिया का एक उदाहरण यहाँ है:

{
    "workspace": {
        "name": "Roboflow",
        "url": "roboflow",
        "members": 7,
        "projects": [
            {
                "id": "roboflow/chess-sample-4ckfl",
                "type": "object-detection",
                "name": "Chess Sample",
                "created": 1630335544.592,
                "updated": 1630335741.988,
                "images": 12,
                "unannotated": 3,
                "annotation": "pieces",
                "versions": 3,
                "public": false,
                "splits": {
                    "train": 9,
                    "test": 1,
                    "valid": 2
                },
                "classes": {
                    "white-queen": 7,
                    "black-queen": 4,
                    "black-bishop": 8,
                    "white-knight": 10,
                    "white-bishop": 11,
                    "black-knight": 11,
                    "black-rook": 10,
                    "white-pawn": 34,
                    "black-pawn": 37,
                    "white-rook": 10,
                    "black-king": 8,
                    "white-king": 8
                }
            }
        ]
    }
}

एक प्रोजेक्ट प्राप्त करें और संस्करणों की सूची बनाएं

आप निम्नलिखित REST एंडपॉइंट का उपयोग करके किसी प्रोजेक्ट के बारे में जानकारी प्राप्त कर सकते हैं:

यह एंडपॉइंट निम्नलिखित संरचना के साथ एक JSON प्रतिक्रिया लौटाता है:

प्रोजेक्ट मॉडल्स की सूची बनाएं

आप निम्नलिखित का उपयोग करके किसी प्रोजेक्ट में मौजूद सभी प्रशिक्षित मॉडल्स प्राप्त कर सकते हैं /:workspace/:project/models एंडपॉइंट। यह संस्करण-प्रशिक्षित मॉडल्स और स्वतंत्र मॉडल्स (जैसे NAS चाइल्ड) दोनों लौटाता है।

के साथ Roboflow के साथ साइन इन करें (शुरुआत), उपयोग करें Authorization: Bearer और स्कोप model:infer की जगह api_key:

सभी मॉडल्स की सूची बनाएं

NAS समूह के अनुसार फ़िल्टर करें

केवल किसी विशिष्ट NAS रन के मॉडल्स की सूची बनाने के लिए, group क्वेरी पैरामीटर पास करें:

यह group मान प्रत्येक मॉडल ऑब्जेक्ट पर लौटाए गए NAS रन पहचानकर्ता का होता है। यदि समूह किसी भी मॉडल से मेल नहीं खाता, तो एंडपॉइंट एक खाली array लौटाता है।

प्रतिक्रिया

एंडपॉइंट मॉडल ऑब्जेक्ट्स की एक JSON array लौटाता है:

NAS मॉडल फ़ील्ड्स

द्वारा बनाए गए मॉडल्स न्यूरल आर्किटेक्चर सर्च में अतिरिक्त फ़ील्ड शामिल होते हैं:

फ़ील्ड
प्रकार
विवरण

nasFamily

string

"child" NAS द्वारा खोजे गए मॉडल्स के लिए, null बेसलाइन के लिए

group

string

NAS रन पहचानकर्ता, जो उसी रन के सभी मॉडल्स में साझा होता है

favorites

object

यूज़र IDs से पसंदीदा स्थिति का मानचित्र

recommended

boolean

उपस्थित और true जब यह मॉडल कम से कम एक मेट्रिक/हार्डवेयर संयोजन के लिए अनुशंसित चयन हो

metrics.map5095

number

mAP@50-95 स्कोर (प्रतिशत)

metrics.f1

number

F1 स्कोर (प्रतिशत)

metrics.hardware

string

वह हार्डवेयर लक्ष्य जिस पर मॉडल का बेंचमार्क किया गया था (उदा. "gpu", "jetson-orin-nano")

metrics.latency

number

लक्षित हार्डवेयर पर मिलीसेकंड में इन्फरेंस लेटेंसी

metrics.paretoOptimalFor

string[]

वे हार्डवेयर लक्ष्य जिनके लिए यह मॉडल Pareto frontier पर स्थित है

ये फ़ील्ड केवल NAS मॉडल्स पर मौजूद होते हैं। मानक प्रशिक्षित मॉडल्स प्रभावित नहीं होते।

Python SDK

एक वर्कस्पेस हैंडल प्राप्त करें उस वर्कस्पेस के लिए जिसके विरुद्ध आपका API key प्रमाणित होता है:

हर Roboflow API key एक ही वर्कस्पेस तक सीमित होती है। किसी अलग वर्कस्पेस के साथ काम करने के लिए, एक अलग API key का उपयोग करें (या सार्वजनिक Universe वर्कस्पेस के लिए, वर्कस्पेस स्लग पास करें):

वर्कस्पेस गुण

लौटाया गया वर्कस्पेस प्रदान करता है:

प्रोजेक्ट्स और संस्करणों की सूची बनाएं

प्रोजेक्ट्स की सूची बनाएं

अपने वर्कस्पेस में मौजूद प्रोजेक्ट्स प्राप्त करें:

प्रत्येक प्रविष्टि में प्रोजेक्ट का id (URL स्लग), प्रदर्शित नाम, प्रोजेक्ट प्रकार, इमेज संख्या, और कुछ अन्य मेटाडेटा फ़ील्ड शामिल होते हैं।

एक सार्वजनिक Universe वर्कस्पेस के साथ काम करने के लिए, उसका स्लग पास करें:

एक प्रोजेक्ट प्राप्त करें

या शीर्ष-स्तरीय शॉर्टकट का उपयोग करें:

संस्करणों की सूची बनाएं

project.versions() लौटाता है Version ऑब्जेक्ट्स जिन्हें आप सीधे मेथड्स के साथ कॉल कर सकते हैं (download, train, deleteआदि)। हल्के dict प्रतिक्रिया के लिए, उपयोग करें project.list_versions() या project.get_version_information().

एक संस्करण प्राप्त करें

संख्यात्मक - संस्करण 1 से आरंभ होते हैं।

CLI

वर्कस्पेसेस की सूची बनाएं

आप CLI के साथ उन सभी वर्कस्पेसेस की सूची प्राप्त कर सकते हैं जिनके आप सदस्य हैं।

CLI के साथ वर्कस्पेसेस की सूची बनाने के लिए, निम्नलिखित कमांड का उपयोग करें:

यह उनके संबंधित ऐप्लिकेशन लिंक और Workspace IDs के साथ वर्कस्पेसेस की सूची लौटाएगा:

आउटपुट को JSON के रूप में प्राप्त करने के लिए (स्क्रिप्ट्स या AI agents में उपयोग हेतु):

किसी वर्कस्पेस में प्रोजेक्ट्स की सूची बनाएं

किसी वर्कस्पेस में प्रोजेक्ट्स की सूची बनाने के लिए, निम्नलिखित कमांड का उपयोग करें:

यदि आपने डिफ़ॉल्ट वर्कस्पेस कॉन्फ़िगर किया है, तो -w फ्लैग वैकल्पिक है। अन्यथा, इसे निर्दिष्ट करें:

यह प्रोजेक्ट्स की एक तालिका लौटाएगा:

आउटपुट को JSON के रूप में प्राप्त करने के लिए:

एक प्रोजेक्ट प्राप्त करें

किसी प्रोजेक्ट के बारे में विस्तृत जानकारी प्राप्त करने के लिए, निम्नलिखित कमांड का उपयोग करें:

आप resource shorthand का उपयोग कर सकते हैं - वर्कस्पेस को अलग से निर्दिष्ट करने की आवश्यकता नहीं है:

यह उसके संस्करणों सहित प्रोजेक्ट के बारे में जानकारी लौटाएगा:

पूर्ण JSON प्रतिक्रिया प्राप्त करने के लिए:

MCP सर्वर

अपने AI agent को MCP सर्वर से जोड़ें और यह इन टूल्स के साथ आपके workspace में क्या है, इसकी सूची बना सकता है:

टूल
विवरण

projects_list

वर्कस्पेस में प्रोजेक्ट्स की सूची बनाएं।

projects_get

संस्करणों, कक्षाओं, विभाजनों और प्रशिक्षित मॉडलों सहित प्रोजेक्ट विवरण प्राप्त करें।

अंतिम अपडेट

क्या यह उपयोगी था?