Examples: query, "exact match", wildcard*, wild?ard, wild*rd
Fuzzy search: cake~ (finds cakes, bake)
Term boost: "red velvet"^4, chocolate^2
Field grouping: tags:(+work -"fun-stuff")
Escaping: Escape characters +-&|!(){}[]^"~*?:\ with \, e.g. \+
Range search: properties.timestamp:[1587729413488 TO *] (inclusive), properties.title:{A TO Z}(excluding A and Z)
Combinations: chocolate AND vanilla, chocolate OR vanilla, (chocolate OR vanilla) NOT "vanilla pudding"
Field search: properties.title:"The Title" AND text
Answered
Is There Any Api Reference? Somewhere In The Docs I Can See The Signature Of Methods/Classes And See What Arguments They Accept And Description? Before I'M Rushing To Ask Questions Here Myself, I'D Prefer To Do As Much Learning As I Can Through The Docs

Is there any API reference? Somewhere in the docs I can see the signature of methods/classes and see what arguments they accept and description?

Before I'm rushing to ask questions here myself, I'd prefer to do as much learning as I can through the docs

  
  
Posted 3 years ago
Votes Newest

Answers 4


Hi WackyRabbit7
First always check the functions on the Task object, they are the most straight forward access to the system.
Then if you need general purpose API calls, currently they are only documented in the doc-string of the API schema (that said it should be quite documented)
You can check all the endpoints https://github.com/allegroai/trains/tree/master/trains/backend_api/services/v2_8
And finally if you want to easily use the RestAPI :
from trains.backend_api.session.client import APIClient client = APIClient() client.tasks.get_all(only_field=['id'])This will call the https://github.com/allegroai/trains/blob/master/trains/backend_api/services/v2_8/tasks.py#L4182 endpoint

  
  
Posted 3 years ago

I'm not, just want to be very precise an consice about them when I do ask... but bear with me, its coming 🙂

  
  
Posted 3 years ago

just want to be very precise an concise about them

Always appreciated 🙂

  
  
Posted 3 years ago

Also, don't be shy, we love questions 🙂

  
  
Posted 3 years ago
504 Views
4 Answers
3 years ago
one year ago
Tags