AI Dev Kit
Search Results for

    Show / Hide Table of Contents

    Class EmbeddingRequest

    Returns a list of embedding objects.

    Inheritance
    object
    RequestBody
    ModelRequest
    EmbeddingRequest
    Inherited Members
    ModelRequest.Model
    ModelRequest.N
    ModelRequest.Metadata
    ModelRequest.User
    Namespace: Glitch9.AIDevKit.OpenAI
    Assembly: .dll
    Syntax
    public class EmbeddingRequest : ModelRequest

    Properties

    Dimensions

    The number of dimensions the resulting Output embeddings should have. Only supported in Text-embedding-3 and later models.

    Declaration
    public int Dimensions { get; set; }
    Property Value
    Type Description
    int

    EncodingFormat

    The format to return the embeddings in. Can be either float or base64.

    Declaration
    public EncodingFormat? EncodingFormat { get; set; }
    Property Value
    Type Description
    EncodingFormat?

    Input

    [Required] Input Text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens for Text-embedding-ada-002), cannot be an empty string, and any array must be 2048 dimensions or less. Example Python code for counting tokens.

    Declaration
    public StringOr<string> Input { get; set; }
    Property Value
    Type Description
    StringOr<string>

    Extension Methods

    RequestExtensions.ExecuteAsync(EmbeddingRequest)
    In this article
    Back to top Generated by DocFX