Docs/リファレンス/翻訳/翻訳の全文検索
GET/v1/translations/searchプラン · Developer

翻訳の全文検索

翻訳済み開示書類の全文検索を行います。

関連度の高い順にハイライト付きスニペットを返します。PostgreSQLのtsvector/tsqueryによる全文検索を使用。

クエリパラメータ · 5

任意のフィルターと修飾子。URLエンコードした ?key=value で渡します。

qstring必須

検索クエリ

sectionstring | null任意

セクションキーでフィルター。mda(経営者分析), risk_factors(リスク情報), business_overview(事業の内容), strategy(経営方針), sustainability(サステナビリティ), research_and_development(研究開発), dividend_policy(配当政策), governance(ガバナンス), company_history(沿革), employees(従業員), critical_contracts(重要な契約), capital_expenditures(設備投資), accounting_policy(会計方針), segment_info(セグメント情報), financial_instruments(金融商品)

fiscal_yearinteger | null任意

決算年度でフィルター

limitinteger任意

1ページあたりの件数

default 20
offsetinteger任意

スキップする件数(cursor指定時は無視)

default 0

リクエストヘッダー · 1

認証ヘッダー。

Authorizationstring必須

本番用のAPIキー。次の形式で渡します: Bearer ax_live_…

返り値 · 200

標準の { data, meta } エンベロープ。 data は TranslationSearchResult 型の配列です。

エンベロープ

dataTranslationSearchResult[]

結果オブジェクトの配列。

metaMeta

ページネーションとリクエストメタデータ。request_iddata_as_ofontology_version を含みます。

ontology_version 2.1.0replay meta.as_of · ?as_of=<token>

TranslationSearchResult

sectionstring

一致が見つかったセクション名。

snippetstring

一致するキーワードがハイライトされたテキストスニペット。

edinet_codestring

一致した企業のEDINET提出者コード。

company_namestring | null

会社名(日本語)。

fiscal_yearinteger

一致した書類の決算年度。

doc_idstring

一致した書類のEDINET書類ID。

ranknumber

PostgreSQL ts_rankの関連度スコア。高いほど関連性が高い。

エラー

標準のHTTPステータスコードに加え、{ error: { code, message } } エンベロープ内で型付きの error.code を返します。

すべてのエンドポイントは共通の型付きエラーエンベロープ({ error: { code, message } })を返します。 全コードの一覧はエラーリファレンスを参照してください。