macaroni

complete

Description:
The complete executor is used to call the Azure Open AI service, to complete a prompt.

Parent: execute, then, else

Value (simple form): string specifying the prompt to be completed
Value (key/value form):

• complete: string, required, specifying the prompt to be completed
• key: string, optional, specifying the Azure Open AI api-key (default: from configuration)
• version: string, optional, specifying the Azure Open AI api-version (default: from configuration)
• endpoint: string, optional, specifying the Azure Open AI endpoint (default: from configuration)
• deployment: string, optional, specifying the Azure Open AI deployment (default: from configuration)
• maxTokens: int, optional, specifying the maximum number of tokens to generate in a response (default: 100)
• temperature: float, optional, specifying the stability (1) vs randomness (0) of the completion (default: 1)
• frequencyPenalty: float, optional, specifying the penalty for repeating a token proportionally in the completion (default: 0)
• presencePenalty: float, optional, specifying the penalty for repeating any token that has appeared in the text at all so far (default: 0)
• topP: float, optional, controlling which tokens the model will consider when generating a response via nucleus sampling (default: 0.5)
• stop: string or sequence of string, optional, specifying that responses stop at a desired point, such as the end of a sentence or list (default: null)

# simple form
- complete: (string, or sequence of string)

# simple example
- complete: 'Explain this to a 5 year old child: {clipboard.text}'

# key/value form
- complete: (string, or sequence of string, required)
  key: (string, optional)
  version: (string, optional)
  endpoint: (string, optional)
  deployment: (string, optional)
  maxTokens: (int, optional)
  temperature: (float, optional)
  frequencyPenalty: (float, optional)
  presencePenalty: (float, optional)
  topP: (float, optional)
  stop: (string or sequence of string, optional)

# key/value example
- complete: |
    Top 5 reasons {words}
    1.
  temperature: 0.8
  maxTokens: 50

EXAMPLE

# using Open AI GPT completion service, calculate and insert a 6 digit hex color code based on what was spoken
commands:
- name: insert hex color code
  examples:
  - insert hot rod red color code
  - insert banana yellow color code
  triggers:
  - insert {name} color code
  execute:
  - complete: |
      {name} hex color code: #
    deployment: robch-southcentral-oai-txtdav002
  - clipboard: '{complete.text}'
  - sendKeys: '{ctrl-v}'

Status: ✅ IMPLEMENTED (version not yet implemented)

…

!! make it more clear that “complete.text” is an output … !!