記事検索API（β版）仕様書 - helpfeel-api-document

記事検索API（β版）仕様書

Ver.1.0.0

ベースURLと認証について

記事検索API

概要

検索クエリで記事を検索し、関連性の高い順に結果を返します

※「記事」とは「Helpfeelの検索対象になるページ」のことで、つまり「質問文のあるページ」のことを指します

エンドポイント

POST /v1/projects/:projectName/search/articles

:projectName

Helpfeelのプロジェクト名を指定してください

リクエスト

code:schema.ts

type RequestBody = {

query: string // 検索クエリ

kinds?: string[] // 検索の対象とする記事の種類別タグ(オプショナル)

}

code:json

{

"query": "商品Aの利用方法を知りたい"

}

種類別タグを指定する場合

code:json

{

"query": "商品Aの利用方法を知りたい",

}

レスポンス

code:schema.ts

type ResponseBody = {

items: {

question: string // 質問文。例: "商品Aの使い方について教えてください"

kinds: string[] // 記事の種類別タグ。例: "商品カテゴリA"

}[] // 検索結果の一覧(関連性の高い順)

}

エラーについてはHelpfeelの公開API: 検索系エラーをご参照ください

リクエストの例

code:shell

curl -X POST \

-H "X-API-KEY: <your API key>" \

-H "Content-Type: application/json" \

-d '{"query": "商品Aの利用方法を知りたい"}' \