Interface: DialogGenerateOptions

Defined in: src/types/DialogGenerateOptions.ts:7

Options accepted by ai.text.generateDialog.

Extends

• GenerateOptions

Properties

context?

> optional context?: string

Defined in: src/types/GenerateOptions.ts:19

Additional developer context, injected verbatim into the prompt.

Inherited from

GenerateOptions.context

history?

> optional history?: boolean

Defined in: src/types/GenerateOptions.ts:15

Include the Pixi'VN narrative history.

When not false, the history is retrieved directly from Pixi'VN and serialized into JSON.

Default

true

Inherited from

GenerateOptions.history

language?

> optional language?: string

Defined in: src/types/DialogGenerateOptions.ts:24

Output language.

listeners?

> optional listeners?: CharacterItem | CharacterItem[]

Defined in: src/types/DialogGenerateOptions.ts:20

Character(s) receiving the dialogue.

Can be any serializable object (or array of objects).

scene?

> optional scene?: string

Defined in: src/types/GenerateOptions.ts:23

Scene description.

Inherited from

GenerateOptions.scene

speaker?

> optional speaker?: CharacterItem | CharacterItem[]

Defined in: src/types/DialogGenerateOptions.ts:14

Character(s) speaking.

Can be any serializable object (or array of objects). Pixi'VN AI does not define a Character model: developers are free to pass whatever shape fits their game.

style?

> optional style?: string

Defined in: src/types/GenerateOptions.ts:27

Desired style (tone of voice, art style, etc).

Inherited from

GenerateOptions.style