标准化术语

Rememberizer 文档的标准化术语和命名规范

本文档提供了讨论 Rememberizer 功能和概念时使用的首选术语的参考。遵循这些标准有助于在文档中保持一致性。

首选术语和定义

首选术语
替代术语
定义

向量存储

向量数据库

Rememberizer 的向量数据库实现的首选术语是“向量存储”。虽然“向量数据库”在技术上是准确的,但为了保持一致性,应使用“向量存储”。

向量嵌入

嵌入

在教育内容中首选使用完整术语“向量嵌入”,而在技术上下文和代码示例中“嵌入”是可以接受的。

数据源

知识源,集成

“数据源”是指数据来源(Slack、Google Drive 等)的首选术语。

共同知识

共享知识

在提及允许与其他用户和应用程序共享知识的功能时,请使用“共同知识”。

备忘录

备忘录过滤器

使用“备忘录”作为主要术语,尽管在用户界面上下文中“备忘录过滤器”是可以接受的。

内存集成

共享内存,内存

“内存集成”是该功能的首选全名;“共享内存”在面向用户的内容中是可以接受的。

OAuth2 认证

OAuth

在正式文档中使用完整术语“OAuth2 认证”,尽管在不太正式的上下文中“OAuth”是可以接受的。

搜索你的知识

在 Rememberizer 中搜索

在提及标题和导航中的功能名称时,应使用“搜索你的知识”。

记忆

存储

对于 API 端点和功能名称,请使用“记忆”,而“存储”可以在解释性上下文中使用。

X-API-Key

x-api-key

在文档中使用大写的“X-API-Key”,尽管在代码示例中小写是可以接受的。

API 约定

API 文档目录

官方 API 文档路径为 /en/developer/api-docs/。旧路径 /en/developer/api-documentations/ 应该逐步淘汰。

API 头部

以下头部约定应一致使用:

  • 授权头部Authorization: Bearer YOUR_JWT_TOKEN

  • API 密钥头部X-API-Key: YOUR_API_KEY

  • 内容类型头部Content-Type: application/json

API 端点样式

API 端点应保持一致的样式:

  • 基础 URL: https://api.rememberizer.ai/api/v1/

  • 端点路径使用小写字母,并根据需要使用连字符: /documents/search/

  • 向量存储路径带有参数占位符: /vector-stores/{vector_store_id}/documents/search

特性命名约定

集成名称

集成名称应遵循以下模式:

  • Rememberizer {集成名称} 集成(例如,“Rememberizer Slack 集成”)

MCP 服务器命名

MCP 服务器类型应明确区分:

  • Rememberizer MCP 服务器:通用服务器

  • Rememberizer 向量存储 MCP 服务器:专门用于向量存储操作的服务器

文档标题规范

文档标题应遵循以下规范:

  • 重要词汇首字母大写(标题式)

  • 对功能使用一致的术语

  • 除非广泛认可,否则避免在标题中使用缩略词(例如,API)

  • 保持标题简洁且具有描述性

使用本指南

在创建或更新文档时,请参考本指南以确保术语的一致性。当在文档中遇到变体术语时,优先在对这些文档进行其他更改时更新为此处列出的首选术语。

请记住,维护链接完整性和文件名称至关重要,因此请专注于在文本中更新术语,同时保留 URL 和文件结构。

Last updated