Table of Contents

Class EmbeddingRequest

Namespace
Glitch9.AIDevKit
public class EmbeddingRequest : GenerativeRequest<EmbeddingRequest, EmbeddingPrompt, EmbeddingResult, string, INoopStreamEvent<EmbeddingResult>>, IGenerativeRequest, ISequentialRequest
Inheritance
object
EmbeddingRequest
Implements
Inherited Members
Extension Methods

Constructors

EmbeddingRequest(EmbeddingPrompt) 

public EmbeddingRequest(EmbeddingPrompt texts)

Parameters

texts EmbeddingPrompt

Properties

Dimensions 

public int Dimensions { get; set; }

Property Value

int

EmbedTaskType 

public EmbedTaskType EmbedTaskType { get; set; }

Property Value

EmbedTaskType

ModelType 

public override ModelType ModelType { get; }

Property Value

ModelType

Type 

public override FluentApiRequestType Type { get; }

Property Value

FluentApiRequestType

Methods

CreateStreamAsyncInternal() 

protected override UniTask<IRESTStream<INoopStreamEvent<EmbeddingResult>>> CreateStreamAsyncInternal()

Returns

UniTask<IRESTStream<INoopStreamEvent<EmbeddingResult>>>

ExecuteAsyncInternal() 

protected override UniTask<EmbeddingResult> ExecuteAsyncInternal()

Returns

UniTask<EmbeddingResult>

SetEmbedTaskType(EmbedTaskType)

Google Only, Optional. Task type for which the embeddings will be used. Can only be set for models/embedding-001. If not specified, the default is Unspecified, which lets the model choose the best type for the input content.

public EmbeddingRequest SetEmbedTaskType(EmbedTaskType taskType)

Parameters

taskType EmbedTaskType

Returns

EmbeddingRequest

SetOutputDimensionality(int)

The dimensionality of the output embedding vector. Must be one of the following values: 128, 256, 512, 768, 1024, 1536, 2048, 4096, 8192, 16384. Default is 1536.

Supported models:

  • OpenAI: Text-embedding-3 and later models
  • Google: All embedding models
public EmbeddingRequest SetOutputDimensionality(int dimensionality)

Parameters

dimensionality int

Returns

EmbeddingRequest