comp-syn API (1.0.0)

Download OpenAPI specification:Download

E-mail: [email protected] License: Apache 2.0

This is an API for accessing data and analysis generated by the comp-syn python package and the comp-syn group.

Find out more about comp-syn group

search

Access analysis data by query

Find Hits by text matching a query

path Parameters

query

required

string

Examples:

shark - Hits with a `query` field matching this value will be returned
deep+space - Spaces must be replaced with url-encoded %20 character, or +

Text to match

query Parameters

include_in_response	string Default: "colorgram" Enum: "all" "colorgram" "vectors" Which attributes to include in the returned data
filter	string (internal) Extra filter to include in the query in lucene query syntax
size	number [ 1 .. 100 ] Default: 12 Maximum number of hits to return
format	string Default: "json" Enum: "json" "html" Format of response, facilitates a nice browser experience with the API

Responses

Response samples

Content type

application/json

{"hits": [{"query": "string",
"language": "string",
"experiment_name": "string",
"trial_id": "string",
"hostname": "string",
"trial_timestamp": "2019-08-24T14:15:22Z",
"jzazbz_dist": [0,
0,
0,
0,
0,
0,
0,
0
],
"jzazbz_dist_std": [0,
0,
0,
0,
0,
0,
0,
0
],
"rgb_dist": [0,
0,
0,
0,
0,
0,
0,
0
],
"rgb_dist_std": [0,
0,
0,
0,
0,
0,
0,
0
],
"rgb_ratio": [0,
0,
0
],
"rgb_hex": "string",
"jzazbz_wavelet_embedding": [0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"rgb_wavelet_embedding": [0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"grey_wavelet_embedding": [0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"presigned_colorgram_url": "string"
}
]
}

Find Hits by color similarity to a query