API उपयोगकर्ता और संगतता
VoiceStudio के कौन से इंटरफ़ेस सार्वजनिक हैं, कौन केवल ब्राउज़र के लिए हैं और कौन कभी ग्राहक सतह नहीं हैं।
कंट्रोल-प्लेन का हर ऑपरेशन एक उपयोगकर्ता वर्ग का है। एक OpenAPI स्रोत साझा करने से ऑपरेशन सार्वजनिक नहीं हो जाता।
| उपयोगकर्ता वर्ग | रूट | कौन कॉल करता है | यहाँ प्रकाशित? |
|---|---|---|---|
| सार्वजनिक डेवलपर API | /v1/* | सीमित अधिकार वाली डेवलपर क्रेडेंशियल | हाँ, Cloud प्रोजेक्शन में |
| वेबसाइट एज API | जाँचा गया अनाम /v1/marketing/* | साइट के अपने फ़ॉर्म | नहीं |
| डैशबोर्ड/BFF API | /dashboard/v1/* | समान-ऑरिजिन सत्र वाला डैशबोर्ड | नहीं |
| ऑपरेटर API | जाँचा गया /internal/v1/* | प्लेटफ़ॉर्म ऑपरेटर | नहीं |
| आंतरिक सेवा API | अन्य /internal/v1/* | निजी सेवाएँ | नहीं |
वेबसाइट एज, ऑपरेटर और आंतरिक रूट कभी ग्राहक API का हिस्सा नहीं हैं। वे /cloud-openapi.json में नहीं हैं, उनके विशिष्ट स्कीमा भी नहीं। ब्राउज़र को कभी डेवलपर क्रेडेंशियल नहीं मिलता और सार्वजनिक क्लाइंट कभी डैशबोर्ड सत्र कुकी इस्तेमाल नहीं करते।
संगतता
उत्पादों के बीच कोई संगतता उपसमूह जारी नहीं हुआ है। स्थानीय 0.5.0 और Cloud प्रीव्यू 1.0.0 दोनों कॉन्ट्रैक्ट में POST /v1/audio/transcriptions है, लेकिन फ़ील्ड, प्रमाणीकरण, Artifact और Job व्यवहार, टाइमआउट और त्रुटियों को परस्पर बदलने योग्य नहीं बताया गया है। इसके लिए संस्करणों की निर्दिष्ट जोड़ी पर #71 के व्यवहार परीक्षण पास होने चाहिए। तब तक एक जैसा रूट नाम केवल समानता है, संगतता नहीं।
Cloud जारी करना
OpenAPI दस्तावेज़ या चलने योग्य उदाहरणों में सक्रिय Cloud सर्वर प्रकाशित करना रिलीज़ का चरण है। इसके लिए क्रम से चाहिए:
- सत्यापित प्रोडक्शन DNS और TLS।
- प्रमाणीकरण, सार्वजनिक रूटिंग और ग्राहक-सुरक्षित विफलताओं के स्मोक टेस्ट।
- सटीक संस्करणों के लिए #71 संगतता और रोलबैक जाँच।
- पुनः बनाया गया प्रोजेक्शन जिसमें
unavailableन हो।
रोलबैक सक्रिय सर्वर हटाता है। टिकाऊ Jobs, Artifacts और idempotency रिकॉर्ड वैसे ही रहते हैं।