Class BaseEmbeddings`Abstract`

Base class for all embedding model implementations

Hierarchy (view full)

BaseModel
- BaseEmbeddings
  - Embeddings

Index

Constructors

Properties

_additionalSettings

Accessors

AdditionalSettings apiKey

Methods

ClearAdditionalSettings EmbedText EmbedTexts GetEmbeddingModels SetAdditionalSettings

Constructors

constructor

new BaseEmbeddings(apiKey): BaseEmbeddings
Parameters
- apiKey: string
Returns BaseEmbeddings
Inherited from BaseModel.constructor
- Defined in generic/baseModel.ts:165

Properties

`Protected` _additionalSettings

_additionalSettings: Record<string, any> = {}

Protected property to store additional provider-specific settings

Accessors

AdditionalSettings

get AdditionalSettings(): Record<string, any>
Get the current additional settings

Returns Record<string, any>
- Defined in generic/baseEmbeddings.ts:16

`Protected` apiKey

get apiKey(): string
Only sub-classes can access the API key

Returns string
Inherited from BaseModel.apiKey
- Defined in generic/baseModel.ts:162

Methods

ClearAdditionalSettings

ClearAdditionalSettings(): void
Clear all additional settings This is useful for resetting the state of the provider or when switching between different configurations.

Returns void
- Defined in generic/baseEmbeddings.ts:35

`Abstract` EmbedText

EmbedText(params): Promise<EmbedTextResult>
Parameters
- params: EmbedTextParams
Returns Promise<EmbedTextResult>
- Defined in generic/baseEmbeddings.ts:39

`Abstract` EmbedTexts

EmbedTexts(params): Promise<EmbedTextsResult>
Parameters
- params: EmbedTextsParams
Returns Promise<EmbedTextsResult>
- Defined in generic/baseEmbeddings.ts:40

`Abstract` GetEmbeddingModels

GetEmbeddingModels(): Promise<any>
Returns Promise<any>
- Defined in generic/baseEmbeddings.ts:41

SetAdditionalSettings

SetAdditionalSettings(settings): void
Set additional provider-specific settings Subclasses should override this method to validate required settings
Parameters
- settings: Record<string, any>
  Provider-specific settings
Returns void
- Defined in generic/baseEmbeddings.ts:26