ElevenLabs Python API 使用教程

ElevenLabs Python API 使用教程

elevenlabs-python The official Python API for ElevenLabs text-to-speech. 项目地址: https://gitcode.com/gh_mirrors/el/elevenlabs-python

1. 项目目录结构及介绍

elevenlabs-python/
├── assets/
├── src/
│   └── elevenlabs/
├── tests/
├── .fernignore
├── .gitignore
├── LICENSE
├── README.md
├── poetry.lock
├── pyproject.toml
└── reference.md

目录结构介绍

• assets/: 存放项目相关的静态资源文件。
• src/elevenlabs/: 项目的核心代码库，包含了ElevenLabs API的Python实现。
• tests/: 存放项目的单元测试代码。
• .fernignore: 用于指定哪些文件或目录不需要被Fern工具处理。
• .gitignore: 用于指定Git版本控制系统中需要忽略的文件或目录。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍文档，包含了项目的安装、使用说明等。
• poetry.lock: 用于锁定项目依赖的版本。
• pyproject.toml: 项目的配置文件，包含了项目的依赖、构建工具等信息。
• reference.md: 项目的参考文档，包含了API的详细说明。

2. 项目的启动文件介绍

在 src/elevenlabs/ 目录下，主要的启动文件是 client.py。这个文件包含了ElevenLabs API的客户端实现，用户可以通过这个文件与ElevenLabs的API进行交互。

主要功能

• ElevenLabs 类: 这是API的主要入口点，用户可以通过实例化这个类来调用各种API方法。
• AsyncElevenLabs 类: 这是异步版本的客户端，适用于需要异步操作的场景。

示例代码

from elevenlabs.client import ElevenLabs

client = ElevenLabs(api_key="YOUR_API_KEY")
audio = client.generate(text="Hello, world!", voice="Rachel", model="eleven_multilingual_v2")

3. 项目的配置文件介绍

项目的配置文件主要是 pyproject.toml，这个文件使用Poetry作为依赖管理工具。

pyproject.toml 内容示例

[tool.poetry]
name = "elevenlabs-python"
version = "1.0.0"
description = "The official Python API for ElevenLabs Text to Speech"
authors = ["ElevenLabs <support@elevenlabs.io>"]
license = "MIT"

[tool.poetry.dependencies]
python = "^3.7"
httpx = "^0.18.2"

[tool.poetry.dev-dependencies]
pytest = "^6.2.4"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

配置文件介绍

• [tool.poetry]: 定义了项目的基本信息，如名称、版本、描述、作者和许可证。
• [tool.poetry.dependencies]: 定义了项目的依赖包及其版本要求。
• [tool.poetry.dev-dependencies]: 定义了开发环境下的依赖包。
• [build-system]: 定义了构建系统的要求和后端。

通过这个配置文件，用户可以轻松地管理项目的依赖，并确保项目的构建和运行环境的一致性。

elevenlabs-python The official Python API for ElevenLabs text-to-speech. 项目地址: https://gitcode.com/gh_mirrors/el/elevenlabs-python