---
title: "POST /v1/documents/chat/"
method: POST
path: "/v1/documents/chat/"
tags: ["chat"]
---

# POST /v1/documents/chat/

`POST /v1/documents/chat/`

## Request

- Base URL: `https://api.ai.sakura.ad.jp`
- URL: `https://api.ai.sakura.ad.jp/v1/documents/chat/`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/sakura/apis/sakura-ai-engine-rag-api/docs/v1/documents/chat/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- ChatQueryRequest
  - `distance_type` 'cosine' | 'l2': * `cosine` - cosine * `l2` - l2
  - `model` string: 検索時に使用する埋め込みモデルを指定します。 指定したモデルでクエリおよびドキュメントの埋め込みを生成し、 類似度検索を行います。(利用可能なモデルはコントロールパネル等をご確認ください。)
  - `chat_model` string, required: 回答生成に使用するチャットモデルを指定します。 検索結果をもとに、このモデルを用いて回答文を生成します。(利用可能なモデルはコントロールパネル等をご確認ください。)
  - `query` string, required: 質問文を指定します。 指定されたクエリは検索および回答生成の両方に使用されます。
  - `prompt` string: 回答生成時の`system_prompt`に追加されるカスタム指示文を指定します。 口調の指定や回答形式の制御などに利用できます。 未指定の場合は、デフォルトのsystem_promptが使用されます。
  - `tags` string[]: 検索対象にするタグを指定します。 指定したタグが含まれるドキュメントのみが検索対象となります。 複数指定した場合はすべてのタグが指定されているドキュメントのみ対象となります。
  - `top_k` integer: 検索結果として取得する最大件数を指定します。 類似度の高いドキュメントから順に、この件数分が使用されます。
  - `threshold` number, double: ベクトル距離のしきい値。この值よりも距離が大きいドキュメントは検索結果から除外されます。
  - `use_full_content` boolean: trueの場合は、ドキュメント全文をコンテキストとして使用します。 falseの場合は、分割されたチャンク単位で検索・回答生成を行います。

## Response `200`

- ChatResult
  - `answer` string, required
  - `sources` ChatResultSource[], required
    - union
      - QueryResultChunk
        - `document` DocumentList, required
          - `id` string, uuid, required
          - `created_at` string, date-time, required
          - `status` 'pending' | 'processing' | 'available' | 'deleted' | 'error', required: * `pending` - Pending * `processing` - Processing * `available` - Available * `deleted` - Deleted * `error` - Error
          - `name` string, required
          - `model` string, required
          - `chunk_size` integer, required
          - `chunk_count` integer, required
          - `tags` string[]
          - `error_message` string, required
        - `chunk_index` integer, required
        - `distance` number, double, required
        - `content` string, required
        - `metadata` object, required
      - QueryResultDocument
        - `id` string, uuid, required
        - `name` string, required
        - `tags` string[]
        - `model` string, required
        - `chunk_size` integer, required
        - `distance` number, double, required
        - `content` string, required

---

[API](https://skmtc.dev/sakura/apis/sakura-ai-engine-rag-api.md) - [All operations](https://skmtc.dev/sakura/apis/sakura-ai-engine-rag-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sakura/apis/sakura-ai-engine-rag-api/revisions/229dfe3a3f2a?raw)