{"info":{"_postman_id":"f944d66a-94ac-4804-9db6-b816755170a4","name":"JAI","description":"

The easiest way for developers to build, deploy and consume AI applications.

$\"\"$

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"11432617","collectionId":"f944d66a-94ac-4804-9db6-b816755170a4","publishedId":"UVJcmxB1","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"fa5f1e"},"publishDate":"2021-11-29T16:59:48.000Z"},"item":[{"name":"Authentication","item":[{"name":"Get Auth Key","id":"fd794dbb-950a-411a-8a62-3767765829fb","request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"company\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://mycelia.azure-api.net/auth","description":"

Use this method to generate your free-forever JAI auth-key. Please note that the key will be sent to your e-mail, so please be sure to use a valid one and check your spam/junk inbox.

\n","urlObject":{"path":["auth"],"host":["https://mycelia.azure-api.net"],"query":[],"variable":[]}},"response":[{"id":"6b141319-51a9-41f3-bc82-6649145e27bb","name":"Successful Response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: apikey","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"company\": \"string\",\n}","options":{"raw":{"language":"json"}}},"url":"https://mycelia.azure-api.net/auth"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"b9e21284-e04b-4c34-87af-b83d8cce9aec","name":"Not found","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: apikey","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"company\": \"string\",\n}","options":{"raw":{"language":"json"}}},"url":"https://mycelia.azure-api.net/auth"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"b09290f9-837b-42a3-bc88-d76ce6bbfaed","name":"Validation Error","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: apikey","key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"company\": \"string\",\n}","options":{"raw":{"language":"json"}}},"url":"https://mycelia.azure-api.net/auth"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}"}],"_postman_id":"fd794dbb-950a-411a-8a62-3767765829fb"}],"id":"2d45e8e1-c009-4fc5-b2e5-7bb92f9a3577","_postman_id":"2d45e8e1-c009-4fc5-b2e5-7bb92f9a3577","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"f944d66a-94ac-4804-9db6-b816755170a4","id":"f944d66a-94ac-4804-9db6-b816755170a4","name":"JAI","type":"collection"}}},{"name":"Collection Creation","item":[{"name":"Insert Data","id":"04a7ceb6-db7f-4e30-b4e3-eb4e2f6202b7","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"id\": 0,\n \"col_name_0\": \"value_0_0\",\n \"col_name_1\": \"value_0_1\",\n \"col_name_2\": 0\n },\n {\n \"id\": 1,\n \"col_name_0\": \"value_1_0\",\n \"col_name_1\": \"value_1_1\",\n \"col_name_2\": 1\n },\n {\n \"id\": 2,\n \"col_name_0\": \"value_2_0\",\n \"col_name_1\": \"value_2_1\",\n \"col_name_2\": 2\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://mycelia.azure-api.net/data/:db_name?filter_name=filter_name","description":"

Description

General purpose data insertion method. You can insert tabular, image or text data
using this method. Please refer to the examples below to check how to format your
JSON file.

JAI does not keep any raw data that is sent. This method is only a convenience buffer, that gets automatically cleaned after some time

Please note that JAI collections are always pairs of (id, vector), so:

It is always mandatory to send an unique id attribute per data (table row, text or image). The id's will be the only reference for data queries. JAI will never return any raw data. Ever.
JAI doesn't allows duplicated ids
There is no auto-increment functionality. The developer is responsible for assigning unique id's for the data. Please refer to the Get Ids method for querying the ids already inserted into the collection.

Parameters

db_name string
Database name to perform the insertion in.

Request body

Inserting Table Data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

id	col_name_0	col_name_1
0	value_0_0	value_0_1
1	value_1_0	value_1_1
2	value_2_0	value_2_1

Please note that:

Each table's entire row will be converted into a vector representation via SelfSupervised Learning.
Table's fields can be strings, integers, floats
Strings will not be automatically converted into semantic representations. By entering strings directly into the table and performing the JAI Setup, it is assumed that text data is \"purely categorical\" and will have it's representation learned as a categorical embedding.
If the intention is to extract semantics from text data and then relate it to other attributes, please refer to the usage of the attribute pretrained_bases on the Setup method to create a relationship between collections.
NaNs will be treated internally
Input ID.

id integer

column_name string

column_fields string, int, float, tuples

Example

[\n    {\n        \"id\": 0,\n        \"col_name_0\": \"value_0_0\",\n        \"col_name_1\": \"value_0_1\",\n        \"col_name_2\": 0\n    },\n    {\n        \"id\": 1,\n        \"col_name_0\": \"value_1_0\",\n        \"col_name_1\": \"value_1_1\",\n        \"col_name_2\": 1\n    },\n    {\n        \"id\": 2,\n        \"col_name_0\": \"value_2_0\",\n        \"col_name_1\": \"value_2_1\",\n        \"col_name_2\": 2\n    }\n]\n\n

Inserting Image Data

In order to insert Image data, it is needed to first convert it into base64 encoding, so it can be JSON serializable.

Each image should be associated with a corresponding unique id.

id integer

image_base64 string (Base64 encoded image)

Example

[\n    {\n        \"id\": 0,\n        \"image_base64\": b\"xArktjUotnNbjd...\",\n    },\n    {\n        \"id\": 1,\n        \"image_base64\": b\"tBtLO9083Xggry...\",\n    },\n]\n\n

Inserting Text Data

Each text should be associated with a corresponding unique id.

id integer

text string

Example

[\n    {\n        \"id\": 0,\n        \"text\": \"Lorem ipsum dolor caterva sit amet\",\n    },\n    {\n        \"id\": 1,\n        \"text\": \"Ut obtuso ad parvo veniam\",\n    },\n]\n\n

Returns

string Insertion message.

Column name used as filter.

\n","type":"text/plain"},"key":"filter_name","value":"filter_name"}],"variable":[{"description":{"content":"

(Required) Database name

\n","type":"text/plain"},"type":"any","value":"collection_name","key":"db_name"}]}},"response":[{"id":"5be096c1-3f9f-4f64-a830-31ca3defc310","name":"Successful Response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"id\": 0,\n \"col_name_0\": \"value_0_0\",\n \"col_name_1\": \"value_0_1\",\n \"col_name_2\": 0\n },\n {\n \"id\": 1,\n \"col_name_0\": \"value_1_0\",\n \"col_name_1\": \"value_1_1\",\n \"col_name_2\": 1\n },\n {\n \"id\": 2,\n \"col_name_0\": \"value_2_0\",\n \"col_name_1\": \"value_2_1\",\n \"col_name_2\": 2\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mycelia.azure-api.net/data/:db_name?filter_name=filter_name","host":["https://mycelia.azure-api.net"],"path":["data",":db_name"],"query":[{"key":"filter_name","value":"filter_name"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"019bad6e-b93b-4cd9-8160-23a2f937d76e","name":"Not found","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"id\": 0,\n \"col_name_0\": \"value_0_0\",\n \"col_name_1\": \"value_0_1\",\n \"col_name_2\": 0\n },\n {\n \"id\": 1,\n \"col_name_0\": \"value_1_0\",\n \"col_name_1\": \"value_1_1\",\n \"col_name_2\": 1\n },\n {\n \"id\": 2,\n \"col_name_0\": \"value_2_0\",\n \"col_name_1\": \"value_2_1\",\n \"col_name_2\": 2\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mycelia.azure-api.net/data/:db_name?filter_name=filter_name","host":["https://mycelia.azure-api.net"],"path":["data",":db_name"],"query":[{"key":"filter_name","value":"filter_name"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"b1b64a7e-a939-4fb3-816e-d9676e21c20a","name":"Validation Error","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"id\": 0,\n \"col_name_0\": \"value_0_0\",\n \"col_name_1\": \"value_0_1\",\n \"col_name_2\": 0\n },\n {\n \"id\": 1,\n \"col_name_0\": \"value_1_0\",\n \"col_name_1\": \"value_1_1\",\n \"col_name_2\": 1\n },\n {\n \"id\": 2,\n \"col_name_0\": \"value_2_0\",\n \"col_name_1\": \"value_2_1\",\n \"col_name_2\": 2\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mycelia.azure-api.net/data/:db_name?filter_name=filter_name","host":["https://mycelia.azure-api.net"],"path":["data",":db_name"],"query":[{"key":"filter_name","value":"filter_name"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}"}],"_postman_id":"04a7ceb6-db7f-4e30-b4e3-eb4e2f6202b7"},{"name":"Check Inserted Data","id":"53fa171b-0bff-431b-93f2-5b234a5f0c9c","request":{"method":"GET","header":[],"url":"https://mycelia.azure-api.net/setup/ids/:db_name?mode=simple","description":"

Description

Get the IDs of data inserted with POST https://mycelia.azure-api.net/data/{db_name}.
\nThis method should be used when we insert new data using POST https://mycelia.azure-api.net/data/{db_name} and want to\ncheck the IDs of the newly inserted data.

Parameters

db_name string
Database name to check the inserted data.

mode IdReport, optional
Response mode of IDs. We have three options:

complete: get ALL IDs.
summarized: get groups of consecutive IDs.
simple: get the number of IDs and their min and max IDs as well.\n

Returns

list Integers or strings depending on the mode parameter.

Detail of response expected

\n","type":"text/plain"},"key":"mode","value":"simple"}],"variable":[{"description":{"content":"

(Required) Database name

\n","type":"text/plain"},"type":"any","value":"collection_name","key":"db_name"}]}},"response":[{"id":"c954640b-6a48-47f7-834c-fc7888896842","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/setup/ids/:db_name?mode=simple","host":["https://mycelia.azure-api.net"],"path":["setup","ids",":db_name"],"query":[{"key":"mode","value":"simple"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"0f82c73c-0af6-49e7-9c59-321192a7fcd3","name":"Not found","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/setup/ids/:db_name?mode=simple","host":["https://mycelia.azure-api.net"],"path":["setup","ids",":db_name"],"query":[{"key":"mode","value":"simple"}],"variable":[{"key":"db_name","value":"ea occaeca","description":"(Required) Database name"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"eecc7b19-8aa6-4740-a86b-37b790bfd739","name":"Validation Error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/setup/ids/:db_name?mode=simple","host":["https://mycelia.azure-api.net"],"path":["setup","ids",":db_name"],"query":[{"key":"mode","value":"simple"}],"variable":[{"key":"db_name","value":"ea occaeca","description":"(Required) Database name"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}"}],"_postman_id":"53fa171b-0bff-431b-93f2-5b234a5f0c9c"},{"name":"Delete Data","id":"2d9cf230-b4d0-41bd-8a80-984c8a3597bd","request":{"method":"DELETE","header":[],"url":"https://mycelia.azure-api.net/data/:db_name","description":"

Description

Delete all raw data relative to a specified database.

Parameters

db_name string
Database name we want to delete.

Returns

Deletion status message.

(Required) Database name

\n","type":"text/plain"},"type":"any","value":"collection_name","key":"db_name"}]}},"response":[{"id":"a800af75-f9f0-4337-9cf4-24966279f9e7","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/data/:db_name","host":["https://mycelia.azure-api.net"],"path":["data",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"string\""},{"id":"a7ab20c1-02d5-45a9-a446-5d7350e138c0","name":"Not found","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/data/:db_name","host":["https://mycelia.azure-api.net"],"path":["data",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"5ff008a6-08dc-4847-9281-20684b2da37e","name":"Validation Error","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/data/:db_name","host":["https://mycelia.azure-api.net"],"path":["data",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}"}],"_postman_id":"2d9cf230-b4d0-41bd-8a80-984c8a3597bd"},{"name":"Setup Database","id":"ac5f88ae-2b1a-4b14-a131-ccdf431e2994","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"db_type\": \"Image\",\n \"hyperparams\": {},\n \"num_process\": {\n \"embedding_dim\": 8,\n \"scaler\": \"standard\",\n \"fill_value\": 0\n },\n \"cat_process\": {\n \"embedding_dim\": 32,\n \"fill_value\": \"_other\",\n \"min_freq\": 3\n },\n \"datetime_process\": {\n \"embedding_dim\": 32\n },\n \"features\": {},\n \"mycelia_bases\": [\n {\n \"db_parent\": \"string\",\n \"id_name\": \"string\",\n \"embedding_dim\": 128,\n \"aggregation_method\": \"sum\"\n }\n ],\n \"label\": {\n \"task\": \"classification\",\n \"label_name\": \"string\",\n \"quantiles\": [\n 0\n ]\n },\n \"split\": {\n \"type\": \"random\",\n \"split_column\": \"\",\n \"test_size\": 0.2,\n \"gap\": 0\n },\n \"callback_url\": \"https://gJtOBGQXmhcwkZqQfhnSnvLaTijpu.mfHxJ8szLwcMA\"\n}","options":{"raw":{"language":"json"}}},"url":"https://mycelia.azure-api.net/setup/:db_name?quick_test=false&overwrite=false","description":"

Description

General purpose data setup method. This is the method to train models for\ntabular, text or image data. \n

Parameters

db_name string
Database name to perform the insertion in.

Request body

Attributes - Mandatory

\ndb_type string
\nYou have to specify your database type. Possible values are: Supervised, selfsupervised, Image, Text and FastText.

\nlabel string
\nMandatory only when your database type is \"Supervised\".
\n\"label_name\": column name for your label.
\n\"task\": possible values are \"classification\", \"metric_classification\" and \"regression\"

Attributes - Optional

\nhyperparams dictionary
\nHyperparams for the model. It varies for each database type defined.
\nWhen your database type is \"Image\":

\"model_name\": (torchvision) model for image preprocessing.

\"mode\": last layer of the model, varies for each model.

\"resize_H\": height of image resizing, must be greater or equal to 224, default is 224.
\n\"resize_W\": width of image resizing, must be greater or equal to 224, default is 224.
\nWhen your database type is \"FastText\":
\n\"minn\": min length of char ngram, default is 2.

\"maxn\": max length of char ngram, default is 5.

\"dim\": final latent layer dimension, default is 128.
\n\"epoch\": number of epochs, default is 10.
\nWhen your database type is \"Text\":
\n\"nlp_model\": (transformers) model name for text preprocessing.
\n\"batch_size\": 256, desciption='batch size for training, default is 256.
\n\"max_length\": Controls the maximum length to use by one of the truncation/padding parameters, default is 100.
\nWhen your database type is \"Supervised\" or \"SelfSupervised\":
\n\"batch_size\": batch size for training, default is 512.
\n\"dropout_rate\": dropout rate, default is 0.25.
\n\"learning_rate\": initial learning rate, default is 0.001.
\n\"encoder_layer\": possible values are \"2L\".
\n\"decoder_layer\": possible values are \"2L\", \"2L_BN\" and \"1L\"
\n\"hidden_latent_dim\": hidden layer size, default is 64.
\n\"patience\": Number of validation checks with no improvement after which training will be stopped. Default is 7.
\n\"min_delta\": Minimum change in the monitored quantity (loss) to qualify as an improvement, i.e. an absolute change of less than min_delta, will count as no improvement. Default is 1e-5.

num_process dictionary
\nNumerical processing details, should you want custom preprocessing.

cat_process dictionary
\nCategorical processing details, should you want custom preprocessing.

datetime_process dictionary
\nDatetime processing details, should you want custom preprocessing.

features dictionary
\nA dictionary with column names as keys, unspecified columns will follow the num_process, cat_process or datetime_process.
\nThe values of the dictionary are dictionaries with:
\n\"dtype\": possible values are \"int32\", \"int64\", \"float32\", \"float64\", \"category\" or \"datetime\".
\n\"embedding_dim\": size of the first embedding layer.
\n\"fill_value\": value to fill nans for dtype numerical/category.
\n\"scaler\": optional, for dtype numerical.
\n\"min_freq\": categories with less than that will be discarted, for dtype category.

mycelia_bases list of dictionaries
\nWhether or not the current table references another table previously processed by Mycelia.

split dictionary
\nHow to split your training data.
\n\"type\": possible values are \"random\", \"sequential\" or \"stratified\".
\n\"split_column\": if \"type\" is \"sequential\", indicates which column should be used for splitting. If type is \"stratified\", you must pass the label name.
\n\"test_size\": integer between 0 and 1 stating the percentage of data to use for testing.

callback_url string
\nIn case a callback URL is set in place.

Example - General case, except for Supervised

    {\n        \"db_type\": \"SelfSupervised\"\n    }\n

Example - Supervised

    {\n        \"db_type\": \"Supervised\",\n        \"label\": {\n            \"task\": \"classification\",\n            \"label_name\": \"my_label\"\n        }\n    }\n

Returns

string Message stating training is ongoing.

(Required) Database name

\n","type":"text/plain"},"type":"any","value":"ea occaeca","key":"db_name"}]}},"response":[{"id":"9fb17caf-c093-4ea7-a6fa-23db60082cb5","name":"Successful Response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"db_type\": \"Image\",\n \"hyperparams\": {},\n \"num_process\": {\n \"embedding_dim\": 8,\n \"scaler\": \"standard\",\n \"fill_value\": 0\n },\n \"cat_process\": {\n \"embedding_dim\": 32,\n \"fill_value\": \"_other\",\n \"min_freq\": 3\n },\n \"datetime_process\": {\n \"embedding_dim\": 32\n },\n \"features\": {},\n \"mycelia_bases\": [\n {\n \"db_parent\": \"string\",\n \"id_name\": \"string\",\n \"embedding_dim\": 128,\n \"aggregation_method\": \"sum\"\n }\n ],\n \"label\": {\n \"task\": \"classification\",\n \"label_name\": \"string\",\n \"quantiles\": [\n 0\n ]\n },\n \"split\": {\n \"type\": \"random\",\n \"split_column\": \"\",\n \"test_size\": 0.2,\n \"gap\": 0\n },\n \"callback_url\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mycelia.azure-api.net/setup/:db_name?quick_test=false&overwrite=false","host":["https://mycelia.azure-api.net"],"path":["setup",":db_name"],"query":[{"key":"quick_test","value":"false"},{"key":"overwrite","value":"false"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"c2d97db6-8446-4f5c-87a3-05919eec8f69","name":"Not found","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"db_type\": \"Image\",\n \"hyperparams\": {},\n \"num_process\": {\n \"embedding_dim\": 8,\n \"scaler\": \"standard\",\n \"fill_value\": 0\n },\n \"cat_process\": {\n \"embedding_dim\": 32,\n \"fill_value\": \"_other\",\n \"min_freq\": 3\n },\n \"datetime_process\": {\n \"embedding_dim\": 32\n },\n \"features\": {},\n \"mycelia_bases\": [\n {\n \"db_parent\": \"string\",\n \"id_name\": \"string\",\n \"embedding_dim\": 128,\n \"aggregation_method\": \"sum\"\n }\n ],\n \"label\": {\n \"task\": \"classification\",\n \"label_name\": \"string\",\n \"quantiles\": [\n 0\n ]\n },\n \"split\": {\n \"type\": \"random\",\n \"split_column\": \"\",\n \"test_size\": 0.2,\n \"gap\": 0\n },\n \"callback_url\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mycelia.azure-api.net/setup/:db_name?quick_test=false&overwrite=false","host":["https://mycelia.azure-api.net"],"path":["setup",":db_name"],"query":[{"key":"quick_test","value":"false"},{"key":"overwrite","value":"false"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"9c19c281-9591-4285-94dd-04d4a30fd8b3","name":"Validation Error","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"db_type\": \"Image\",\n \"hyperparams\": {},\n \"num_process\": {\n \"embedding_dim\": 8,\n \"scaler\": \"standard\",\n \"fill_value\": 0\n },\n \"cat_process\": {\n \"embedding_dim\": 32,\n \"fill_value\": \"_other\",\n \"min_freq\": 3\n },\n \"datetime_process\": {\n \"embedding_dim\": 32\n },\n \"features\": {},\n \"mycelia_bases\": [\n {\n \"db_parent\": \"string\",\n \"id_name\": \"string\",\n \"embedding_dim\": 128,\n \"aggregation_method\": \"sum\"\n }\n ],\n \"label\": {\n \"task\": \"classification\",\n \"label_name\": \"string\",\n \"quantiles\": [\n 0\n ]\n },\n \"split\": {\n \"type\": \"random\",\n \"split_column\": \"\",\n \"test_size\": 0.2,\n \"gap\": 0\n },\n \"callback_url\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mycelia.azure-api.net/setup/:db_name?quick_test=false&overwrite=false","host":["https://mycelia.azure-api.net"],"path":["setup",":db_name"],"query":[{"key":"quick_test","value":"false"},{"key":"overwrite","value":"false"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}"}],"variable":[{"id":"0b67ded4-6dd6-47a4-828c-3e7512a571cd","key":"db_name","value":"ea occaeca","type":"any","description":"(Required) Database name"}],"_postman_id":"ac5f88ae-2b1a-4b14-a131-ccdf431e2994"},{"name":"Set Interruption","id":"caab1662-e18f-4164-a37d-afdb93cd309a","request":{"method":"POST","header":[],"url":"https://mycelia.azure-api.net/cancel/:db_name","description":"

Set Interruption

(Required) Database name

\n","type":"text/plain"},"type":"any","value":"collection_name","key":"db_name"}]}},"response":[{"id":"6f4999a5-ff50-4e54-ab49-1dc8f4cbd255","name":"Successful Response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/cancel/:db_name","host":["https://mycelia.azure-api.net"],"path":["cancel",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"7b9bff91-a225-4bfc-8d1e-1edf8e9957a2","name":"Not found","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/cancel/:db_name","host":["https://mycelia.azure-api.net"],"path":["cancel",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"a5317ce5-1dbb-4a50-9901-e33a9bea81b3","name":"Validation Error","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/cancel/:db_name","host":["https://mycelia.azure-api.net"],"path":["cancel",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}"}],"_postman_id":"caab1662-e18f-4164-a37d-afdb93cd309a"}],"id":"13822590-6283-49f0-9c88-8f3f2e835e41","description":"

This set of APIs are used to create collections inside JAI.

Every time you run a JAI Setup API call, a new vector collection is generated either through a new trained model or via feature-extraction of a pre-trained model

The expected usage flow is:

Add your raw data using Insert Data
Check that the data has been correctly inserted using Check Inserted Data
You can always delete the raw data inserted by using Delete Data
Run Setup Database to start the model training/feature extraction and create your JAI collection
If for some reason you need to interrupt the process started in 4, run Set Interruption

\n","_postman_id":"13822590-6283-49f0-9c88-8f3f2e835e41","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"f944d66a-94ac-4804-9db6-b816755170a4","id":"f944d66a-94ac-4804-9db6-b816755170a4","name":"JAI","type":"collection"}}},{"name":"Similarity Search","item":[{"name":"Search by ID","id":"44fc5018-d692-4a2a-b93c-860b940c9300","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Origin","value":"http://localhost","type":"text"}],"body":{"mode":"raw","raw":"[\n 10000\n]","options":{"raw":{"language":"json"}}},"url":"https://mycelia.azure-api.net/similar/id/:db_name?top_k=5","description":"

Description

Perform ID similarity search in the vector representations of a database.

Parameters

db_name string
Database name to perform similarity search operation.

id list
IDs to search for the most similar vectors.

top_k int (optional)
Number of similar vectors to return for each ID. Default is 5.

Returns

dictionary Return top_k IDs and and distances of the most similar IDs to each ID passed as input.

Example

{\n    \"similarity\":[\n        {\n            \"query_id\": 0,\n            \"results\": [\n                {\n                    \"id\": 0,\n                    \"distance\": 0\n                },\n                {\n                    \"id\": 1,\n                    \"distance\": 1\n                }\n            ]\n        },\n        {\n            \"query_id\": 1,\n            \"results\": [\n                {\n                    \"id\": 2,\n                    \"distance\": 0\n                },\n                {\n                    \"id\": 3,\n                    \"distance\": 1\n                }\n            ]\n        }\n    ]\n}\n\n

Number of alikes to return

\n","type":"text/plain"},"key":"top_k","value":"5"}],"variable":[{"description":{"content":"

(Required) Database name

\n","type":"text/plain"},"type":"any","value":"fashion_products","key":"db_name"}]}},"response":[{"id":"15023bf8-e31a-4b4a-987c-1ef18286c3b1","name":"Successful Response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n 0\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mycelia.azure-api.net/similar/id/:db_name?top_k=5","host":["https://mycelia.azure-api.net"],"path":["similar","id",":db_name"],"query":[{"key":"top_k","value":"5"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"similarity\": [\n {\n \"query_id\": 0,\n \"results\": [\n {\n \"id\": 0,\n \"distance\": 0\n }\n ]\n }\n ]\n}"},{"id":"ba91ece2-ff2f-4ef7-905c-21e35f2571f2","name":"Not found","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"body":{"mode":"raw","raw":"[\n 0\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mycelia.azure-api.net/similar/id/:db_name?top_k=5","host":["https://mycelia.azure-api.net"],"path":["similar","id",":db_name"],"query":[{"key":"top_k","value":"5"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"2d9c2a54-bce3-4197-9837-971689b3a8aa","name":"Validation Error","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"body":{"mode":"raw","raw":"[\n 0\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mycelia.azure-api.net/similar/id/:db_name?top_k=5","host":["https://mycelia.azure-api.net"],"path":["similar","id",":db_name"],"query":[{"key":"top_k","value":"5"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}"}],"_postman_id":"44fc5018-d692-4a2a-b93c-860b940c9300"},{"name":"Search by ID","id":"28ec79e7-99f4-4d47-954d-06f8d3ff763c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://mycelia.azure-api.net/similar/id/:db_name?id=0&top_k=5","description":"

Description

Perform ID similarity search in the vector representations of a database.

Parameters

db_name string
Database name to perform similarity search operation.

id list
IDs to search for the most similar vectors.

top_k int (optional)
Number of similar vectors to return for each ID. Default is 5.

Returns

dictionary Return top_k IDs and and distances of the most similar IDs to each ID passed as input.

Example

{\n    \"similarity\":[\n        {\n            \"query_id\": 0,\n            \"results\": [\n                {\n                    \"id\": 0,\n                    \"distance\": 0\n                },\n                {\n                    \"id\": 1,\n                    \"distance\": 1\n                }\n            ]\n        },\n        {\n            \"query_id\": 1,\n            \"results\": [\n                {\n                    \"id\": 2,\n                    \"distance\": 0\n                },\n                {\n                    \"id\": 3,\n                    \"distance\": 1\n                }\n            ]\n        }\n    ]\n}\n\n

(Required) Database name

\n","type":"text/plain"},"type":"any","value":"ea occaeca","key":"db_name"}]}},"response":[{"id":"cbb80db3-ece1-41ac-bfd5-b81f85925acf","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/similar/id/:db_name?id=0&top_k=5","host":["https://mycelia.azure-api.net"],"path":["similar","id",":db_name"],"query":[{"key":"id","value":"0"},{"key":"top_k","value":"5"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"similarity\": [\n {\n \"query_id\": 0,\n \"results\": [\n {\n \"id\": 0,\n \"distance\": 0\n }\n ]\n }\n ]\n}"},{"id":"e304630d-6c74-461a-8b7a-7b2cf83eb781","name":"Not found","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/similar/id/:db_name?id=0&top_k=5","host":["https://mycelia.azure-api.net"],"path":["similar","id",":db_name"],"query":[{"key":"id","value":"0"},{"key":"top_k","value":"5"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"20ecb1ce-2aa3-40cf-afa1-c26622515c13","name":"Validation Error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/similar/id/:db_name?id=0&top_k=5","host":["https://mycelia.azure-api.net"],"path":["similar","id",":db_name"],"query":[{"key":"id","value":"0"},{"key":"top_k","value":"5"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}"}],"variable":[{"id":"c1c84014-4d39-44e9-9d2f-2ff061031c4b","key":"db_name","value":"ea occaeca","type":"any","description":"(Required) Database name"}],"_postman_id":"28ec79e7-99f4-4d47-954d-06f8d3ff763c"},{"name":"Search by Data","id":"9a79a098-5eec-4098-9814-c3de49ac6aa1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"id\": 1,\n \"Time\": 0.0976,\n \"V1\": 0.0206,\n \"V2\": 0.0792,\n \"V3\": 0.0213,\n \"V4\": 0.0206,\n \"V5\": 0.0792,\n \"V6\": 0.0213,\n \"V7\": 0.0973,\n \"V8\": 0.1150,\n \"V9\": 0.0410,\n \"V10\": 0.0827,\n \"V11\": 0.0206,\n \"V12\": 0.0792,\n \"V13\": 0.0213,\n \"V14\": 0.0206,\n \"V15\": 0.0792,\n \"V16\": 0.0213,\n \"V17\": 0.0973,\n \"V18\": 0.1150,\n \"V19\": 0.0410,\n \"V20\": 0.0827,\n \"V21\": 0.0973,\n \"V22\": 0.1150,\n \"V23\": 0.0410,\n \"V24\": 0.0827,\n \"V25\": 0.1143,\n \"V26\": 0.0706,\n \"V27\": 0.0556,\n \"V28\": 0.0739,\n \"Amount\": 0.0272\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://mycelia.azure-api.net/similar/data/:db_name?top_k=5","description":"

Description

Perform data similarity search in the vector representations of a database.

Parameters

db_name string
Database name to perform similarity search operation.

data list
Data to process and search for the most similar vectors .

top_k int (optional)
Number of similar vectors to return for each ID. Default is 5.

Returns

dictionary Return top_k IDs and and distances of the most similar IDs to each ID passed as input.

Example

{\n    \"similarity\":[\n        {\n            \"query_id\": 0,\n            \"results\": [\n                {\n                    \"id\": 0,\n                    \"distance\": 0\n                },\n                {\n                    \"id\": 1,\n                    \"distance\": 1\n                }\n            ]\n        },\n        {\n            \"query_id\": 1,\n            \"results\": [\n                {\n                    \"id\": 2,\n                    \"distance\": 0\n                },\n                {\n                    \"id\": 3,\n                    \"distance\": 1\n                }\n            ]\n        }\n    ]\n}\n\n

Number of alikes to return

\n","type":"text/plain"},"key":"top_k","value":"5"}],"variable":[{"description":{"content":"

(Required) Database name

\n","type":"text/plain"},"type":"any","value":"cc_fraud_supervised","key":"db_name"}]}},"response":[{"id":"1afaaa33-0b71-4b7e-bf2f-1c88cb5f4aef","name":"Successful Response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {}\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mycelia.azure-api.net/similar/data/:db_name?top_k=5","host":["https://mycelia.azure-api.net"],"path":["similar","data",":db_name"],"query":[{"key":"top_k","value":"5"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"similarity\": [\n {\n \"query_id\": 0,\n \"results\": [\n {\n \"id\": 0,\n \"distance\": 0\n }\n ]\n }\n ]\n}"},{"id":"5b12db4a-5e18-49f0-b2cd-1c157cdf6c2b","name":"Not found","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"body":{"mode":"raw","raw":"[\n {}\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mycelia.azure-api.net/similar/data/:db_name?top_k=5","host":["https://mycelia.azure-api.net"],"path":["similar","data",":db_name"],"query":[{"key":"top_k","value":"5"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"b146cc2d-be30-4243-a71d-810b7537eb87","name":"Validation Error","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"body":{"mode":"raw","raw":"[\n {}\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mycelia.azure-api.net/similar/data/:db_name?top_k=5","host":["https://mycelia.azure-api.net"],"path":["similar","data",":db_name"],"query":[{"key":"top_k","value":"5"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}"}],"_postman_id":"9a79a098-5eec-4098-9814-c3de49ac6aa1"}],"id":"7752dc92-4330-4423-91e4-03ad75d5abc1","_postman_id":"7752dc92-4330-4423-91e4-03ad75d5abc1","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"f944d66a-94ac-4804-9db6-b816755170a4","id":"f944d66a-94ac-4804-9db6-b816755170a4","name":"JAI","type":"collection"}}},{"name":"Model Inference","item":[{"name":"Predict","id":"9450e18e-0d81-4fd3-a988-c1a49cf16ff4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"id\":0,\"productdisplayname\":\"ray-ban glasses\"}]","options":{"raw":{"language":"json"}}},"url":"https://mycelia.azure-api.net/predict/:db_name?predict_proba=false","description":"

Description

Return the predict of the supervised model.

Parameters

db_name string
Database name of the supervised model.

data list
Data to process and search for the most similar vectors.

Returns

list Return a list of dictionaries with keys \"id\" and \"predict\".

}\n```

returns the probability of the predicts (if model is classification)

\n","type":"text/plain"},"key":"predict_proba","value":"false"}],"variable":[{"description":{"content":"

(Required) Database name

\n","type":"text/plain"},"type":"any","value":"articletype_sup","key":"db_name"}]}},"response":[{"id":"63e35ddc-eadc-4345-b9b6-7bebe788c191","name":"Successful Response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {}\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mycelia.azure-api.net/predict/:db_name?predict_proba=false","host":["https://mycelia.azure-api.net"],"path":["predict",":db_name"],"query":[{"key":"predict_proba","value":"false"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 0,\n \"predict\": {}\n }\n]"},{"id":"adeb3446-542a-49c6-bb22-9e745e9e1935","name":"Not found","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"body":{"mode":"raw","raw":"[\n {}\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mycelia.azure-api.net/predict/:db_name?predict_proba=false","host":["https://mycelia.azure-api.net"],"path":["predict",":db_name"],"query":[{"key":"predict_proba","value":"false"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"87103afa-7e9a-4a44-9ba6-de1a015a40ca","name":"Validation Error","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"body":{"mode":"raw","raw":"[\n {}\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mycelia.azure-api.net/predict/:db_name?predict_proba=false","host":["https://mycelia.azure-api.net"],"path":["predict",":db_name"],"query":[{"key":"predict_proba","value":"false"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}"}],"_postman_id":"9450e18e-0d81-4fd3-a988-c1a49cf16ff4"}],"id":"4eee2ec4-4173-4923-bc4c-918f6a9a7517","_postman_id":"4eee2ec4-4173-4923-bc4c-918f6a9a7517","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"f944d66a-94ac-4804-9db6-b816755170a4","id":"f944d66a-94ac-4804-9db6-b816755170a4","name":"JAI","type":"collection"}}},{"name":"Collection Management","item":[{"name":"Get Database Info","id":"766da877-b4ca-49cb-94da-eeff62160e3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://mycelia.azure-api.net/info?mode=complete&get_size=true","description":"

Description

Get information of all databases in your Mycelia environment.

Parameters

mode DatabaseInfo (optional)
Response mode of IDs. We have three options:

complete: get database names and types.
names: get database names only.
\n

Returns

list Databases names in your Mycelia environment.

Detail of response expected

\n","type":"text/plain"},"key":"mode","value":"complete"},{"key":"get_size","value":"true"}],"variable":[]}},"response":[{"id":"d5d58ff7-815d-487c-9a00-31784054dabd","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/info?mode=complete&get_size=true","host":["https://mycelia.azure-api.net"],"path":["info"],"query":[{"key":"mode","value":"complete"},{"key":"get_size","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"db_name\": \"\",\n \"db_type\": \"\",\n \"db_version\": \"\",\n \"db_parents\": [],\n \"size\": 0\n }\n]"},{"id":"84e738ca-e8d2-4715-a179-d53844259c4e","name":"Not found","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/info?mode=collection_name&get_size=false","host":["https://mycelia.azure-api.net"],"path":["info"],"query":[{"key":"mode","value":"collection_name"},{"key":"get_size","value":"false"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"ae376816-2c6a-4d33-8a19-69799cb784b1","name":"Validation Error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/info?mode=collection_name&get_size=false","host":["https://mycelia.azure-api.net"],"path":["info"],"query":[{"key":"mode","value":"collection_name"},{"key":"get_size","value":"false"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}"}],"_postman_id":"766da877-b4ca-49cb-94da-eeff62160e3b"},{"name":"Get Database Description","id":"dcfca878-0896-483c-81f0-8e42a18698ce","request":{"method":"GET","header":[],"url":"https://mycelia.azure-api.net/describe/:db_name","description":"

Description

Get description of a specific database in your Mycelia environment.

Parameters

Returns

dict Database params.

(Required) Database name

\n","type":"text/plain"},"type":"any","value":"collection_name","key":"db_name"}]}},"response":[{"id":"c9f00c9d-20fe-4684-8dff-edd4ecf90384","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/describe/:db_name","host":["https://mycelia.azure-api.net"],"path":["describe",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"e751023d-b491-4b60-addc-35a7d8b12fb0","name":"Not found","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/describe/:db_name","host":["https://mycelia.azure-api.net"],"path":["describe",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"8ba7b4a4-41af-48b8-af88-7f479dcfa851","name":"Validation Error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/describe/:db_name","host":["https://mycelia.azure-api.net"],"path":["describe",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}"}],"_postman_id":"dcfca878-0896-483c-81f0-8e42a18698ce"},{"name":"Get Table Fields","id":"0d983f5c-af16-47bf-907b-ba8316e61b81","request":{"method":"GET","header":[],"url":"https://mycelia.azure-api.net/fields/:db_name","description":"

Description

Get the column names of a supervised/selfsupervised database.

Parameters

db_name string
Database name to get the column names from.

Returns

dictionary The names of columns as keys and an example of their values as values.

int: 0
float: 0.01
string: \"string\"

(Required) Database name

\n","type":"text/plain"},"type":"any","value":"collection_name","key":"db_name"}]}},"response":[{"id":"814428a4-5511-4bf4-a126-201c05f5ec91","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/fields/:db_name","host":["https://mycelia.azure-api.net"],"path":["fields",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"85ac4f9a-6c84-418a-b030-dadebd7d1969","name":"Not found","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""}],"url":{"raw":"https://mycelia.azure-api.net/fields/:db_name","host":["https://mycelia.azure-api.net"],"path":["fields",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"52be5fb4-688e-4a82-ace9-9df1ace37deb","name":"Validation Error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""}],"url":{"raw":"https://mycelia.azure-api.net/fields/:db_name","host":["https://mycelia.azure-api.net"],"path":["fields",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}"}],"_postman_id":"0d983f5c-af16-47bf-907b-ba8316e61b81"},{"name":"Get Ids","id":"6d7abcde-51e4-4340-b45b-5260231eb3af","request":{"method":"GET","header":[],"url":"https://mycelia.azure-api.net/id/:db_name?mode=simple","description":"

Description

Get IDs info of a given database.

Parameters

db_name string
Name of the database we want to get IDs info from.

mode IdReport (optional)
Response mode of IDs. We have three options:

complete: get ALL IDs.
summarized: get groups of consecutive IDs.
simple: get the number of IDs and their min and max IDs as well.\n

Returns

list Return a list of integers or strings depending on the mode parameter definition.

Detail of response expected

\n","type":"text/plain"},"key":"mode","value":"simple"}],"variable":[{"description":{"content":"

(Required) Database name

\n","type":"text/plain"},"type":"any","value":"collection_name","key":"db_name"}]}},"response":[{"id":"d87b3739-045d-43d4-aea2-296dfaf1f29a","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/id/:db_name?mode=simple","host":["https://mycelia.azure-api.net"],"path":["id",":db_name"],"query":[{"key":"mode","value":"simple"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"b440d1b4-4e3f-4300-a2ca-becc8ecb0c08","name":"Not found","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""}],"url":{"raw":"https://mycelia.azure-api.net/id/:db_name?mode=simple","host":["https://mycelia.azure-api.net"],"path":["id",":db_name"],"query":[{"key":"mode","value":"simple"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"dd960a0b-c1ad-481f-8d4b-34f3e9edb269","name":"Validation Error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""}],"url":{"raw":"https://mycelia.azure-api.net/id/:db_name?mode=simple","host":["https://mycelia.azure-api.net"],"path":["id",":db_name"],"query":[{"key":"mode","value":"simple"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}"}],"_postman_id":"6d7abcde-51e4-4340-b45b-5260231eb3af"},{"name":"Get Filters","id":"54d469ad-3551-4d2b-beea-6a0ed8612abc","request":{"method":"GET","header":[],"url":"https://mycelia.azure-api.net/filters/:db_name","description":"

Description

Get the list of all existing filters in the database.

Parameters

db_name string
Database name to get the column names from.

Returns

list of strings list of filters

(Required) Database name

\n","type":"text/plain"},"type":"any","value":"collection_name","key":"db_name"}]}},"response":[{"id":"c6636ed5-0946-461b-9d9f-598539c7c256","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/filters/:db_name","host":["https://mycelia.azure-api.net"],"path":["filters",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n \"string\"\n]"},{"id":"ead9079a-85bd-45c5-a453-1ab09051ffb2","name":"Not found","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""}],"url":{"raw":"https://mycelia.azure-api.net/filters/:db_name","host":["https://mycelia.azure-api.net"],"path":["filters",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"2a8a6880-9aa7-4a77-9986-e1ecff13f29f","name":"Validation Error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""}],"url":{"raw":"https://mycelia.azure-api.net/filters/:db_name","host":["https://mycelia.azure-api.net"],"path":["filters",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}"}],"_postman_id":"54d469ad-3551-4d2b-beea-6a0ed8612abc"},{"name":"Get Report","id":"e0ed37d6-335b-41bd-b816-64dc2c035c53","request":{"method":"GET","header":[],"url":"https://mycelia.azure-api.net/report/:db_name?verbose=2","description":"

Get Report

Level of description from training

\n","type":"text/plain"},"key":"verbose","value":"2"}],"variable":[{"description":{"content":"

(Required) Database name

\n","type":"text/plain"},"type":"any","value":"collection_name","key":"db_name"}]}},"response":[{"id":"a80fd504-53f8-4162-938a-72d4a9cc4a87","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/report/:db_name?verbose=2","host":["https://mycelia.azure-api.net"],"path":["report",":db_name"],"query":[{"key":"verbose","value":"2"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"f00a4c85-cb59-4984-808a-5ef378c29c89","name":"Not found","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""}],"url":{"raw":"https://mycelia.azure-api.net/report/:db_name?verbose=2","host":["https://mycelia.azure-api.net"],"path":["report",":db_name"],"query":[{"key":"verbose","value":"2"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"498dd37e-38dc-4cd0-8edc-6c8f0aa7fe85","name":"Validation Error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""}],"url":{"raw":"https://mycelia.azure-api.net/report/:db_name?verbose=2","host":["https://mycelia.azure-api.net"],"path":["report",":db_name"],"query":[{"key":"verbose","value":"2"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}"}],"_postman_id":"e0ed37d6-335b-41bd-b816-64dc2c035c53"},{"name":"Get Vector","id":"df31abbe-9931-40f1-8155-4c74f0153ca4","request":{"method":"GET","header":[],"url":"https://mycelia.azure-api.net/vector/:db_name?id=[object Object]","description":"

Description

Get vectors according to the specified IDs.

Parameters

db_name string
Database name we want to extract vectors from.

id list
List of IDs associated with the vectors we are interested in.

Returns

list List of dictionaries. Each dictionary entry has an ID and its corresponding vector.

(Required) The ID of the item to return the vector

\n","type":"text/plain"},"key":"id","value":"[object Object]"}],"variable":[{"id":"6acbcf20-4295-423d-a305-9c4a16a0293c","description":{"content":"

(Required) Database name

\n","type":"text/plain"},"type":"any","value":"ea occaeca","key":"db_name"}]}},"response":[{"id":"1baefc10-a971-40c0-8b5b-fef721608518","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/vector/:db_name","host":["https://mycelia.azure-api.net"],"path":["vector",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 0,\n \"vector\": [\n 0\n ]\n }\n]"},{"id":"6eef75b0-5941-4a44-bb78-74b9bb60fa38","name":"Not found","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""}],"url":{"raw":"https://mycelia.azure-api.net/vector/:db_name","host":["https://mycelia.azure-api.net"],"path":["vector",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"4075676a-dc8c-47b3-a148-b32e03e6d427","name":"Validation Error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""}],"url":{"raw":"https://mycelia.azure-api.net/vector/:db_name","host":["https://mycelia.azure-api.net"],"path":["vector",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}"}],"variable":[{"id":"6acbcf20-4295-423d-a305-9c4a16a0293c","key":"db_name","value":"ea occaeca","type":"any","description":"(Required) Database name"}],"_postman_id":"df31abbe-9931-40f1-8155-4c74f0153ca4"},{"name":"Is Valid Name","id":"0053601f-0014-4754-b917-347783ec4866","request":{"method":"GET","header":[],"url":"https://mycelia.azure-api.net/validation/:db_name","description":"

Description

Check if a database name is valid.

Returns

string Message showing if the database name is or isn't a valid name.

(Required) Database name

\n","type":"text/plain"},"type":"any","value":"collection_name","key":"db_name"}]}},"response":[{"id":"4eaef07b-c44b-48b7-bf3f-df9511010bb9","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/validation/:db_name","host":["https://mycelia.azure-api.net"],"path":["validation",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"197b4f85-959c-413f-995c-989a2f371bb7","name":"Not found","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""}],"url":{"raw":"https://mycelia.azure-api.net/validation/:db_name","host":["https://mycelia.azure-api.net"],"path":["validation",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"bc0c23ce-caae-41e0-ac5d-619bb6952cad","name":"Validation Error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""}],"url":{"raw":"https://mycelia.azure-api.net/validation/:db_name","host":["https://mycelia.azure-api.net"],"path":["validation",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}"}],"_postman_id":"0053601f-0014-4754-b917-347783ec4866"},{"name":"Get Download Key","id":"da7393ec-6f10-4544-a884-18820e6c1e0d","request":{"method":"GET","header":[],"url":"https://mycelia.azure-api.net/key/:db_name","description":"

Description

Get the url for the download of the vector file.

Parameters

db_name string
Database name to get the column names from.

Returns

string url for the download of the vector file

(Required) Database name

\n","type":"text/plain"},"type":"any","value":"collection_name","key":"db_name"}]}},"response":[{"id":"a8604cb3-3d54-48bf-8853-a2d681154bc0","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/key/:db_name","host":["https://mycelia.azure-api.net"],"path":["key",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"389292ec-c080-4555-9803-4b416ca3ca2a","name":"Not found","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""}],"url":{"raw":"https://mycelia.azure-api.net/key/:db_name","host":["https://mycelia.azure-api.net"],"path":["key",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"5ca43328-1148-42fa-80bc-6bb3156e0832","name":"Validation Error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""}],"url":{"raw":"https://mycelia.azure-api.net/key/:db_name","host":["https://mycelia.azure-api.net"],"path":["key",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}"}],"_postman_id":"da7393ec-6f10-4544-a884-18820e6c1e0d"},{"name":"Entity Delete","id":"ba488100-8d24-4ae6-b8d6-40331b8f6baa","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n 0\n]","options":{"raw":{"language":"json"}}},"url":"https://mycelia.azure-api.net/entity/:db_name","description":"

Description

Delete vectors from a given database according to the specified IDs. This is a dev method.

Parameters

db_name string
Database name to perform the deletion operation.

id List[int]
IDs to be removed from the database.

Returns

dictionary Information about the task status.

(Required) Database name

\n","type":"text/plain"},"type":"any","value":"collection_name","key":"db_name"}]}},"response":[{"id":"92862295-1129-4665-bda0-defa8b090dc0","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"body":{"mode":"raw","raw":"[\n 0\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mycelia.azure-api.net/entity/:db_name","host":["https://mycelia.azure-api.net"],"path":["entity",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"string\""},{"id":"dae98761-f62f-48b4-b7f6-d6f7ed70514e","name":"Not found","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""}],"body":{"mode":"raw","raw":"[\n 0\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mycelia.azure-api.net/entity/:db_name","host":["https://mycelia.azure-api.net"],"path":["entity",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"086a73e6-e700-433a-ac91-1fbf86b22177","name":"Validation Error","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""}],"body":{"mode":"raw","raw":"[\n 0\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mycelia.azure-api.net/entity/:db_name","host":["https://mycelia.azure-api.net"],"path":["entity",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}"}],"_postman_id":"ba488100-8d24-4ae6-b8d6-40331b8f6baa"},{"name":"Delete Database","id":"5561a26a-a0cc-4506-943a-6c11021b70e7","request":{"method":"DELETE","header":[],"url":"https://mycelia.azure-api.net/database/:db_name","description":"

Description

Delete everything relative to a specified database.

Parameters

db_name string
Database name we want to delete.

Returns

Deletion status message.

(Required)

\n","type":"text/plain"},"type":"any","value":"ea occaeca","key":"db_name"}]}},"response":[{"id":"61d6f698-4d27-460e-a510-da1755d6c5a0","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/database/:db_name","host":["https://mycelia.azure-api.net"],"path":["database",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"string\""},{"id":"2cb64e35-e178-4b84-a570-1056cccb286b","name":"Not found","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""}],"url":{"raw":"https://mycelia.azure-api.net/database/:db_name","host":["https://mycelia.azure-api.net"],"path":["database",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) "}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"8d1c82ba-b862-412a-8232-cf382e40a476","name":"Validation Error","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""}],"url":{"raw":"https://mycelia.azure-api.net/database/:db_name","host":["https://mycelia.azure-api.net"],"path":["database",":db_name"],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) "}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}"}],"_postman_id":"5561a26a-a0cc-4506-943a-6c11021b70e7"},{"name":"Add Data","id":"ac024c5e-5293-4096-b4c1-8150d29a95b5","request":{"method":"PATCH","header":[],"url":"https://mycelia.azure-api.net/data/:db_name?callback_url=ea occaeca","description":"

Description

Add new data to a given database.
\nThis method should be used when we insert new data using POST https://mycelia.azure-api.net/table/data/{db_name} and want to create the vector representations \nof the new data using the model we already trained for that database.

Parameters

db_name string
Database name to perform the insertion operation.

[\n    {\n        \"db_parent\": \"string\",\n        \"id_name\": \"string\",\n        \"embedding_dim\": 0\n    }\n]\n

Returns

dictionary Information about the task status.

Callback API

Path

{callback_url}/mycelia_status\n

Request body

{\n    \"Task\": str,\n    \"Status\": str,\n    \"Description\": str\n}\n

Response body

{\n    \"ok\": bool\n}\n

Format - uri. Format - uri.

\n","type":"text/plain"},"key":"callback_url","value":"ea occaeca"}],"variable":[{"description":{"content":"

(Required) Database name

\n","type":"text/plain"},"type":"any","value":"ea occaeca","key":"db_name"}]}},"response":[{"id":"b4db3515-ee78-4d11-a0e6-8e59d38f8194","name":"Successful Response","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/data/:db_name?callback_url=ea occaeca","host":["https://mycelia.azure-api.net"],"path":["data",":db_name"],"query":[{"key":"callback_url","value":"ea occaeca"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"32f3fc1b-3bf1-4697-87f4-83302d91bcfb","name":"Not found","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""}],"url":{"raw":"https://mycelia.azure-api.net/data/:db_name?callback_url=ea occaeca","host":["https://mycelia.azure-api.net"],"path":["data",":db_name"],"query":[{"key":"callback_url","value":"ea occaeca"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"1a42f723-ff73-451f-8911-0d181d1cd0bf","name":"Validation Error","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""}],"url":{"raw":"https://mycelia.azure-api.net/data/:db_name?callback_url=ea occaeca","host":["https://mycelia.azure-api.net"],"path":["data",":db_name"],"query":[{"key":"callback_url","value":"ea occaeca"}],"variable":[{"key":"db_name","value":"collection_name","description":"(Required) Database name"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}"}],"_postman_id":"ac024c5e-5293-4096-b4c1-8150d29a95b5"}],"id":"c982fb21-3e40-4688-8c09-7b5ab7d93fbd","_postman_id":"c982fb21-3e40-4688-8c09-7b5ab7d93fbd","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"f944d66a-94ac-4804-9db6-b816755170a4","id":"f944d66a-94ac-4804-9db6-b816755170a4","name":"JAI","type":"collection"}}},{"name":"Status","item":[{"name":"Get Status","id":"ea48df8a-978f-49ed-915f-055144b21ace","request":{"method":"GET","header":[],"url":"https://mycelia.azure-api.net/status","description":"

Get status of API tasks.\nSo far, only provides status of background tasks (responses 202).

Returns

last_status dictionary

{\n    'Task': 'string',\n    'Status': 'string',\n    'Description': 'string'\n}\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"f944d66a-94ac-4804-9db6-b816755170a4","id":"f944d66a-94ac-4804-9db6-b816755170a4","name":"JAI","type":"collection"}},"urlObject":{"path":["status"],"host":["https://mycelia.azure-api.net"],"query":[],"variable":[]}},"response":[{"id":"93875771-e3fd-4303-8080-0dd8df383dac","name":"Successful Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"url":"https://mycelia.azure-api.net/status"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"5b10d5ba-006f-4e1e-b32d-0d7419b0f361","name":"Not found","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""}],"url":"https://mycelia.azure-api.net/status"},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ea48df8a-978f-49ed-915f-055144b21ace"},{"name":"Del Status","id":"b22d4aba-db31-4fa1-b1af-4f334516b104","request":{"method":"DELETE","header":[],"url":"https://mycelia.azure-api.net/status?db_name=ea occaeca","description":"

Del Status

(Required)

\n","type":"text/plain"},"key":"db_name","value":"ea occaeca"}],"variable":[]}},"response":[{"id":"33b127ee-da56-462a-87e8-ce7bf17742e1","name":"Successful Response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""},{"key":"Content-Type","value":"application-json","type":"text"}],"url":{"raw":"https://mycelia.azure-api.net/status?db_name=collection_name","host":["https://mycelia.azure-api.net"],"path":["status"],"query":[{"key":"db_name","value":"collection_name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"96792108-e9db-40b4-b5f3-dd9f8e4c46fb","name":"Not found","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""}],"url":{"raw":"https://mycelia.azure-api.net/status?db_name=collection_name","host":["https://mycelia.azure-api.net"],"path":["status"],"query":[{"key":"db_name","value":"collection_name"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"dcaebdb8-b823-4d3d-82c0-9f920a057943","name":"Validation Error","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"Auth","value":""}],"url":{"raw":"https://mycelia.azure-api.net/status?db_name=collection_name","host":["https://mycelia.azure-api.net"],"path":["status"],"query":[{"key":"db_name","value":"collection_name"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": [\n {\n \"loc\": [\n \"string\"\n ],\n \"msg\": \"string\",\n \"type\": \"string\"\n }\n ]\n}"}],"_postman_id":"b22d4aba-db31-4fa1-b1af-4f334516b104"}],"id":"408061fb-053d-418e-8c3a-2fb2e6591ab8","_postman_id":"408061fb-053d-418e-8c3a-2fb2e6591ab8","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"f944d66a-94ac-4804-9db6-b816755170a4","id":"f944d66a-94ac-4804-9db6-b816755170a4","name":"JAI","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Auth"},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"f16d0dfd-2284-42cf-b7c6-b3525987707a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"148c6e95-7283-4857-a8d0-8c5e01988cfb","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://mycelia.azure-api.net"},{"key":"AUTH","value":""}]}