Recherche

Trouvez des documents dans les fichiers de votre entreprise par leurs mots et par leur sens. Les mots se trouvent aussi à l'intérieur des mots composés, donc « Stuhl » trouve « Bürostuhl ». Le sens traverse les langues, donc « office chairs » trouve « Bürostühle ». La recherche trouve des documents. Elle ne répond à aucune question et ne change rien.

Rechercher

Appelez GET /public/v1/search avec vos mots dans q. La clé a besoin de l'autorisation 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"

La réponse liste un résultat par document, le meilleur d'abord :

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"
}

Affiner

Chaque paramètre sauf q est facultatif. Répétez kind pour plusieurs types.

ParamètreSignification
qObligatoire, de 1 à 200 caractères.
matchhybrid utilise les mots et le sens, et c'est la valeur par défaut. keywords n'utilise que les mots, meaning que le sens. exact ne trouve que les documents contenant q tel qu'écrit, sans tenir compte de la casse, des accents ni des espaces.
kindUn type comme invoice, credit_note, delivery_note ou contract.
since, untilLa date d'émission, ISO 8601, bornes incluses.
due_since, due_untilLa date d'échéance d'une facture, ISO 8601, bornes incluses.
partyLe nom d'une partie quelconque, tel que lu. La casse, les trémas et les formes juridiques ne comptent pas, donc « Müller Sanitär GmbH » trouve « MUELLER SANITAER G.m.b.H. ».
vat_idLe numéro de TVA d'une partie, tel que lu, sans tenir compte des espaces ni de la casse.
gross_min, gross_maxLe montant TTC dans la devise de votre entreprise, converti au taux de la BCE, pour le leu à celui de la Banque nationale de Moldavie, bornes incluses.
directionincoming venant des fournisseurs, ou outgoing vers les clients.
statusCelui d'une facture : open (impayée) ou paid.
categoryUn code ECLASS de n'importe quel niveau, huit chiffres comme 24000000. Il trouve les documents ayant une ligne dans cette classe ou en dessous.
limit, offsetlimit de 1 à 50, 20 par défaut. offset jusqu'à 250.

Lire les résultats

Chaque résultat nomme son document et son fichier, avec les champs montrés plus haut. Un fichier sans document arrive tel quel, avec document_id à null.

  • passages contient jusqu'à cinq passages d'environ 300 caractères chacun, le meilleur d'abord.
  • highlights marque les mots trouvés dans le text d'un passage, en intervalles [start, end).
  • found_by dit si un passage a été trouvé par words, par meaning ou par both.
  • facts liste les faits de la fiche d'un document qui contiennent vos mots.
  • file_url et document_url mènent au fichier et au document dans cette API.

total compte les résultats. Ocost classe les 300 meilleurs, et truncated indique qu'il y en avait plus. Les fichiers supprimés n'apparaissent jamais.

Quand meaning vaut unavailable, la recherche par le sens est en construction ou injoignable. Les mots répondent toujours.

Voir aussi