Index > prompting
Namespace: prompting
Prompting utilities for Grit workflows.
Interfaces
ButtonPromptSettings
Extends
BasePromptSettings
Type parameters
| Parameter |
|---|
OptionType extends string |
Properties
| Property | Type | Description |
|---|---|---|
__typename | "PromptSettings" | - |
kind | "buttons" | - |
message | string | - |
name? | string | A name for this prompt to use across workflows. |
options | PromptContinueOptions< OptionType >[] | - |
source? | PromptSource | - |
stepId? | string | - |
target | PromptTarget | - |
timeout? | PromptTimeout | - |
title | string | - |
SelectPromptSettings
Extends
BasePromptSettings
Type parameters
| Parameter |
|---|
OptionType extends string |
Properties
| Property | Type | Description |
|---|---|---|
__typename | "PromptSettings" | - |
kind | "select" | - |
message | string | - |
name? | string | A name for this prompt to use across workflows. |
options | OptionType[] | - |
placeholder? | OptionType | - |
source? | PromptSource | - |
stepId? | string | - |
target | PromptTarget | - |
timeout? | PromptTimeout | - |
title | string | - |
TextPromptSettings
Extends
BasePromptSettings
Properties
| Property | Type | Description |
|---|---|---|
__typename | "PromptSettings" | - |
kind | "text" | - |
message | string | - |
name? | string | A name for this prompt to use across workflows. |
options? | object | - |
options.action_id? | string | - |
options.multiline? | boolean | - |
source? | PromptSource | - |
stepId? | string | - |
target | PromptTarget | - |
timeout? | PromptTimeout | - |
title | string | - |
Type Aliases
PromptKind
PromptKind:
PromptSettings<string>["kind"]
PromptSettings
PromptSettings: <
OptionType>SelectPromptSettings<OptionType> |ButtonPromptSettings<OptionType> |TextPromptSettings
Type parameters
| Parameter |
|---|
OptionType extends string |
PromptSource
PromptSource:
"agent"|undefined
PromptTarget
PromptTarget:
"user"|"admin"
Functions
isButtonPromptSettings
isButtonPromptSettings<
OptionType>(settings):settings is ButtonPromptSettings<OptionType>
Type parameters
| Parameter |
|---|
OptionType extends string |
Parameters
| Parameter | Type |
|---|---|
settings | any |
Returns
settings is ButtonPromptSettings<OptionType>
isContinuePrompt
isContinuePrompt(
promptSettings):boolean
Parameters
| Parameter | Type |
|---|---|
promptSettings | PromptSettings< string > |
Returns
boolean
isSelectPromptSettings
isSelectPromptSettings<
OptionType>(settings):settings is SelectPromptSettings<OptionType>
Type parameters
| Parameter |
|---|
OptionType extends string |
Parameters
| Parameter | Type |
|---|---|
settings | any |
Returns
settings is SelectPromptSettings<OptionType>
isTextPromptSettings
isTextPromptSettings(
settings):settings is TextPromptSettings
Parameters
| Parameter | Type |
|---|---|
settings | any |
Returns
settings is TextPromptSettings
Generated using TypeDoc and typedoc-plugin-markdown