Skip to main content

getVector

codebolt.vectordb.getVector(key: string): Promise<GetVectorResponse>
Retrieves a vector from the vector database based on the provided key.

Parameters

NameTypeDescription
keystringThe key of the vector to retrieve.

Returns:

 Promise<GetVectorResponse>
A promise that resolves with the retrieved vector.

Response Structure

{
type: 'getVectorResponse';
vector: {
object: string; // 'list'
data: any[]; // Array of vector data
model: string; // 'text-embedding-3-small'
usage: {
prompt_tokens: number;
total_tokens: number;
};
};
}

Simple Example

// Get vector by key
const getResult = await codebolt.vectordb.getVector('test-vector-001');
console.log('✅ Vector retrieval result:', getResult);

Detailed Example

// Get vector with error handling
try {
const getResult = await codebolt.vectordb.getVector('test-vector-001');
console.log('✅ Vector retrieval result:', getResult);
console.log(' - Type:', getResult?.type);
console.log(' - Data available:', !!getResult?.data);
console.log(' - Model:', getResult?.vector?.model);
} catch (error) {
console.log('⚠️ Vector retrieval failed:', error.message);
}