仕様書の全文検索

GET

/spec/search

curl --request GET \
  --url 'https://api.plateauview.mlit.go.jp/spec/search?q=example&document_type=standard&limit=10'

PLATEAU 3D都市モデルの標準製品仕様書・標準作業手順書を全文検索し、該当セクションのパス・関連度スコア・スニペットを返します。 得られた path は /spec/{document_type}/{path} で本文を取得できます。

Parameters

Query Parameters

q

required

string

検索クエリ。日本語・英語に対応。例: LOD, CityGML, 属性, メタデータ

document_type

string

default: all

Allowed values: standard procedure all

検索対象。standard(標準製品仕様書) / procedure(標準作業手順書) / all(両方)。既定: all

limit

integer

default: 10 <= 50

最大取得件数。既定: 10、最大: 50

Responses

200

成功時のレスポンス

Media type application/json

object

query

string

results

Array<object>

object

title

セクションのタイトル

string

path

/spec/{document_type}/{path} で本文取得に使うパス

string

document_type

該当文書の種類

string

Allowed values: standard procedure

score

関連度スコア

number

snippets

マッチした箇所の抜粋

Array<string>

Example

{
  "results": [
    {
      "document_type": "standard"
    }
  ]
}

400

クエリが不正

Media type application/json

object

error

required

エラーメッセージ

string

url

エラーが発生したURL

string

reason

エラーの原因

string

Example ^generated

{
  "error": "example",
  "url": "example",
  "reason": "example"
}

500

検索インデックスの初期化または検索に失敗

Media type application/json

object

error

required

エラーメッセージ

string

url

エラーが発生したURL

string

reason

エラーの原因

string

Example ^generated

{
  "error": "example",
  "url": "example",
  "reason": "example"
}