Skip to content

Commit

Permalink
Rebuild coco-server docs for version main
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jan 19, 2025
1 parent aa1eebb commit 2689e67
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion coco-server/main/docs/references/assistant/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
<span style=color:#f92672>}</span>,
<span style=color:#e6db74>&#34;result&#34;</span>: <span style=color:#e6db74>&#34;created&#34;</span>
<span style=color:#f92672>}]</span>
</code></pre></div><p>Tips: <code>WEBSOCKET-SESSION-ID</code> should be replaced with the actual WebSocket session ID. You will receive a message each time you connect to the Coco AI WebSocket server. For example: <code>ws://localhost:2900/ws</code> or <code>wss://localhost:2900/ws</code> if TLS is enabled.</p><p><img src="/img/websocket-on-connect.jpg?raw=true" alt></p><h3 id=close-a-chat-session>Close a Chat Session
</code></pre></div><p>Tips: <code>WEBSOCKET-SESSION-ID</code> should be replaced with the actual WebSocket session ID. You will receive a message each time you connect to the Coco AI WebSocket server. For example: <code>ws://localhost:2900/ws</code> or <code>wss://localhost:2900/ws</code> if TLS is enabled.</p><p><img src="/coco-server/main/img/websocket-on-connect.jpg?raw=true" alt="WebSocket ID"></p><h3 id=close-a-chat-session>Close a Chat Session
<a class=anchor href=#close-a-chat-session>#</a></h3><div class=highlight><pre style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-shell data-lang=shell>//request
curl -H <span style=color:#e6db74>&#39;Content-Type: application/json&#39;</span> -XPOST http://localhost:9000/chat/csk30fjq50k7l4akku9g/_close

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
</code></pre></div><blockquote><p>Use <code>google_drive</code> as a unique identifier, as it is a builtin connector.</p></blockquote><h1 id=using-the-google-drive-connector>Using the Google Drive Connector
<a class=anchor href=#using-the-google-drive-connector>#</a></h1><p>To use the Google Drive Connector, follow these steps to obtain your token:
<a href=https://developers.google.com/drive/api/quickstart/go>Google Drive API Quickstart</a>.</p><h2 id=obtain-google-drive-credentials>Obtain Google Drive credentials
<a class=anchor href=#obtain-google-drive-credentials>#</a></h2><ol><li><p>Set the <strong>Authorized Redirect URIs</strong> as shown in the following screenshot:</p><p><img src=/img/google_drive_token.jpg alt="Authorized Redirect URIs"></p></li><li><p>The Google Drive connector uses <code>/connector/google_drive/oauth_redirect</code> as the callback URL to receive authorization responses.</p></li><li><p>Once the token is successfully obtained, download the <code>credentials.json</code> file.</p><p><img src=/img/download_google_drive_token.png alt=credentials.json></p></li></ol><h3 id=important-notes>Important Notes:
<a class=anchor href=#obtain-google-drive-credentials>#</a></h2><ol><li>Set the <strong>Authorized Redirect URIs</strong> as shown in the following screenshot:</li></ol><p><img src=/coco-server/main/img/google_drive_token.jpg alt="Authorized Redirect URIs"></p><ol start=2><li><p>The Google Drive connector uses <code>/connector/google_drive/oauth_redirect</code> as the callback URL to receive authorization responses.</p></li><li><p>Once the token is successfully obtained, download the <code>credentials.json</code> file.</p></li></ol><p><img src=/coco-server/main/img/download_google_drive_token.png alt=credentials.json></p><h3 id=important-notes>Important Notes:
<a class=anchor href=#important-notes>#</a></h3><ul><li>If you deploy the <strong>coco-server</strong> in your production environment, ensure you:<ul><li>Update the domain name accordingly.</li><li>Adjust the callback URL or configure a custom prefix if you have an <strong>Nginx</strong> instance in front of the server.</li></ul></li></ul><h2 id=update-coco-servers-config>Update coco-server&rsquo;s config
<a class=anchor href=#update-coco-servers-config>#</a></h2><p>Below is an example configuration for enabling the Google Drive Connector in coco-server:</p><div class=highlight><pre style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-shell data-lang=shell>connector:
google_drive:
Expand Down

0 comments on commit 2689e67

Please # to comment.