Using x-ibm properties to configure apps and skills
You can use the following x-ibm properties in your OpenAPI specification to enhance your watsonx Orchestrate skills by adding more details and clarity.
x-ibm properties to configure the apps
Use the following x-ibm properties to enhance your apps.
| Extension tag | Required/Optional | Description |
|---|---|---|
| x-ibm-application-icon | Optional | Displays an icon for the app and its skill. |
| x-ibm-application-id | Required | Defines the unique ID of the app. |
| x-ibm-application-name | Required | Displays the name of the app. |
| x-ibm-disable-default-server-url | Optional | Sets the custom endpoint configuration as required. |
| x-ibm-skill-headers | Optional | Indicates the username and the user email to be passed to the skill so that an action can happen. |
| x-ibm-skill-type | Required | Indicates the type of skill referenced. |
| x-ibm-skill-subtype | Required | Indicates the type of the skill. |
x-ibm properties to configure the skills
Use the following x-ibm properties to enhance your skills.
| Extension tag | Required/Optional | Description |
|---|---|---|
| x-ibm-conversational-skill | Optional | Enables skills to be used as skill-based actions in AI assistants. |
| x-ibm-display-message-ref | Optional | Customizes the error message that must be presented to the user whenever a skill run fails. |
| x-ibm-message-abs-path | Optional | Refers to the absolute path to the property in the error response that contains the error message returned from the skill server. |
| x-ibm-message-template | Optional | Displays a message response with an error when a skill run fails. |
| x-ibm-next-actions | Optional | Suggests next actions to the user after they run a skill. |
| x-ibm-nl-entities | Optional | Maps input values from the user message. |
| x-ibm-nl-intent-examples | Optional | Provides training data for the skill's Natural Language Understanding model. |
| x-ibm-nl-output-template | Optional | Configures output messages. |
| x-ibm-parameter-wrapper | Optional | Wrap schemas for synchronous skills to use the skill in project workflows. |
| x-ibm-response-wrapper | Optional | Wrap schemas for asynchronous skills to use the skill in project workflows. |
| x-ibm-visible | Optional | Shows or hides skills on the skill catalog. |
x-ibm properties to configure input, output, and parameter schemas of skills
Use the following x-ibm properties to enhance your input, output, and parameter schemas.
| Extension tag | Required/Optional | Description |
|---|---|---|
| x-ibm-disable | Optional | Disables a field in a form. |
| x-ibm-important | Optional | Promotes optional fields from the initially hidden section of the form to the main section. |
| x-ibm-label | Optional | Supplies a human-readable name for input parameters and request body. |
| x-ibm-multiline | Optional | Switches the text box used in the input form from a single line to a multiline box. |
| x-ibm-order | Optional | Orders the input and output fields on watsonx Orchestrate. |
| x-ibm-pagination | Optional | Sets a pagination to output list. |
| x-ibm-show | Optional | Shows or hide an optional input in the generated form. |
| x-ibm-skill-inputs | Optional | Automatically fills string input fields for Assistant. |
| x-ibm-ui-extension | Optional | Turns the input fields into dynamic input fields. You can use this property to: |