Vapi Python SDK 项目启动与配置教程

1. 项目的目录结构及介绍

Vapi Python SDK 项目目录结构如下：

vapi_python/
├── .github/
├── .gitignore
├── HISTORY.rst
├── LICENSE
├── MANIFEST.in
├── Makefile
├── README.md
├── README.rst
├── requirements.txt
├── requirements_dev.txt
├── setup.cfg
├── setup.py
├── tox.ini
└── vapi_python/

• .github/: 存放与 GitHub 相关的配置文件。
• .gitignore: 定义了哪些文件和目录应该被 Git 忽略。
• HISTORY.rst: 记录了项目的更新历史。
• LICENSE: 项目的许可协议文件，本项目采用 MIT 许可。
• MANIFEST.in: 指定了打包时包含的文件。
• Makefile: Makefile 文件，用于构建项目。
• README.md: 项目的自述文件，包含项目介绍、安装和使用说明。
• README.rst: 与 README.md 类似，但是是 reStructuredText 格式。
• requirements.txt: 项目运行所需的 Python 库依赖。
• requirements_dev.txt: 开发环境所需的 Python 库依赖。
• setup.cfg: 包含了包配置信息。
• setup.py: 包的设置脚本，用于安装包。
• tox.ini: tox 配置文件，用于自动化测试。
• vapi_python/: 包含项目的 Python 代码。

2. 项目的启动文件介绍

项目的启动主要是通过 vapi_python 目录中的 Python 类实现的。以下是启动 Vapi 调用的基本步骤：

首先，需要从 vapi_python 包中导入 Vapi 类：

from vapi_python import Vapi

然后，创建 Vapi 类的实例，并传入公共密钥作为参数：

vapi = Vapi(api_key='your-public-key')

接着，可以开始一个新的调用，通过传递 assistant 对象或 assistantId 来实现：

assistant = {
    'firstMessage': 'Hey, how are you?',
    'context': 'You are an employee at a drive thru...',
    'model': 'gpt-3.5-turbo',
    'voice': 'jennifer-playht',
    "recordingEnabled": True,
    "interruptionsEnabled": False
}

vapi.start(assistant=assistant)

3. 项目的配置文件介绍

项目的配置主要通过 setup.py 和 requirements.txt 文件来管理。

• setup.py 文件定义了项目的元数据和安装过程。例如，项目名称、版本、描述、作者、依赖项等。

from setuptools import setup, find_packages

setup(
    name='vapi_python',
    version='0.1.0',
    packages=find_packages(),
    install_requires=[
        # 依赖项列表
    ],
    # 其他配置
)

• requirements.txt 文件列出了项目运行时所需的第三方 Python 库。使用 pip 安装这些依赖时，只需运行：

pip install -r requirements.txt

以上就是 Vapi Python SDK 项目的启动和配置文档。按照以上步骤，您可以顺利地启动和配置该项目。