Generated from OpenAPI

API Reference

このページは momonga-search-api の FastAPI / Pydantic schema から生成した OpenAPI JSON を表示しています。

手書きのガイドは使い方を説明し、endpoint、request、response の詳細はコード由来の OpenAPI を正本にします。

API

GET/health

Health

stability: unspecifiedquota: unspecifiedunits: unspecified

Responses

Status	Description	Schema
`200`	Successful Response	HealthResponse

GET/health/ready

Ready

stability: unspecifiedquota: unspecifiedunits: unspecified

Responses

Status	Description	Schema
`200`	Successful Response	HealthResponse

Catalog

GET/v1/issuers/search

Search issuers

企業名または証券コードから issuer を検索します。

stability: betaquota: catalogunits: 0

Parameters

Name	In	Required	Schema
`q`	query	yes	string
`limit`	query	no	integer

Responses

Status	Description	Schema
`200`	Successful Response	IssuerSearchResponse
`422`	Validation Error	HTTPValidationError

GET/v1/documents

List documents

公開対象の文書を discovery timeline の降順で一覧します。

stability: betaquota: catalogunits: 0

Parameters

Name	In	Required	Schema
`security_codes`	query	no	string[] \| null
`document_types`	query	no	string[] \| null
`timeline_since`	query	no	string:date \| null
`timeline_until`	query	no	string:date \| null
`limit`	query	no	integer
`cursor`	query	no	string \| null

Responses

Status	Description	Schema
`200`	Successful Response	DocumentListResponse
`422`	Validation Error	HTTPValidationError

GET/v1/documents/{document_id}

Get document

文書のメタデータと取得可否を返します。

stability: betaquota: catalogunits: 0

Parameters

Name	In	Required	Schema
`document_id`	path	yes	string

Responses

Status	Description	Schema
`200`	Successful Response	DocumentSummary
`422`	Validation Error	HTTPValidationError

GET/v1/news

List news

一次情報への参照を持つ public news statement を一覧します。

stability: betaquota: catalogunits: 0

Parameters

Name	In	Required	Schema
`security_codes`	query	no	string[] \| null
`timeline_since`	query	no	string:date \| null
`timeline_until`	query	no	string:date \| null
`limit`	query	no	integer
`cursor`	query	no	string \| null

Responses

Status	Description	Schema
`200`	Successful Response	NewsListResponse
`422`	Validation Error	HTTPValidationError

GET/v1/news/{news_id}

Get news

news statement の詳細を返します。

stability: betaquota: catalogunits: 0

Parameters

Name	In	Required	Schema
`news_id`	path	yes	string

Responses

Status	Description	Schema
`200`	Successful Response	NewsSummary
`422`	Validation Error	HTTPValidationError

GET/v1/documents/{document_id}/toc

Get document TOC

文書の目次とセクション単位の token count を返します。

stability: betaquota: catalogunits: 0

Parameters

Name	In	Required	Schema
`document_id`	path	yes	string

Responses

Status	Description	Schema
`200`	Successful Response	DocumentTocResponse
`422`	Validation Error	HTTPValidationError

GET/v1/documents/{document_id}/page-images

List page images

文書内で JPEG 画像として取得できるページをページ番号昇順で返します。

stability: betaquota: catalogunits: 0

Parameters

Name	In	Required	Schema
`document_id`	path	yes	string

Responses

Status	Description	Schema
`200`	Successful Response	DocumentPageImagesResponse
`422`	Validation Error	HTTPValidationError

Delivery

GET/v1/documents/{document_id}/content

Get document content

文書本文、または指定セクションの本文を返します。

stability: betaquota: computeunits: token_count

Parameters

Name	In	Required	Schema
`document_id`	path	yes	string
`sections`	query	no	string[] \| null

Responses

Status	Description	Schema
`200`	Successful Response	DocumentContentResponse
`422`	Validation Error	HTTPValidationError

GET/v1/documents/{document_id}/pages/{page_number}/image

Get page image

指定ページの JPEG 画像を返します。取得可能なページは `GET /v1/documents/{document_id}/page-images` で確認してください。

stability: betaquota: computeunits: 1 per page

Parameters

Name	In	Required	Schema
`document_id`	path	yes	string
`page_number`	path	yes	integer

Responses

Status	Description	Schema
`200`	JPEG page image	string:binary
`422`	Validation Error	HTTPValidationError

Compute

POST/v1/search/documents

Search documents

文書本文を自然文クエリで検索します。

stability: betaquota: computeunits: 1

Request body

Field	Required	Schema	Default
`query`	yes	string	-
`security_codes`	no	string[]	-
`document_types`	no	string[]	-
`timeline_since`	no	string:date \| null	-
`timeline_until`	no	string:date \| null	-
`match_type`	no	"semantic" \| "lexical"	semantic
`top_k`	no	integer	10
`include_snippet`	no	boolean	false
`document_families`	no	string[]	-

Responses

Status	Description	Schema
`200`	Successful Response	DocumentSearchResponse
`422`	Validation Error	HTTPValidationError

POST/v1/search/news

Search news

news statement を自然文クエリで検索します。

stability: betaquota: computeunits: 1

Request body

Field	Required	Schema	Default
`query`	yes	string	-
`security_codes`	no	string[]	-
`timeline_since`	no	string:date \| null	-
`timeline_until`	no	string:date \| null	-
`top_k`	no	integer	10

Responses

Status	Description	Schema
`200`	Successful Response	NewsSearchResponse
`422`	Validation Error	HTTPValidationError