Class ChatBaiduWenxin

Deprecated

Install and import from @langchain/baidu-qianfan instead. Wrapper around Baidu ERNIE large language models that use the Chat endpoint.

To use you should have the BAIDU_API_KEY and BAIDU_SECRET_KEY environment variable set.

Example

const ernieTurbo = new ChatBaiduWenxin({
  apiKey: "YOUR-API-KEY",
  baiduSecretKey: "YOUR-SECRET-KEY",
});

const ernie = new ChatBaiduWenxin({
  model: "ERNIE-Bot",
  temperature: 1,
  apiKey: "YOUR-API-KEY",
  baiduSecretKey: "YOUR-SECRET-KEY",
});

const messages = [new HumanMessage("Hello")];

let res = await ernieTurbo.call(messages);

res = await ernie.call(messages);

Hierarchy (view full)

Implements

  • BaiduWenxinChatInput

Constructors

constructor

Properties

accessToken apiUrl model modelName streaming apiKey? baiduApiKey? baiduSecretKey? penaltyScore? prefixMessages? temperature? topP? userId?

Accessors

callKeys

Methods

getAccessToken identifyingParams invocationParams

Constructors

constructor

Properties

accessToken

accessToken: string

apiUrl

apiUrl: string

model

model: string = "ERNIE-Bot-turbo"

Model name to use. Available options are: ERNIE-Bot, ERNIE-Bot-turbo, ERNIE-Bot-4

Default

"ERNIE-Bot-turbo"

modelName

modelName: string = "ERNIE-Bot-turbo"

Model name to use. Available options are: ERNIE-Bot, ERNIE-Bot-turbo, ERNIE-Bot-4 Alias for model

Default

"ERNIE-Bot-turbo"

streaming

streaming: boolean = false

Whether to stream the results or not. Defaults to false.

OptionalapiKey

apiKey?: string

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

OptionalbaiduApiKey

baiduApiKey?: string

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

OptionalbaiduSecretKey

baiduSecretKey?: string

Secret key to use when making requests. Defaults to the value of BAIDU_SECRET_KEY environment variable.

OptionalpenaltyScore

penaltyScore?: number

Penalizes repeated tokens according to frequency. Range from 1.0 to 2.0. Defaults to 1.0.

OptionalprefixMessages

prefixMessages?: WenxinMessage[]

Messages to pass as a prefix to the prompt

Optionaltemperature

temperature?: number

Amount of randomness injected into the response. Ranges from 0 to 1 (0 is not included). Use temp closer to 0 for analytical / multiple choice, and temp closer to 1 for creative and generative tasks. Defaults to 0.95.

OptionaltopP

topP?: number

Total probability mass of tokens to consider at each step. Range from 0 to 1.0. Defaults to 0.8.

OptionaluserId

userId?: string

ID of the end-user who made requests.

Accessors

callKeys

Methods

getAccessToken

  • getAccessToken(options?): Promise<any>

  • Method that retrieves the access token for making requests to the Baidu API.

    Parameters

    • Optionaloptions: unknown

      Optional parsed call options.

    Returns Promise<any>

    The access token for making requests to the Baidu API.

identifyingParams

  • identifyingParams(): {
        model_name: string;
        penalty_score?: number;
        stream?: boolean;
        system?: string;
        temperature?: number;
        top_p?: number;
        user_id?: string;
    }

  • Get the identifying parameters for the model

    Returns {
        model_name: string;
        penalty_score?: number;
        stream?: boolean;
        system?: string;
        temperature?: number;
        top_p?: number;
        user_id?: string;
    }

    • model_name: string
    • Optionalpenalty_score?: number
    • Optionalstream?: boolean
    • Optionalsystem?: string
    • Optionaltemperature?: number
    • Optionaltop_p?: number
    • Optionaluser_id?: string

invocationParams

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods