Class ChatIflytekXinghuo

Example

const model = new ChatIflytekXinghuo();
const response = await model.invoke([new HumanMessage("Nice to meet you!")]);
console.log(response);

Hierarchy

BaseChatIflytekXinghuo
- ChatIflytekXinghuo

Index

Constructors

constructor

new ChatIflytekXinghuo(fields?): ChatIflytekXinghuo
Parameters
- Optionalfields: any
Returns ChatIflytekXinghuo
Inherited from BaseChatIflytekXinghuo.constructor
- Defined in libs/langchain-community/src/chat_models/iflytek_xinghuo/common.ts:225

Properties

apiUrl

apiUrl: string

domain

domain: string

iflytekApiKey

iflytekApiKey: string

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

iflytekApiSecret

iflytekApiSecret: string

API Secret to use when making requests. Defaults to the value of IFLYTEK_API_SECRET environment variable.

iflytekAppid

iflytekAppid: string

APPID to use when making requests. Defaults to the value of IFLYTEK_APPID environment variable.

max_tokens

max_tokens: number = 2048

streaming

streaming: boolean = false

temperature

temperature: number = 0.5

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.5.

top_k

top_k: number = 4

version

version: string = "v2.1"

Model version to use. Available options are: v1.1, v2.1, v3.1

Default

"v2.1"

`Optional`userId

userId?: string

ID of the end-user who made requests.

Accessors

callKeys

get callKeys(): string[]
Returns string[]
Inherited from BaseChatIflytekXinghuo.callKeys
- Defined in libs/langchain-community/src/chat_models/iflytek_xinghuo/common.ts:186

Methods

completion

completion(request, stream, signal?): Promise<IterableReadableStream<string>>
Calls the Xinghuo API completion.
Parameters
- request: ChatCompletionRequest
  The request to send to the Xinghuo API.
- stream: true
- Optionalsignal: AbortSignal
  The signal for the API call.
Returns Promise<IterableReadableStream<string>>
The response from the Xinghuo API.
Inherited from BaseChatIflytekXinghuo.completion
- Defined in libs/langchain-community/src/chat_models/iflytek_xinghuo/common.ts:316
completion(request, stream, signal?): Promise<ChatCompletionResponse>
Parameters
- request: ChatCompletionRequest
- stream: false
- Optionalsignal: AbortSignal
Returns Promise<ChatCompletionResponse>
Inherited from BaseChatIflytekXinghuo.completion
- Defined in libs/langchain-community/src/chat_models/iflytek_xinghuo/common.ts:322

identifyingParams

identifyingParams(): {
    streaming: boolean;
    version: string;
    chat_id?: string;
    max_tokens?: number;
    temperature?: number;
    top_k?: number;
}
Get the identifying parameters for the model

Returns {
    streaming: boolean;
    version: string;
    chat_id?: string;
    max_tokens?: number;
    temperature?: number;
    top_k?: number;
}
- streaming: boolean
- version: string
- Optionalchat_id?: string
- Optionalmax_tokens?: number
- Optionaltemperature?: number
- Optionaltop_k?: number
Inherited from BaseChatIflytekXinghuo.identifyingParams
- Defined in libs/langchain-community/src/chat_models/iflytek_xinghuo/common.ts:282

invocationParams

invocationParams(): Omit<ChatCompletionRequest, "messages"> & {
streaming: boolean;
}
Get the parameters used to invoke the model

Returns Omit<ChatCompletionRequest, "messages"> & {
streaming: boolean;
}
Inherited from BaseChatIflytekXinghuo.invocationParams
- Defined in libs/langchain-community/src/chat_models/iflytek_xinghuo/common.ts:292

openWebSocketStream

openWebSocketStream<WebSocketStream>(options): Promise<WebSocketStream>
Method that retrieves the auth websocketStream for making requests to the Iflytek Xinghuo API.
Type Parameters
- WebSocketStream
Parameters
- options: WebSocketStreamOptions
Returns Promise<WebSocketStream>
The auth websocketStream for making requests to the Iflytek Xinghuo API.
Overrides BaseChatIflytekXinghuo.openWebSocketStream
- Defined in libs/langchain-community/src/chat_models/iflytek_xinghuo/index.ts:25

Class ChatIflytekXinghuo

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ChatIflytekXinghuo

Properties

apiUrl

domain

iflytekApiKey

iflytekApiSecret

iflytekAppid

max_tokens

streaming

temperature

top_k

version

Default

OptionaluserId

Accessors

callKeys

Returns string[]

Methods

completion

Parameters

Returns Promise<IterableReadableStream<string>>

Parameters

Returns Promise<ChatCompletionResponse>

identifyingParams

Returns { streaming: boolean; version: string; chat_id?: string; max_tokens?: number; temperature?: number; top_k?: number; }

streaming: boolean

version: string

Optionalchat_id?: string

Optionalmax_tokens?: number

Optionaltemperature?: number

Optionaltop_k?: number

invocationParams

Returns Omit<ChatCompletionRequest, "messages"> & { streaming: boolean; }

openWebSocketStream

Type Parameters

Parameters

Returns Promise<WebSocketStream>

Settings

On This Page

`Optional`userId

Returns {
streaming: boolean;
version: string;
chat_id?: string;
max_tokens?: number;
temperature?: number;
top_k?: number;
}

`Optional`chat_id?: string

`Optional`max_tokens?: number

`Optional`temperature?: number

`Optional`top_k?: number

Returns Omit<ChatCompletionRequest, "messages"> & {
streaming: boolean;
}