탐색으로 건너뛰기

코드로 도구 관리

Python 및 JavaScript SDK로 에이전트 도구를 구축, 편집 및 버전 관리

개요

도구는 매개변수용 중첩 JSON 스키마가 포함된 구성으로 저장됩니다. 이 구성을 직접 작성하려면 경로 매개변수를 URL과 일치시키고, required 목록을 해당 속성과 일치시키며, 모든 매개변수에 정확히 하나의 값 소스를 지정해야 합니다. Python 및 JavaScript SDK의 도구 빌더를 사용하면 메서드 체이닝으로 동일한 도구를 설명할 수 있습니다. 그러면 tools.create() 및 tools.update()가 이미 수락하는 요청을 생성합니다.

다음과 같은 작업에 사용하세요.

  • 웹훅, 클라이언트 및 시스템 도구를 코드로 정의하고 다른 코드 변경과 마찬가지로 검토합니다.
  • 도구를 로드하고 매개변수 하나를 변경한 뒤 나머지 구성은 건드리지 않고 다시 푸시합니다.
  • 도구를 JSON으로 버전 관리에 저장하고 CI에서 검증합니다.

빌더는 SDK 내에서 완전히 실행됩니다. 새 API 엔드포인트를 호출하지 않으며, 빌드한 모든 항목은 대시보드에서 열고 편집할 수 있습니다.

요구 사항

  • Python: elevenlabs 패키지. 빌더는 elevenlabs.agent_tools에서 가져옵니다.
  • JavaScript: @elevenlabs/elevenlabs-js 패키지. 빌더는 패키지 루트에서 내보냅니다.

웹훅 도구 구축

Tool.webhook(name, description)은 웹훅 도구를 시작합니다. 이름과 설명은 LLM이 도구 호출 여부를 결정할 때 확인하는 정보입니다. 이 예시는 발신자가 제공한 번호로 주문을 조회하고, 워크스페이스의 시크릿에서 API 키를 전송하며, 주문 상태를 동적 변수에 저장합니다.

from elevenlabs import ElevenLabs
from elevenlabs.agent_tools import Header, Schema, Tool
elevenlabs = ElevenLabs()
get_order = (
Tool.webhook("get_order", "Look up an order by the number the caller gives")
.get("https://api.example.com/orders/{order_id}")
.path_param("order_id", Schema.string().describe("The order number, e.g. A-1042"))
.query_param("include", Schema.string().constant("items"))
.header("Authorization", Header.secret("sec_orders_api"))
.assign("order_status", "order.status")
.options(response_timeout_secs=10)
)
tool = elevenlabs.conversational_ai.tools.create(request=get_order.build())

요청 메서드는 HTTP 메서드와 URL을 설정합니다. URL의 {name} 자리 표시자는 경로 매개변수로 채워집니다.

PythonJavaScript설정 내용
get(url), post(url), put(url), patch(url), delete(url)동일메서드와 URL입니다. POST, PUT, PATCH에는 본문이 필요하며, GET에는 본문을 포함할 수 없습니다.
path_param(name, schema)pathParam(name, schema)URL의 {name} 자리 표시자에 사용할 경로 매개변수입니다.
query_param(name, schema)queryParam(name, schema)쿼리 매개변수입니다.
body(schema)body(schema)요청 본문입니다. 객체 스키마여야 합니다.
response(schema)response(schema)응답 본문 스키마입니다. 객체 스키마여야 합니다.
header(name, value)header(name, value)요청 헤더입니다. 헤더 및 인증을 참조하세요.
auth(connection)auth(connection)사용할 인증 연결입니다.
assign(variable, path)assign(variable, path)응답의 path 위치 값(점 표기법)을 동적 변수에 저장합니다.

이미 존재하는 이름의 매개변수나 헤더를 설정하면 해당 항목을 대체하되 위치는 유지합니다. remove_path_param(), remove_query_param(), remove_header(), remove_assignment()(JavaScript에서는 removePathParam() 등)을 사용하면 항목을 제거할 수 있습니다. 매개변수 이름은 경로, 쿼리, 본문 전체에서 고유해야 합니다.

본문은 속성을 하나씩 추가해 구성하는 객체 스키마입니다.

refund = (
Tool.webhook("issue_refund", "Refund an order the caller asked to return")
.post("https://api.example.com/refunds")
.body(
Schema.object()
.property("order_id", Schema.string().from_variable("order_id"))
.property(
"reason",
Schema.string().describe("Why the caller wants a refund").choices(["damaged", "late", "other"]),
)
.property("note", Schema.string().describe("Anything else the caller said").optional())
)
)

매개변수 스키마

Schema는 웹훅 및 클라이언트 도구에서 사용하는 매개변수 스키마를 빌드합니다. 모든 메서드는 새 스키마를 반환하고 호출된 기존 스키마는 변경하지 않으므로, 스키마를 한 번 정의해 여러 도구에서 사용할 수 있습니다.

생성자생성 항목
Schema.string(), Schema.integer(), Schema.number(), Schema.bool()리터럴 값
Schema.object()객체. property()로 속성을 추가합니다.
Schema.array(items)요소가 items 스키마와 일치하는 배열

값의 출처

모든 리터럴에는 위치와 관계없이 정확히 하나의 값 소스가 필요합니다. 매개변수, 본문, 응답 스키마, 객체 또는 배열 내부 모두 마찬가지입니다. 객체나 배열 자체에도 값 소스를 하나 지정할 수 있으며, 이 경우 전체 값을 제공합니다.

PythonJavaScript값
describe(text)describe(text)text의 안내에 따라 LLM이 제공합니다.
from_variable(name)fromVariable(name)도구 실행 시 동적 변수에서 읽어 옵니다.
constant(value)constant(value)항상 value입니다.
system_provided()systemProvided()도구 실행 시 시스템이 채웁니다. 리터럴에만 사용할 수 있습니다.
omit()omit()요청에서 제외합니다. 선택적 속성에만 사용할 수 있습니다.

객체나 배열에서 describe()는 LLM을 위해 컨테이너를 문서화하며, 각 속성이나 요소에는 여전히 자체 소스가 필요합니다.

기타 스키마 메서드

PythonJavaScript기능
optional()optional()속성을 선택 사항으로 만듭니다. 선택 사항으로 표시하지 않은 속성은 필수입니다.
choices(values)choices(values)문자열을 LLM이 선택할 수 있는 고정된 값 집합으로 제한합니다.
allowed_from(variable)allowedFrom(variable)동적 변수가 보유한 목록에 없는 LLM 값을 거부합니다. describe()가 필요합니다.
property(name, schema) / without(name)property(name, schema) / without(name)객체 속성을 추가, 대체 또는 제거합니다. 대체된 속성은 위치를 유지합니다.
require_any_of(names) / require_all_of(names)requireAnyOf(names) / requireAllOf(names)선택적 속성 그룹 중 하나 이상 또는 전체를 요구합니다.

헤더 및 인증

헤더 값은 네 곳 중 하나에서 가져옵니다. 민감한 정보에는 시크릿 또는 환경 변수를 사용해 값이 도구 구성에 표시되지 않도록 하세요.

생성자헤더 값
Header.value(text)고정 텍스트입니다.
Header.secret(id)워크스페이스의 시크릿 저장소에 있는 시크릿입니다.
Header.variable(name)도구 실행 시 읽어 오는 동적 변수입니다.
Header.env_var(label) / Header.envVar(label)현재 환경에 맞게 확인되는 워크스페이스 환경 변수입니다.

AuthConnection.id(id)는 ID로 워크스페이스의 인증 연결을 사용합니다. AuthConnection.env_var(label) / AuthConnection.envVar(label)는 환경 변수에서 인증 연결을 선택하므로, 동일한 도구 구성이 각 환경에서 서로 다른 연결을 사용할 수 있습니다.

from elevenlabs.agent_tools import AuthConnection, Header
update_profile = (
Tool.webhook("update_profile", "Update the caller's email address")
.put("https://api.example.com/profiles/{profile_id}")
.path_param("profile_id", Schema.string().from_variable("profile_id"))
.body(Schema.object().property("email", Schema.string().describe("The new email address")))
.header("X-Api-Key", Header.env_var("profiles_api_key"))
.auth(AuthConnection.env_var("profiles_oauth"))
)

클라이언트 도구 구축

Tool.client(name, description)은 서버가 아닌 애플리케이션에서 실행되는 클라이언트 도구를 시작합니다. param(name, schema)로 매개변수를 추가하세요. 에이전트가 애플리케이션 결과를 기다려야 하는 경우 expects_response / expectsResponse를 설정하세요.

show_map = (
Tool.client("show_store_map", "Show the caller a map of the nearest store")
.param("store_id", Schema.string().describe("The store to show"))
.options(expects_response=False)
)

시스템 도구 구축

시스템 도구는 플랫폼에 내장되어 있습니다. 각 도구에는 해당 도구의 설정을 받는 SystemTool 전용 생성자가 있습니다.

PythonJavaScript
SystemTool.end_call()SystemTool.endCall()
SystemTool.skip_turn(wait_timeout_secs=...)SystemTool.skipTurn({ waitTimeoutSecs })
SystemTool.language_detection(...)SystemTool.languageDetection(options?)
SystemTool.play_keypad_touch_tone(...)SystemTool.playKeypadTouchTone(options?)
SystemTool.voicemail_detection(voicemail_message=...)SystemTool.voicemailDetection({ voicemailMessage })
SystemTool.knowledge_base(enabled_strategies=...)SystemTool.knowledgeBase({ enabledStrategies })
SystemTool.transfer_to_number(...)SystemTool.transferToNumber(options?)
SystemTool.transfer_to_agent()SystemTool.transferToAgent()

두 전송 도구는 transfer(condition, destination, options)에서 목적지를 받습니다. 조건은 LLM에 언제 해당 위치로 전송할지 알려 주며, 목적지는 코드로 워크플로 관리와 동일한 Destination을 사용합니다. SIP URI로 전송하려면 SIP REFER 전송이 필요합니다.

from elevenlabs.agent_tools import SystemTool
from elevenlabs.agent_workflows import Destination
transfer = (
SystemTool.transfer_to_number()
.transfer("Caller asks for billing", Destination.phone("+15551234567"))
.transfer("Caller is a reseller partner", Destination.sip("sip:partners@pbx.example.com"), transfer_type="sip_refer")
)
to_sales = SystemTool.transfer_to_agent().transfer(
"Caller wants to buy something", Destination.agent("agent_sales"), transfer_message="Connecting you to sales"
)

도구 옵션

모든 유형의 도구에서 공유하는 설정은 Python에서는 키워드 인수로, JavaScript에서는 객체로 options()에 전달합니다. 이름은 API의 도구 구성 필드와 일치합니다.

적용 대상PythonJavaScript
모든 도구name, description, response_timeout_secs, interruption_mode, pre_tool_speech, tool_call_sound, tool_error_handling_mode, …name, description, responseTimeoutSecs, interruptionMode, preToolSpeech, toolCallSound, toolErrorHandlingMode, …
웹훅 도구execution_mode, content_type, response_filter, follow_redirects, follow_redirects_allowed_domains, dynamic_variable_placeholdersexecutionMode, contentType, responseFilter, followRedirects, followRedirectsAllowedDomains, dynamicVariablePlaceholders
클라이언트 도구execution_mode, expects_response, dynamic_variable_placeholdersexecutionMode, expectsResponse, dynamicVariablePlaceholders

웹훅 도구의 응답 시간 제한은 5300초입니다. 클라이언트 도구는 1120초이며, 완료될 때까지 기다리려면 -1로 설정할 수 있습니다. 이 경우 expects_response / expectsResponse가 필요합니다. follow_redirects / followRedirects에는 허용된 도메인 목록이 필요합니다.

에이전트에 도구 연결

웹훅 및 클라이언트 도구는 tools.create()로 개별 생성하고 ID로 에이전트에 연결하므로 하나의 도구를 여러 에이전트와 공유할 수 있습니다. 시스템 도구는 에이전트 구성의 일부입니다. build_config() / buildConfig()는 에이전트의 내장 도구 항목을 반환합니다.

from elevenlabs import AgentConfig, BuiltInToolsOutput, ConversationalConfig, PromptAgentApiModelOutput
order_tool = elevenlabs.conversational_ai.tools.create(request=get_order.build())
agent = elevenlabs.conversational_ai.agents.create(
name="Support line",
conversation_config=ConversationalConfig(
agent=AgentConfig(
prompt=PromptAgentApiModelOutput(
prompt="You are a support agent for Acme.",
tool_ids=[order_tool.id],
built_in_tools=BuiltInToolsOutput(
end_call=SystemTool.end_call().build_config(),
transfer_to_number=transfer.build_config(),
),
)
)
),
)

도구 구성을 인라인으로 보관하는 에이전트의 prompt.tools 필드는 더 이상 사용되지 않습니다. 이 필드는 tool_ids와 함께 사용할 수 없으며, 요청에 이 필드가 포함되면 에이전트의 내장 도구는 해당 필드에 포함된 시스템 도구로 대체됩니다. 대신 tools.create()로 도구를 생성하고 ID로 연결하세요.

기존 도구 편집

Tool.from_response() / Tool.fromResponse()는 tools.get()이 반환한 도구를 로드합니다. 빌더가 모델링하지 않는 필드와 API가 채우는 기본값은 유지되므로, 다시 푸시할 때 변경한 내용만 바뀝니다. as_webhook(), as_client(), as_system()(JavaScript에서는 asWebhook() 등)은 편집할 수 있는 타입 지정 도구를 반환하며, 다른 유형인 경우 None / undefined를 반환합니다.

본문 속성을 변경하려면 본문 스키마를 읽고, 속성을 다시 설정한 다음 본문을 설정하세요.

from elevenlabs.agent_tools import ObjectSchema
loaded = Tool.from_response(elevenlabs.conversational_ai.tools.get("tool_id")).as_webhook()
if loaded is None:
raise ValueError("Not a webhook tool")
body = loaded.body_schema
assert isinstance(body, ObjectSchema)
loaded.body(body.property("reason", Schema.string().describe("Why the caller wants a refund")))
loaded.query_param("locale", Schema.string().describe("The caller's language").optional())
elevenlabs.conversational_ai.tools.update("tool_id", request=loaded.build())

버전 관리에 도구 저장

to_json_string() / toJSONString()은 API의 와이어 형식으로 도구를 작성합니다. 즉, snake_case 키를 사용하고 모든 수준에서 정렬하며 2칸 들여쓰기를 적용합니다. 이는 CLI가 tool_configs/ 디렉터리에 보관하는 것과 동일한 형식이며, 두 SDK는 같은 도구에 대해 바이트 단위로 동일한 파일을 작성하므로 diff가 작게 유지됩니다. Tool.from_json() / Tool.fromJSON()으로 다시 읽어 올 수 있습니다.

from pathlib import Path
from elevenlabs.agent_tools import Tool
Path("tool_configs/get_order.json").write_text(get_order.to_json_string())
stored = Tool.from_json(Path("tool_configs/get_order.json").read_text())
elevenlabs.conversational_ai.tools.update("tool_id", request=stored.build())

일반적인 설정은 워크플로와 같습니다. elevenlabs tools pull로 파일을 초기화하고, 직접 또는 빌더로 편집한 뒤, 모든 풀 리퀘스트에서 CI로 Tool.from_json(file).build() / Tool.fromJSON(file).build()를 실행하고, 병합 시 tools.update() 또는 elevenlabs tools push로 푸시합니다.

검증

메서드 체이닝 호출 자체는 실패하지 않습니다. build(), build_config() / buildConfig(), to_json() / toJSON(), to_json_string() / toJSONString()는 전체 도구를 검사하고 단일 ToolValidationError를 발생시키거나 throw합니다. 이 오류의 issues 목록에는 모든 문제가 포함되며, 각 문제에는 body.reason과 같은 해당 부분의 code, message, path가 있습니다.

from elevenlabs.agent_tools import ToolValidationError
try:
request = refund.build()
except ToolValidationError as err:
for issue in err.issues:
print(issue.code, issue.path, issue.message)

오류에는 다음이 포함됩니다.

  • 경로 매개변수가 없는 URL 자리 표시자 또는 자리 표시자가 없는 경로 매개변수. {{system__env_api_host}}와 같은 환경 변수 템플릿은 자리 표시자가 아닙니다.
  • 값 소스가 없거나 둘 이상인 리터럴.
  • GET의 본문 또는 POST, PUT, PATCH의 본문 누락.
  • 경로, 쿼리, 본문 중 둘 이상의 위치에 같은 매개변수 이름이 있는 경우.
  • 필수 속성의 omit(), 문자열이 아닌 스키마의 choices(), 또는 스키마 유형과 일치하지 않는 상수.
  • 목적지가 없는 전송 도구, 잘못된 종류의 목적지 또는 SIP REFER 전송이 없는 SIP URI 목적지.
  • 도구 유형에 적용되지 않는 옵션 또는 범위를 벗어난 시간 제한.

SDK보다 새로운 도구 유형

API 또는 파일에서 로드한 도구는 MCP 도구처럼 빌더가 편집할 수 없는 유형일 수 있습니다. 이러한 도구는 "other" 유형으로 로드되며, from_json() / fromJSON() 및 to_json_string() / toJSONString()을 거쳐도 변경되지 않습니다. build()는 on_warning / onWarning을 통해 이를 경고로 보고합니다.