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. $and
  2. $asc(GenericQuery)
  3. $asc(Relate)
  4. $atomic
  5. $context
  6. $defined
  7. $desc(GenericQuery)
  8. $desc(Relate)
  9. $exists
  10. $gt
  11. $gte
  12. $has
  13. $hit
  14. $is
  15. $lift
  16. $lt
  17. $lte
  18. $match
  19. $mod
  20. $multiply
  21. $not
  22. $on
  23. $or
  24. $p
  25. $pow
  26. $similarity
  27. $startsWith
  28. $sum
  29. DocumentProposition
  30. EvaluateMatch
  31. EvaluateOperation
  32. EvaluatePredict
  33. EvaluateRecommend
  34. EvaluateSimilarity
  35. From
  36. Get
  37. Goal
  38. Hits
  39. OrderBy
  40. PlainLift
  41. PlainProbability
  42. PlainSimilarity
  43. PrimitiveProposition
  44. Proposition
  45. PropositionSet
  46. RelateOrder
  47. Score
  48. Selection
  49. Value