# GBase docs

## Docs

- [Add file to dataset](https://docs.gbase.ai/api-reference/datasets/add-file-to-dataset.md)
- [Add Lark files to dataset by appid, app secret and share urls](https://docs.gbase.ai/api-reference/datasets/add-lark-files-to-dataset-by-appid-app-secret-and-share-urls.md)
- [Add link to dataset](https://docs.gbase.ai/api-reference/datasets/add-link-to-dataset.md)
- [Add url's content as file to dataset](https://docs.gbase.ai/api-reference/datasets/add-urls-content-as-file-to-dataset.md)
- [Add url's content as file to dataset](https://docs.gbase.ai/api-reference/datasets/add-urls-content-as-file-to-dataset-1.md)
- [Bind dataset to ai](https://docs.gbase.ai/api-reference/datasets/bind-dataset-to-ai.md): Bind dataset to ai
- [Create dataset](https://docs.gbase.ai/api-reference/datasets/create-dataset.md): Create dataset
- [Delete dataset](https://docs.gbase.ai/api-reference/datasets/delete-dataset.md): Delete dataset
- [Delete dataset file](https://docs.gbase.ai/api-reference/datasets/delete-dataset-file.md): Delete dataset file
- [Get ai datasets](https://docs.gbase.ai/api-reference/datasets/get-ai-datasets.md): Get ai datasets
- [Get dataset](https://docs.gbase.ai/api-reference/datasets/get-dataset.md): Get dataset
- [Get dataset file chunks](https://docs.gbase.ai/api-reference/datasets/get-dataset-file-chunks.md): Get dataset file chunks
- [Get dataset file metadata](https://docs.gbase.ai/api-reference/datasets/get-dataset-file-metadata.md)
- [Get dataset files](https://docs.gbase.ai/api-reference/datasets/get-dataset-files.md)
- [Get dataset files counts](https://docs.gbase.ai/api-reference/datasets/get-dataset-files-counts.md): Get dataset files counts
- [Get datasets](https://docs.gbase.ai/api-reference/datasets/get-datasets.md): Get user's datasets
- [Refresh dataset file list](https://docs.gbase.ai/api-reference/datasets/refresh-dataset-file-list.md)
- [Refresh dataset upload file list](https://docs.gbase.ai/api-reference/datasets/refresh-dataset-upload-file-list.md)
- [Refresh dataset upload file list](https://docs.gbase.ai/api-reference/datasets/refresh-dataset-upload-file-list-1.md)
- [Unbind dataset to ai](https://docs.gbase.ai/api-reference/datasets/unbind-dataset-to-ai.md): Unbind dataset to ai
- [Update dataset](https://docs.gbase.ai/api-reference/datasets/update-dataset.md): Update dataset
- [Update Dataset Configs](https://docs.gbase.ai/api-reference/datasets/update-dataset-configs.md)
- [Update dataset file](https://docs.gbase.ai/api-reference/datasets/update-dataset-file.md): Update dataset file
- [Chat Agent](https://docs.gbase.ai/api-reference/digital-human/chat-agent.md)
- [Chat Agent Runtime](https://docs.gbase.ai/api-reference/digital-human/chat-agent-runtime.md)
- [Welcome Message](https://docs.gbase.ai/api-reference/digital-human/welcome-message.md)
- [Delete AI](https://docs.gbase.ai/api-reference/gbase-ai/delete-ai.md): You can delete an AI type you don't want through this interface.
- [generate prompt](https://docs.gbase.ai/api-reference/gbase-ai/generate-prompt.md): 一键生成机器人的prompt, 使用Meta Prompt调用大模型进行生成
- [generate prompt](https://docs.gbase.ai/api-reference/gbase-ai/generate-prompt-1.md): 更新robot的prompt信息, 暂时不用, 后续看看如何修改. todo -
- [Get AI](https://docs.gbase.ai/api-reference/gbase-ai/get-ai.md): You can get an AI Info
- [Get AIs](https://docs.gbase.ai/api-reference/gbase-ai/get-ais.md): You can obtain all AI types you create through this interface.
- [Update AI](https://docs.gbase.ai/api-reference/gbase-ai/update-ai.md): You can modify your AI type through this interface.
- [Get Azure Stt Token](https://docs.gbase.ai/api-reference/get-azure-stt-token.md): 获取 Azure Speech-to-Text Token
- [Get References](https://docs.gbase.ai/api-reference/get-references/get-references.md)
- [Get Message](https://docs.gbase.ai/api-reference/question-message/get-message.md)
- [Ask Question](https://docs.gbase.ai/api-reference/question/ask-question.md): When you upload a file through the file upload interface, you can use this interface to ask questions about the content of the file you upload, and this interface will return the retrieved answer.
- [Ask Recommend Translation](https://docs.gbase.ai/api-reference/question/ask-recommend-translation.md)
- [Delete Session Messages](https://docs.gbase.ai/api-reference/question/delete-session-messages.md)
- [Get Agent Bot Config](https://docs.gbase.ai/api-reference/question/get-agent-bot-config.md): 获取Bot配置信息接口，用于获取Agent模式所需的配置参数
- [Get Session Messages](https://docs.gbase.ai/api-reference/question/get-session-messages.md)
- [Message Rating](https://docs.gbase.ai/api-reference/question/message-rating.md)
- [Rag Retrieve](https://docs.gbase.ai/api-reference/question/rag-retrieve.md): RAG检索接口，根据查询文本检索相关文档片段 支持GBase集成知识库检索
- [Save Realtime Session](https://docs.gbase.ai/api-reference/question/save-realtime-session.md): Batch save realtime voice session from live-stream WebSocket.
- [Set Message Canvas Url](https://docs.gbase.ai/api-reference/question/set-message-canvas-url.md)
- [Introduction](https://docs.gbase.ai/introduction.md): Welcome to GBase documentation
- [クイックスタート](https://docs.gbase.ai/user-manual/quickstart.md): GBaseの基本操作とクイックスタート手順をまとめてあります。
- [アクセス管理](https://docs.gbase.ai/user-manual/welcome/access-management.md): チャットボットとナレッジベースのコラボレーション機能です。
- [API](https://docs.gbase.ai/user-manual/welcome/api.md): GBaseのAPIドキュメントを確認できます。
- [コラボレーションスペース](https://docs.gbase.ai/user-manual/welcome/collaboration-space.md): 他のユーザーから共有されたチャットボットやナレッジベースの詳細を確認できます。
- [キー](https://docs.gbase.ai/user-manual/welcome/key.md): APIキーの作成ができます。
- [ナレッジベース](https://docs.gbase.ai/user-manual/welcome/knowledge-base.md): 作成したナレッジベースを管理できます。
- [ログインユーザー](https://docs.gbase.ai/user-manual/welcome/login-user.md): ログインユーザーのIDとAPIキーの確認やログアウトの機能を行うことができます。
- [マニュアル](https://docs.gbase.ai/user-manual/welcome/manual.md): GBaseの操作手順をまとめたマニュアルです。
- [ドキュメント](https://docs.gbase.ai/user-manual/welcome/mybot/bot-creation/document.md): サポートしている各種ファイルをアップロードし、ナレッジベースへ追加します。
- [よくある質問のリスト](https://docs.gbase.ai/user-manual/welcome/mybot/bot-creation/faq-list.md): サポートしている各種FAQファイルをアップロードし、ナレッジベースへ追加します。製品やサービスに関するよくある質問に対して、ボットの回答を最適化・調整するのに適しています。また、過去の質問ログをもとに回答を編集し、それをもとにFAQを作成することができます。
- [Gitbook](https://docs.gbase.ai/user-manual/welcome/mybot/bot-creation/gitbook.md): Gitbookからページ情報とコンテンツ情報を取得し、ナレッジベースへ追加します。文書や本に特化したチャットボットを作成でき、ユーザーや読者に価値のある情報やサポートを提供します。
- [インテグレーション](https://docs.gbase.ai/user-manual/welcome/mybot/bot-creation/integration.md): Larkから情報を取得し、ナレッジベースへ追加します。
- [サイトマップ](https://docs.gbase.ai/user-manual/welcome/mybot/bot-creation/sitemap.md): XMLサイトマップからページ情報とコンテンツ情報を取得し、ナレッジベースへ追加します。ウェブサイトのコンテンツに関連する質問に、より適した回答をするようになります。
- [ウェブサイト](https://docs.gbase.ai/user-manual/welcome/mybot/bot-creation/website.md): ウェブサイトをクロールし、ナレッジベースへ追加します。
- [チャット履歴](https://docs.gbase.ai/user-manual/welcome/mybot/customize/chat-history.md): チャットの履歴を確認し、品質を管理できます。
- [ウィジェット埋め込み](https://docs.gbase.ai/user-manual/welcome/mybot/customize/widget-embed.md): ウェブサイトにボットを簡単に埋め込むことができます。
- [ボット削除](https://docs.gbase.ai/user-manual/welcome/mybot/setting/bot-delete.md): 不要なボットを削除できます。
- [Canvas](https://docs.gbase.ai/user-manual/welcome/mybot/setting/canvas.md): ユーザーが入力した情報をもとに外部APIを呼び出し、取得したデータをパラメーターとして受け取ることで、Canvas上にさまざまな情報を表示することができます。
- [プロンプト](https://docs.gbase.ai/user-manual/welcome/mybot/setting/prompt.md): プロンプトの編集ができます。
- [LINE連携設定](https://docs.gbase.ai/user-manual/welcome/mybot/setting/publish-line.md): GBaseSupportとLINEプラットフォームの連携設定手順です。
- [詳細設定](https://docs.gbase.ai/user-manual/welcome/mybot/setting/settings-details.md): ボットの詳細設定ができます。
- [一般設定](https://docs.gbase.ai/user-manual/welcome/mybot/setting/settings-general.md): ボットの設定ができます。
- [ツールリスト](https://docs.gbase.ai/user-manual/welcome/mybot/tool-list.md): GBaseと外部システムをつなぐ設定情報です。通知・登録・情報取得などの操作を、エージェントが自動で実行できます。
- [データ辞書](https://docs.gbase.ai/user-manual/welcome/mybot/training/data-dictionary.md): 専門用語や略語を登録できます。
- [関連ナレッジベース](https://docs.gbase.ai/user-manual/welcome/mybot/training/related-knowledge-base.md): ボットが使用できるナレッジベースを設定します。
- [チャット](https://docs.gbase.ai/user-manual/welcome/mybot/workshop/chat.md): ボットの動作を確認できます。
- [ダッシュボード](https://docs.gbase.ai/user-manual/welcome/mybot/workshop/dashboard.md): ボットの利用状況を分析・モニタリングができます。ユーザーの反応、フィードバックなどを数値で可視化できます。ユーザーの反応・フィードバックなどを数値で可視化し、サービスの活用状況や改善ポイントを把握するのに役立ちます。
- [オンライン訪問者](https://docs.gbase.ai/user-manual/welcome/mybot/workshop/online-visitor.md): ボットを利用しているユーザーをリアルタイムで確認できます。
- [言語設定](https://docs.gbase.ai/user-manual/welcome/setting-language.md): GBaseの表示言語を設定できます。

## OpenAPI Specs

- [openapi-redoc](https://api.gbase.ai/openapi-redoc.json)
- [GBase-api](https://docs.gbase.ai/user-manual/.gitbook/assets/GBase-api.json)
- [openapi](https://docs.gbase.ai/api-reference/openapi.json)