Adicionar novo documento de texto a um Armazenamento Vetorial

post

Create a new text document in a vector store.

Path parameters

vector-store-idstringRequired

The ID of the vector store.

Header parameters

x-api-keystringRequired

The API key for authentication.

Body

namestringOptional

The name of the document.

textstringOptional

The text content of the document.

Responses

201

Document created successfully.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/vector-stores/{vector-store-id}/documents/create HTTP/1.1
Host: api.rememberizer.ai
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "name": "text",
  "text": "text"
}

201

Document created successfully.

{
  "id": 1,
  "name": "text",
  "type": "text",
  "vector_store": "text",
  "size": 1,
  "status": "text",
  "processing_status": "text",
  "indexed_on": "2025-05-01T23:16:59.285Z",
  "status_error_message": "text",
  "created": "2025-05-01T23:16:59.285Z",
  "modified": "2025-05-01T23:16:59.285Z"
}

Exemplo de Solicitações

cURL

curl -X POST \
  https://api.rememberizer.ai/api/v1/vector-stores/vs_abc123/documents/create \
  -H "x-api-key: SUA_CHAVE_API" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Visão Geral do Produto",
    "text": "Nosso produto é uma solução inovadora para gerenciar embeddings vetoriais. Ele oferece integração perfeita com seus sistemas existentes e oferece poderosas capacidades de busca semântica."
  }'

Substitua SUA_CHAVE_API pela sua chave API real do Vector Store e vs_abc123 pelo seu ID do Vector Store.

JavaScript

const addTextDocument = async (vectorStoreId, name, text) => {
  const response = await fetch(`https://api.rememberizer.ai/api/v1/vector-stores/${vectorStoreId}/documents/create`, {
    method: 'POST',
    headers: {
      'x-api-key': 'SUA_CHAVE_API',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      name: name,
      text: text
    })
  });
  
  const data = await response.json();
  console.log(data);
};

addTextDocument(
  'vs_abc123',
  'Visão Geral do Produto',
  'Nosso produto é uma solução inovadora para gerenciar embeddings vetoriais. Ele oferece integração perfeita com seus sistemas existentes e oferece poderosas capacidades de busca semântica.'
);

Substitua SUA_CHAVE_API pela sua chave API real do Vector Store e vs_abc123 pelo seu ID do Vector Store.

Python

import requests
import json

def add_text_document(vector_store_id, name, text):
    headers = {
        "x-api-key": "SUA_CHAVE_API",
        "Content-Type": "application/json"
    }
    
    payload = {
        "name": name,
        "text": text
    }
    
    response = requests.post(
        f"https://api.rememberizer.ai/api/v1/vector-stores/{vector_store_id}/documents/create",
        headers=headers,
        data=json.dumps(payload)
    )
    
    data = response.json()
    print(data)

add_text_document(
    'vs_abc123',
    'Visão Geral do Produto',
    'Nosso produto é uma solução inovadora para gerenciar embeddings vetoriais. Ele oferece integração perfeita com seus sistemas existentes e oferece poderosas capacidades de busca semântica.'
)

Substitua SUA_CHAVE_API pela sua chave API real do Vector Store e vs_abc123 pelo seu ID do Vector Store.

Parâmetros de Caminho

Parâmetro	Tipo	Descrição
vector-store-id	string	Obrigatório. O ID do armazenamento de vetores para o qual adicionar o documento.

Corpo da Solicitação

{
  "name": "Visão Geral do Produto",
  "text": "Nosso produto é uma solução inovadora para gerenciar embeddings vetoriais. Ele oferece integração perfeita com seus sistemas existentes e oferece poderosas capacidades de busca semântica."
}

Parâmetro	Tipo	Descrição
name	string	Obrigatório. O nome do documento.
text	string	Obrigatório. O conteúdo de texto do documento.

Formato de Resposta

{
  "id": 1234,
  "name": "Visão Geral do Produto",
  "type": "text/plain",
  "vector_store": "vs_abc123",
  "size": 173,
  "status": "processando",
  "processing_status": "na fila",
  "indexed_on": null,
  "status_error_message": null,
  "created": "2023-06-15T10:15:00Z",
  "modified": "2023-06-15T10:15: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
400	Solicitação Inválida - Campos obrigatórios ausentes ou formato inválido
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 permite que você adicione conteúdo de texto diretamente ao seu armazenamento de vetores. É particularmente útil para armazenar informações que podem não existir em formato de arquivo, como descrições de produtos, artigos de base de conhecimento ou conteúdo personalizado. O texto será processado automaticamente em embeddings vetoriais, tornando-o pesquisável usando similaridade semântica.