Back to welcome page

Aito documentation

This documentation contains a brief introduction to Aito and detailed documentation into Aito's API endpoints and query expressions.

Disclaimer:

The API is in beta phase and it is not frozen yet. We try to avoid changes that break the API compatibility, but we cannot promise full API backward compatibility at this stage.

Contents

1. Getting started

  1. What are the Aito core concepts?
  2. How can I make Aito API requests?
  3. How can I get support and report bugs?

2. The example dataset

This repository contains a sample ecommerce data set that has four tables and a schema for these four tables:

  1. Customers
  2. Products
  3. Impressions
  4. Messages
  5. Schema

This dataset will be used for the example queries

3. Write APIs:

List of Aito write APIs:

  1. Schema
  2. Data

These APIs require READ_WRITE key

4. Query APIs:

List of Aito query APIs:

  1. Search
  2. Similarity
  3. Predict
  4. Match
  5. Recommend
  6. Relate
  7. Query
  8. Evaluate

Each API description contains instructions and examples.

The Query APIs can be used with both READ_WRITE and READ_ONLY keys

6. Query operation and expression documentation:

List of Aito's operations and query expressions:

  1. $&
  2. $and
  3. $asc(GenericQuery)
  4. $asc(Relate)
  5. $context
  6. $defined
  7. $desc(GenericQuery)
  8. $desc(Relate)
  9. $exists
  10. $gt
  11. $gte
  12. $has
  13. $is
  14. $lt
  15. $lte
  16. $match
  17. $mod
  18. $not
  19. $on
  20. $or
  21. $p
  22. $prop
  23. $startsWith
  24. DocumentProposition
  25. EvaluateMatch
  26. EvaluateOperation
  27. EvaluatePredict
  28. EvaluateRecommend
  29. EvaluateSimilarity
  30. From
  31. Get
  32. Hits
  33. OrderBy
  34. PrimitiveProposition
  35. Probability
  36. Proposition
  37. PropositionSet
  38. RelateOrder
  39. Selection
  40. Value