標準化された用語
Rememberizer ドキュメントの標準化された用語と命名規則
この文書は、Rememberizer の機能や概念について話す際に使用する推奨用語のリファレンスを提供します。これらの基準に従うことで、文書全体の一貫性を維持するのに役立ちます。
推奨用語と定義
ベクトルストア
ベクトルデータベース
Rememberizerのベクトルデータベース実装の推奨用語は「ベクトルストア」です。「ベクトルデータベース」は技術的には正確ですが、一貫性のために「ベクトルストア」を使用するべきです。
ベクトル埋め込み
埋め込み
教育コンテンツでは「ベクトル埋め込み」という完全な用語が推奨されますが、技術的な文脈やコード例では「埋め込み」が許容されます。
データソース
知識ソース、統合
データの起源（Slack、Google Driveなど）を指す際の推奨用語は「データソース」です。
コモンナレッジ
共有知識
他のユーザーやアプリケーションと知識を共有する機能を指す際には「コモンナレッジ」を使用してください。
メメント
メメントフィルター
主な用語として「メメント」を使用しますが、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_TOKENAPI キーヘッダー:
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