क्लाइंट टूल्स

क्लाइंट टूल्स आपके असिस्टेंट को क्लाइंट-साइड फ़ंक्शंस चलाने देते हैं। वेबहुक टूल्स के विपरीत, क्लाइंट टूल्स असिस्टेंट को ब्राउज़र इवेंट्स ट्रिगर करने, क्लाइंट-साइड फ़ंक्शंस चलाने या UI को नोटिफ़िकेशन भेजने जैसे काम करने देते हैं।

ओवरव्यू

ऐप्लिकेशन में असिस्टेंट्स को यूज़र के एनवायरनमेंट के साथ सीधे इंटरैक्ट करना पड़ सकता है। क्लाइंट-साइड टूल्स आपके असिस्टेंट को क्लाइंट-साइड ऑपरेशंस करने की सुविधा देते हैं।

यहां कुछ उदाहरण हैं जहां क्लाइंट टूल्स उपयोगी हो सकते हैं:

• UI इवेंट्स ट्रिगर करना: असिस्टेंट को अलर्ट, मोडल या नोटिफ़िकेशन जैसे ब्राउज़र इवेंट्स ट्रिगर करने दें।
• DOM के साथ इंटरैक्ट करना: असिस्टेंट को डायनामिक कंटेंट अपडेट्स के लिए Document Object Model (DOM) में बदलाव करने या यूज़र्स को जटिल इंटरफ़ेस में गाइड करने दें।

गाइड

ज़रूरी शर्तें

• एक ElevenLabs अकाउंट
• कॉन्फ़िगर किया गया ElevenLabs कन्वर्सेशनल एजेंट (यहां बनाएं)

from elevenlabs import ElevenLabs
from elevenlabs.conversational_ai.conversation import Conversation, ClientTools
def log_message(parameters):
    message = parameters.get("message")
    print(message)
client_tools = ClientTools()
client_tools.register("logMessage", log_message)
conversation = Conversation(
    client=ElevenLabs(api_key="your-api-key"),
    agent_id="agent_7101k5zvyjhmfg983brhmhkd98n6",
    requires_auth=True,
    client_tools=client_tools,
    # ...
)
conversation.start_session()

बातचीत के संदर्भ में क्लाइंट टूल के नतीजे भेजना

जब आप चाहते हैं कि आपके एजेंट को क्लाइंट टूल से डेटा वापस मिले, तो सुनिश्चित करें कि टूल कॉन्फ़िगरेशन में Wait for response विकल्प चुना गया हो।

क्लाइंट टूल जुड़ने के बाद, जब फ़ंक्शन कॉल होगा, एजेंट उसके रिस्पॉन्स का इंतज़ार करेगा और रिस्पॉन्स को बातचीत के संदर्भ में जोड़ देगा।

def get_customer_details():
    # Fetch customer details (e.g., from an API or database)
    customer_data = {
        "id": 123,
        "name": "Alice",
        "subscription": "Pro"
    }
    # Return the customer data; it can also be a JSON string if needed.
    return customer_data
client_tools = ClientTools()
client_tools.register("getCustomerDetails", get_customer_details)
conversation = Conversation(
    client=ElevenLabs(api_key="your-api-key"),
    agent_id="agent_7101k5zvyjhmfg983brhmhkd98n6",
    requires_auth=True,
    client_tools=client_tools,
    # ...
)
conversation.start_session()

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

समस्या निवारण

सर्वोत्तम तरीके

टूल्स के नाम सहज रखें और विस्तृत descriptions दें

अगर आपको लगता है कि assistant सही टूल्स को कॉल नहीं कर रहा है, तो आपको टूल के names और descriptions अपडेट करने पड़ सकते हैं, ताकि assistant को बेहतर तरीके से समझ आए कि हर टूल कब चुनना है। टूल और argument names को छोटा करने के लिए abbreviations या acronyms इस्तेमाल न करें।

आप यह भी बता सकते हैं कि किसी टूल को कब कॉल करना चाहिए। Complex tools के लिए, हर argument का description शामिल करें, ताकि assistant को पता हो कि उस argument को पाने के लिए यूज़र से क्या पूछना है।

टूल parameters के नाम सहज रखें और विस्तृत descriptions दें

टूल parameters के लिए स्पष्ट और descriptive names इस्तेमाल करें। अगर लागू हो, तो description में parameter का expected format बताएं (जैसे किसी date के लिए YYYY-mm-dd या dd/mm/yy)।

अपने assistant के system prompt में टूल्स को कैसे और कब कॉल करना है, इसकी अतिरिक्त जानकारी देने पर विचार करें

अपने system prompt में स्पष्ट निर्देश देने से assistant की टूल-कॉलिंग accuracy काफ़ी बेहतर हो सकती है। उदाहरण के लिए, assistant को इस तरह के निर्देश दें:

Use `check_order_status` when the user inquires about the status of their order, such as 'Where is my order?' or 'Has my order shipped yet?'.

Complex scenarios के लिए context दें। उदाहरण के लिए:

Before scheduling a meeting with `schedule_meeting`, check the user's calendar for availability using check_availability to avoid conflicts.

LLM चयन

यह ध्यान रखना ज़रूरी है कि function calls की सफलता में LLM का चयन अहम होता है। कुछ LLMs को conversation से relevant parameters निकालने में मुश्किल हो सकती है।