query

POST /v1/documents/query/

Request

Base URL
https://api.ai.sakura.ad.jp
Auth
HTTP bearer
TypeScript
https://skmtc.dev/sakura/apis/sakura-ai-engine-rag-api/docs/v1/documents/query/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

modelstring

namestring

tagstring

Request body

modelstring

クエリのベクトル化に利用するモデル。

querystring required

tagsstring[]

すべてのタグを持つドキュメントのみ対象。

top_kinteger

返す検索結果の最大件数。

thresholdnumber double

ベクトル距離のしきい値。この值よりも距離が大きいドキュメントは検索結果から除外されます。

distance_type'cosine' | 'l2'

cosine - cosine
l2 - l2

Response

Changes

No recorded changes to this operation across all 1 revision of this API.