Пошук

Знаходьте документи у файлах вашої компанії за їхніми словами і за змістом. Слова знаходяться і всередині складених слів, тож «Stuhl» знаходить «Bürostuhl». Зміст працює між мовами, тож «office chairs» знаходить «Bürostühle». Пошук знаходить документи. Він не відповідає на запитання і нічого не змінює.

Пошук

Викличте GET /public/v1/search зі своїми словами в q. Ключу потрібен дозвіл search:read.

curl -sS -G https://api.ocost.io/public/v1/search \
  -H "Authorization: Bearer $OCOST_KEY" \
  --data-urlencode "q=Wartungsvertrag Aufzug" \
  --data-urlencode "kind=contract"

Відповідь перелічує один результат на документ, від найкращого:

JSON
{
  "results": [
    {
      "document_id": "01a1b08c-7aa1-7b52-9d4e-2f1f1c0c4f11",
      "file_id": "01a1b08c-6e3a-7562-8f4a-7924722667b1",
      "file_name": "invoice.pdf",
      "kind": "invoice",
      "number": "RE-2026-1187",
      "seller": "Musterbüro Lieferant GmbH",
      "buyer": "Beispiel Handel GmbH",
      "issue_date": "2026-11-03",
      "gross": 1270.92,
      "currency": "EUR",
      "pages": [1],
      "passages": [
        { "page": 1, "text": "4 Bürostuhl ErgoPlus schwarz à 189,00 €", "highlights": [[2, 11]], "found_by": "both" }
      ],
      "facts": [],
      "file_url": "/public/v1/files/01a1b08c-6e3a-7562-8f4a-7924722667b1",
      "document_url": "/public/v1/documents/01a1b08c-7aa1-7b52-9d4e-2f1f1c0c4f11"
    }
  ],
  "total": 1,
  "truncated": false,
  "meaning": "available"
}

Звузьте пошук

Кожен параметр, крім q, необов’язковий. Повторіть kind для кількох видів.

ПараметрЗміст
qОбов’язковий, від 1 до 200 символів.
matchhybrid шукає за словами і за змістом, це типове значення. keywords шукає лише за словами, meaning лише за змістом. exact знаходить лише документи, що містять q як написано, без урахування регістру, діакритики та пробілів.
kindВид, наприклад invoice, credit_note, delivery_note або contract.
since, untilДата документа, ISO 8601, включно.
due_since, due_untilСтрок оплати рахунку, ISO 8601, включно.
partyНазва будь-якої сторони, як її прочитано. Регістр, умлаути і правові форми не мають значення, тож «Müller Sanitär GmbH» знаходить «MUELLER SANITAER G.m.b.H.».
vat_idНомер платника ПДВ сторони, як його прочитано, без урахування пробілів і регістру.
gross_min, gross_maxСума брутто у валюті вашої компанії, перерахована за курсом ЄЦБ, для лея за курсом Національного банку Молдови, включно.
directionincoming від постачальників або outgoing клієнтам.
statusСтатус рахунку: open (неоплачений) або paid.
categoryКод ECLASS будь-якого рівня, вісім цифр, наприклад 24000000. Знаходить документи з рядком у цьому класі або нижче за ним.
limit, offsetlimit від 1 до 50, типово 20. offset до 250.

Читайте результати

Кожен результат називає свій документ і файл із полями, показаними вище. Файл без документа приходить сам, з document_id, рівним null.

  • passages містить до п’яти уривків приблизно по 300 символів, від найкращого.
  • highlights позначає знайдені слова в text уривка як діапазони [start, end).
  • found_by каже, чи уривок знайдено за словами (words), за змістом (meaning) чи за обома (both).
  • facts перелічує факти на картці документа, що містять ваші слова.
  • file_url і document_url ведуть до файлу та документа в цьому API.

total рахує збіги. Ocost ранжує найкращі 300, а truncated каже, що їх було більше. Видалені файли ніколи не з’являються.

Коли meaning дорівнює unavailable, пошук за змістом будується або недоступний. Пошук за словами все одно відповідає.

Див. також