Document Platform

Find documents in given categories across a batch of buildings

Deterministic category-filtered search, FGA-filtered per document. Called once per building batch so the client can render results progressively. When intentSummary is sent, the batch is additionally scored against it by a model (metered as doc_discovery_rerank), with each rationale written in locale (else the stored user locale, else English); the document set itself is unaffected.

post/customers/{customerId}/documents/discover

Request

  • Base URL: http://localhost:9000
  • URL: http://localhost:9000/customers/{customerId}/documents/discover
  • Auth: API key in header x-api-key

Path parameters

customerIdstring uuid required

Request body

categoryCodesstring[] required
buildingIdsstring[] required
remainingBudgetinteger
intentSummarystring
locale'en' | 'no' | 'fr' | 'sv' | 'fi' | 'da'

Response

Default Response

totalMatchesinteger required
capReachedboolean required

Changes

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