Documentation

获取转录数据

从待处理或已完成的转录中获取数据。 这包括转录时间线、关键字、摘要和段落段。

从麦克风或 LiveStream 转录

从麦克风或直播流转录实时演讲。 与 Polyglot 集成,为用户可以用任何语言阅读的转录创建公共可共享链接。

转录会议

通过会话监控和管理转录状态。 使用会话,您可以重新连接到之前创建的异步连接。

翻译一个转录

将转录的文本翻译成另一种语言。 这可以对任何转录进行,包括预录制的转录、现场转录或多语种会话转录。

从 URL 转录音频

将 URL 中预先录制的音频转录为纯文本。 支持主要文件格式,包括 MP3、WAV、FLAC 和 OGG。

转录请求和回复

所有转录操作的常见请求选项和响应。 使用选项配置转录设置。

转录和演示多语种会议

创建一个会话,可用于通过公共可共享链接广播实时转录。 用户可以用他们首选的语言阅读实时转录,甚至在您的会话处于闲置状态时,也可以阅读过去的转录。

客户端身份验证令牌

浏览文档
为客户端请求创建临时身份验证令牌。 在 Web 浏览器中安全实现 API 请求,而不会暴露您的 API 密钥。.
身份验证令牌是客户端环境中需要 VocalStack API 服务的重要安全措施。 在 Web 浏览器、应用或任何其他公共环境中实施 API 请求时,您将需要这一功能。.
在服务器端,我们可以使用 SDK 生成一个授权令牌。 默认情况下,令牌的选项是限制性的。 您可能想要更新这些以满足您的要求:
  • access: 只读或写入。 前者允许您执行返回数据的 API 调用。 后者还允许您执行包含可收费转录相关操作的 API 请求。 此选项的默认值为. 只读.
  • lifetime_s: 1 到 120 之间的数字,表示令牌的寿命(秒 ) 。 此时期过后,令牌将过期,并且将不再可用。 请注意,这不会影响已经开始使用此令牌的异步请求。 (换句话说,一旦异步请求启动,即使令牌在请求启动后过期,它也会运行到完成。 ) 此选项的默认值为. 10个月.
  • one_time: 表示此 API 令牌是否用于单次使用的布尔值。 如果为 true,则一旦此令牌被用于 API 请求,它将过期。 此选项的默认值为. .
这是您的服务器上将会看到的内容:
JavaScript
import { Security } from '@vocalstack/js-sdk'; const sdk = new Security({ apiKey: 'YOUR-API-KEY' }); const authToken = await sdk.generateToken({ access: 'readwrite', // Optional: 'readonly' or 'readwrite' lifetime_s: 60, // Optional: 1-120 seconds one_time: true, // Optional: true or false }); // Next, return the token to the client where API request will be made. // Make sure to keep the token secure and do not expose it to the public.
您需要设置一个机制,以便向客户端提供服务器生成的 API 令牌。 这在很大程度上取决于您的基础设施和技术堆栈。 确保您实施了安全最佳实践。 例如,您不应创建向未经身份验证的请求提供生成的 API 令牌的 API 端点。.
客户端上消耗 VocalStack API 需要使用. authToken 设置代替 apiKey.例如,考虑 的文档。.
在这个例子中,只需替换:
{ apiKey: 'YOUR-API-KEY' }{ authToken: 'YOUR-AUTH-TOKEN' } 👇
JavaScript
import { UrlTranscription } from '@vocalstack/js-sdk'; const authToken = await fetch('http://example.com/your-secured-api/authenticate') .then((response) => response.json()) .then((data) => data.token); const sdk = new UrlTranscription({ authToken }); const transcription = await sdk.connect({ url: 'http://example.com/speech.mp3' }); transcription.start();
生成和提供客户端身份验证令牌时,必须实施严格的安全措施,以防止未经授权访问 API。 令牌是访问资源和服务的强大工具,如果不加以保护,就可能被滥用。 您必须确保只有授权的客户端才能请求和使用令牌,并且您绝不应在公共环境中暴露敏感数据(如 API 密钥 ) 。 否则可能会导致数据泄露、未经授权访问资源或意外收取应付服务费用。.
为了帮助保护您的实施,请考虑以下最佳实践:
  • 切勿在客户端上暴露 API 密钥: API 密钥应始终保密,并安全存储在服务器上。 将它们暴露在客户端代码中(e. 格林尼治时间 JavaScript, HTML)可能导致未经授权访问 API。.
  • 使用安全服务器端令牌生成: 始终在服务器端生成身份验证令牌,以防止客户端代码中暴露 API 密钥。.
  • 验证令牌请求: 通过强制实施身份验证机制(如:API 令牌)确保只有经过身份验证的用户或服务才能请求 API 令牌。 g. 其他资源 ,OAuth,会话验证 ) 。.
  • 实现 HTTPS: 始终通过 HTTPS 提供令牌,以防止中间人攻击。.
  • 避免在 URL 中暴露令牌: 永远不要在 URL 查询参数中传递令牌,因为它们可能会被记录在服务器日志中或在浏览器历史中暴露。.
  • 限制令牌范围: 将令牌限制在最低必要的权限,例如只读访问,除非明确要求写入访问。.
  • 设置令牌过期: 使用短令牌寿命来降低令牌滥用的风险。 考虑根据使用模式和安全需求限制令牌寿命。.
  • 启用一次性令牌: 如有可能,使用一次性令牌来进行特别敏感的操作,以确保它们不能被重复使用。.
Scroll Up