Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
engine:7.0:api [2014/04/10 16:54]
alamy [GetApplicationStatus - MODIFY version]
engine:7.0:api [2014/10/24 10:19]
achey [Table]
Line 175: Line 175:
 **Common Parameters** **Common Parameters**
 \\ \\
-^    Parameter ​    ​^ ​                                                                                                                          ​Description ​                                                                                                                           ^ +^    Parameter ​    ​^ ​                                                                                                                           Description ​                                                                                                                           ^ 
-|     ​keywords ​    | Restrict the search to a list of keywords. Images that do not have these keywords will be discarded in the search. It is a list of strings and defaults to an empty list thus not restricting the search. ​                                                                                                                                        ​|+|     ​keywords ​    | Restrict the search to a list of keywords. Images that do not have these keywords will be discarded in the search. It is a list of strings and defaults to an empty list thus not restricting the search. ​                                                        ​|
 |   ​color_weight ​  | Only applicable for //Image Similarity//​ application. //​color_weight//​ defines the importance of color when doing a //​SearchImageByDna//​ or //​SearchImageByUpload//​. Defaults to 50 (balance between color and shape), values are integers in the range [0, 100]  | |   ​color_weight ​  | Only applicable for //Image Similarity//​ application. //​color_weight//​ defines the importance of color when doing a //​SearchImageByDna//​ or //​SearchImageByUpload//​. Defaults to 50 (balance between color and shape), values are integers in the range [0, 100]  |
-|    nb_results ​   | Return at most //​nb_results//​ images no matter how many images actually matched the query image. Max value is 1,000 , defaults to 10                                                                                                                             ​+|    nb_results ​   | Return at most //​nb_results//​ images no matter how many images actually matched the query image. Max value is 1,000 , defaults to 10                                                                                                                              
-|  starting_index ​ | LTU's algorithms being deterministic they will always return images that matched a given query in the same order. //​starting_index//​ allows to get results starting at a specific index. Defaults to 0.                                                          +|  starting_index ​ | LTU's algorithms being deterministic they will always return images that matched a given query in the same order. //​starting_index//​ allows to get results starting at a specific index. Defaults to 0.                                                           ​
-|     ​ids_list ​    | Restrict the search to the //​image_id//​s in this list. It is a string of coma separated //​image_id//​s. Maximum size is 10,​000. ​                                                                                                                                                                                    ​|+|     ​ids_list ​    | Restrict the search to the //​image_id//​s in this list. It is a string of  ​semi-colon ​separated //​image_id//​s. Maximum size is 10,​000. ​                                                                                                                            ​| 
  
  
Line 989: Line 990:
  
  
-==== GetTaskStatus | **DEPRECATED** ==== 
-This method is only used for //​Asynchronous Applications//​ and his is in the interest of completeness. 
- 
-It returns the progress status of an asynchronous task. 
- 
-  * **Request type :​**''​GET''​ 
-  * **Required Parameters** : 
-    * application_key (string): the unique key of the application to query. 
-    * task_id (integer): id of the task as returned by a //​AddImage//​ or //​DeleteImage//​ API call on an //​Asynchronous Application//​. 
-  * **Response**:​ 
-    * status (object): 
-      * message (string): comprehensive message regarding the status of your query 
-      * code (integer): a specific status code, 0 means success 
-    * task_id (integer): id of the task 
-    * task_status (string): describe the state the task is in e.g "​processed"​ 
-    * task_status_code (integer): denote the exact step the task is in 
-    * task_status_message (string): a more in depth description of the task state 
- 
-\\  
-**JSON response** 
-<sxh jscript; title: Sample result> 
-{ 
-  "​status":​ { 
-    "​message":​ "No error",​ 
-    "​code":​ 0 
-  }, 
-  "​task_status":​ "​processed",​ 
-  "​task_status_code":​ 0, 
-  "​task_id":​ 2, 
-  "​task_status_message":​ ""​ 
-} 
-</​sxh>​