跳至主要内容

使用生成式 AI 进行开发

本文介绍如何让生成式 AI 和编码 Agent 参考 AmiVoice API 的官方文档，用于选定接口、调查规格、生成示例代码等。

什么是 llms.txt​

llms.txt是一个面向生成式 AI 的索引文件，它将 AmiVoice API 的主要规格和文档链接汇总在一处。发布于以下 URL。

它并非罗列站点的所有页面，而是精选并整理了在选定方式、实现和运用时应优先阅读的页面。链接指向的是便于生成式 AI 获取的 Markdown 版文档。

可以做什么​

将llms.txt交给生成式 AI 后，可用于以下这类工作。

  • 调查要使用的接口和参数
  • 选定符合需求的方式
  • 生成示例代码
  • 支持使用新功能进行开发

无论哪一种，其目的都是让 AI 以官方文档为依据进行参考。

使用方法​

在给生成式 AI 的指示中加入llms.txt的 URL。当你告诉它"请以此 URL 为起点，参考其链接指向的官方文档"时，生成式 AI 就会打开所需页面并作答。

为了获得准确的回答，请在指示中再加入以下两点。

  • 不要推测参数名或规格
  • 在回答中标明所参考的官方文档的 URL

提示词示例​

以下是可直接复制使用的提示词示例。请根据用途改写语音条件或想要实现的内容。

选定接口​

这是处理已录制文件时的示例。

请以 https://docs.amivoice.com/llms.txt 为起点，
参考其链接指向的 AmiVoice API 官方文档。

在对已录制的约 30 分钟的音频文件进行转写时，
请整理应使用的接口、连接引擎和所需的请求参数。

请不要推测参数名或规格，
并在回答中标明所参考的官方文档的 URL。

这是实时发送语音时的示例。

请以 https://docs.amivoice.com/llms.txt 为起点，
参考其链接指向的 AmiVoice API 官方文档。

我想从浏览器实时发送麦克风的语音，
并在画面上显示识别的中间结果。

请整理应使用同步 HTTP、异步 HTTP、WebSocket 中的哪一种，
以及理由、实现步骤和应参考的文档。

生成示例代码​

请以 https://docs.amivoice.com/llms.txt 为起点，
参考其链接指向的 AmiVoice API 官方文档。

请编写使用同步 HTTP 接口，
对 16kHz、单声道、WAV 格式的音频文件进行转写的 Python 代码。

API 密钥从环境变量获取，
并处理 HTTP 错误和响应正文中的结果代码。
请不要推测不存在的端点或参数。

请在回答中也标明所参考的官方文档的 URL。

改善识别准确度​

请以 https://docs.amivoice.com/llms.txt 为起点，
参考其链接指向的 AmiVoice API 官方文档。

我想提高包含大量专业术语的语音的识别准确度。
请整理可以使用的方法，例如用户词典和连接引擎的选择等，
并给出各自的设置步骤和应参考的文档。

请不要推测规格，并在回答中标明所参考的官方文档的 URL。

调查错误​

请以 https://docs.amivoice.com/llms.txt 为起点，
参考其链接指向的 AmiVoice API 官方文档。

请整理同步 HTTP 接口的响应中返回的结果代码的含义、
可能的原因和处理方法。

在不仅确认 HTTP 状态，还要确认响应正文中的结果代码的前提下，
请不要推测规格，并标明所参考的官方文档的 URL。

在无法参考网页的 AI 上的使用方法​

要通过 URL 参考llms.txt，生成式 AI 需要具备读取网页的功能。如果没有该功能，请将内容直接粘贴到提示词中使用。

不过，llms.txt是一份链接列表。仅仅粘贴它，并不能传达其链接指向页面的详细规格。请按以下步骤使用。

  1. 粘贴llms.txt的内容，让 AI 确定符合用途所需的页面。
  2. 接着，将所确定页面的 Markdown 版文档也一并粘贴。

在页面 URL 的末尾加上.md即可获取 Markdown 版。例如，入门页面为https://docs.amivoice.com/zh/amivoice-api/manual/getting-started.md。

llms.txt 无法做到的事​

llms.txt用于让官方文档更易于查找和参考。它无法做到以下这些事。

  • 让生成式 AI 自动连接到 AmiVoice API
  • 让生成式 AI 将 AmiVoice API 作为工具直接执行
  • 保证所生成代码的正确性

生成的代码请务必与官方参考文档核对后再使用。

使用上的注意事项​

由于处理的是语音识别 API，请特别注意以下几点。

API 密钥和语音数据的处理
  • 在向生成式 AI 输入 API 密钥、语音数据、个人信息等内容前，请确认使用条款以及所属组织等的安全规则。此外，在输入代码或错误日志时，也请务必确认其中未意外包含这些信息。
  • 如果无需提供 API 密钥本身，请将其替换为虚拟值或环境变量名。
  • 生成的代码请与官方参考文档核对后再使用。
  • 费用、限制事项、使用条款和 SLA，请务必在当前的官方页面上确认。