Rivya API क्या है?

Rivya API डेवलपर एकीकरण का अनुबंध है। व्यवस्था में Public API चालू होने और खाते को पहुंच मिलने पर इससे अपने उत्पाद, स्क्रिप्ट या कार्यप्रवाह में Rivya की समर्थित मॉडल क्षमताएं इस्तेमाल की जा सकती हैं।

यह Rivya Studio से अलग उत्पाद नहीं है। यह वही खाता सीमा, वही क्रेडिट वॉलेट और वही सार्वजनिक मॉडल परत इस्तेमाल करता है जो उपयोगकर्ता को Rivya में दिखती है। फर्क केवल काम शुरू करने के तरीके में है: Studio में क्लिक करने के बजाय आपका ऐप API कुंजी के साथ अनुरोध भेजता है।

अगर आपको एंडपॉइंट विवरण चाहिए, तो Rivya API परिचय और Rivya API त्वरित शुरुआत से शुरू करें। यह लेख उत्पाद-स्तर की व्याख्या है: API किसलिए है, कहां उपयुक्त है और कब इसे पहला मार्ग नहीं बनाना चाहिए।

छोटा संस्करण

Rivya API v1 योग्य लॉग-इन खाते को API कुंजियां बनाने और वेब इंटरफेस के बाहर से API के लिए तैयार Rivya मॉडल इस्तेमाल करने देती है। डेवलपर पेज लागू एकीकरण अनुबंध बताते हैं; अनुरोध चलेगा या नहीं, यह उपलब्ध व्यवस्था, खाते की अनुमतियों और मॉडल की तैयारी पर निर्भर है।

लागू किए गए API हिस्सा में शामिल हैं:

• API मॉडल सूची से मॉडल खोज

• असिंक्रोनस इमेज, वीडियो और ऑडियो जनरेशन कार्य

• संदर्भ मीडिया चाहने वाले मॉडल के लिए Files API से अपलोड

• सार्वजनिक कार्य ID से जनरेशन की स्थिति पोल करना

• खाता क्रेडिट जांच

• बातचीत API बातचीत के दौर, वैकल्पिक SSE स्ट्रीमिंग सहित

• व्यवस्था में वेबहुक चालू होने पर निर्माण पूरा होना के लिए प्रवेश किया हुआ वेबहुक

• क्लाइंट आवरण चाहने वाली टीम के लिए TypeScript SDK परीक्षण संस्करण

सार्वजनिक डेवलपर केंद्र डेवलपर है। अगर आपको निर्देशित परिचय, API कुंजी सेटिंग के लिंक और सुरक्षित डीबगर प्रक्रिया चाहिए, तो यह सबसे अच्छा प्रवेश बिंदु है।

Rivya के पास API क्यों है

जब कोई व्यक्ति अभी मॉडल चुन रहा हो, प्रॉम्प्ट आकार कर रहा हो, नतीजे समीक्षा कर रहा हो और अगला चरण तय कर रहा हो, Studio उपयोगी है।

API तब उपयोगी है जब वह निर्णय दोहराने योग्य उत्पाद या संचालन संबंधी कार्यप्रवाह बन चुका हो।

API पहुंच चालू होने पर आम उदाहरण हैं:

• उपयोगकर्ता के संक्षिप्त विवरण भेजने के बाद उत्पाद चित्रों के अलग-अलग संस्करण तैयार करने हैं

• विपणन कार्यप्रवाह संरचित अभियान इनपुट से दृश्य मसौदे बनाना चाहता है

• कोई आंतरिक टूल ब्राउज़र खोले बिना वीडियो या ऑडियो कार्य भेजना चाहता है

• समर्थन या सामग्री व्यवस्था अपने इंटरफेस में बातचीत मॉडल बातचीत का दौर चाहता है

• बैकएंड सेवा निर्माण कार्य पूरा होने पर प्रमाणित कॉलबैक पाना चाहती है

इन स्थितियों में Rivya API काम को एक ही Rivya खाते से जोड़े रखती है, ताकि बिलिंग, मॉडल चयन और कार्य स्थिति के लिए अलग तंत्र न बनाना पड़े।

API क्या जगह लेना नहीं करती

API Rivya को सीधे इस्तेमाल करने की हर वजह जगह लेना नहीं करती।

Studio या सार्वजनिक काम हिस्से इस्तेमाल करें जब:

• प्रॉम्प्ट को अभी मानवीय खोज और प्रयोग की जरूरत है

• मॉडल का चुनाव स्थिर नहीं है

• रचनाकार को नतीजों की दृश्य तुलना करनी है

• परियोजना सहेजे गए इतिहास और मानवीय समीक्षा पर निर्भर है

• टीम ने तय नहीं किया कि कौन सा इनपुट और नतीजा प्रारूप दोहराने योग्य बनना चाहिए

जब कार्यप्रवाह स्वचालित करने लायक स्पष्ट हो जाए, तब API इस्तेमाल करें।

यह सीमा मायने रखती है। अस्पष्ट रचनात्मक सवाल आम तौर पर पहले Studio में रहने चाहिए। तय और अनुमान योग्य इनपुट वाली उत्पाद प्रक्रिया API में चल सकती है।

मुख्य घटक

API को छह जुड़े हुए हिस्सों की तरह समझें।

अनुरोध और जवाब की संरचना के लिए API दस्तावेज मूल स्रोत हैं। यह लेख यह तय करने में मदद करता है कि पहले कौन-सा हिस्सा चाहिए।

क्रेडिट कैसे काम करते हैं

API का उपयोग Studio की तरह उसी Rivya खाता क्रेडिट वॉलेट से क्रेडिट खर्च करता है।

इसका मतलब है कि API गुमनाम मॉडल माध्यम नहीं है। हर अनुरोध किसी Rivya खाते से जुड़ा होता है, उसी खाते से बनाई गई API कुंजी इस्तेमाल करता है और API क्रेडिट में बताई उत्पाद-स्तर की क्रेडिट सीमा मानता है।

टीम के लिए यह उपयोगी है क्योंकि Studio के प्रयोग और API का उपयोग एक ही संचालन व्यवस्था में रहते हैं। आप मॉडल को स्वयं परख सकते हैं और फिर दोहराए जा सकने वाले हिस्से को अलग बिलिंग परत बनाए बिना एकीकरण में चला सकते हैं।

फाइलें कैसे उपयुक्तता होती हैं

कुछ मॉडल सिर्फ टेक्स्ट से प्रयास कर सकते हैं। दूसरे मॉडल को संदर्भ चित्र, वीडियो या ध्वनि फाइल चाहिए।

API एकीकरण में ये संदर्भ Files API के जरिए भेजे जाने चाहिए। अपलोड एक प्रबंधित फ़ाइल रिकॉर्ड बनाता है, जिसे समर्थित मॉडल पैरामीटर में भेजा जा सकता है।

व्यावहारिक नियम सरल है:

• अगर मॉडल केवल टेक्स्ट इनपुट स्वीकार करता है करता है, तो निर्माण समापन बिंदु से शुरू करें

• अगर मॉडल को संदर्भ माध्यम चाहिए, तो पहले फाइल अपलोड करें

• अगर यह चैट मॉडल है और इमेज संलग्न करनी है, तो Chat API और फाइल आईडी इस्तेमाल करें

अपने एकीकरण को केवल ब्राउज़र में चलने वाली अपलोड प्रक्रिया या सहेजे हुए Studio सत्र के आधार पर डिजाइन न करें। API की अपनी सार्वजनिक फाइल सीमा इसी कारण है।

वेबहुक कहां मदद करते हैं

पोलिंग सबसे सरल शुरुआती एकीकरण है। जनरेशन कार्य भेजें, सार्वजनिक कार्य ID सुरक्षित रखें और सफलता या विफलता तक स्थिति पोल करें।

व्यवस्था में वेबहुक चालू हों, तो एकीकरण के निर्माण के करीब पहुंचने पर वे उपयोगी होते हैं:

• आप हर काम के लिए कोई प्रक्रिया बार-बार स्थिति जांचती नहीं रखना चाहते

• निर्माण पूरा होने पर ऐप को रिकॉर्ड अद्यतन करना है

• आपको ऐसी लॉग इन घटना चाहिए जिसे सुरक्षित ढंग से दोबारा भेजा जा सके

• विफल काम को साफ पुनर्प्राप्ति मार्ग में जाना है

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

अच्छा पहला API परियोजना

पहली API परियोजना आम तौर पर छोटी और ठोस होनी चाहिए।

उदाहरण के लिए:

1. पक्का करें कि व्यवस्था और खाता के लिए API पहुंच चालू है

2. सेटिंग में API कुंजी बनाएं

3. मॉडल सूची देखें

4. एक API-तैयार मॉडल चुनें

5. idempotency कुंजी के साथ एक जनरेशन कार्य भेजें

6. स्थिति एंडपॉइंट को पोल करें

7. पहले और बाद में क्रेडिट जांचें

8. इसके बाद जरूरत के अनुसार Files API, Chat API या वेबहुक जोड़ें

यह मार्ग पहले परीक्षण में हर API सुविधा जोड़े बिना काम करने वाला एकीकरण देता है।

कब API गलत शुरुआती बिंदु है

API शायद सही पहला चरण नहीं है जब:

• टीम ने अभी मॉडल समूह नहीं चुनी है

• वांछित नतीजा हर प्रयास में बदल रहा है

• प्रॉम्प्ट मानवीय पसंद और समीक्षा पर निर्भर है

• एकीकरण क्रेडिट उपयोग उन लोगों से छिपा देगा जिन्हें उसे समझना चाहिए

• उत्पाद को स्वचालन से पहले सार्वजनिक प्रदर्शन चाहिए

इन स्थितियों में चित्र, वीडियो, ध्वनि, बातचीत, या AI मॉडल से शुरू करें। रास्ता दोहराने योग्य हो जाए, तब उसके स्थिर हिस्से को API में चलाएं।

आगे कहां जाएं

• सार्वजनिक API केंद्र और त्रुटि-जांच के लिए डेवलपर खोलें।

• पहला सुरक्षित अनुरोध बनाने के लिए Rivya API की त्वरित शुरुआत पढ़ें।

• सर्वर पर कुंजी रखने से पहले API पहचान सत्यापन पढ़ें।

• मॉडल आईडी चुनने से पहले API मॉडल पढ़ें।

• उत्पाद सीमा अभी अस्पष्ट है तो Studio के बजाय Rivya API कब इस्तेमाल करें पढ़ें।

• पूरा इमेज, वीडियो, ऑडियो या चैट एकीकरण बनाने के लिए Rivya API से मल्टीमोडल AI कार्यप्रवाह कैसे बनाएं पढ़ें।