Interface ConversationOptions

A JSON representation of a Conversation instance.

Hierarchy

Properties

callableFunctions? config? history? id? plugins? pluginsData? requestOptions?

Properties

Optional callableFunctions

callableFunctions?: {
    functions?: ({ name: string; id?: string | undefined; description?: string | undefined; parameters?: { type: "object"; title?: string | undefined; description?: string | undefined; default?: any; examples?: any[] | undefined; ... 10 more ...; additionalProperties?: boolean | ... 1 more ... | undefined; } | undefined; })[];
} = ...

Type declaration

  • Optional functions?: ({ name: string; id?: string | undefined; description?: string | undefined; parameters?: { type: "object"; title?: string | undefined; description?: string | undefined; default?: any; examples?: any[] | undefined; ... 10 more ...; additionalProperties?: boolean | ... 1 more ... | undefined; } | undefined; })[]

Optional config

config?: {
    apiKey?: string;
    context?: string;
    disableModeration?: boolean | "soft";
    dry?: boolean;
    frequency_penalty?: number;
    function_call?: "none" | "auto" | ({ name: string; });
    logit_bias?: Record<string, number>;
    max_tokens?: number;
    model?: string;
    presence_penalty?: number;
    stop?: null | string | string[];
    stream?: boolean;
    temperature?: number;
    top_p?: number;
    user?: string;
} = ...

Type declaration

  • Optional apiKey?: string
  • Optional context?: string
  • Optional disableModeration?: boolean | "soft"
  • Optional dry?: boolean
  • Optional frequency_penalty?: number
  • Optional function_call?: "none" | "auto" | ({ name: string; })
  • Optional logit_bias?: Record<string, number>
  • Optional max_tokens?: number
  • Optional model?: string
  • Optional presence_penalty?: number
  • Optional stop?: null | string | string[]
  • Optional stream?: boolean
  • Optional temperature?: number
  • Optional top_p?: number
  • Optional user?: string

Optional history

history?: {
    messages?: ({ role: "function" | "user" | "assistant" | "system"; content: string | null; id?: string | undefined; name?: string | undefined; function_call?: { name: string; arguments: Record<string, any>; } | undefined; model?: string | undefined; flags?: string[] | ... 1 more ... | undefined; })[];
} = ...

Type declaration

  • Optional messages?: ({ role: "function" | "user" | "assistant" | "system"; content: string | null; id?: string | undefined; name?: string | undefined; function_call?: { name: string; arguments: Record<string, any>; } | undefined; model?: string | undefined; flags?: string[] | ... 1 more ... | undefined; })[]

Optional id

id?: string = ...

Optional plugins

plugins?: ConversationPlugin<string, any, any>[]

Plugins to be used in the conversation.

Note that the order of the plugins is important. Each plugin are called in the order they are defined.

Optional pluginsData

pluginsData?: Record<string, any> = ...

Optional requestOptions

requestOptions?: {
    headers?: Record<string, string>;
    proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; };
} = ...

Type declaration

  • Optional headers?: Record<string, string>
  • Optional proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; }

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc