Document-Q&A वर्कफ़्लो में OpenAI API Keys को सुरक्षित रखें
OpenAI के साथ document question answering के लिए एक व्यावहारिक सुरक्षा तरीका: क्रेडेंशियल अलग रखें, अनुमतियाँ सीमित करें, लॉग से संवेदनशील जानकारी हटाएँ और स्रोत attribution बनाए रखते हुए keys को सुरक्षित रूप से rotate करें।
सारांश · TL;DR
Document-Q&A ऐप्लिकेशन में OpenAI ऐप्लिकेशन क्रेडेंशियल को किसी भरोसेमंद सर्वर-साइड secret store में रखें—ब्राउज़र, sandbox, source file या log में नहीं। हर workload को केवल ज़रूरी access दें, logs से संवेदनशील डेटा हटाएँ और दर्ज overlap-and-revoke प्रक्रिया के अनुसार credentials rotate करें। हर जवाब के साथ source references दें, ताकि उपयोगकर्ता retrieved documents के आधार पर दावों की जाँच कर सकें।
मुख्य बातें
- OpenAI ऐप्लिकेशन key को agent-generated code और अन्य अविश्वसनीय execution environments से बाहर रखें।
- एक समर्पित project या workload boundary का उपयोग करें और ऐप्लिकेशन को केवल ज़रूरी API permissions दें।
- Credentials, document passages या पूरे prompts के बजाय request IDs, timings और source identifiers log करें।
- जवाबों के साथ document IDs और page या section references दें; धाराप्रवाह जवाब को प्रमाण न मानें।
- Replacement credential deploy करके, traffic की पुष्टि करने के बाद पुरानी key revoke करें; exposure का संदेह हो तो तुरंत revoke करें।
इस पृष्ठ पर (6)
Document-Q&A सिस्टम को दो काम अच्छी तरह करने चाहिए: सही सामग्री के आधार पर जवाब देना और credentials को सामग्री-प्रसंस्करण के रास्ते से बाहर रखना। सबसे सुरक्षित सामान्य तरीका यह है कि कोई भरोसेमंद application server OpenAI को call करे और retrieval तथा citation handling आपके अपने workflow के स्पष्ट हिस्से बने रहें। Application key को browser, document, prompt, source repository या agent की पहुँच वाले sandbox में न रखें।
भरोसे की सीमा तय करें
एक सामान्य flow यह है: उपयोगकर्ता सवाल पूछता है; आपका application किसी अधिकृत document store से प्रासंगिक passages retrieve करता है; server सवाल और चुने हुए passages OpenAI को भेजता है; और application उन passages के references के साथ जवाब लौटाता है। Key server side पर, किसी managed secret store या उसके समकक्ष सुरक्षित configuration में होनी चाहिए—ऐसे code में नहीं जो उपयोगकर्ता को भेजा जाए, या ऐसे workload में नहीं जो अपने environment की जाँच कर सके।
OpenAI की sandbox security guidance चेतावनी देती है कि agent-generated code अपने environment में उपलब्ध files, credentials और network resources तक पहुँच सकता है। इसमें isolated workloads का उपयोग करने, जहाँ डेटा साझा नहीं होना चाहिए वहाँ अलग environments रखने, applications या workloads के लिए dedicated OpenAI projects बनाने और application API key को environment से बाहर रखने की सलाह दी गई है। यह भी कहा गया है कि keys को images, source code या logs में embed न करें। देखें OpenAI sandbox security guidance।
Document Q&A में इसका मतलब है कि uploaded documents और model-generated code को अविश्वसनीय inputs मानें। Retrieval worker को उसके काम के लिए ज़रूरी documents और tools ही दें। केवल इसलिए उसे unrestricted application credential न दें कि उसे inference के लिए सवाल भेजना है।
अनुमतियाँ सीमित करें और credentials अलग रखें
इस application के लिए अलग project या credential boundary बनाएँ; अलग-अलग workloads में एक व्यापक उपयोग वाली key साझा न करें। आपके implementation में जिन API operations का वास्तव में उपयोग होता है, उनके लिए उपलब्ध सबसे सीमित permissions लागू करें। OpenAI की उद्धृत guidance में sessions के लिए api.agents.read और api.agents.write, inference के लिए api.responses.write, तथा vault management के लिए api.vaults.read और api.vaults.write बताए गए हैं। ये दस्तावेज़ में दिए गए Agents API उपयोग के उदाहरण हैं; हर permission डिफ़ॉल्ट रूप से न दें। जिन APIs को आप वास्तव में call करते हैं, उनके लिए आवश्यक permissions की पुष्टि करें।
अगर executor environment को OpenAI से connect करना है, तो guide इस connection के लिए अलग environment key इस्तेमाल करने का वर्णन करती है। इसके अनुसार, यह key environments को connect करने की अनुमति देती है और अन्य API actions को authorize नहीं कर सकती। इसे application key से अलग रखें। Third-party services के credentials application या किसी भरोसेमंद proxy में रखें; generated code जिस environment को पढ़ सकता हो, उसमें लंबे समय तक चलने वाले secrets न डालें।
संचालन संबंधी उपयोगिता बनाए रखते हुए logs से संवेदनशील जानकारी हटाएँ
Logs खाली retrievals, विफल requests और missing citations की समस्या का पता लगाने में मदद करते हैं, लेकिन पूरे prompts और documents में व्यक्तिगत, गोपनीय या व्यावसायिक रूप से संवेदनशील जानकारी हो सकती है। सेवा चलाने के लिए आपकी टीम को जितनी जानकारी चाहिए, केवल उतनी ही log करें। उदाहरण के लिए:
- Request ID, timestamp, status और latency।
- Debugging में उपयोगी होने पर model और application version।
- पूरा retrieved text नहीं, बल्कि internal document IDs और page या section references।
- Request headers या secret values नहीं, बल्कि redacted error category।
डिफ़ॉल्ट रूप से authorization headers, API keys, पूरे user prompts या document के पूरे passages कभी log न करें। अगर content-level debugging के लिए अस्थायी तौर पर ऐसा करना ज़रूरी हो, तो पहुँच-सीमाओं और स्पष्ट deletion date वाली नियंत्रित, समय-सीमित प्रक्रिया अपनाएँ। Application, proxy, tracing और error-reporting systems भी जाँचें: मुख्य application logger में redaction करने से अन्य capture points अपने-आप साफ़ नहीं होते।
Logging pattern का एक उदाहरण:
log_event(
request_id="generated-request-id",
outcome="success",
retrieved_sources=["policy-17:p4", "handbook-03:section-2"],
credential="[never include]",
prompt="[omit or redact]",
passage_text="[omit or redact]"
)
यह pseudocode है, OpenAI SDK का जाँचा हुआ उदाहरण नहीं। इसे अपने logging system के अनुसार ढालें और सत्यापित करें कि events के application process से बाहर जाने से पहले secrets हटा दिए जाते हैं।
Source attribution को जवाब के अनुबंध का हिस्सा बनाएँ
Model से बाद में citations गढ़ने को न कहें। Retrieval के दौरान source metadata सुरक्षित रखें, हर passage को उसके document ID और page, section या URL से जोड़ें, और यह metadata जवाब तैयार करने के चरण को दें। Application को जिस response format की अपेक्षा है, वही अनिवार्य करें: जवाब के साथ केवल retrieved set से लिए गए references। फिर दिखाने से पहले application code में references validate करें।
अगर retrieval से कोई प्रासंगिक passage न मिले, तो बताएँ कि उपलब्ध documents जवाब का समर्थन नहीं करते, या उपयोगकर्ता से सवाल को सीमित करने को कहें। अगर जवाब में कोई दावा returned source से नहीं जोड़ा जा सकता, तो उसे unsupported के रूप में चिह्नित करें या हटा दें। Citation तभी उपयोगी है जब दिया गया स्थान मौजूद हो और दावे के समर्थन में प्रमाण रखता हो। Retrieval और response-format का सटीक implementation आपके चुने हुए APIs पर निर्भर करता है; यहाँ उद्धृत security guidance document-Q&A या citation implementation निर्धारित नहीं करती।
Credential rotation की प्रक्रिया तय करें
किसी incident से पहले चरण लिखकर रखें। एक व्यावहारिक प्रक्रिया:
- मौजूदा credential का उपयोग करने वाले application, project, secret-store entry और services की पहचान करें।
- उतनी ही न्यूनतम ज़रूरी access वाला replacement credential बनाएँ और उसे स्वीकृत secret store में रखें।
- नियंत्रित configuration change के ज़रिए replacement deploy करें। Deployment के दौरान उसे print करने या build artifacts में रखने से बचें।
- सामान्य workflow से एक test question भेजें। पुष्टि करें कि inference सफल है, citations अब भी resolve होते हैं और logs में कोई secret या document text नहीं है।
- Errors पर नज़र रखें; replacement के उपयोग की पुष्टि हो जाए तो पुराना credential revoke करें। Deployment systems और local development environments से उसकी पुरानी copies हटाएँ।
- Exposure का संदेह हो तो प्रभावित credential तुरंत revoke करें, access और logs की जाँच करें और replacement जारी करें। नियमित rotation अवधि का इंतज़ार न करें।
OpenAI की guidance कहती है कि ज़रूरत पड़ने पर keys rotate या revoke करें और exposure का संदेह होने पर credentials तुरंत revoke करें। आपके संगठन को जोखिम, नीति और संचालन संबंधी सीमाओं के आधार पर अपना rotation interval तय करना चाहिए; उद्धृत स्रोत कोई सार्वभौमिक schedule निर्धारित नहीं करता।
लॉन्च से पहले checklist
- Application key server side पर है और browser तथा agent-generated code की पहुँच से बाहर है।
- Workload को उचित रूप से isolate किया गया है; जहाँ ज़रूरी हो, dedicated project या environment का उपयोग किया गया है।
- Permissions केवल उन operations तक सीमित हैं जिनकी application को ज़रूरत है।
- Logs में keys, authorization headers, raw prompts और पूरे retrieved passages शामिल नहीं हैं।
- जवाबों में retrieved documents के validated references हैं।
- एक नामित owner replacement credential deploy कर सकता है और पुराना credential revoke कर सकता है।
मुख्य design choice सरल है: credentials को document-processing environment से बाहर रखें और citations को retrieved sources तक traceable बनाएँ। इससे compromised workload का असर कम होता है और उपयोगकर्ताओं को यह जाँचने का तरीका मिलता है कि जवाब किन स्रोतों पर आधारित है।
सामान्य प्रश्न
क्या browser-based document-Q&A ऐप में OpenAI API key रख सकता हूँ?
Application key को browser code के सामने न रखें। OpenAI requests किसी भरोसेमंद server-side component से करें, जो protected configuration या secrets manager से key प्राप्त करता हो।
क्या जवाबों को debug करने के लिए prompts और retrieved document passages log करने चाहिए?
डिफ़ॉल्ट रूप से ऐसा करने से बचें। Request IDs, status, timing और source identifiers को प्राथमिकता दें। अगर अस्थायी content-level debugging ज़रूरी हो, तो access सीमित रखें, deletion deadline तय करें और सुनिश्चित करें कि credentials कभी capture न हों।
OpenAI API keys को कितनी बार rotate करना चाहिए?
उद्धृत OpenAI security guidance कहती है कि ज़रूरत पड़ने पर keys rotate या revoke करें, लेकिन कोई सार्वभौमिक interval नहीं बताती। अपने संगठन के जोखिम और नीति के आधार पर schedule तय करें; exposure का संदेह हो तो तुरंत revoke करें।
Document-Q&A citations को भरोसेमंद कैसे बनाएँ?
Retrieval के दौरान document IDs और page, section या URL metadata साथ रखें, references को retrieved source set तक सीमित करें और दिखाने से पहले हर reference validate करें। Model से citations गढ़ने की अपेक्षा न करें।
संबंधित लेख
Guides
दस्तावेज़ों से सवाल-जवाब में OpenAI API की विफलताओं का निदान
ऑथेंटिकेशन, रेट लिमिट, टाइमआउट और गलत स्रोत-संदर्भ वाले जवाबों के लिए एक व्यावहारिक समस्या-निवारण गाइड।
Guides
दस्तावेज़ प्रश्नोत्तर के लिए Kimi K3.1 Pro Highspeed की लागत का अनुमान
दस्तावेज़ प्रश्नोत्तर के लिए लागत का ऐसा अनुमान जिसे दोबारा निकाला जा सकता है। इसमें Kimi K3.1 Pro Highspeed की आधिकारिक और OneMux कीमतें, कैश संबंधी मान्यताएँ और वर्कलोड की गणना शामिल है।
Guides
ग्राहक सहायता ट्रायेज के लिए OpenAI API कुंजियाँ सुरक्षित रखें
ग्राहक सहायता ट्रायेज में OpenAI के सुरक्षित उपयोग की व्यावहारिक प्रक्रिया: API कुंजियों की सुरक्षा करें, लॉग से संवेदनशील जानकारी हटाएँ, अनुमतियाँ सीमित रखें, क्रेडेंशियल बदलें और मानव अनुमोदन अनिवार्य करें।
Guides
दस्तावेज़ों पर प्रश्नोत्तर के लिए Gemini 4 Argon API लागत: एक दोहराने योग्य अनुमान
स्पष्ट टोकन मान्यताओं, स्रोत-आधारित संदर्भ, कैश परिदृश्यों और प्रकाशित OneMux कीमतों से तुलना के साथ दस्तावेज़ प्रश्नोत्तर के लिए Gemini 4 Argon API लागत का अनुमान लगाएँ।