Theia API Documentation v1.76.0
    Preparing search index...

    Interface OpenAiClientOptions

    Options for createOpenAiClient.

    interface OpenAiClientOptions {
        apiKey: undefined | string;
        apiVersion?: string;
        baseURL?: string;
        deployment?: string;
        headers?: Record<string, string>;
        proxyUrl?: string;
    }
    Index

    Properties

    apiKey apiVersion? baseURL? deployment? headers? proxyUrl?

    Properties

    apiKey: undefined | string

    The key to authenticate with. A custom endpoint may need none.

    apiVersion?: string

    Azure API version. Its presence is what selects the Azure client over the plain one.

    baseURL?: string

    Base URL of a custom endpoint; the SDK's own default is used without one.

    deployment?: string
    headers?: Record<string, string>

    Additional HTTP headers sent with every request, e.g. headers required by a gateway in front of the API.

    proxyUrl?: string

    Settings

    Member Visibility

    On This Page

    Properties