OpenAIEmbedding
Defined in: .build/typescript/packages/providers/openai/src/embedding.ts:33
Extends
Section titled “Extends”BaseEmbedding
OpenAIEmbedding<
Options>(nodes,options?):Promise
Defined in: .build/typescript/packages/providers/openai/src/embedding.ts:33
Type Parameters
Section titled “Type Parameters”Options
Section titled “Options”Options extends Record<string, unknown>
Parameters
Section titled “Parameters”BaseNode<Metadata>[]
options?
Section titled “options?”Options
Returns
Section titled “Returns”Promise
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new OpenAIEmbedding(
init?):OpenAIEmbedding
Defined in: .build/typescript/packages/providers/openai/src/embedding.ts:68
OpenAI Embedding
Parameters
Section titled “Parameters”Omit<Partial<OpenAIEmbedding>, "session"> & object
initial parameters
Returns
Section titled “Returns”OpenAIEmbedding
Overrides
Section titled “Overrides”BaseEmbedding.constructor
Properties
Section titled “Properties”model:
string
Defined in: .build/typescript/packages/providers/openai/src/embedding.ts:35
embeddding model. defaults to “text-embedding-ada-002”
dimensions?
Section titled “dimensions?”
optionaldimensions:number
Defined in: .build/typescript/packages/providers/openai/src/embedding.ts:37
number of dimensions of the resulting vector, for models that support choosing fewer dimensions. undefined will default to model default
apiKey?
Section titled “apiKey?”
optionalapiKey:string=undefined
Defined in: .build/typescript/packages/providers/openai/src/embedding.ts:42
api key
baseURL?
Section titled “baseURL?”
optionalbaseURL:string=undefined
Defined in: .build/typescript/packages/providers/openai/src/embedding.ts:44
base url
maxRetries
Section titled “maxRetries”maxRetries:
number
Defined in: .build/typescript/packages/providers/openai/src/embedding.ts:46
maximum number of retries, default 10
timeout?
Section titled “timeout?”
optionaltimeout:number
Defined in: .build/typescript/packages/providers/openai/src/embedding.ts:48
timeout in ms, default 60 seconds
additionalSessionOptions?
Section titled “additionalSessionOptions?”
optionaladditionalSessionOptions:Omit<Partial<ClientOptions>,"apiKey"|"maxRetries"|"timeout">
Defined in: .build/typescript/packages/providers/openai/src/embedding.ts:50
other session options for OpenAI
lazySession()
Section titled “lazySession()”lazySession: () =>
Promise<LLMInstance>
Defined in: .build/typescript/packages/providers/openai/src/embedding.ts:55
Returns
Section titled “Returns”Promise<LLMInstance>
Accessors
Section titled “Accessors”session
Section titled “session”Get Signature
Section titled “Get Signature”get session():
Promise<LLMInstance>
Defined in: .build/typescript/packages/providers/openai/src/embedding.ts:57
Returns
Section titled “Returns”Promise<LLMInstance>
Methods
Section titled “Methods”getTextEmbeddings()
Section titled “getTextEmbeddings()”getTextEmbeddings(
texts):Promise<number[][]>
Defined in: .build/typescript/packages/providers/openai/src/embedding.ts:138
Get embeddings for a batch of texts
Parameters
Section titled “Parameters”string[]
Returns
Section titled “Returns”Promise<number[][]>
Overrides
Section titled “Overrides”BaseEmbedding.getTextEmbeddings
getTextEmbedding()
Section titled “getTextEmbedding()”getTextEmbedding(
text):Promise<number[]>
Defined in: .build/typescript/packages/providers/openai/src/embedding.ts:146
Get embeddings for a single text
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<number[]>
Overrides
Section titled “Overrides”BaseEmbedding.getTextEmbedding