API 提示

API 提示提供 UFO 中使用的 API 的描述和用法。共享 API 和应用程序特定的 API 存储在不同的目录中。

目录	描述
`ufo/prompts/share/base/api.yaml`	多个应用程序使用的共享 API
`ufo/prompts/{app_name}`	特定于应用程序的 API

信息

您可以在 config.yaml 文件中配置使用的 API 提示。您可以在此处找到有关配置文件的更多信息。

提示

您可以通过在应用程序目录中添加 API 提示来为特定应用程序自定义 API 提示。

API 提示示例

下面是一个 API 提示示例

click_input:
  summary: |-
    "click_input" is to click the control item with mouse.
  class_name: |-
    ClickInputCommand
  usage: |-
    [1] API call: click_input(button: str, double: bool)
    [2] Args:
      - button: 'The mouse button to click. One of ''left'', ''right'', ''middle'' or ''x'' (Default: ''left'')'
      - double: 'Whether to perform a double click or not (Default: False)'
    [3] Example: click_input(button="left", double=False)
    [4] Available control item: All control items.
    [5] Return: None

要创建新的 API 提示，请遵循上述模板并将其添加到相应的目录中。