Heroku AI SDK Provider - v0.4.3
    Preparing search index...

    Interface HerokuAIOptions

    Configuration settings for the Heroku AI provider.

    import { createHerokuAI } from "heroku-ai-provider";

    const heroku = createHerokuAI({
      chatApiKey: "your_inference_api_key",
      embeddingsApiKey: "your_embedding_api_key",
      chatBaseUrl: "https://us.inference.heroku.com/v1/chat/completions",
      embeddingsBaseUrl: "https://us.inference.heroku.com/v1/embeddings"
    });
    interface HerokuAIOptions {
        chatApiKey?: string;
        embeddingsApiKey?: string;
        imageApiKey?: string;
        chatBaseUrl?: string;
        embeddingsBaseUrl?: string;
        imageBaseUrl?: string;
    }
    Index

    Properties

    chatApiKey? embeddingsApiKey? imageApiKey? chatBaseUrl? embeddingsBaseUrl? imageBaseUrl?

    Properties

    chatApiKey?: string

    API key for chat completions.

    process.env.INFERENCE_KEY (Node.js only; not available in browsers)
    embeddingsApiKey?: string

    API key for embeddings.

    process.env.EMBEDDING_KEY (Node.js only; not available in browsers)
    imageApiKey?: string

    API key for image generations.

    process.env.DIFFUSION_KEY ?? process.env.HEROKU_DIFFUSION_KEY (Node.js only; not available in browsers)
    chatBaseUrl?: string

    Base URL for chat completions API.

    process.env.INFERENCE_URL ?? "https://us.inference.heroku.com/v1/chat/completions" (process.env only available in Node.js)
    embeddingsBaseUrl?: string

    Base URL for embeddings API.

    process.env.EMBEDDING_URL ?? "https://us.inference.heroku.com/v1/embeddings" (process.env only available in Node.js)
    imageBaseUrl?: string

    Base URL for image generations API.

    process.env.DIFFUSION_URL ?? "https://us.inference.heroku.com/v1/images/generations" (process.env only available in Node.js)

    Settings

    Member Visibility

    On This Page

    Properties