Obter informações do armazenamento vetorial

get

Retrieve information about the vector store associated with the API key.

Header parameters

x-api-keystringRequired

The API key for authentication.

Responses

200

Vector store information retrieved successfully.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/vector-stores/me HTTP/1.1
Host: api.rememberizer.ai
x-api-key: text
Accept: */*

200

Vector store information retrieved successfully.

{
  "id": "text",
  "name": "text",
  "description": "text",
  "embedding_model": "text",
  "indexing_algorithm": "text",
  "vector_dimension": 1,
  "search_metric": "text",
  "created": "2025-05-02T00:43:01.906Z",
  "modified": "2025-05-02T00:43:01.906Z"
}

Exemplos de Requisições

cURL

curl -X GET \
  https://api.rememberizer.ai/api/v1/vector-stores/me \
  -H "x-api-key: SUA_CHAVE_API"

Substitua SUA_CHAVE_API pela sua chave API real do Vector Store.

JavaScript

const getVectorStoreInfo = async () => {
  const response = await fetch('https://api.rememberizer.ai/api/v1/vector-stores/me', {
    method: 'GET',
    headers: {
      'x-api-key': 'SUA_CHAVE_API'
    }
  });
  
  const data = await response.json();
  console.log(data);
};

getVectorStoreInfo();

Substitua SUA_CHAVE_API pela sua chave API real do Vector Store.

Python

import requests

def get_vector_store_info():
    headers = {
        "x-api-key": "SUA_CHAVE_API"
    }
    
    response = requests.get(
        "https://api.rememberizer.ai/api/v1/vector-stores/me",
        headers=headers
    )
    
    data = response.json()
    print(data)

get_vector_store_info()

Substitua SUA_CHAVE_API pela sua chave API real do Vector Store.

Formato de Resposta

{
  "id": "vs_abc123",
  "name": "Meu Armazenamento de Vetores",
  "description": "Um armazenamento de vetores para documentação de produtos",
  "embedding_model": "sentence-transformers/all-mpnet-base-v2",
  "indexing_algorithm": "ivfflat",
  "vector_dimension": 128,
  "search_metric": "cosine_distance",
  "created": "2023-06-01T10:30:00Z",
  "modified": "2023-06-15T14:45:00Z"
}

Autenticação

Este endpoint requer autenticação usando uma chave de API no cabeçalho x-api-key.

Respostas de Erro

Código de Status	Descrição
401	Não Autorizado - Chave de API inválida ou ausente
404	Não Encontrado - Armazenamento de Vetores não encontrado
500	Erro Interno do Servidor

Este endpoint recupera informações sobre o armazenamento de vetores associado à chave de API fornecida. É útil para verificar detalhes de configuração, incluindo o modelo de incorporação, dimensionalidade e métrica de busca sendo utilizada. Essas informações podem ser valiosas para otimizar consultas de busca e entender as capacidades do armazenamento de vetores.