Class ChatIflytekXinghuo

Example

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

Hierarchy

  • BaseChatIflytekXinghuo
    • ChatIflytekXinghuo

Constructors

constructor

Properties

apiUrl domain iflytekApiKey iflytekApiSecret iflytekAppid max_tokens streaming temperature top_k version userId?

Accessors

callKeys

Methods

completion identifyingParams invocationParams openWebSocketStream

Constructors

constructor

Properties

apiUrl

apiUrl: string

domain

domain: string

iflytekApiKey

iflytekApiKey: string

iflytekApiSecret

iflytekApiSecret: string

iflytekAppid

iflytekAppid: string

max_tokens

max_tokens: number = 2048

streaming

streaming: boolean = false

temperature

temperature: number = 0.5

top_k

top_k: number = 4

version

version: string = "v2.1"

Optional userId

userId?: string

Accessors

callKeys

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
    • Optional signal: AbortSignal

      The signal for the API call.

    Returns Promise<IterableReadableStream<string>>

    The response from the Xinghuo API.

  • completion(request, stream, signal?): Promise<ChatCompletionResponse>

  • Parameters

    • request: ChatCompletionRequest
    • stream: false
    • Optional signal: AbortSignal

    Returns Promise<ChatCompletionResponse>

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
    • Optional chat_id?: string
    • Optional max_tokens?: number
    • Optional temperature?: number
    • Optional top_k?: number

invocationParams

  • invocationParams(): Omit<ChatCompletionRequest, "messages"> & {
        streaming: boolean;
    }

  • Get the parameters used to invoke the model

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

openWebSocketStream

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc