Interface ChatOpenAIFields

interface ChatOpenAIFields {
    apiKey?: string;
    azureADTokenProvider?: (() => Promise<string>);
    azureOpenAIApiCompletionsDeploymentName?: string;
    azureOpenAIApiDeploymentName?: string;
    azureOpenAIApiEmbeddingsDeploymentName?: string;
    azureOpenAIApiInstanceName?: string;
    azureOpenAIApiKey?: string;
    azureOpenAIApiVersion?: string;
    azureOpenAIBasePath?: string;
    configuration?: ClientOptions & LegacyOpenAIInput;
    frequencyPenalty?: number;
    logitBias?: Record<string, number>;
    logprobs?: boolean;
    maxTokens?: number;
    model?: string;
    modelKwargs?: Record<string, any>;
    modelName?: string;
    n?: number;
    openAIApiKey?: string;
    prefixMessages?: ChatCompletionMessageParam[];
    presencePenalty?: number;
    stop?: string[];
    stopSequences?: string[];
    streamUsage?: boolean;
    streaming?: boolean;
    supportsStrictToolCalling?: boolean;
    temperature?: number;
    timeout?: number;
    topLogprobs?: number;
    topP?: number;
    user?: string;
}

Hierarchy (view full)

Properties

apiKey? azureADTokenProvider? azureOpenAIApiCompletionsDeploymentName? azureOpenAIApiDeploymentName? azureOpenAIApiEmbeddingsDeploymentName? azureOpenAIApiInstanceName? azureOpenAIApiKey? azureOpenAIApiVersion? azureOpenAIBasePath? configuration? frequencyPenalty? logitBias? logprobs? maxTokens? model? modelKwargs? modelName? n? openAIApiKey? prefixMessages? presencePenalty? stop? stopSequences? streamUsage? streaming? supportsStrictToolCalling? temperature? timeout? topLogprobs? topP? user?

Properties

OptionalapiKey

apiKey?: string

API key to use when making requests to OpenAI. Defaults to the value of OPENAI_API_KEY environment variable.

OptionalazureADTokenProvider

azureADTokenProvider?: (() => Promise<string>)

A function that returns an access token for Microsoft Entra (formerly known as Azure Active Directory), which will be invoked on every request.

OptionalazureOpenAIApiCompletionsDeploymentName

azureOpenAIApiCompletionsDeploymentName?: string

Azure OpenAI API deployment name to use for completions when making requests to Azure OpenAI. Completions are only available for gpt-3.5-turbo and text-davinci-003 deployments. This is the name of the deployment you created in the Azure portal. This will fallback to azureOpenAIApiDeploymentName if not provided. e.g. "my-openai-deployment" this will be used in the endpoint URL: https://{InstanceName}.openai.azure.com/openai/deployments/my-openai-deployment/

OptionalazureOpenAIApiDeploymentName

azureOpenAIApiDeploymentName?: string

Azure OpenAI API deployment name to use for completions when making requests to Azure OpenAI. This is the name of the deployment you created in the Azure portal. e.g. "my-openai-deployment" this will be used in the endpoint URL: https://{InstanceName}.openai.azure.com/openai/deployments/my-openai-deployment/

OptionalazureOpenAIApiEmbeddingsDeploymentName

azureOpenAIApiEmbeddingsDeploymentName?: string

Azure OpenAI API deployment name to use for embedding when making requests to Azure OpenAI. This is the name of the deployment you created in the Azure portal. This will fallback to azureOpenAIApiDeploymentName if not provided. e.g. "my-openai-deployment" this will be used in the endpoint URL: https://{InstanceName}.openai.azure.com/openai/deployments/my-openai-deployment/

OptionalazureOpenAIApiInstanceName

azureOpenAIApiInstanceName?: string

Azure OpenAI API instance name to use when making requests to Azure OpenAI. this is the name of the instance you created in the Azure portal. e.g. "my-openai-instance" this will be used in the endpoint URL: https://my-openai-instance.openai.azure.com/openai/deployments/{DeploymentName}/

OptionalazureOpenAIApiKey

azureOpenAIApiKey?: string

API key to use when making requests to Azure OpenAI.

OptionalazureOpenAIApiVersion

azureOpenAIApiVersion?: string

API version to use when making requests to Azure OpenAI.

OptionalazureOpenAIBasePath

azureOpenAIBasePath?: string

Custom endpoint for Azure OpenAI API. This is useful in case you have a deployment in another region. e.g. setting this value to "https://westeurope.api.cognitive.microsoft.com/openai/deployments" will be result in the endpoint URL: https://westeurope.api.cognitive.microsoft.com/openai/deployments/{DeploymentName}/

Optionalconfiguration

configuration?: ClientOptions & LegacyOpenAIInput

OptionalfrequencyPenalty

frequencyPenalty?: number

Penalizes repeated tokens according to frequency

OptionallogitBias

logitBias?: Record<string, number>

Dictionary used to adjust the probability of specific tokens being generated

Optionallogprobs

logprobs?: boolean

Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message.

OptionalmaxTokens

maxTokens?: number

Maximum number of tokens to generate in the completion. -1 returns as many tokens as possible given the prompt and the model's maximum context size.

Optionalmodel

model?: string

Model name to use

OptionalmodelKwargs

modelKwargs?: Record<string, any>

Holds any additional parameters that are valid to pass to openai.createCompletion that are not explicitly specified on this class.

OptionalmodelName

modelName?: string

Model name to use Alias for model

Optionaln

n?: number

Number of completions to generate for each prompt

OptionalopenAIApiKey

openAIApiKey?: string

API key to use when making requests to OpenAI. Defaults to the value of OPENAI_API_KEY environment variable. Alias for apiKey

OptionalprefixMessages

prefixMessages?: ChatCompletionMessageParam[]

ChatGPT messages to pass as a prefix to the prompt

OptionalpresencePenalty

presencePenalty?: number

Penalizes repeated tokens

Optionalstop

stop?: string[]

List of stop words to use when generating Alias for stopSequences

OptionalstopSequences

stopSequences?: string[]

List of stop words to use when generating

OptionalstreamUsage

streamUsage?: boolean

Whether or not to include token usage data in streamed chunks.

Default

true

Optionalstreaming

streaming?: boolean

Whether to stream the results or not. Enabling disables tokenUsage reporting

OptionalsupportsStrictToolCalling

supportsStrictToolCalling?: boolean

Whether the model supports the 'strict' argument when passing in tools. Defaults to true if modelName/model starts with 'gpt-' otherwise defaults to false.

Optionaltemperature

temperature?: number

Sampling temperature to use

Optionaltimeout

timeout?: number

Timeout to use when making requests to OpenAI.

OptionaltopLogprobs

topLogprobs?: number

An integer between 0 and 5 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used.

OptionaltopP

topP?: number

Total probability mass of tokens to consider at each step

Optionaluser

user?: string

Unique string identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

Settings

Member Visibility

On This Page

Properties