Search Semantic

自然文クエリによるセマンティック検索。クエリをベクトル化し、意味的に近いノートを返します。note_includes_text/note_excludes_text で語単位のキーワード絞り込み(ハードフィルタ)を併用できます。

get/api/v1/data/search/semantic

Request

  • Base URL: https://dev.api-birdxplorer.code4japan.org (the document declares no server; this is the origin it was published from)
  • URL: https://dev.api-birdxplorer.code4japan.org/api/v1/data/search/semantic
  • Auth: none declared

Query parameters

qstring required

検索クエリ(自然文)

languagestring nullable

ノートの言語で絞り込み

limitinteger

取得件数(最大100)

note_includes_textstring[] nullable

指定した文字列を含む Note を検索して取得する。検索は Note のSummaryに対して行われる。

note_search_mode'or' | 'and'

note_includes_text で指定した複数キーワードの結合方法。

値意味
orいずれかのキーワードを含むノートを取得
andすべてのキーワードを含むノートのみを取得
note_excludes_textstring nullable

指定した文字列を含む Note を検索して取得する。検索は Note のSummaryに対して行われる。

Response

Successful Response

Changes

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