Recognize

create a request for processing a group of photos images are processed in batches scenes a report is generated for all images in the scene in one scene, there can be photos of different parts of one shelf or photos of several shelves of the same product category images must be pre loaded into the system via /uploads https //docs eyrene com/uploads#ou post uploads or /uploads by url https //docs eyrene com/uploads#or get uploadsid note the number of requests to the point is limited to 100 requests per minute { "tab" "request", "url" "https //instance name/api/v1 5/recognize/", "name" "request example", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "kind" "optional", "name" "images ", "type" "object", "description" "list of strings \nlist of image ids for processing " }, { "kind" "optional", "name" "display", "type" "string", "description" "list of displays id \nthe field is optional, but some report types are not available without the display, e g planogram compliance and must have list " }, { "kind" "optional", "name" "report types", "type" "object", "description" "list of strings \nlist of reports to be generated " }, { "kind" "optional", "name" "visit", "type" "string", "description" "use this field to include images to a previously created visit \nthe field is optional if not specified, a new visit will be created " }, { "kind" "optional", "name" "datetime", "type" "string", "description" "the field is optional if you need to specify the date and time of the visit " }, { "kind" "optional", "name" "webhook", "type" "string", "description" "use webhook to reduce latency if specified, the reports will be sent by post request to this url immediately when ready (one by one) \nthe field is optional if not specified, the client should explicitly poll reports " }, { "kind" "optional", "name" "panorama stack height", "type" "number", "description" "hint to panorama stitching engine, see panorama report " }, { "kind" "optional", "name" "panorama stack width", "type" "number", "description" "hint to panorama stitching engine, see panorama report " }, { "kind" "optional", "name" "counry code", "type" "string", "description" "two character сountry code to specify from which country the sku on the photo eg «ru», «kz» standart iso 3166 (a2) " }, { "kind" "optional", "name" "retail chain", "type" "string", "description" "use retail chain to define retail chain that owns the shop " }, { "kind" "optional", "name" "metadata", "type" "object", "description" "dictionary of additional parameters " }, { "kind" "optional", "name" "metadata/agent id", "type" "string", "description" "agent client id if the agent exists and the name has been changed, it will be updated the created scene will be associated with this agent " }, { "kind" "optional", "name" "metadata/agent name", "type" "string", "description" "agent name used to create or update an agent " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "amstz nwixsb5ys7cnrnf", "code" "{\n \\"id\\" 11234,\n \\"images\\" \[\n 156673,\n 156674,\n 156675,\n 156676\n ],\n \\"display\\" 13,\n \\"scene\\" \\"4d8b66992cd841f6922723afe9bd8cf8\\",\n \\"reports\\" {\n \\"facing count\\" 1786,\n \\"planogram compliance\\" 1789\n }\n}", "language" "201", "customlabel" "" } ], "selectedlanguageid" "amstz nwixsb5ys7cnrnf" }, "examples" { "languages" \[ { "id" "nome199lfcaduhw16wzez", "code" "{\n \\"images\\" \[\n 156673,\n 156674,\n 156675,\n 156676\n ],\n \\"display\\" 13,\n \\"report types\\" \[\n \\"facing count\\",\n \\"planogram compliance\\"\n ],\n \\"country code\\" \\"ru\\",\n \\"metadata\\" {\n \\"agent id\\" 23,\n \\"agent name\\" \\"paul mccartney\\"\n }\n}", "language" "json", "customlabel" "" } ], "selectedlanguageid" "nome199lfcaduhw16wzez" }, "description" "post /recognize", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } in response, the system will return report identifiers the reports can be accessed later using /reports https //help inspector cloud com/en/docs/api/backend/methods/v1 5/reports/reports if a webhook is specified, once the reports are generated, json will be sent to it with a post request 201 { "id" 11234, "images" \[ 156673, 156674, 156675, 156676 ], "display" 13, "reports" { "1786" {// report in json text }, "1786" {// report in json text } } } response parameters ​ https //help inspector cloud com/en/docs/api/backend/methods/v1 5/recognition/recognize#response definitions id string (id) report id images list of strings list of image id's from the request display integer list of display ids reports dictionary report type > report id report id's for the scene scene string uuid created scene id