GET search_text¶
Given some wine metadata, search against your collection and return all matching images.
Resource URL¶
https://wineengine.tineye.com/<company>/rest/search_text/
Notes¶
The miscellaneous fields and text tokens should be separated using commas.
All names, fields and tokens are combined using an AND operator and used to perform a text search again the whole collection. The collection images containing all these query words are returned.
Parameters¶
In addition to the Common parameters there are:
Key |
Description |
|---|---|
variety (optional) |
The wine variety to search for. |
vintage (optional) |
The wine vintage to search for. |
color (optional) |
The wine color to search for. |
region (optional) |
The wine region to search for. |
country (optional) |
The wine country to search for. |
fields (optional) |
The comma separated miscellaneous wine fields to search for. |
tokens (optional) |
The comma separated text tokens to search for. |
name_filter (optional) |
Return only matches whose names match this filter (see Name Filtering for details). |
path_filter (optional) |
Return only matches whose paths match this filter (see Name Filtering for details). |
offset (optional) |
The offset of results from the start, defaults to 0. |
limit (optional) |
The maximum number of matches that should be returned, defaults to 10. A value of 0 indicates no limit. |
Request examples¶
curl https://wineengine.tineye.com/<company>/rest/search_text/ \
-F "variety=tempranillo" \
-F "vintage=2016" \
-F "fields=sparkling organic"
Response examples¶
JSON¶
{
"method": "search_text",
"status": "ok",
"error": [],
"result": [
{
"filepath": "image01.jpg"
},
{
"filepath": "image02.jpg"
},
{
"filepath": "image03.jpg"
}
],
"stats": {
"total_results": 3,
"total_filtered_results": 3,
"total_returned_results": 3,
"time_search_text": 4.7,
"time_total": 5.04
}
}
XML¶
<?xml version="1.0" encoding="utf-8"?>
<data>
<method>search_text</method>
<status>ok</status>
<error/>
<result>
<item>
<filepath>image01.jpg</filepath>
</item>
<item>
<filepath>image02.jpg</filepath>
</item>
<item>
<filepath>image03.jpg</filepath>
</item>
</result>
<stats>
<total_results>3</total_results>
<total_filtered_results>3</total_filtered_results>
<total_returned_results>3</total_returned_results>
<time_search_text>4.7</time_search_text>
<time_total>5.04</time_total>
</stats>
</data>