Class: TogetherEmbedding
Hierarchy
-
↳
TogetherEmbedding
Constructors
constructor
• new TogetherEmbedding(init?
): TogetherEmbedding
Parameters
Name | Type |
---|---|
init? | Partial <OpenAIEmbedding > |
Returns
Overrides
Defined in
packages/core/src/embeddings/together.ts:4
Properties
additionalSessionOptions
• Optional
additionalSessionOptions: Omit
<Partial
<ClientOptions
>, "apiKey"
| "timeout"
| "maxRetries"
>
other session options for OpenAI
Inherited from
OpenAIEmbedding.additionalSessionOptions
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:44
apiKey
• Optional
apiKey: string
= undefined
api key
Inherited from
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:38
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
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:33
embedBatchSize
• embedBatchSize: number
= DEFAULT_EMBED_BATCH_SIZE
Inherited from
OpenAIEmbedding.embedBatchSize
Defined in
packages/core/src/embeddings/types.ts:8
maxRetries
• maxRetries: number
maximum number of retries, default 10
Inherited from
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:40
model
• model: string
embeddding model. defaults to "text-embedding-ada-002"
Inherited from
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:31
session
• session: OpenAISession
session object
Inherited from
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:50
timeout
• Optional
timeout: number
timeout in ms, default 60 seconds
Inherited from
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:42
Methods
getQueryEmbedding
▸ getQueryEmbedding(query
): Promise
<number
[]>
Get embeddings for a query
Parameters
Name | Type |
---|---|
query | string |
Returns
Promise
<number
[]>
Inherited from
OpenAIEmbedding.getQueryEmbedding
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:141
getTextEmbedding
▸ getTextEmbedding(text
): Promise
<number
[]>
Get embeddings for a single text
Parameters
Name | Type |
---|---|
text | string |
Returns
Promise
<number
[]>
Inherited from
OpenAIEmbedding.getTextEmbedding
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:132
getTextEmbeddings
▸ getTextEmbeddings(texts
): Promise
<number
[][]>
Get embeddings for a batch of texts
Parameters
Name | Type |
---|---|
texts | string [] |
Returns
Promise
<number
[][]>
Inherited from
OpenAIEmbedding.getTextEmbeddings
Defined in
packages/core/src/embeddings/OpenAIEmbedding.ts:124
getTextEmbeddingsBatch
▸ getTextEmbeddingsBatch(texts
, options?
): Promise
<number
[][]>
Get embeddings for a batch of texts
Parameters
Name | Type |
---|---|
texts | string [] |
options? | Object |
options.logProgress? | boolean |
Returns
Promise
<number
[][]>
Inherited from
OpenAIEmbedding.getTextEmbeddingsBatch
Defined in
packages/core/src/embeddings/types.ts:41
similarity
▸ similarity(embedding1
, embedding2
, mode?
): number
Parameters
Name | Type | Default value |
---|---|---|
embedding1 | number [] | undefined |
embedding2 | number [] | undefined |
mode | SimilarityType | SimilarityType.DEFAULT |