# LLM Widget

### Widgets in Workshop

![LLM widget](/files/MSEii4koS43h9NwM8mXx)

### Config

Most fields are compatible with [OpenAI API](https://platform.openai.com/docs/api-reference/chat/create).

Fields besides `widget_id` and `output_name`

| Field's Name           | JSON Type (Required/Optional)   | Description                                                                   | Example                                                                            |
| ---------------------- | ------------------------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| temperature            | number (Optional)               | Controls randomness in the LLMConfig model's responses.                       | 0.6                                                                                |
| top\_p                 | number (Optional)               | Controls diversity via nucleus sampling in LLMConfig.                         | 0.8                                                                                |
| max\_tokens            | number (Optional)               | Determines the maximum length of the model’s response in LLMConfig.           | 150                                                                                |
| presence\_penalty      | number (Optional)               | Influences the likelihood of the model to talk about new topics in LLMConfig. | 0.6                                                                                |
| frequency\_penalty     | number (Optional)               | Controls how often the model makes use of infrequent words in LLMConfig.      | 0.5                                                                                |
| memory                 | MemoryItem\[] (Optional)        | Stores information acquired across multiple rounds of dialog in LLMConfig.    | \[{ role: 'user', content: 'Hello World' }]                                        |
| need\_memory           | boolean (Optional)              | Determines if memory usage is required in LLMConfig.                          | true                                                                               |
| system\_prompt         | string                          | Expression (Required)                                                         | Provides system prompt for the user in LLMConfig.                                  |
| user\_prompt           | string                          | Expression (Required)                                                         | Provides user prompt for the system in LLMConfig.                                  |
| function\_name         | string (Optional)               | Specifies the name of the function in LLMFunctionConfig.                      | 'get\_current\_weather'                                                            |
| function\_description  | string (Optional)               | Provides a description of the function in LLMFunctionConfig.                  | 'Get the current weather in a given location'                                      |
| function\_parameters   | FunctionParameter\[] (Optional) | Specifies the parameters of the function in LLMFunctionConfig.                | \[{name: 'city', type: 'string', description: 'The city, e.g. San Francisco, CA'}] |
| knowledge\_base\_token | string (Optional)               | Specify the knowledge base the widget uses.                                   |                                                                                    |

`FunctionParameter`

| Field's Name | JSON Type (Required/Optional) | Description                                                            | Example                            |
| ------------ | ----------------------------- | ---------------------------------------------------------------------- | ---------------------------------- |
| name         | string (Required)             | Specifies the name of the function parameter in FunctionParameter.     | 'city'                             |
| type         | string (Required)             | Specifies the type of the function parameter in FunctionParameter.     | 'list', 'string' or 'number'       |
| description  | string (Required)             | Provides a description of the function parameter in FunctionParameter. | 'The city, e.g. San Francisco, CA' |

### Function Call

If you want to execute LLM function calls, you may specify `function_name`, `function_description` and `function_parameters` fields.

{% hint style="info" %}
Function calls can be seen as a formatting wrapper provided by LLM (currently only supports OpenAI series models), allowing parameters to be input via JSON, and outputting a serial JSON. 

Reference:

* <https://www.promptingguide.ai/applications/function_calling>
* <https://platform.openai.com/docs/api-reference/chat/create>
  {% endhint %}

For LLM function calls, the output of the widget is a JSON object, which includes the LLM returned results and will be automatically output to the state machine output in the form of key-value pairs.

### Example

```json
{
  "id": "prompt_widget_template",
  "initial": "home_state",
  "states": {
    "home_state": {
      "inputs": {
        "input_message": {
          "type": "IM",
          "user_input": true
        }
      },
      "tasks": [
        {
          "name": "llm_widget_example_task",
          "module_type": "AnyWidgetModule",
          "module_config": {
            "widget_id": "1744214047475109888",
            "user_prompt": "{{input_message}}", // the text inputted into prompt widget, you can get it from user input or upper state
            "system_prompt": "Act as ...", // Optional field. You can input system prompt of bot.
            "top_p": 0.5, // Optional field. Default value is 0.5
            "temperature": 0.5, // Optional field. Default value is 0.5
            "frequency_penalty": 0, // Optional field. Default value is 0
            "presence_penalty": 0, // Optional field. Default value is 0
            "output_name": "result"
          }
        }
      ],
      "render": {
        "text": "{{result}}", // it's a string produced by prompt widget.
        "buttons": [
          {
            "content": "Chat Again",
            "description": "",
            "on_click": "rerun"
          }
        ]
      },
      "transitions": {
        "rerun": "home_state",
        "CHAT": "home_state"
      }
    }
  }
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.myshell.ai/create/pro-config-mode/api-reference/module/anywidget-module/llm-widget.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.