Class ChatZhipuAI

Interface defining the input to the ZhipuAIChatInput class.

Hierarchy (view full)

Implements

Constructors

constructor

Properties

apiUrl modelName streaming maxTokens? messages? requestId? stop? temperature? topP? zhipuAIApiKey?

Accessors

callKeys

Methods

identifyingParams invocationParams encodeApiKey

Constructors

constructor

Properties

apiUrl

apiUrl: string

modelName

modelName: ModelName

Default

"glm-3-turbo"

streaming

streaming: boolean

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

Optional maxTokens

maxTokens?: number

max value is 8192，defaults to 1024

Optional messages

messages?: ZhipuMessage[]

Messages to pass as a prefix to the prompt

Optional requestId

requestId?: string

Unique identifier for the request. Defaults to a random UUID.

Optional stop

stop?: string[]

Optional temperature

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

Optional topP

topP?: number

Total probability mass of tokens to consider at each step. Range from 0 to 1 Defaults to 0.7

Optional zhipuAIApiKey

zhipuAIApiKey?: string

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

Accessors

callKeys

Methods

identifyingParams

  • identifyingParams(): {
        incremental_output?: null | boolean;
        max_tokens?: null | number;
        request_id?: string;
        result_format?: "text" | "message";
        stream?: boolean;
        temperature?: null | number;
        top_k?: null | number;
        top_p?: null | number;
    } & Pick<ChatCompletionRequest, "model">

  • Get the identifying parameters for the model

    Returns {
        incremental_output?: null | boolean;
        max_tokens?: null | number;
        request_id?: string;
        result_format?: "text" | "message";
        stream?: boolean;
        temperature?: null | number;
        top_k?: null | number;
        top_p?: null | number;
    } & Pick<ChatCompletionRequest, "model">

invocationParams

  • invocationParams(): {
        incremental_output?: null | boolean;
        max_tokens?: null | number;
        request_id?: string;
        result_format?: "text" | "message";
        stream?: boolean;
        temperature?: null | number;
        top_k?: null | number;
        top_p?: null | number;
    }

  • Get the parameters used to invoke the model

    Returns {
        incremental_output?: null | boolean;
        max_tokens?: null | number;
        request_id?: string;
        result_format?: "text" | "message";
        stream?: boolean;
        temperature?: null | number;
        top_k?: null | number;
        top_p?: null | number;
    }

    • Optional incremental_output?: null | boolean
    • Optional max_tokens?: null | number
    • Optional request_id?: string
    • Optional result_format?: "text" | "message"
    • Optional stream?: boolean
    • Optional temperature?: null | number
    • Optional top_k?: null | number
    • Optional top_p?: null | number

Static encodeApiKey

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc