VoyageAIEmbedding
Defined in: .build/typescript/packages/providers/voyage-ai/src/embedding.ts:16
VoyageAIEmbedding is an alias for VoyageAI that implements the BaseEmbedding interface.
Extends
Section titled “Extends”BaseEmbedding
VoyageAIEmbedding<
Options>(nodes,options?):Promise
Defined in: .build/typescript/packages/providers/voyage-ai/src/embedding.ts:16
VoyageAIEmbedding is an alias for VoyageAI that implements the BaseEmbedding interface.
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 VoyageAIEmbedding(
init?):VoyageAIEmbedding
Defined in: .build/typescript/packages/providers/voyage-ai/src/embedding.ts:68
Parameters
Section titled “Parameters”Partial<VoyageAIEmbedding>
Returns
Section titled “Returns”VoyageAIEmbedding
Overrides
Section titled “Overrides”BaseEmbedding.constructor
Properties
Section titled “Properties”model:
string
Defined in: .build/typescript/packages/providers/voyage-ai/src/embedding.ts:22
VoyageAI model to use
Default
Section titled “Default”"voyage-3"https://docs.voyageai.com/docs/embeddings
apiKey
Section titled “apiKey”apiKey:
string
Defined in: .build/typescript/packages/providers/voyage-ai/src/embedding.ts:30
VoyageAI API token
https://docs.voyageai.com/docs/api-key-and-installation
If not provided, it will try to get the token from the environment variable VOYAGE_API_KEY
maxRetries
Section titled “maxRetries”maxRetries:
number
Defined in: .build/typescript/packages/providers/voyage-ai/src/embedding.ts:36
Maximum number of retries
Default
Section titled “Default”5timeout
Section titled “timeout”timeout:
number
Defined in: .build/typescript/packages/providers/voyage-ai/src/embedding.ts:42
Timeout in seconds
Default
Section titled “Default”60truncation
Section titled “truncation”truncation:
boolean
Defined in: .build/typescript/packages/providers/voyage-ai/src/embedding.ts:48
Whether to truncate the input texts to fit within the context length. Defaults to true.
If true, over-length input texts will be truncated to fit within the context length, before vectorized by the embedding model.
If false, an error will be raised if any given text exceeds the context length.
useInputTypes
Section titled “useInputTypes”useInputTypes:
undefined|"query"|"document"|"both"
Defined in: .build/typescript/packages/providers/voyage-ai/src/embedding.ts:61
VoyageAI supports document and query as input types, or it can be left undefined. Using an input type prepends the input with a prompt before embedding.
Example from their docs: using “query” adds “Represent the query for retrieving supporting documents:”
VoyageAI says these types improve performance, but it will add to token usage. Embeddings with input types are compatible with those that don’t use them.
Setting this to query will use the query input type for getQueryEmbedding(s).
Setting this to document will use the document input type for getTextEmbedding(s).
Setting this to both will do both of the above.
By default, this is undefined, which means no input types are used.
https://docs.voyageai.com/docs/embeddings
Default
Section titled “Default”undefinedclient
Section titled “client”client:
VoyageAIClient
Defined in: .build/typescript/packages/providers/voyage-ai/src/embedding.ts:66
VoyageAI client
Methods
Section titled “Methods”getTextEmbedding()
Section titled “getTextEmbedding()”getTextEmbedding(
text):Promise<number[]>
Defined in: .build/typescript/packages/providers/voyage-ai/src/embedding.ts:82
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<number[]>
Overrides
Section titled “Overrides”BaseEmbedding.getTextEmbedding
getQueryEmbedding()
Section titled “getQueryEmbedding()”getQueryEmbedding(
query):Promise<null|number[]>
Defined in: .build/typescript/packages/providers/voyage-ai/src/embedding.ts:87
Parameters
Section titled “Parameters”MessageContentDetail
Returns
Section titled “Returns”Promise<null | number[]>
Overrides
Section titled “Overrides”BaseEmbedding.getQueryEmbedding
getTextEmbeddings()
Section titled “getTextEmbeddings()”getTextEmbeddings(
texts):Promise<number[][]>
Defined in: .build/typescript/packages/providers/voyage-ai/src/embedding.ts:99
Parameters
Section titled “Parameters”string[]
Returns
Section titled “Returns”Promise<number[][]>
Overrides
Section titled “Overrides”BaseEmbedding.getTextEmbeddings
getQueryEmbeddings()
Section titled “getQueryEmbeddings()”getQueryEmbeddings(
queries):Promise<number[][]>
Defined in: .build/typescript/packages/providers/voyage-ai/src/embedding.ts:103
Parameters
Section titled “Parameters”queries
Section titled “queries”string[]
Returns
Section titled “Returns”Promise<number[][]>