Class ConversationConfig`Internal`

The configuration for a conversation. Contains library specific options and OpenAI's Chat Completion default options.

This class is used internally by the library and is not meant to be instantiated by consumers of the library.

Hierarchy

ConversationConfig

Index

Constructors

Constructors

constructor

new ConversationConfig(pluginService, options?): ConversationConfig
Parameters
- pluginService: ConversationPluginService<ConversationPlugin<string, any, any>[]>
- options: {
      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;
  } = {}
  - 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
Returns ConversationConfig
- Defined in packages/lib/src/classes/ConversationConfig.ts:45

Properties

`Private` _apiKey

_apiKey: string

`Private` _context

_context: string

`Private` _dry

_dry: boolean

`Private` _stop

_stop: undefined | null | string | string[]

disableModeration

disableModeration: boolean | "soft"

frequencyPenalty

frequencyPenalty: undefined | number

functionCall

functionCall: undefined | {
name: string;
} | "none" | "auto"

Type declaration

name: string

logitBias

logitBias: undefined | {
[token: number]: number;
}

Type declaration

[token: number]: number

maxTokens

maxTokens: undefined | number

model

model: string

`Private` `Readonly` pluginService

pluginService: ConversationPluginService<ConversationPlugin<string, any, any>[]>

presencePenalty

presencePenalty: undefined | number

stream

stream: boolean

temperature

temperature: undefined | number

topP

topP: undefined | number

user

user: undefined | string

Accessors

apiKey

get apiKey(): string
Returns string
- Defined in packages/lib/src/classes/ConversationConfig.ts:155
set apiKey(apiKey): void
Parameters
- apiKey: string
Returns void
- Defined in packages/lib/src/classes/ConversationConfig.ts:159

context

get context(): string
Returns string
- Defined in packages/lib/src/classes/ConversationConfig.ts:166
set context(context): void
Parameters
- context: string
Returns void
- Defined in packages/lib/src/classes/ConversationConfig.ts:170

dry

get dry(): boolean
Returns boolean
- Defined in packages/lib/src/classes/ConversationConfig.ts:174
set dry(dry): void
Parameters
- dry: boolean
Returns void
- Defined in packages/lib/src/classes/ConversationConfig.ts:178

isModerationEnabled

get isModerationEnabled(): boolean
Returns boolean
- Defined in packages/lib/src/classes/ConversationConfig.ts:188

isModerationSoft

get isModerationSoft(): boolean
Returns boolean
- Defined in packages/lib/src/classes/ConversationConfig.ts:197

isModerationStrict

get isModerationStrict(): boolean
Returns boolean
- Defined in packages/lib/src/classes/ConversationConfig.ts:192

stop

get stop(): undefined | null | string | string[]
Returns undefined | null | string | string[]
- Defined in packages/lib/src/classes/ConversationConfig.ts:202
set stop(stop): void
Parameters
- stop: undefined | null | string | string[]
Returns void
- Defined in packages/lib/src/classes/ConversationConfig.ts:206

Methods

getChatCompletionConfig

getChatCompletionConfig(): ChatCompletionConfigProperties
Returns the OpenAI-specific options of the config.

Returns ChatCompletionConfigProperties
- Defined in packages/lib/src/classes/ConversationConfig.ts:81

getConfig

getConfig(): ConfigProperties
Returns both the library-specific and OpenAI-specific options of the config.

Returns ConfigProperties
- Defined in packages/lib/src/classes/ConversationConfig.ts:101

getConversationConfig

getConversationConfig(): ConversationConfigProperties
Returns the library-specific options of the config.

Returns ConversationConfigProperties
- Defined in packages/lib/src/classes/ConversationConfig.ts:70

setConfig

setConfig(config, merge?): void
Assigns a new config to the conversation.
Parameters
- config: Partial<ConfigProperties>
  
  The new config to use.
- merge: boolean = false
  
  Set to true to shallow merge the new config with the existing config instead of replacing it.
Returns void
- Defined in packages/lib/src/classes/ConversationConfig.ts:114

toJSON

toJSON(): {
    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;
}
Internal
Serializes the ConversationConfig to JSON.

Returns {
    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;
}
The ConversationConfig as a JSON object.

This method is used internally by the library and is not meant to be used by consumers of the library.
- 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
- Defined in packages/lib/src/classes/ConversationConfig.ts:60

Class ConversationConfigInternal

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

pluginService: ConversationPluginService<ConversationPlugin<string, any, any>[]>

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

Returns ConversationConfig

Properties

Private _apiKey

Private _context

Private _dry

Private _stop

disableModeration

frequencyPenalty

functionCall

Type declaration

name: string

logitBias

Type declaration

[token: number]: number

maxTokens

model

Private Readonly pluginService

presencePenalty

stream

temperature

topP

user

Accessors

apiKey

Returns string

Parameters

apiKey: string

Returns void

context

Returns string

Parameters

context: string

Returns void

dry

Returns boolean

Parameters

dry: boolean

Returns void

isModerationEnabled

Returns boolean

isModerationSoft

Returns boolean

isModerationStrict

Returns boolean

stop

Returns undefined | null | string | string[]

Parameters

stop: undefined | null | string | string[]

Returns void

Methods

getChatCompletionConfig

Returns ChatCompletionConfigProperties

getConfig

Returns ConfigProperties

Class ConversationConfig`Internal`

`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

`Private` _apiKey

`Private` _context

`Private` _dry

`Private` _stop

`Private` `Readonly` pluginService

`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