Share via

root.composeExtensions.commands.parameters object

The list of parameters the command takes.

Properties that reference this object type:

Syntax

{
  "name": "{string}",
  "inputType": "text | textarea | number | date | time | toggle | choiceset",
  "isRequired": {boolean},
  "title": "{string}",
  "description": "{string}",
  "value": "{string}",
  "choices": [
    {
      "title": "{string}",
      "value": "{string}"
    }
  ],
  "semanticDescription": "{string}"
}

{
  "name": "{string}",
  "inputType": "text | textarea | number | date | time | toggle | choiceset",
  "title": "{string}",
  "description": "{string}",
  "value": "{string}",
  "isRequired": {boolean},
  "semanticDescription": "{string}",
  "choices": [
    {
      "title": "{string}",
      "value": "{string}"
    }
  ]
}

Properties

name

The name of the parameter as it appears in the client. This is included in the user request.
For Api-based message extension, The name must map to the parameters.name in the OpenAPI Description. If you're referencing a property in the request body schema, then the name must map to properties.name or query parameters.

Type
string

Required
✅

Constraints
Maximum string length: 64.

Supported values

inputType

Defines the type of control displayed on a dialog for fetchTask: false.

Type
string

Required
—

Constraints

Supported values
Allowed values: text, textarea, number, date, time, toggle, choiceset.

isRequired

Indicates whether this parameter is required or not. By default, it is not.

Type
boolean

Required
—

Constraints

Supported values

isRequired

Indicates whether this parameter is required or not. By default, it is not.

Type
boolean

Required
—

Constraints

Supported values
Default value: False.

title

User-friendly title for the parameter.

This property is localizable. For more information, see the localization schema.

Type
string

Required
✅

Constraints
Maximum string length: 32.

Supported values

description

User-friendly description of parameter’s purpose.

This property is localizable. For more information, see the localization schema.

Type
string

Required
—

Constraints
Maximum string length: 128.

Supported values

value

Initial value for the parameter.

This property is localizable. For more information, see the localization schema.

Type
string

Required
—

Constraints
Maximum string length: 512.

Supported values

choices

The choice options for the parameter. Use only when parameters.inputType is choiceset.

Type
Array of choices

Required
—

Constraints
Maximum array items: 10.

Supported values

semanticDescription

Semantic description of the parameter. This is typically meant for consumption by the large language model (LLM).

Type
string

Required
—

Constraints
Maximum string length: 2000.

Supported values

Examples

{
"composeExtensions": [
        {
            "commands": [
                {
                    "parameters": [
                        {
                            "name": "keyword",
                            "title": "Search keywords",
                            "inputType": "choiceset",
                            "description": "Enter the keywords to search for",
                            "value": "Initial value for the parameter",
                            "choices": [
                                {
                                    "title": "Title of the choice",
                                    "value": "Value of the choice"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}