第 6 章 请求任务建议
Red Hat Ansible Lightspeed 通过 Ansible VS Code 扩展集成到 Visual Studio (VS) Code 中。您可以使用 Ansible VS Code 扩展为任务意图请求代码建议。
6.1. 概述
您可以从 Ansible VS Code 扩展执行以下任务:
使用自然语言提示创建单任务或多任务请求
创建单个任务提示
在 Ansible 文件中新任务行的
- name:
key 中编写您的任务描述。例如,若要自动执行安装 PostgreSQL 服务器的任务,您可以输入 prompt- name: Install postgresql-server
。创建多任务提示
将光标放在 Ansible YAML 文件中的新行中,并使用 Pound 键启动您的提示(#)。
编写任务的描述,使用 Ampersand 符号(&)分隔每个提示。例如,要自动执行安装 PostgreSQL 服务器的多任务并运行初始 PostgreSQL setup 命令,您可以输入提示
# Install postgresql-server 并运行 postgresql-setup 命令
。Ansible Lightspeed 服务读取文本,与 IBM watsonx Code Assistant 模型交互,并根据您的自然语言提示生成 Ansible 任务建议。
注意目前,Red Hat Ansible Lightspeed 仅支持英语语言的用户提示。但是,有些情况下,用于培训 IBM watsonx Code Assistant 模型的培训数据包括非英语语言。在这种情况下,模型可以为同一非英语语言的提示生成代码建议,但生成的代码建议可能并不准确。
查看内容源匹配结果
对于每个生成的代码建议,Red Hat Ansible Lightspeed 会列出内容源匹配,包括潜在源、内容作者和相关许可证等详情。您可以使用这些数据深入了解用于生成代码建议的潜在培训数据源。
对 Ansible Lightspeed 服务提供反馈
Ansible Lightspeed 服务了解您的机构模式,并改进代码建议体验。您可以提供反馈,了解生成的代码建议是否适合您的任务意图。这个反馈可让带有 IBM watsonx Code Assistant 的 Red Hat Ansible Lightspeed 改进其建议质量。
6.1.1. 改进推荐指导的最佳实践
按照以下步骤提高质量代码建议的可能性。
- 确保您的 YAML 文件已正确格式化。详情请参阅 Ansible YAML 语法指南。
避免在单个 playbook 文件中切换上下文。
Ansible Lightspeed 服务尝试将早期任务与活跃建议关联,在光标位置用作模型的上下文之前,该文件的整个内容。如果之前的任务与您的提示无关,则 VS 代码提供内联建议而不是代码建议。
对自然语言提示进行重新传输,以获取与您的任务意图匹配的代码建议。
如果您获得一个与任务名称意图不匹配的建议,那么请重新输入您的提示,以提供有关所需内容的更多信息,从而可以改进结果。
使用描述性提示并提供附加内容来提高代码建议。
在生成代码建议时,Red Hat Ansible Lightspeed 会读取完整的 Ansible YAML 文件。使用描述性提示和具有与所需任务相关的其他 YAML 文件内容提高了代码建议。例如,您可以添加前面的 Ansible 任务和适当的 playbook 和变量名称,以改进代码建议。