# QAIP Docs

## Docs

- [Generate LLM completion](https://developer.qaip.com/docs/api-reference/completions/generate-llm-completion.md): <p> Generates a completion based on the input messages and retrieval chunks. If the 'stream' parameter is set to true, the response is returned as a stream of plain text (text/plain). </p> <p> Required roles: All, App </p>
- [Get content](https://developer.qaip.com/docs/api-reference/content/get-content.md): <p> Get through indexed content. </p> <p> Required roles: All, App </p>
- [Get web crawl setting](https://developer.qaip.com/docs/api-reference/crawl-settings/get-web-crawl-setting.md): <p> Gets the setting (schedule, URL, etc.) for web crawl data sources. </p> <p> Required roles: All </p>
- [Update web crawl setting](https://developer.qaip.com/docs/api-reference/crawl-settings/update-web-crawl-setting.md): <p> Updates the setting (name, schedule) for web crawl data sources. </p> <p> Required roles: All </p>
- [Create a web crawl data source](https://developer.qaip.com/docs/api-reference/crawls/create-a-web-crawl-data-source.md): <p> Creates a new web crawl data source and starts ingestion. </p> <p> Required roles: All </p>
- [Get web crawl data source details](https://developer.qaip.com/docs/api-reference/crawls/get-web-crawl-data-source-details.md): <p> Gets detailed information about a specific web crawl data source. </p> <p> Required roles: All </p>
- [List web crawl data sources](https://developer.qaip.com/docs/api-reference/crawls/list-web-crawl-data-sources.md): <p> Lists web crawl data sources with cursor-based pagination. </p> <p> Required roles: All </p>
- [Start deletion of web crawl data source](https://developer.qaip.com/docs/api-reference/crawls/start-deletion-of-web-crawl-data-source.md): <p> Initiates an asynchronous deletion job for the specified web crawl data source. The response indicates that the deletion job has been accepted, not that the deletion is complete. </p> <p> Required roles: All </p>
- [Data extraction](https://developer.qaip.com/docs/api-reference/extract/data-extraction.md): <p> Performs data extraction using LLM based on the specified data source, filter conditions, and JSON schema. Retrieves chunked data and uses the schema to extract and return the result as JSON via LLM. </p> <p> Required roles: All, App </p>
- [Get GitHub setting](https://developer.qaip.com/docs/api-reference/github-settings/get-github-setting.md): <p> Gets the setting (schedule, repository, etc.) for GitHub data sources. </p> <p> Required roles: All </p>
- [Update GitHub setting](https://developer.qaip.com/docs/api-reference/github-settings/update-github-setting.md): <p> Updates the setting (name, schedule) for GitHub data sources. </p> <p> Required roles: All </p>
- [Create a GitHub data source](https://developer.qaip.com/docs/api-reference/githubs/create-a-github-data-source.md): <p> Creates a new GitHub data source and starts ingestion. </p> <p> Required roles: All </p>
- [Get GitHub data source details](https://developer.qaip.com/docs/api-reference/githubs/get-github-data-source-details.md): <p> Gets detailed information about a specific GitHub data source. </p> <p> Required roles: All </p>
- [List GitHub data sources](https://developer.qaip.com/docs/api-reference/githubs/list-github-data-sources.md): <p> Lists GitHub data sources with cursor-based pagination. </p> <p> Required roles: All </p>
- [Start deletion of GitHub data source](https://developer.qaip.com/docs/api-reference/githubs/start-deletion-of-github-data-source.md): <p> Initiates an asynchronous deletion job for the specified GitHub data source. The response indicates that the deletion job has been accepted, not that the deletion is complete. </p> <p> Required roles: All </p>
- [Get Google Drive setting](https://developer.qaip.com/docs/api-reference/google-drive-settings/get-google-drive-setting.md): <p> Gets the setting (schedule, folder URL, etc.) for Google Drive data sources. </p> <p> Required roles: All </p>
- [Update Google Drive setting](https://developer.qaip.com/docs/api-reference/google-drive-settings/update-google-drive-setting.md): <p> Updates the setting (name, schedule) for Google Drive data sources. </p> <p> Required roles: All </p>
- [Create a Google Drive data source](https://developer.qaip.com/docs/api-reference/google-drives/create-a-google-drive-data-source.md): <p> Creates a new Google Drive data source and starts ingestion. </p> <p> Required roles: All </p>
- [Get Google Drive data source details](https://developer.qaip.com/docs/api-reference/google-drives/get-google-drive-data-source-details.md): <p> Gets detailed information about a specific Google Drive data source. </p> <p> Required roles: All </p>
- [List Google Drive data sources](https://developer.qaip.com/docs/api-reference/google-drives/list-google-drive-data-sources.md): <p> Lists Google Drive data sources with cursor-based pagination. </p> <p> Required roles: All </p>
- [Start deletion of Google Drive data source](https://developer.qaip.com/docs/api-reference/google-drives/start-deletion-of-google-drive-data-source.md): <p> Initiates an asynchronous deletion job for the specified Google Drive data source. The response indicates that the deletion job has been accepted, not that the deletion is complete. </p> <p> Required roles: All </p>
- [Create local file group](https://developer.qaip.com/docs/api-reference/local-file-groups/create-local-file-group.md): <p> Creates a new local file group by uploading files directly via multipart form data. </p> <p> The total request body size must not exceed 500 MB. </p> <p> Required roles: All </p>
- [Get local file group](https://developer.qaip.com/docs/api-reference/local-file-groups/get-local-file-group.md): <p> Returns a single local file group by ID. </p> <p> Required roles: All </p>
- [List local file groups](https://developer.qaip.com/docs/api-reference/local-file-groups/list-local-file-groups.md): <p> Lists local file groups with cursor-based pagination. </p> <p> Required roles: All </p>
- [Start deletion of local file group](https://developer.qaip.com/docs/api-reference/local-file-groups/start-deletion-of-local-file-group.md): <p> Initiates an asynchronous deletion job for the specified local file group. The response indicates that the deletion job has been accepted, not that the deletion is complete. </p> <p> Required roles: All </p>
- [Get Notion setting](https://developer.qaip.com/docs/api-reference/notion-settings/get-notion-setting.md): <p> Gets the setting (schedule, page ID, etc.) for Notion data sources. </p> <p> Required roles: All </p>
- [Update Notion setting](https://developer.qaip.com/docs/api-reference/notion-settings/update-notion-setting.md): <p> Updates the setting (name, schedule) for Notion data sources. </p> <p> Required roles: All </p>
- [Create a Notion data source](https://developer.qaip.com/docs/api-reference/notions/create-a-notion-data-source.md): <p> Creates a new Notion data source and starts ingestion. </p> <p> Required roles: All </p>
- [Get Notion data source details](https://developer.qaip.com/docs/api-reference/notions/get-notion-data-source-details.md): <p> Gets detailed information about a specific Notion data source. </p> <p> Required roles: All </p>
- [List Notion data sources](https://developer.qaip.com/docs/api-reference/notions/list-notion-data-sources.md): <p> Lists Notion data sources with cursor-based pagination. </p> <p> Required roles: All </p>
- [Start deletion of Notion data source](https://developer.qaip.com/docs/api-reference/notions/start-deletion-of-notion-data-source.md): <p> Initiates an asynchronous deletion job for the specified Notion data source. The response indicates that the deletion job has been accepted, not that the deletion is complete. </p> <p> Required roles: All </p>
- [Search content](https://developer.qaip.com/docs/api-reference/search/search-content.md): <p> Searches through indexed content using query. </p> <p> Required roles: All, App </p>
- [Create a secret](https://developer.qaip.com/docs/api-reference/secrets/create-a-secret.md): <p> Creates a new secret. </p> <p> Required roles: All </p>
- [Delete a secret](https://developer.qaip.com/docs/api-reference/secrets/delete-a-secret.md): <p> Deletes an existing secret and its associated schedules. </p> <p> Required roles: All </p>
- [Get secret details](https://developer.qaip.com/docs/api-reference/secrets/get-secret-details.md): <p> Gets detailed information about a specific secret. The secret value is not returned. </p> <p> Required roles: All </p>
- [List secrets](https://developer.qaip.com/docs/api-reference/secrets/list-secrets.md): <p> Lists secrets with cursor-based pagination. </p> <p> Required roles: All </p>
- [Update a secret](https://developer.qaip.com/docs/api-reference/secrets/update-a-secret.md): <p> Updates an existing secret. </p> <p> Required roles: All </p>
- [Create tag source group](https://developer.qaip.com/docs/api-reference/tag-source-groups/create-tag-source-group.md): <p> Creates a new tag source group association. A source group is a collection of files ingested by a single job. </p> <p> Required roles: All </p>
- [Delete tag source group](https://developer.qaip.com/docs/api-reference/tag-source-groups/delete-tag-source-group.md): <p> Deletes a tag source group association. </p> <p> Required roles: All </p>
- [List tags](https://developer.qaip.com/docs/api-reference/tags/list-tags.md): <p> Returns the list of tags. </p> <p> Required roles: All, App </p>
- [クロール](https://developer.qaip.com/docs/datasources/crawl.md): QAIPでWebサイトをクロールしてコンテンツを取得
- [ローカルファイル](https://developer.qaip.com/docs/datasources/file.md): QAIPにPDF・Word・Excel・PowerPointなどのドキュメントファイルをアップロードする
- [GitHub](https://developer.qaip.com/docs/datasources/github.md): QAIPにGitHubのドキュメントファイルを取り込む
- [Google Drive](https://developer.qaip.com/docs/datasources/google-drive.md): QAIPでGoogle Driveのファイルを取り込む
- [データソースの概要](https://developer.qaip.com/docs/datasources/index.md): QAIPでは様々な形式のデータを取り込み、AIチャットや検索の知識ベースとして活用できます。データソースを適切に管理することで、より正確で関連性の高い回答を生成できるようになります。
- [Notion](https://developer.qaip.com/docs/datasources/notion.md): QAIPとNotionワークスペースを連携してページを同期
- [APIキー](https://developer.qaip.com/docs/features/apikey.md): QAIPのAPIキー管理機能はAPIに安全にアクセスするための認証情報です。外部アプリケーションやサービスからQAIPの機能を利用する際に必要となります。
- [キーワード](https://developer.qaip.com/docs/features/keyword.md): QAIPのキーワード機能は、完全一致で検索できるキーワードを定義できる機能です。これによりブランド名・製品名・技術用語などの重要なキーワードを含む情報を確実に検索し、回答の参考情報として含めることができます。
- [スケジュール](https://developer.qaip.com/docs/features/schedule.md): QAIPのスケジュール機能は各データソースで設定したスケジュールの確認・削除ができます。
- [シークレット](https://developer.qaip.com/docs/features/secrets.md): QAIPのシークレット管理機能はGoogleドライブ・GitHub・Notionのシークレットを安全に保存し、利用可能な状態にします。
- [タグ](https://developer.qaip.com/docs/features/tag.md): タグ機能はQAIPに取り込んだコンテンツを分類・整理するための強力な機能です。タグを活用することで特定の情報源のみを参照した回答を生成できます。
- [GPTs](https://developer.qaip.com/docs/integrations/gpts.md): QAIPの検索APIを活用してOpenAIのGPTsからあらゆるデータソースを検索し、目的の情報を取得できます。取得した情報を元に回答を生成することで、より正確な情報提供が可能になります。さらにChatGPT Business・Enterpriseでは取り込んだデータをGPTsを通じて会社やチームの他のユーザーと共有できます。
- [LangChain](https://developer.qaip.com/docs/integrations/langchain.md): QAIPのデータを検索してLangChainと組み合わせる
- [MCP](https://developer.qaip.com/docs/integrations/mcp.md): Model Context Protocol (MCP) を用いて外部サービスと連携する
- [n8n](https://developer.qaip.com/docs/integrations/n8n.md): n8nのワークフローからQAIPのデータソースを活用して回答生成・情報抽出・検索を行うことができます。
- [イントロダクション](https://developer.qaip.com/docs/introduction.md): QAIPは、組織内外に散在するWebページ・ファイル・クラウドドキュメントを安全に取り込み、検索・チャット・抽出で活用するためのプラットフォームです。RAGベースのチャット、ハイブリッド検索、スキーマに沿った構造化データ抽出、DuckDBエクスポートなどを提供し、SDK / API と各種連携でアプリケーションに組み込めます。
- [チャット](https://developer.qaip.com/docs/playground/chat.md): QAIPのチャット機能は標準で検索拡張生成(RAG)を行います。データソースをある大きさのチャンクに分割し、ユーザーの質問に対して関連するチャンクを検索し、その内容を元に回答を生成します。
- [DuckDBファイル](https://developer.qaip.com/docs/playground/duckdb.md): QAIPに取り込んだチャンクデータをDuckDBファイルとしてエクスポートする
- [データ抽出](https://developer.qaip.com/docs/playground/extract.md): QAIPに取り込んだデータを検索し、任意のスキーマで抽出する
- [Playgroundの概要](https://developer.qaip.com/docs/playground/index.md): PlaygroundはQAIPの機能をブラウザ上で簡単に試せる環境です。APIを使って実装する前に設定やパラメータを調整しながら実際の動作を確認できます。
- [検索](https://developer.qaip.com/docs/playground/search.md): QAIPはデータソースをある大きさのチャンクに分割し、そのチャンクに対してセマンティック検索と全文検索によるハイブリッド検索を行います。Playgroundの検索機能は、チャットやデータ抽出で使用するデータソースが具体的にどのようにしてフィルタリングされ、検索されるかを確認するためのものです。
- [クイックスタート](https://developer.qaip.com/docs/quickstart.md): QAIPを使って10分でチャットボットを作成する
- [プロダクトの更新情報](https://developer.qaip.com/docs/release-notes.md): プロダクトの機能追加や改善についての履歴を確認できます。
- [SDK イントロダクション](https://developer.qaip.com/docs/sdks/index.md): QAIPはPython SDKを提供しています。SDKを利用することで、簡単にQAIPの機能をアプリケーションに組み込むことができます。
- [FAQ](https://developer.qaip.com/docs/support/faq.md): QAIPに関するよくある質問
- [価格](https://developer.qaip.com/docs/support/pricing.md): QAIPの価格についての詳細
- [Claude Code連携によるコンテキスト活用型開発](https://developer.qaip.com/docs/use-cases/claude_code.md): QAIPに取り込まれた多様なデータをMCP経由でClaude Codeに連携できます。<br/> データに[タグ](/features/tag)を付与して整理することで、必要なコンテキストだけを参照できます。
- [Dify連携による大規模データ対応チャットボット構築](https://developer.qaip.com/docs/use-cases/dify.md): QAIPがデータを取り込み・検索し、Difyがその結果に基づいて回答を生成します。
- [ドキュメント横断検索](https://developer.qaip.com/docs/use-cases/docs-retrieval.md): QAIPを活用することでGitHub・Google DocsといったサービスからPowerPoint・PDFなどあらゆるドキュメントを横断的に検索し、必要な情報を迅速に見つけ出すことができます。
- [Lovableを組み合わせてRAGアプリケーションを短時間で構築](https://developer.qaip.com/docs/use-cases/lovable.md): QAIPとLovableを組み合わせ、取り込み済みデータに対する自然言語検索とAI回答を備えたWebアプリケーションを短時間で構築できます。
- [Slackボットによるナレッジ共有](https://developer.qaip.com/docs/use-cases/qaip-slack-bot.md): データソースの内容をもとにQAIP AIがSlackでの質問に即時回答。組織のナレッジを簡単に共有できます。

## OpenAPI Specs

- [openapi.documented](https://app.stainless.com/api/spec/documented/qaip/openapi.documented.yml)

## Optional

- [Qiita](https://qiita.com/tags/qaip)
- [Discord](https://discord.gg/2MdxWtYRue)