Skip to main content

Get Store

Schema

This request accepts an optional schema field. When it is omitted, the server uses the public schema. Set schema to target a store in another schema.

The GetStore request retrieves detailed information about a single AI store by its name.

  • Input: Store name.

  • Behavior: The server returns detailed information about the specified AI store.

  • Response: AI store information including models, dimension, and indices.

Click to expand source code
TypeScript
import { createAiClient } from "ahnlich-client-node";
import { GetStore } from "ahnlich-client-node/grpc/ai/query_pb";

async function getStore() {
const client = createAiClient("127.0.0.1:1370");

const response = await client.getStore(
new GetStore({ store: "ai_store", schema: "analytics" })
);

console.log(response.name); // Store name
console.log(response.queryModel); // AI model used for querying
console.log(response.indexModel); // AI model used for indexing
console.log(response.embeddingSize); // Number of stored embeddings
console.log(response.dimension); // Vector dimension
console.log(response.predicateIndices); // Indexed predicate keys
console.log(response.dbInfo); // Optional DB store info
}

getStore();

Parameters

ParameterTypeRequiredDescription
storestringYesThe name of the AI store to retrieve

Response Fields

FieldTypeDescription
namestringThe name of the store
queryModelAIModelAI model used for query embedding
indexModelAIModelAI model used for indexing
embeddingSizenumberNumber of stored embeddings
dimensionnumberVector dimension
predicateIndicesstring[]List of indexed predicate keys
dbInfoStoreInfoOptional underlying DB store info