Merge pull request #27 from wupz1027/main

Update docs.html

Author: kkkjz

docs/docs.html

@@ -330,6 +330,7 @@
         <li><a class="nav-link" href="#" data-section="welcome">Welcome to MemoryOS</a></li>
         <li><a class="nav-link" href="#" data-section="getstarted">Get started</a></li>
         <li><a class="nav-link" href="#" data-section="configure">Configure Instruction</a></li>
+        <li><a class="nav-link" href="#" data-section="api-reference">API Reference</a></li>
         <li><a class="nav-link" href="#" data-section="howitworks">How It Works</a></li>
         <li><a class="nav-link" href="#" data-section="platform">MemoryOS Playground</a></li>
       </ul>
@@ -475,7 +476,6 @@ <h2>Get Started</h2>
         <pre><code># Pull the latest official image
 docker pull ghcr.io/bai-lab/memoryos:latest
 
-# Run the container (add --gpus=all if you have a GPU)
 docker run -it --gpus=all ghcr.io/bai-lab/memoryos /bin/bash</code></pre>
         <ul class="features">
           <li><b>Option 2: Build from Dockerfile</b></li>
@@ -490,8 +490,34 @@ <h2>Get Started</h2>
 
 docker run -it --gpus=all memoryos /bin/bash</code></pre>
 
+<li><b>MemoryOS_Chromadb Getting Started</b></li>
+<div style="margin: 24px 0 32px 0;">
+  <h3 style="font-size:1.18rem;font-weight:600;">1. Install dependencies</h3>
+  <pre style="font-size:1em;"><code>cd memoryos-chromadb
+pip install -r requirements.txt</code></pre>
+  <h3 style="font-size:1.18rem;font-weight:600;">2. Test</h3>
+  <div style="background:#f8f9fa;padding:18px 18px 18px 18px;border-radius:8px;margin-bottom:18px;">
+    <p>The edit information is in <b>comprehensive_test.py</b></p>
+    <pre style="font-size:1em;"><code>memoryos = Memoryos(
+    user_id='travel_user_test',
+    openai_api_key='',
+    openai_base_url='',
+    data_storage_path='./comprehensive_test_data',
+    assistant_id='travel_assistant',
+    embedding_model_name='BAAI/bge-m3',
+    mid_term_capacity=1000,
+    mid_term_heat_threshold=13.0,
+    mid_term_similarity_threshold=0.7,
+    short_term_capacity=2
+)
+</code></pre>
+    <pre style="font-size:1em;"><code>python3 comprehensive_test.py
+# Make sure to use a different data storage path when switching embedding models.
+</code></pre>
+  </div>
+</div>
+
 
-        </ul>
       </section>
       <section class="section" id="configure">
         <h3>📋 <strong>Complete List of 13 Parameters</strong></h3>
@@ -630,6 +656,54 @@ <h2>MemoryOS Playground</h2>
         <a class="memory-platform-btn" href="https://baijia.online/memoryos/" target="_blank" rel="noopener">Go to MemoryOS Playground</a>
         <p style="margin-top:18px;">Web-based memory analytics and management platform for MemoryOS. Coming soon!</p>
       </section>
+      <section class="section" id="api-reference">
+        <h2 style="font-size:1.6rem;font-weight:700;margin-top:36px;">MemoryOS Public API Reference</h2>
+        <hr>
+        <h3 style="font-size:1.18rem;font-weight:600;">PyPI</h3>
+        <div style="font-size:1.08rem;">
+          <b>Class:</b> <code>Memoryos</code>
+          <h4 style="margin-top:18px;">Constructor parameters</h4>
+          <pre><code>Memoryos(
+    user_id: str,
+    assistant_id: str,
+    openai_api_key: str,
+    openai_base_url: str,
+    data_storage_path: str,
+    llm_model: str,
+    short_term_capacity: int,
+    mid_term_heat_threshold: float,
+    retrieval_queue_capacity: int,
+    long_term_knowledge_capacity: int,
+    embedding_model_name: str
+)
+          </code></pre>
+          <h4>Methods</h4>
+          <pre><code>add_memory(user_input: str, agent_response: str) -> None
+          </code></pre>
+          <p>Add a user-assistant message pair to the memory system.</p>
+          <pre><code>get_response(query: str) -> str
+          </code></pre>
+          <p>Retrieve and generate a response based on the memory system.</p>
+          <pre><code>get_user_profile() -> dict
+          </code></pre>
+          <p>Get the user profile inferred from conversation history.</p>
+        </div>
+        <hr>
+        <h3 style="font-size:1.18rem;font-weight:600;">MCP mode (MemoryOS-MCP server tools)</h3>
+        <div style="font-size:1.08rem;">
+          <b>Core API endpoints / tools</b>
+          <pre><code>add_memory(user_input: str, agent_response: str) -> None
+          </code></pre>
+          <p>Store a conversation pair in the memory system.</p>
+          <pre><code>retrieve_memory(query: str) -> list
+          </code></pre>
+          <p>Retrieve relevant past conversations, preferences, and knowledge.</p>
+          <pre><code>get_user_profile() -> dict
+          </code></pre>
+          <p>Return the analyzed user profile.</p>
+        </div>
+      </section>
+
     </main>
   </div>
 </body>