API-Prompts

Die API-Prompts liefern die Beschreibung und Verwendung der in UFO verwendeten APIs. Gemeinsam genutzte APIs und app-spezifische APIs werden in verschiedenen Verzeichnissen gespeichert.

Verzeichnis	Beschreibung
`ufo/prompts/share/base/api.yaml`	Gemeinsam genutzte APIs, die von mehreren Anwendungen verwendet werden.
`ufo/prompts/{app_name}`	APIs, die spezifisch für eine Anwendung sind.

Info

Sie können den in der Datei config.yaml verwendeten API-Prompt konfigurieren. Weitere Informationen zur Konfigurationsdatei finden Sie hier.

Tipp

Sie können den API-Prompt für eine bestimmte Anwendung anpassen, indem Sie den API-Prompt im Verzeichnis der Anwendung hinzufügen.

Beispiel API-Prompt

Unten sehen Sie ein Beispiel für einen API-Prompt.

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

Um einen neuen API-Prompt zu erstellen, folgen Sie der obigen Vorlage und fügen Sie ihn dem entsprechenden Verzeichnis hinzu.