Skip to main content

KeywordSearchResponse

Response schema for keyword/faceted search.

results object[]required

List of matching documents

  • Array [
  • entry_idEntry Id (integer)required

    Entry ID

    dataset_idDataset Id (integer)required

    Dataset ID

    nameName (string)required

    Entry name

    titleTitle (string)required

    Document title

    descriptionDescription (string)required

    Document description

    scoreScore (number)required

    Meilisearch ranking score

    highlighted object

    Highlighted matching terms (fields with tags)

    property name*any

    Highlighted matching terms (fields with tags)

    metadata object

    Additional metadata (mime_type, status, tags, created_at, etc.)

    property name*any

    Additional metadata (mime_type, status, tags, created_at, etc.)

  • ]
  • totalTotal (integer)required

    Estimated total number of matching documents

    query_info object

    Query metadata (query, filters applied, execution time, etc.)

    property name*any

    Query metadata (query, filters applied, execution time, etc.)

    KeywordSearchResponse
    {
    "results": [
    {
    "entry_id": 0,
    "dataset_id": 0,
    "name": "string",
    "title": "string",
    "description": "string",
    "score": 0,
    "highlighted": {},
    "metadata": {}
    }
    ],
    "total": 0,
    "query_info": {}
    }