표준화된 Rememberizer 용어¶
이 문서는 Rememberizer 기능 및 개념에 대해 논의할 때 사용할 선호 용어에 대한 참조를 제공합니다. 이러한 표준을 따르는 것은 문서 전반에 걸쳐 일관성을 유지하는 데 도움이 됩니다.
선호 용어 및 정의¶
| 선호 용어 | 대체 용어 | 정의 |
|---|---|---|
| 벡터 저장소 | 벡터 데이터베이스 | Rememberizer의 벡터 데이터베이스 구현에 대한 선호 용어는 "벡터 저장소"입니다. "벡터 데이터베이스"는 기술적으로 정확하지만, 일관성을 위해 "벡터 저장소"를 사용해야 합니다. |
| 벡터 임베딩 | 임베딩 | 교육 콘텐츠에서는 전체 용어 "벡터 임베딩"이 선호되며, 기술적 맥락과 코드 예제에서는 "임베딩"이 허용됩니다. |
| 데이터 소스 | 지식 소스, 통합 | 데이터의 출처(슬랙, 구글 드라이브 등)를 지칭할 때 "데이터 소스"가 선호되는 용어입니다. |
| 공통 지식 | 공유 지식 | 다른 사용자 및 애플리케이션과 지식을 공유할 수 있는 기능을 언급할 때 "공통 지식"을 사용하십시오. |
| 메멘토 | 메멘토 필터 | 기본 용어로 "메멘토"를 사용하되, UI 맥락에서는 "메멘토 필터"도 허용됩니다. |
| 메모리 통합 | 공유 메모리, 메모리 | 이 기능의 선호 전체 이름은 "메모리 통합"이며, 사용자 대상 콘텐츠에서는 "공유 메모리"가 허용됩니다. |
| 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과 파일 구조를 보존하면서 텍스트 내 용어 업데이트에 집중하십시오.