Method GetEmbeddings
- Namespace
- LMKit.Embeddings
- Assembly
- LM-Kit.NET.dll
GetEmbeddings(string, CancellationToken)
Generates the embedding vector for a given text string.
This vector represents the text in a high-dimensional space, enabling various natural language processing tasks by capturing semantic meaning.
public float[] GetEmbeddings(string text, CancellationToken cancellationToken = default)Parameters
textstringThe text string to be converted into an embedding vector. Cannot be null or empty.
cancellationTokenCancellationTokenOptional. A CancellationToken for handling cancellation requests.
Returns
- float[]
An array of floats representing the embedding vector of the input text. Each element in the array contributes to the multidimensional representation of the text's semantic meaning.
Remarks
The dimension of the array is specified by the EmbeddingSize property.
Exceptions
- ArgumentNullException
Thrown when the input text is null or an empty string, as an embedding vector cannot be generated from an empty input.
GetEmbeddings(IList<int>, CancellationToken)
Generates the embedding vector for a given tokenized text.
This vector represents the text in a high-dimensional space, enabling various natural language processing tasks by capturing semantic meaning.
public float[] GetEmbeddings(IList<int> tokens, CancellationToken cancellationToken = default)Parameters
tokensIList<int>The array of tokens to be converted into an embedding vector. Cannot be null or empty.
cancellationTokenCancellationTokenOptional. A CancellationToken for handling cancellation requests.
Returns
- float[]
An array of floats representing the embedding vector of the input text. Each element in the array contributes to the multidimensional representation of the text's semantic meaning.
Remarks
The dimension of the array is specified by the EmbeddingSize property.
Exceptions
- ArgumentNullException
Thrown when the input array of tokens is null or empty, as an embedding vector cannot be generated from an empty input.