एजेंट ऑथेंटिकेशन

परिचय

कन्वर्सेशनल एजेंट बनाते समय, आपको कुछ एजेंट या बातचीत का एक्सेस सीमित करना पड़ सकता है। ElevenLabs कई ऑथेंटिकेशन तरीके देता है, ताकि सिर्फ़ अधिकृत यूज़र ही आपके एजेंट्स से इंटरैक्ट कर सकें।

ऑथेंटिकेशन के तरीके

ElevenLabs आपके कन्वर्सेशनल एजेंट्स को सुरक्षित रखने के लिए दो मुख्य तरीके देता है:

साइन्ड URLs का इस्तेमाल

क्लाइंट-साइड ऐप्लिकेशन के लिए साइन्ड URLs सुझाया गया तरीका है। इससे आप अपनी API key दिखाए बिना यूज़र्स को ऑथेंटिकेट कर सकते हैं।

साइन्ड URLs कैसे काम करते हैं

1. आपका सर्वर आपकी API key का इस्तेमाल करके ElevenLabs से साइन्ड URL मांगता है।
2. ElevenLabs एक अस्थायी टोकन जनरेट करता है और साइन्ड WebSocket URL लौटाता है।
3. आपका क्लाइंट ऐप्लिकेशन WebSocket कनेक्शन बनाने के लिए इस साइन्ड URL का इस्तेमाल करता है।
4. साइन्ड URL 15 मिनट बाद एक्सपायर हो जाता है।

API से साइन्ड URL जनरेट करें

साइन्ड URL पाने के लिए, अपने एजेंट ID के साथ get_signed_url endpoint पर रिक्वेस्ट करें:

# Server-side code using the Python SDK
from elevenlabs.client import ElevenLabs
async def get_signed_url():
    try:
        elevenlabs = ElevenLabs(api_key="your-api-key")
        response = await elevenlabs.conversational_ai.conversations.get_signed_url(agent_id="agent_7101k5zvyjhmfg983brhmhkd98n6")
        return response.signed_url
    except Exception as error:
        print(f"Error getting signed URL: {error}")
        raise

curl रिस्पॉन्स का फ़ॉर्मैट इस तरह होता है:

{
  "signed_url": "wss://api.elevenlabs.io/v1/convai/conversation?agent_id=agent_7101k5zvyjhmfg983brhmhkd98n6&conversation_signature=your-token"
}

साइन्ड URL से अपने एजेंट से कनेक्ट करना

क्लाइंट से सर्वर द्वारा जनरेट किया गया साइन्ड URL प्राप्त करें और WebSocket से कनेक्ट करने के लिए उसका इस्तेमाल करें।

# Client-side code using the Python SDK
from elevenlabs.conversational_ai.conversation import (
    Conversation,
    AudioInterface,
    ClientTools,
    ConversationInitiationData
)
import os
from elevenlabs.client import ElevenLabs
api_key = os.getenv("ELEVENLABS_API_KEY")
elevenlabs = ElevenLabs(api_key=api_key)
conversation = Conversation(
  client=elevenlabs,
  agent_id=os.getenv("AGENT_ID"),
  requires_auth=True,
  audio_interface=AudioInterface(),
  config=ConversationInitiationData()
)
async def start_conversation():
  try:
    signed_url = await get_signed_url()
    conversation = Conversation(
      client=elevenlabs,
      url=signed_url,
    )
    conversation.start_session()
  except Exception as error:
    print(f"Failed to start conversation: {error}")

साइन्ड URL की एक्सपायरी

साइन्ड URLs 15 मिनट तक मान्य रहते हैं। बातचीत का सेशन ज़्यादा समय तक चल सकता है, लेकिन बातचीत 15 मिनट की अवधि के भीतर शुरू होनी चाहिए।

अलाउलिस्ट का इस्तेमाल

अलाउलिस्ट, मूल डोमेन के आधार पर आपके कन्वर्सेशनल एजेंट्स का एक्सेस सीमित करने का तरीका देती हैं। इससे सिर्फ़ स्वीकृत डोमेन से आने वाली रिक्वेस्ट ही आपके एजेंट से कनेक्ट हो पाती हैं।

अलाउलिस्ट कैसे काम करती हैं

1. आप अपने एजेंट के लिए स्वीकृत होस्टनेम की सूची कॉन्फ़िगर करते हैं।
2. जब कोई क्लाइंट कनेक्ट करने की कोशिश करता है, तो ElevenLabs जांचता है कि रिक्वेस्ट का मूल किसी अनुमति वाले होस्टनेम से मेल खाता है या नहीं।
3. अगर मूल अलाउलिस्ट में है, तो कनेक्शन की अनुमति मिलती है; वरना उसे अस्वीकार कर दिया जाता है।

अलाउलिस्ट कॉन्फ़िगर करना

अलाउलिस्ट आपके एजेंट की ऑथेंटिकेशन सेटिंग्स के हिस्से के रूप में कॉन्फ़िगर होती हैं। आप अपने एजेंट से कनेक्ट होने के लिए अधिकतम 10 अलग-अलग होस्टनेम तय कर सकते हैं।

उदाहरण: अलाउलिस्ट सेट अप करना

ऑथेंटिकेशन तरीका चुनना

हर एजेंट के लिए एक ऑथेंटिकेशन तरीका कॉन्फ़िगर करें:

1. ऑथेंटिकेटेड क्लाइंट सेशन के लिए साइन्ड URLs (enable_auth) का इस्तेमाल करें।
2. होस्टनेम-आधारित एक्सेस कंट्रोल के लिए अलाउलिस्ट (allowlist) का इस्तेमाल करें।

एक ही एजेंट पर साइन्ड URLs और अलाउलिस्ट को साथ में कॉन्फ़िगर न करें। अपने डिप्लॉयमेंट मॉडल के अनुसार तरीका चुनें।

उदाहरण: सिर्फ़ साइन्ड URLs

allowlist के बिना enable_auth का इस्तेमाल करें:

from elevenlabs.client import ElevenLabs
import os
from elevenlabs.types import *
api_key = os.getenv("ELEVENLABS_API_KEY")
elevenlabs = ElevenLabs(api_key=api_key)
agent = elevenlabs.conversational_ai.agents.create(
  conversation_config=ConversationalConfig(
    agent=AgentConfig(
      first_message="Hi. I require a signed URL.",
    )
  ),
  platform_settings=AgentPlatformSettingsRequestModel(
    auth=AuthSettings(
      enable_auth=True
    )
  )
)

उदाहरण: सिर्फ़ अलाउलिस्ट

साइन्ड URLs सक्षम किए बिना allowlist का इस्तेमाल करें:

from elevenlabs.client import ElevenLabs
import os
from elevenlabs.types import *
api_key = os.getenv("ELEVENLABS_API_KEY")
elevenlabs = ElevenLabs(api_key=api_key)
agent = elevenlabs.conversational_ai.agents.create(
  conversation_config=ConversationalConfig(
    agent=AgentConfig(
      first_message="Hi. I only accept approved hostnames.",
    )
  ),
  platform_settings=AgentPlatformSettingsRequestModel(
    auth=AuthSettings(
      allowlist=[
        AllowlistItem(hostname="example.com"),
        AllowlistItem(hostname="app.example.com"),
      ]
    )
  )
)

अक्सर पूछे जाने वाले सवाल