Class: TogetherEmbedding
Extends
Constructors
new TogetherEmbedding()
new TogetherEmbedding(
init
?):TogetherEmbedding
Parameters
• init?: Partial
<OpenAIEmbedding
>
Returns
Overrides
Source
packages/core/src/embeddings/together.ts:5
Properties
additionalSessionOptions?
optional
additionalSessionOptions:Omit
<Partial
<ClientOptions
>,"apiKey"
|"timeout"
|"maxRetries"
>
other session options for OpenAI
Inherited from
OpenAIEmbedding
. additionalSessionOptions
Source
packages/core/src/embeddings/OpenAIEmbedding.ts:51
apiKey?
optional
apiKey:string
=undefined
api key
Inherited from
Source
packages/core/src/embeddings/OpenAIEmbedding.ts:45
dimensions
dimensions:
undefined
|number
number of dimensions of the resulting vector, for models that support choosing fewer dimensions. undefined will default to model default
Inherited from
Source
packages/core/src/embeddings/OpenAIEmbedding.ts:40
embedBatchSize
embedBatchSize:
number
=DEFAULT_EMBED_BATCH_SIZE
Inherited from
OpenAIEmbedding
. embedBatchSize
Source
packages/core/src/embeddings/types.ts:20
embedInfo?
optional
embedInfo:EmbeddingInfo
Inherited from
Source
packages/core/src/embeddings/types.ts:21
maxRetries
maxRetries:
number
maximum number of retries, default 10
Inherited from
Source
packages/core/src/embeddings/OpenAIEmbedding.ts:47
model
model:
string
embeddding model. defaults to "text-embedding-ada-002"
Inherited from
Source
packages/core/src/embeddings/OpenAIEmbedding.ts:38
session
session:
OpenAISession
session object
Inherited from
Source
packages/core/src/embeddings/OpenAIEmbedding.ts:57
timeout?
optional
timeout:number
timeout in ms, default 60 seconds
Inherited from
Source
packages/core/src/embeddings/OpenAIEmbedding.ts:49
Methods
getQueryEmbedding()
getQueryEmbedding(
query
):Promise
<null
|number
[]>
Parameters
• query: MessageContentDetail
Returns
Promise
<null
| number
[]>
Inherited from
OpenAIEmbedding
. getQueryEmbedding
Source
packages/core/src/embeddings/types.ts:33
getTextEmbedding()
getTextEmbedding(
text
):Promise
<number
[]>
Get embeddings for a single text
Parameters
• text: string
Returns
Promise
<number
[]>
Inherited from
OpenAIEmbedding
. getTextEmbedding
Source
packages/core/src/embeddings/OpenAIEmbedding.ts:150
getTextEmbeddings()
getTextEmbeddings(
texts
):Promise
<number
[][]>
Get embeddings for a batch of texts
Parameters
• texts: string
[]
Returns
Promise
<number
[][]>
Inherited from
OpenAIEmbedding
. getTextEmbeddings
Source
packages/core/src/embeddings/OpenAIEmbedding.ts:142
getTextEmbeddingsBatch()
getTextEmbeddingsBatch(
texts
,options
?):Promise
<number
[][]>
Get embeddings for a batch of texts
Parameters
• texts: string
[]
• options?
• options.logProgress?: boolean
Returns
Promise
<number
[][]>
Inherited from
OpenAIEmbedding
. getTextEmbeddingsBatch
Source
packages/core/src/embeddings/types.ts:63