Interface IOutlineCompletionArgs

Interface representing the arguments for outline (JSON) completions. Extends base completion args with outline-specific fields for structured JSON output. Used for completions that return data conforming to a predefined schema. IOutlineCompletionArgs

interface IOutlineCompletionArgs {
    clientId: string;
    format: IOutlineFormat;
    messages: IOutlineMessage[];
    outlineName: string;
}

Hierarchy (View Summary)

Properties

clientId: string

client identifier for tracking and error handling.

The outline format (required). Specifies how the completion should be structured.

messages: IOutlineMessage[]

An array of messages providing the conversation history or context for the completion.

outlineName: string

The outline schema name (required). Defines the structure of the expected JSON response.