Heroku LangChain.js - v1.0.1
    Preparing search index...

    Interface HerokuEmbeddingsRequest

    Request payload for Heroku /v1/embeddings API. Based on Heroku embeddings API documentation.

    interface HerokuEmbeddingsRequest {
        model: string;
        input: string[];
        input_type?:
            | "search_document"
            | "search_query"
            | "classification"
            | "clustering";
        encoding_format?: "base64"
        | "raw";
        embedding_type?: "float" | "int8" | "uint8" | "binary" | "ubinary";
        truncate?: "NONE" | "START" | "END";
        [key: string]: any;
    }

    Indexable

    • [key: string]: any

      Additional parameters for future compatibility.

    Index

    Properties

    model input input_type? encoding_format? embedding_type? truncate?

    Properties

    model: string

    Model ID to use for embeddings.

    input: string[]

    Array of strings to embed. Maximum 96 strings, each with maximum 2048 characters.

    input_type?:
        | "search_document"
        | "search_query"
        | "classification"
        | "clustering"

    Type of the input text.

    encoding_format?: "base64" | "raw"

    Format for the embeddings encoding.

    "raw"
    embedding_type?: "float" | "int8" | "uint8" | "binary" | "ubinary"

    Type of embedding to generate.

    "float"
    truncate?: "NONE" | "START" | "END"

    How to handle inputs longer than the maximum length.

    "END"

    Settings

    Member Visibility

    On This Page

    Properties