Header menu logo Nao

OutputFormat Type

Output format the agent should produce. Controls the formatting instruction appended to the system prompt.

Union cases

Union case Description

Custom formatInstruction

Full Usage: Custom formatInstruction

Parameters:
    formatInstruction : string

Custom format described by a freeform instruction

formatInstruction : string

FreeText

Full Usage: FreeText

No format constraint — agent responds in natural language

Json schema

Full Usage: Json schema

Parameters:
    schema : string option

JSON output, optionally constrained to a schema

schema : string option

Markdown

Full Usage: Markdown

Markdown-formatted output

Instance members

Instance member Description

this.IsCustom

Full Usage: this.IsCustom

Returns: bool
Returns: bool

this.IsFreeText

Full Usage: this.IsFreeText

Returns: bool
Returns: bool

this.IsJson

Full Usage: this.IsJson

Returns: bool
Returns: bool

this.IsMarkdown

Full Usage: this.IsMarkdown

Returns: bool
Returns: bool

Type something to start searching.