Interface: RequiredParamDef<T>

Defined in: api_types.ts:433

Marker type for a Required ParamDef, used internally.

Extends

• ParamDef<T>

Type Parameters

Type Parameter
T extends UnionType

Properties

autocomplete?

optional autocomplete: MetadataFormula

Defined in: api_types.ts:357

A MetadataFormula that returns valid values for this parameter, optionally matching a search query. This can be useful both if there are a fixed number of valid values for the parameter, or if the valid values from the parameter can be looked up from some API. Use makeMetadataFormula to wrap a function that implements your autocomplete logic. Typically once you have fetched the list of matching values, you'll use autocompleteSearchObjects to handle searching over those values. If you have a hardcoded list of valid values, you would only need to use makeSimpleAutocompleteMetadataFormula.

Inherited from

ParamDef.autocomplete

---

defaultValue?

optional defaultValue: SuggestedValueType<T>

Defined in: api_types.ts:361

Deprecated

This will be removed in a future version of the SDK. Use ParamDef.suggestedValue instead.

Inherited from

ParamDef.defaultValue

---

description

description: string

Defined in: api_types.ts:334

A brief description of what this parameter is used for, shown to the user when invoking the formula.

Inherited from

ParamDef.description

---

instructions?

optional instructions: string

Defined in: api_types.ts:339

Instructions for LLMs on how to use this parameter, overrides the description for LLMs if set.

Inherited from

ParamDef.instructions

---

name

name: string

Defined in: api_types.ts:326

The name of the parameter, which will be shown to the user when invoking this formula.

Inherited from

ParamDef.name

---

optional?

optional optional: false

Defined in: api_types.ts:434

Whether this parameter can be omitted when invoking the formula. All optional parameters must come after all non-optional parameters.

Overrides

ParamDef.optional

---

suggestedValue?

optional suggestedValue: SuggestedValueType<T>

Defined in: api_types.ts:365

The suggested value to be prepopulated for this parameter if it is not specified by the user.

Inherited from

ParamDef.suggestedValue

---

type

type: T

Defined in: api_types.ts:330

The data type of this parameter (string, number, etc).

Inherited from

ParamDef.type