Python SDK

SDK ElevenAgents: wdrażaj dostosowanych, interaktywnych agentów głosowych w kilka minut.

Zobacz też opis ElevenAgents

Instalacja

Zainstaluj pakiet Python elevenlabs w swoim projekcie:

pip install elevenlabs
# or
poetry add elevenlabs

Jeśli chcesz użyć domyślnej implementacji wejścia/wyjścia audio, potrzebujesz też dodatku pyaudio:

pip install "elevenlabs[pyaudio]"
# or
poetry add "elevenlabs[pyaudio]"

Instalacja pakietu pyaudio może wymagać dodatkowych zależności systemowych.

Więcej informacji znajdziesz w README pakietu PyAudio.

W systemach opartych na Debianie możesz zainstalować zależności poleceniem:

sudo apt-get update
sudo apt-get install libportaudio2 libportaudiocpp0 portaudio19-dev libasound-dev libsndfile1-dev -y

Użycie

W tym przykładzie utworzymy prosty skrypt, który prowadzi rozmowę z agentem ElevenLabs Agents.

Najpierw zaimportuj wymagane zależności:

import os
import signal
from elevenlabs.client import ElevenLabs
from elevenlabs.conversational_ai.conversation import Conversation
from elevenlabs.conversational_ai.default_audio_interface import DefaultAudioInterface

Następnie wczytaj ID agenta i klucz API ze zmiennych środowiskowych:

agent_id = os.getenv("AGENT_ID")
api_key = os.getenv("ELEVENLABS_API_KEY")

Klucz API jest wymagany tylko dla niepublicznych agentów z włączonym uwierzytelnianiem. Nie musisz go ustawiać dla agentów publicznych — kod będzie działać bez niego.

Następnie utwórz instancję klienta ElevenLabs:

elevenlabs = ElevenLabs(api_key=api_key)

Teraz inicjalizujemy instancję Conversation:

conversation = Conversation(
# API client and agent ID.
elevenlabs,
agent_id,
# Assume auth is required when API_KEY is set.
requires_auth=bool(api_key),
# Use the default audio interface.
audio_interface=DefaultAudioInterface(),
# Simple callbacks that print the conversation to the console.
callback_agent_response=lambda response: print(f"Agent: {response}"),
callback_agent_response_correction=lambda original, corrected: print(f"Agent: {original} -> {corrected}"),
callback_user_transcript=lambda transcript: print(f"User: {transcript}"),
# Uncomment if you want to see latency measurements.
# callback_latency_measurement=lambda latency: print(f"Latency: {latency}ms"),
# Uncomment if you want to receive audio alignment data with character-level timing.
# callback_audio_alignment=lambda alignment: print(f"Alignment: {alignment.chars}"),
)

Używamy DefaultAudioInterface, który korzysta z domyślnych systemowych urządzeń wejścia/wyjścia audio na potrzeby rozmowy. Możesz też zaimplementować własny interfejs audio, dziedzicząc po elevenlabs.conversational_ai.conversation.AudioInterface.

Teraz możemy rozpocząć rozmowę. Opcjonalnie zalecamy przekazanie własnych ID użytkowników końcowych, aby powiązać rozmowy z użytkownikami.

conversation.start_session(
user_id=user_id # optional field
)

Aby poprawnie zakończyć działanie, gdy użytkownik naciśnie Ctrl+C, możemy dodać obsługę sygnału, która wywoła end_session():

signal.signal(signal.SIGINT, lambda sig, frame: conversation.end_session())

Na koniec czekamy na zakończenie rozmowy i wyświetlamy ID rozmowy (możesz go użyć do przeglądania historii rozmowy i debugowania):

conversation_id = conversation.wait_for_session_end()
print(f"Conversation ID: {conversation_id}")

Pozostaje tylko uruchomić skrypt i zacząć rozmawiać z agentem:

# For public agents:
AGENT_ID=youragentid python demo.py
# For private agents:
AGENT_ID=youragentid ELEVENLABS_API_KEY=yourapikey python demo.py