Terminologia Padronizada do Rememberizer¶
Este documento fornece uma referência para a terminologia preferida a ser utilizada ao discutir recursos e conceitos do Rememberizer. Seguir esses padrões ajuda a manter a consistência na documentação.
Termos e Definições Preferenciais¶
| Termo Preferido | Termos Alternativos | Definição |
|---|---|---|
| Armazenamento de Vetores | Banco de Dados de Vetores | O termo preferido para a implementação do banco de dados de vetores do Rememberizer é "Armazenamento de Vetores." Embora "Banco de Dados de Vetores" seja tecnicamente preciso, "Armazenamento de Vetores" deve ser usado para consistência. |
| Embeddings de Vetores | Embeddings | O termo completo "Embeddings de Vetores" é preferido em conteúdo educacional, enquanto "Embeddings" é aceitável em contextos técnicos e exemplos de código. |
| Fonte de Dados | Fonte de Conhecimento, Integração | "Fonte de Dados" é o termo preferido para se referir às origens dos dados (Slack, Google Drive, etc.). |
| Conhecimento Comum | Conhecimento Compartilhado | Use "Conhecimento Comum" ao se referir ao recurso que permite compartilhar conhecimento com outros usuários e aplicativos. |
| Memento | Filtro Memento | Use "Memento" como o termo principal, embora "Filtro Memento" seja aceitável em contextos de UI. |
| Integração de Memória | Memória Compartilhada, Memória | "Integração de Memória" é o nome completo preferido do recurso; "Memória Compartilhada" é aceitável em conteúdo voltado para o usuário. |
| Autenticação OAuth2 | OAuth | Use o termo completo "Autenticação OAuth2" na documentação formal, embora "OAuth" seja aceitável em contextos menos formais. |
| Pesquisar Seu Conhecimento | Pesquisar no Rememberizer | "Pesquisar Seu Conhecimento" deve ser usado ao se referir ao nome do recurso em títulos e navegação. |
| Memorizar | Armazenar | Use "Memorizar" para o endpoint da API e nome da funcionalidade, enquanto "Armazenar" pode ser usado em contextos explicativos. |
| X-API-Key | x-api-key | Use "X-API-Key" em maiúsculas na documentação, embora a versão em minúsculas seja aceitável em exemplos de código. |
Convenções da API¶
Diretório da Documentação da API¶
O caminho oficial da documentação da API é /en/developer/api-docs/. O caminho legado /en/developer/api-documentations/ deve ser descontinuado.
Cabeçalhos da API¶
As seguintes convenções de cabeçalho devem ser usadas de forma consistente:
- Cabeçalho de Autorização:
Authorization: Bearer YOUR_JWT_TOKEN - Cabeçalho da Chave da API:
X-API-Key: YOUR_API_KEY - Cabeçalho do Tipo de Conteúdo:
Content-Type: application/json
Estilo de Endpoint da API¶
Os endpoints da API devem ser estilizados de forma consistente:
- URL base:
https://api.rememberizer.ai/api/v1/ - Caminhos de endpoint em letras minúsculas com hífens conforme necessário:
/documents/search/ - Caminhos de armazenamento de vetores com espaço reservado para parâmetros:
/vector-stores/{vector_store_id}/documents/search
Convenções de Nomenclatura de Recursos¶
Nomes de Integração¶
Os nomes de integração devem seguir o padrão:
- Integração {Nome da Integração} do Rememberizer (por exemplo, "Integração do Rememberizer Slack")
Nomeação do Servidor MCP¶
Os tipos de servidor MCP devem ser claramente distinguidos:
- Servidor MCP Rememberizer: Servidor de uso geral
- Servidor MCP de Armazenamento de Vetores Rememberizer: Servidor especificamente para operações de armazenamento de vetores
Convenções de Títulos de Documentos¶
Os títulos dos documentos devem seguir estas convenções:
- Capitalize palavras importantes (Título em Maiúsculas)
- Use terminologia consistente para recursos
- Evite acrônimos nos títulos, a menos que sejam amplamente reconhecidos (por exemplo, API)
- Mantenha os títulos concisos e descritivos
Usando Este Guia¶
Ao criar ou atualizar documentação, consulte este guia para garantir uma terminologia consistente. Ao encontrar termos variantes na documentação, priorize a atualização para os termos preferidos listados aqui ao fazer outras alterações nesses documentos.
Lembre-se de que manter a integridade dos links e nomes de arquivos é crucial, portanto, concentre-se em atualizar a terminologia dentro do texto enquanto preserva URLs e estruturas de arquivos.