Search Documents

APIs

To search for documents in a collection, you can use the following API:

curl -X POST \
  http://localhost:8080/v1/collections/{COLLECTION_ID}/search?api-key=<read_api_key> \
  -H 'Content-Type: application/json' \
  -d '{ "term": "The quick brown fox" }'

The API will return a list of documents that match the search term. The documents will be sorted by relevance, with the most relevant documents appearing first.

Search Parameters

When performing search, you can use a number of parameters to customize the search results:

Where Filters

At index time, OramaCore will index different datatypes in different ways. For example, a string will be indexed differently than a number or a boolean.

When performing a search, you can use the where parameter to filter the search results based on the datatype of the property.

Filtering Numbers

To filter numbers, you can use the following operators:

So a full query complete with a where filter might look like this:

{
  "term": "John Doe",
  "where": {
    "age": {
      "gte": 25
    }
  }
}

Filtering Booleans

To filter booleans, you can use the following operators:

So a full query complete with a where filter might look like this:

{
  "term": "John Doe",
  "where": {
    "is_active": true
  }
}

Facets

OramaCore supports faceted search. You can use the facets parameter to get a list of facets for a given property.

Numeric Facets

The facets parameter can be used to get numeric facets. For example, to get a histogram of the price property, you can use the following query:

{
  "term": "Bluetooth Airbuds",
  "facets": {
    "price": {
      "ranges": [
        { "from": 0, "to": 50 },
        { "from": 50, "to": 100 },
        { "from": 100, "to": 200 },
        { "from": 200, "to": 500 },
        { "from": 500, "to": 1000 },
        { "from": 1000 }
      ]
    }
  }
}

Boolean Facets

The facets parameter can also be used to get boolean facets. For example, to get a list of available values, you can use the following query:

{
  "term": "Bluetooth Airbuds",
  "facets": {
    "available": {
      "true": true,
      "false": false
    }
  }
}