{"openapi":"3.0.0","info":{"description":"BigML.io is a machine learning platform API for creating sources, datasets, models, ensembles and predictions from your data.","version":"andromeda"},"servers":[{"description":"BigML.io is a machine learning platform API for creating sources, datasets, models, ensembles and predictions from your data.","url":"https://api.apirails.com/bigml"}],"paths":{"/andromeda/anomaly":{"post":{"tags":["Anomaly Detectors"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/anomalies/","api_endpoint":"https://bigml.io/andromeda/anomaly"},"summary":"Create an anomaly detector","description":"To create a new **anomaly detector**, you need to POST to the **anomaly detector** base URL an object containing at least the **dataset/id** that you want to use to create the **anomaly detector**. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **anomaly detector**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"all_fields_preferred":{"type":"boolean","description":"Setting this parameter to **true** will set the preferred flag of all fields at once, instead of doing it one by one in a **fields** map. **Example**: true","enum":[true,false]},"anomaly_seed":{"type":"string","description":"A string to generate deterministic anomaly detectors. **Example**: \"My Seed\""},"constraints":{"type":"boolean","description":"An experimental option which adds more predicates to each node in the tree. These predicates help capture expectations about the data, making the tree more sensitive to anomalies. This option tends to inflate the anomaly scores and requires more CPU time to build and evaluate. However, it also seems to make the trees more effective at flagging anomalous data that was not in the training set. It al","enum":[true,false]},"dataset":{"type":"string","description":"A valid **dataset/id**. **Example**: dataset/{{ dataset_id }}"},"datasets":{"type":"array","description":"A list of dataset ids or objects to be used to build the new **anomaly detector**. See the [Section on Multi-Datasets](datasets#multi-datasets) and [Section on Resources Accepting Multi-Datasets Input](datasets#resources-accepting-multi-datasets-input) for more details. **Example**: [{ \"id\": \"dataset/{{ dataset_id }}\", \"sample_rate\": 0.5, \"out_of_bag\": true }, { \"id\": \"dataset/603e20a91f386f43db00","items":{"type":"string"}},"deep":{"type":"boolean","description":"Clone the dataset used to build the **anomaly detector** while cloning the original . Must be used along with the **origin** or **shared_hash** option. **Example**: true","enum":[true,false]},"default_numeric_value":{"type":"string","description":"It accepts any of the following strings to substitute missing numeric values across all the numeric fields in the dataset: **mean**, **median**, **minimum**, **maximum**, **zero**. **Example**: \"median\""},"description":{"type":"string","description":"A description of the **anomaly detector** up to 8192 characters long. **Example**: \"This is a description of my new anomaly detector\""},"excluded_fields":{"type":"array","description":"Specifies the fields that won't be included in the **anomaly detector**. **Example**: [\"000000\", \"000002\"]","items":{"type":"string"}},"fields":{"type":"object","description":"This can be used to change the names of the fields in the anomaly detector with respect to the original names in the dataset or to tell **BigML** that certain fields should be preferred. An entry keyed with the field id generated in the **source** for each field that you want the name updated. **Example**: { \"000001\": {\"name\": \"length_1\"}, \"000003\": {\"name\": \"length_2\"}, }","properties":{}},"fields_maps":{"type":"object","description":"A dictionary keyed by **dataset/id** and **object** values. Each entry maps fields in the first dataset to fields in the dataset referenced by the key. **Example**: { \"dataset/{{ dataset_id }}\": { \"000000\":\"000023\", \"000001\":\"000024\", \"000002\":\"00003a\"}, \"dataset/603e20a91f386f43db000005\": { \"000000\":\"000023\", \"000001\":\"000004\", \"000002\":\"00000f\" }","properties":{}},"forest_size":{"type":"number","description":"The number of trees used by the **anomaly detector**. Must be a number greater than or equal to 2 and less than or equal to 1000. **Example**: 256"},"id_fields":{"type":"array","description":"Specifies the ids for fields which will be included when computing the top anomalies, but will not be considered to create the anomaly detector. The **id_fields** must be a strict subset of the **input_fields**, where the latter is adjusted before passing it to the model creation algorithm by setting it to all non-preferred fields if not provided explicitly, adding to it explicit **id_fields**, an","items":{"type":"string"}},"include_extracted_features":{"type":"array","description":"Extracted image features to use as model inputs. Available options are: **true**: include all extracted features, unless explicitly excluded (this is the default for all non-deepnet models.); **false**: don't include any extracted features (this is the default for deepnet models, if not given.); **list of ids**: a explicit list of field ids, corresponding to extracted fields to add to the default ","items":{"type":"string"}},"input_fields":{"type":"array","description":"Specifies the fields to be considered to create the **anomaly detector**. **Example**: [\"000001\", \"000003\"]","items":{"type":"string"}},"name":{"type":"string","description":"The name you want to give to the new **anomaly detector**. **Example**: \"my new anomaly detector\""},"normalize_repeats":{"type":"boolean","description":"Controls whether the frequency of repeated (or very similar) data points lower the anomaly score of the repeats. **Example**: false","enum":[true,false]},"origin":{"type":"string","description":"The **anomaly/id** of the anomaly detector to be cloned. The price of the anomaly detector must be 0 to be cloned via API. Set **deep** to **true** to clone the dataset used to build the anomaly detector too. Note that the dataset can be cloned only if it is already in the public gallery and free. If multiple datasets have been used to create the anomaly detector, only the first dataset will be cl"},"out_of_bag":{"type":"boolean","description":"Setting this parameter to **true** will return a sequence of the out-of-bag instances instead of the sampled instances. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: true","enum":[true,false]},"project":{"type":"string","description":"The **project/id** you want the **anomaly detector** to belong to. **Example**: \"project/{{ project_id }}\""},"range":{"type":"array","description":"The range of successive instances to build the **anomaly detector**. **Example**: [1, 150]","items":{"type":"string"}},"replacement":{"type":"boolean","description":"Whether sampling should be performed with or without replacement. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: true","enum":[true,false]},"sample_rate":{"type":"string","description":"A real number between 0 and 1 specifying the sample rate. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: 0.5"},"sample_size":{"type":"number","description":"The number of instances used for building each tree. It acts as a maximum sample size. The actual sample used will be the minimum of **sample_size** and 0.63 \\* row count. Also, note that since trees try to isolate each data point, you can expect each isolation tree to have **2 \\* sample_size** nodes. So setting this parameter higher could lead to very large models. **Example**: 94"},"seed":{"type":"string","description":"A string to be hashed to generate deterministic samples. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: \"MySample\""},"shared_hash":{"type":"string","description":"The **shared hash** of the shared **anomaly detector** to be cloned. Set **deep** to **true** to clone the dataset used to build the anomaly detector too. Note that the dataset can be cloned only if it is already shared and set clonable. If multiple datasets have been used to create the anomaly detector, only the first dataset will be cloned. **Example**: \"kpY46mNuNVReITw0Z1mAqoQ9ySW\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **anomaly detector**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"top_n":{"type":"number","description":"The number of instances that will be returned together with the anomaly detector that were scored as most anomalous. The minimum number is 1 and the maximum is 1024. **Example**: 256"},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"all_fields_preferred":true,"anomaly_seed":"My Seed","constraints":"","dataset":"dataset/{{ dataset_id }}","datasets":["datasets_value"],"deep":true,"default_numeric_value":"median","description":"This is a description of my new anomaly detector","excluded_fields":["excluded_fields_value"],"fields":{},"fields_maps":{},"forest_size":256,"id_fields":["id_fields_value"],"include_extracted_features":["include_extracted_features_value"],"input_fields":["input_fields_value"],"name":"my new anomaly detector","normalize_repeats":"","origin":"anomaly/{{ anomaly_id }}","out_of_bag":true,"project":"project/{{ project_id }}","range":["range_value"],"replacement":true,"sample_rate":"0.5","sample_size":94,"seed":"MySample","shared_hash":"kpY46mNuNVReITw0Z1mAqoQ9ySW","tags":["tags_value"],"top_n":256,"webhook":{}}}}}},"get":{"tags":["Anomaly Detectors"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/anomalies/","api_endpoint":"https://bigml.io/andromeda/anomaly"},"summary":"List anomaly detectors","description":"To list all the **anomaly detectors**, you can use the **anomaly detector** base URL. By default, only the 20 most recent **anomaly detectors** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/anomaly/{id}":{"get":{"tags":["Anomaly Detectors"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/anomalies/","api_endpoint":"https://bigml.io/andromeda/anomaly/{id}"},"summary":"Retrieve an anomaly detector","description":"Each **anomaly detector** has a unique identifier in the form **\"anomaly/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **anomaly detector**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Anomaly Detectors"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/anomalies/","api_endpoint":"https://bigml.io/andromeda/anomaly/{id}"},"summary":"Update an anomaly detector","description":"To update an **anomaly detector**, you need to PUT an object containing the fields that you want to update to the **anomaly detector**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **anomaly detector**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **anomaly detector**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **anomaly detector** up to 8192 characters long. **Example**: \"This is a description of my new anomaly detector\""},"fields":{"type":"object","description":"This can be used to change the names of the fields in the anomaly detector with respect to the original names in the dataset or to tell **BigML** that certain fields should be preferred. An entry keyed with the field id generated in the **source** for each field that you want the name updated. **Example**: { \"000001\": {\"name\": \"length_1\"}, \"000003\": {\"name\": \"length_2\"}, }","properties":{}},"name":{"type":"string","description":"The name you want to give to the new **anomaly detector**. **Example**: \"my new anomaly detector\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **anomaly detector**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new anomaly detector","fields":{},"name":"my new anomaly detector","tags":["tags_value"]}}}}},"delete":{"tags":["Anomaly Detectors"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/anomalies/","api_endpoint":"https://bigml.io/andromeda/anomaly/{id}"},"summary":"Delete an anomaly detector","description":"To delete an **anomaly detector**, you need to issue a HTTP DELETE request to the **anomaly/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/anomalyscore":{"post":{"tags":["Anomaly Scores"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/anomalyscores/","api_endpoint":"https://bigml.io/andromeda/anomalyscore"},"summary":"Create an anomaly score","description":"To create a new **anomaly score**, you need to POST to the **anomaly score** base URL an object containing at least the **anomaly/id** that you want to use to find the **anomaly score** and an instance. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **anomaly score**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"anomaly":{"type":"string","description":"A valid **anomaly/id**. **Example**: \"anomaly/{{ anomaly_id }}\""},"description":{"type":"string","description":"A description of the **anomaly score** up to 8192 characters long. **Example**: \"This is a description of my new anomaly score\""},"input_data":{"type":"object","description":"An object with field's id/value pairs or name/value representing the instance you want to find the closest anomaly score for. You can use either field ids or field names as keys in your **input_data**. **Example**: {\"000000\": 5, \"000001\": 3}","properties":{}},"name":{"type":"string","description":"The name you want to give to the new **anomaly score**. **Example**: \"my new anomaly score\""},"project":{"type":"string","description":"The **project/id** you want the **anomaly score** to belong to. **Example**: \"project/{{ project_id }}\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **anomaly score**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"anomaly":"anomaly/{{ anomaly_id }}","description":"This is a description of my new anomaly score","input_data":{},"name":"my new anomaly score","project":"project/{{ project_id }}","tags":["tags_value"],"webhook":{}}}}}},"get":{"tags":["Anomaly Scores"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/anomalyscores/","api_endpoint":"https://bigml.io/andromeda/anomalyscore"},"summary":"List anomaly scores","description":"To list all the **anomaly scores**, you can use the **anomaly score** base URL. By default, only the 20 most recent **anomaly scores** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/anomalyscore/{id}":{"get":{"tags":["Anomaly Scores"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/anomalyscores/","api_endpoint":"https://bigml.io/andromeda/anomalyscore/{id}"},"summary":"Retrieve an anomaly score","description":"Each **anomaly score** has a unique identifier in the form **\"anomalyscore/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **anomaly score**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Anomaly Scores"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/anomalyscores/","api_endpoint":"https://bigml.io/andromeda/anomalyscore/{id}"},"summary":"Update an anomaly score","description":"To update an **anomaly score**, you need to PUT an object containing the fields that you want to update to the **anomaly score**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **anomaly score**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **anomaly score**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **anomaly score** up to 8192 characters long. **Example**: \"This is a description of my new anomaly score\""},"name":{"type":"string","description":"The name you want to give to the new **anomaly score**. **Example**: \"my new anomaly score\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **anomaly score**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new anomaly score","name":"my new anomaly score","tags":["tags_value"]}}}}},"delete":{"tags":["Anomaly Scores"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/anomalyscores/","api_endpoint":"https://bigml.io/andromeda/anomalyscore/{id}"},"summary":"Delete an anomaly score","description":"To delete an **anomaly score**, you need to issue a HTTP DELETE request to the **anomalyscore/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/association":{"post":{"tags":["Associations"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/associations/","api_endpoint":"https://bigml.io/andromeda/association"},"summary":"Create an association","description":"To create a new **association**, you need to POST to the **association** base URL an object containing at least the **dataset/id** that you want to use to create the **association**. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **association**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"type":{"type":"string","description":"Whether the field is discretized using an equal width or equal population strategy. **Example**: \"width\""},"all_fields_preferred":{"type":"boolean","description":"Setting this parameter to **true** will set the preferred flag of all fields at once, instead of doing it one by one in a **fields** map. **Example**: true","enum":[true,false]},"complement":{"type":"boolean","description":"If [complement](https://en.wikipedia.org/wiki/Complement_(set_theory)) is true, complementary items are also taken into account. For example, for the item (coffee), the complement would be (NOT coffee), so a part of the association (milk, coffee) --> (sugar) complementary rules as (milk, NOT coffee) --> (chocolate) may also be detected **Example**: true","enum":[true,false]},"dataset":{"type":"string","description":"A valid **dataset/id**. **Example**: dataset/{{ dataset_id }}"},"datasets":{"type":"array","description":"A list of dataset ids or objects to be used to build the new **association**. See the [Section on Multi-Datasets](datasets#multi-datasets) and [Section on Resources Accepting Multi-Datasets Input](datasets#resources-accepting-multi-datasets-input) for more details. **Example**: [{ \"id\": \"dataset/{{ dataset_id }}\", \"sample_rate\": 0.5, \"out_of_bag\": true }, { \"id\": \"dataset/603e20a91f386f43db000005\"","items":{"type":"string"}},"deep":{"type":"boolean","description":"Clone the dataset used to build the **association** while cloning the original. Must be used along with the **origin** or **shared_hash** option. **Example**: true","enum":[true,false]},"default_numeric_value":{"type":"string","description":"It accepts any of the following strings to substitute missing numeric values across all the numeric fields in the dataset: **mean**, **median**, **minimum**, **maximum**, **zero**. **Example**: \"median\""},"description":{"type":"string","description":"A description of the **association** up to 8192 characters long. **Example**: \"This is a description of my new association\""},"discretization":{"type":"object","description":"Global numeric field transformation parameters. See the [discretization](#Discretization) table below.","properties":{}},"edges":{"type":"array","description":"A numeric array manually specifying edge boundary locations. If this parameter is present the corresponding field will be discretized according to those defined bins, and the remaining discretization parameters will be ignored. The maximum value of the field's distribution is automatically set as the last value in the edges array. **Example**: [1.0,3.3,9.4]","items":{"type":"string"}},"excluded_fields":{"type":"array","description":"Specifies the fields that won't be included in the **association**. **Example**: [\"000000\", \"000002\"]","items":{"type":"string"}},"field_discretizations":{"type":"object","description":"Global numeric field transformation parameters. See the [fields_discretization](#Field-Discretizations) table below.","properties":{}},"fields":{"type":"object","description":"This can be used to change the names of the fields in the association with respect to the original names in the dataset or to tell **BigML** that certain fields should be preferred. An entry keyed with the field id generated in the **source** for each field that you want the name updated. **Example**: { \"000001\": {\"name\": \"length_1\"}, \"000003\": {\"name\": \"length_2\"}, }","properties":{}},"fields_maps":{"type":"object","description":"A dictionary keyed by **dataset/id** and **object** values. Each entry maps fields in the first dataset to fields in the dataset referenced by the key. **Example**: { \"dataset/{{ dataset_id }}\": { \"000000\":\"000023\", \"000001\":\"000024\", \"000002\":\"00003a\"}, \"dataset/603e20a91f386f43db000005\": { \"000000\":\"000023\", \"000001\":\"000004\", \"000002\":\"00000f\" }","properties":{}},"include_extracted_features":{"type":"array","description":"Extracted image features to use as model inputs. Available options are: **true**: include all extracted features, unless explicitly excluded (this is the default for all non-deepnet models.); **false**: don't include any extracted features (this is the default for deepnet models, if not given.); **list of ids**: a explicit list of field ids, corresponding to extracted fields to add to the default ","items":{"type":"string"}},"input_fields":{"type":"array","description":"Specifies the fields to be considered to create the **association**. **Example**: [\"000001\", \"000003\"]","items":{"type":"string"}},"max_k":{"type":"number","description":"The maximum number of associations to be discovered. **Example**: 10"},"max_lhs":{"type":"number","description":"The maximum number of items to be considered within the left-hand-side itemset. **Example**: 2"},"min_confidence":{"type":"string","description":"A real number between 0 and 1 specifying the minimum confidence for the rules discovered. **Example**: 0.5"},"min_leverage":{"type":"string","description":"A real number between -1 and 1 specifying the minimum leverage for the rules discovered. **Example**: 0.5"},"min_lift":{"type":"string","description":"A non-negative real number specifying the minimum lift for the rules discovered. **Example**: 2"},"min_support":{"type":"string","description":"A non-negative real number specifying the minimum support for the rules discovered, i.e., the number of instances matching both the left-hand and right-hand sides. A value less than 1 represents the percentage of the support, and will be multiplied by the total number of instances and rounded up. **Example**: 0.2"},"missing_items":{"type":"boolean","description":"Whether to create items corresponding to missing field values. **Example**: true","enum":[true,false]},"name":{"type":"string","description":"The name you want to give to the new **association**. **Example**: \"my new association\""},"origin":{"type":"string","description":"The **association/id** of the association to be cloned. The price of the association must be 0 to be cloned via API. Set **deep** to **true** to clone the dataset used to build the association too. Note that the dataset can be cloned only if it is already in the public gallery and free. If multiple datasets have been used to create the association, only the first dataset will be cloned. **Example*"},"out_of_bag":{"type":"boolean","description":"Setting this parameter to **true** will return a sequence of the out-of-bag instances instead of the sampled instances. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: true","enum":[true,false]},"pretty":{"type":"boolean","description":"When enabled the bin locations and widths will be chosen to be easy to read numbers, specifically they will be 1, 2, 2.5, or 5 times a power of 10. **Example**: false","enum":[true,false]},"project":{"type":"string","description":"The **project/id** you want the **association** to belong to. **Example**: \"project/{{ project_id }}\""},"range":{"type":"array","description":"The range of successive instances to build the **association**. **Example**: [1, 150]","items":{"type":"string"}},"replacement":{"type":"boolean","description":"Whether sampling should be performed with or without replacement. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: true","enum":[true,false]},"rhs_predicate":{"type":"array","description":"Restriction for the search to rules with certain right-hand side values. Each must contain, at least the **field**, and both **operator** and **value**. See the description below the table for more details. **Example**: [{ \"field\": \"petal width\", \"operator\": \"in\", \"value\": [1.0, 2.0] }, { \"field\": \"species\" }]","items":{"type":"object","properties":{}}},"sample_rate":{"type":"string","description":"A real number between 0 and 1 specifying the sample rate. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: 0.5"},"search_strategy":{"type":"string","description":"The strategy for prioritizing the rules in the search. Available options are **\"confidence\"**, **\"lhs_cover\"**, **\"leverage\"**, **\"lift\"**, and **\"support\"**. **Example**: \"lift\""},"seed":{"type":"string","description":"A string to be hashed to generate deterministic samples. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: \"MySample\""},"shared_hash":{"type":"string","description":"The **shared hash** of the shared **association** to be cloned. Set **deep** to **true** to clone the dataset used to build the association too. Note that the dataset can be cloned only if it is already shared and set clonable. If multiple datasets have been used to create the association, only the first dataset will be cloned. **Example**: \"kpY46mNuNVReITw0Z1mAqoQ9ySW\""},"significance_level":{"type":"string","description":"The [significance level](https://en.wikipedia.org/wiki/Statistical_significance) between 0 and 1 used for statistical significance of the results. **Example**: 0.1"},"size":{"type":"number","description":"The number of equal width bins. If **pretty** is enabled then this value acts as a maximum size, but the actual number of bins may be lower. **Example**: 12"},"tags":{"type":"array","description":"A list of strings that help classify and index your **association**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"trim":{"type":"string","description":"A real number between 0 and 0.1 specifying the portion of the overall population that may be removed from either tail of the distribution. For example, 0.01 indicates that 1 percent of the data may be removed from either tail. Default is 0, however, 0.01 often gives nice looking results. **Example**: 0.01"},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"type":"width","all_fields_preferred":true,"complement":true,"dataset":"dataset/{{ dataset_id }}","datasets":["datasets_value"],"deep":true,"default_numeric_value":"median","description":"This is a description of my new association","discretization":{},"edges":["edges_value"],"excluded_fields":["excluded_fields_value"],"field_discretizations":{},"fields":{},"fields_maps":{},"include_extracted_features":["include_extracted_features_value"],"input_fields":["input_fields_value"],"max_k":10,"max_lhs":2,"min_confidence":"0.5","min_leverage":"0.5","min_lift":"2","min_support":"0.2","missing_items":true,"name":"my new association","origin":"association/{{ association_id }}","out_of_bag":true,"pretty":"","project":"project/{{ project_id }}","range":["range_value"],"replacement":true,"rhs_predicate":["rhs_predicate_value"],"sample_rate":"0.5","search_strategy":"lift","seed":"MySample","shared_hash":"kpY46mNuNVReITw0Z1mAqoQ9ySW","significance_level":"0.1","size":12,"tags":["tags_value"],"trim":"0.01","webhook":{}}}}}},"get":{"tags":["Associations"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/associations/","api_endpoint":"https://bigml.io/andromeda/association"},"summary":"List associations","description":"To list all the **associations**, you can use the **association** base URL. By default, only the 20 most recent **associations** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/association/{id}":{"get":{"tags":["Associations"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/associations/","api_endpoint":"https://bigml.io/andromeda/association/{id}"},"summary":"Retrieve an association","description":"Each **association** has a unique identifier in the form **\"association/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **association**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Associations"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/associations/","api_endpoint":"https://bigml.io/andromeda/association/{id}"},"summary":"Update an association","description":"To update an **association**, you need to PUT an object containing the fields that you want to update to the **association**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **association**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **association**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **association** up to 8192 characters long. **Example**: \"This is a description of my new association\""},"fields":{"type":"object","description":"This can be used to change the names of the fields in the association with respect to the original names in the dataset or to tell **BigML** that certain fields should be preferred. An entry keyed with the field id generated in the **source** for each field that you want the name updated. **Example**: { \"000001\": {\"name\": \"length_1\"}, \"000003\": {\"name\": \"length_2\"}, }","properties":{}},"name":{"type":"string","description":"The name you want to give to the new **association**. **Example**: \"my new association\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **association**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new association","fields":{},"name":"my new association","tags":["tags_value"]}}}}},"delete":{"tags":["Associations"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/associations/","api_endpoint":"https://bigml.io/andromeda/association/{id}"},"summary":"Delete an association","description":"To delete an **association**, you need to issue a HTTP DELETE request to the **association/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/associationset":{"post":{"tags":["Association Sets"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/associationsets/","api_endpoint":"https://bigml.io/andromeda/associationset"},"summary":"Create an association set","description":"To create a new **association set**, you need to POST to the **association set** base URL an object containing at least the **association/id** that you want to use to find the **association set** and an instance. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **association set**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"association":{"type":"string","description":"A valid **association/id**. **Example**: \"association/{{ association_id }}\""},"description":{"type":"string","description":"A description of the **association set** up to 8192 characters long. **Example**: \"This is a description of my new association set\""},"input_data":{"type":"object","description":"An object with field's id/value pairs representing the instance you want to find the closest association set for. You can use either field ids or field names as keys in your **input_data**. **Example**: {\"000000\": 5, \"000001\": 3}","properties":{}},"max_k":{"type":"number","description":"The maximum number of predicted items to return. Each Consequent with a similarity-weighted score greater than 0 may be included in the prediction as long as it is not already contained within the input data. **Example**: 50"},"name":{"type":"string","description":"The name you want to give to the new **association set**. **Example**: \"my new association set\""},"project":{"type":"string","description":"The **project/id** you want the **association set** to belong to. **Example**: \"project/{{ project_id }}\""},"score_by":{"type":"string","description":"The associations measure to rank the predicted items returned. Possible values: **lhs_cover**, **confidence**, **leverage**, **lift**, and **support**. **Example**: \"coverage\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **association set**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"association":"association/{{ association_id }}","description":"This is a description of my new association set","input_data":{},"max_k":50,"name":"my new association set","project":"project/{{ project_id }}","score_by":"coverage","tags":["tags_value"],"webhook":{}}}}}},"get":{"tags":["Association Sets"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/associationsets/","api_endpoint":"https://bigml.io/andromeda/associationset"},"summary":"List association sets","description":"To list all the **association sets**, you can use the **association set** base URL. By default, only the 20 most recent **association sets** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/associationset/{id}":{"get":{"tags":["Association Sets"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/associationsets/","api_endpoint":"https://bigml.io/andromeda/associationset/{id}"},"summary":"Retrieve an association set","description":"Each **association set** has a unique identifier in the form **\"associationset/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **association set**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Association Sets"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/associationsets/","api_endpoint":"https://bigml.io/andromeda/associationset/{id}"},"summary":"Update an association set","description":"To update an **association set**, you need to PUT an object containing the fields that you want to update to the **association set**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **association set**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **association set**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **association set** up to 8192 characters long. **Example**: \"This is a description of my new association set\""},"name":{"type":"string","description":"The name you want to give to the new **association set**. **Example**: \"my new association set\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **association set**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new association set","name":"my new association set","tags":["tags_value"]}}}}},"delete":{"tags":["Association Sets"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/associationsets/","api_endpoint":"https://bigml.io/andromeda/associationset/{id}"},"summary":"Delete an association set","description":"To delete an **association set**, you need to issue a HTTP DELETE request to the **associationset/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/batchanomalyscore":{"post":{"tags":["Batch Anomaly Scores"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/batchanomalyscores/","api_endpoint":"https://bigml.io/andromeda/batchanomalyscore"},"summary":"Create a batch anomaly score","description":"To create a new **batch anomaly score**, you need to POST to the **batch anomaly score** base URL an object containing at least the **anomaly/id** that you want to use to compute anomaly scores and the **dataset/id** of the dataset that contains the input data that will be used to compute anomaly scores. **BigML.io** will compute an anomaly score for each instance in that datas","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **batch anomaly score**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"all_fields":{"type":"boolean","description":"Whether all the fields from the dataset should be part of the generated csv file together with the anomaly score. **Example**: true","enum":[true,false]},"anomaly":{"type":"string","description":"A valid **anomaly/id**. **Example**: \"anomaly/{{ anomaly_id }}\""},"dataset":{"type":"string","description":"A valid **dataset/id**. **Example**: \"dataset/{{ dataset_id }}\""},"default_numeric_value":{"type":"string","description":"It accepts any of the following strings to substitute missing numeric values across all the numeric fields in the dataset: **mean**, **median**, **minimum**, **maximum**, **zero**. **Example**: \"median\""},"description":{"type":"string","description":"A description of the **batch anomaly score** up to 8192 characters long. **Example**: \"This is a description of my new batch anomaly score\""},"excluded_fields":{"type":"array","description":"Specifies the fields in the dataset to be excluded to create the **batch anomaly score**. **Example**: [\"000000\", \"000002\"]","items":{"type":"string"}},"fields_map":{"type":"object","description":"A dictionary of identifiers of the fields to use from the **anomaly score** under test mapped to their corresponding identifiers in the input dataset. **Example**: {\"000000\":\"00000a\", \"000001\":\"000002\", \"000002\":\"000001\", \"000003\":\"000020\", \"000004\":\"000004\"}","properties":{}},"header":{"type":"boolean","description":"Whether the csv file should have a header with the name of each field. **Example**: true","enum":[true,false]},"importance":{"type":"boolean","description":"Whether field importance scores are added as additional columns for each input field. **Example**: true","enum":[true,false]},"input_fields":{"type":"array","description":"Specifies the fields to be considered to create the **batch anomaly score**. **Example**: [\"000001\", \"000003\"]","items":{"type":"string"}},"name":{"type":"string","description":"The name you want to give to the new **batch anomaly score**. **Example**: \"my new batch anomaly score\""},"newline":{"type":"string","description":"The new line character that you want to get as line break in the generated csv file: **\"LF\"**, **\"CRLF\"**. **Example**: \"CRLF\""},"output_dataset":{"type":"boolean","description":"Whether a dataset with the results should be automatically created or not. **Example**: true","enum":[true,false]},"output_fields":{"type":"array","description":"Specifies the fields to be included in the csv file. It can be a list of field ids or names. **Example**: [\"000001\", \"000003\", \"price\"]","items":{"type":"string"}},"project":{"type":"string","description":"The **project/id** you want the **batch anomaly score** to belong to. **Example**: \"project/{{ project_id }}\""},"score_name":{"type":"string","description":"The name of the column in the header of the generated file for the **anomaly score**. It will only have effect if **header** is **true**. **Example**: \"Anomaly Score\""},"separator":{"type":"string","description":"The separator that you want to get between fields in the generated csv file. **Example**: \";\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **batch anomaly score**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the [Section on Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"all_fields":true,"anomaly":"anomaly/{{ anomaly_id }}","dataset":"dataset/{{ dataset_id }}","default_numeric_value":"median","description":"This is a description of my new batch anomaly score","excluded_fields":["excluded_fields_value"],"fields_map":{},"header":true,"importance":true,"input_fields":["input_fields_value"],"name":"my new batch anomaly score","newline":"CRLF","output_dataset":true,"output_fields":["output_fields_value"],"project":"project/{{ project_id }}","score_name":"Anomaly Score","separator":";","tags":["tags_value"],"webhook":{}}}}}},"get":{"tags":["Batch Anomaly Scores"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/batchanomalyscores/","api_endpoint":"https://bigml.io/andromeda/batchanomalyscore"},"summary":"List batch anomaly scores","description":"To list all the **batch anomaly scores**, you can use the **batch anomaly score** base URL. By default, only the 20 most recent **batch anomaly scores** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/batchanomalyscore/{id}":{"get":{"tags":["Batch Anomaly Scores"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/batchanomalyscores/","api_endpoint":"https://bigml.io/andromeda/batchanomalyscore/{id}"},"summary":"Retrieve a batch anomaly score","description":"Each **batch anomaly score** has a unique identifier in the form \"**batchanomalyscore/id**\" where id is a string of 24 alpha-numeric characters that you can use to retrieve the **batch anomaly score**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Batch Anomaly Scores"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/batchanomalyscores/","api_endpoint":"https://bigml.io/andromeda/batchanomalyscore/{id}"},"summary":"Update a batch anomaly score","description":"To update a **batch anomaly score**, you need to PUT an object containing the fields that you want to update to the **batch anomaly score**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **batch anomaly score**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **batch anomaly score**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **batch anomaly score** up to 8192 characters long. **Example**: \"This is a description of my new batch anomaly score\""},"name":{"type":"string","description":"The name you want to give to the new **batch anomaly score**. **Example**: \"my new batch anomaly score\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **batch anomaly score**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new batch anomaly score","name":"my new batch anomaly score","tags":["tags_value"]}}}}},"delete":{"tags":["Batch Anomaly Scores"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/batchanomalyscores/","api_endpoint":"https://bigml.io/andromeda/batchanomalyscore/{id}"},"summary":"Delete a batch anomaly score","description":"To delete a **batch anomaly score**, you need to issue a HTTP DELETE request to the **batchanomalyscore/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/batchcentroid":{"post":{"tags":["Batch Centroids"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/batchcentroids/","api_endpoint":"https://bigml.io/andromeda/batchcentroid"},"summary":"Create a batch centroid","description":"To create a new **batch centroid**, you need to POST to the **batch centroid** base URL an object containing at least the **cluster/id** that you want to use to compute centroids and the **dataset/id** of the dataset that contains the input data that will be used to compute centroids. **BigML.io** will compute a centroid for each instance in that dataset. The **content-type** m","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **batch centroid**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"all_fields":{"type":"boolean","description":"Whether all the fields from the dataset should be part of the generated csv file together with the predictions. **Example**: true","enum":[true,false]},"centroid_name":{"type":"string","description":"The name of the column in the header of the generated file for the centroid. It will only have effect if **header** is **true**. **Example**: \"Centroid\""},"cluster":{"type":"string","description":"A valid **cluster/id**. **Example**: \"cluster/{{ cluster_id }}\""},"dataset":{"type":"string","description":"A valid **dataset/id**. **Example**: \"dataset/{{ dataset_id }}\""},"default_numeric_value":{"type":"string","description":"It accepts any of the following strings to substitute missing numeric values across all the numeric fields in the dataset: **mean**, **median**, **minimum**, **maximum**, **zero**. **Example**: \"median\""},"description":{"type":"string","description":"A description of the **batch centroid** up to 8192 characters long. **Example**: \"This is a description of my new batch centroid\""},"distance":{"type":"boolean","description":"Whether the distance for each centroid should be added to the csv file. **Example**: true","enum":[true,false]},"distance_name":{"type":"string","description":"The name of the column in the header of the generated file containing the distance. It will only have effect if **header** is **true**. **Example**: \"Distance\""},"excluded_fields":{"type":"array","description":"Specifies the fields in the dataset to be excluded to create the **batch centroid**. **Example**: [\"000000\", \"000002\"]","items":{"type":"string"}},"fields_map":{"type":"object","description":"A dictionary of identifiers of the fields to use from the **centroids** under test mapped to their corresponding identifiers in the input dataset. **Example**: {\"000000\":\"00000a\", \"000001\":\"000002\", \"000002\":\"000001\", \"000003\":\"000020\", \"000004\":\"000004\"}","properties":{}},"header":{"type":"boolean","description":"Whether the csv file should have a header with the name of each field. **Example**: true","enum":[true,false]},"input_fields":{"type":"array","description":"Specifies the fields to be considered to create the **batch centroid**. **Example**: [\"000001\", \"000003\"]","items":{"type":"string"}},"name":{"type":"string","description":"The name you want to give to the new **batch centroid**. **Example**: \"my new batch centroid\""},"newline":{"type":"string","description":"The new line character that you want to get as line break in the generated csv file: **\"LF\"**, **\"CRLF\"**. **Example**: \"CRLF\""},"output_dataset":{"type":"boolean","description":"Whether a dataset with the results should be automatically created or not. **Example**: true","enum":[true,false]},"output_fields":{"type":"array","description":"Specifies the fields to be included in the csv file. It can be a list of field ids or names. **Example**: [\"000001\", \"000003\", \"price\"]","items":{"type":"string"}},"project":{"type":"string","description":"The **project/id** you want the **batch centroid** to belong to. **Example**: \"project/{{ project_id }}\""},"separator":{"type":"string","description":"The separator that you want to get between fields in the generated csv file. **Example**: \";\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **batch centroid**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the [Section on Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"all_fields":true,"centroid_name":"Centroid","cluster":"cluster/{{ cluster_id }}","dataset":"dataset/{{ dataset_id }}","default_numeric_value":"median","description":"This is a description of my new batch centroid","distance":true,"distance_name":"Distance","excluded_fields":["excluded_fields_value"],"fields_map":{},"header":true,"input_fields":["input_fields_value"],"name":"my new batch centroid","newline":"CRLF","output_dataset":true,"output_fields":["output_fields_value"],"project":"project/{{ project_id }}","separator":";","tags":["tags_value"],"webhook":{}}}}}},"get":{"tags":["Batch Centroids"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/batchcentroids/","api_endpoint":"https://bigml.io/andromeda/batchcentroid"},"summary":"List batch centroids","description":"To list all the **batch centroids**, you can use the **batch centroid** base URL. By default, only the 20 most recent **batch centroids** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/batchcentroid/{id}":{"get":{"tags":["Batch Centroids"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/batchcentroids/","api_endpoint":"https://bigml.io/andromeda/batchcentroid/{id}"},"summary":"Retrieve a batch centroid","description":"Each **batch centroid** has a unique identifier in the form \"**batchcentroid/id**\" where id is a string of 24 alpha-numeric characters that you can use to retrieve the **batch centroid**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Batch Centroids"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/batchcentroids/","api_endpoint":"https://bigml.io/andromeda/batchcentroid/{id}"},"summary":"Update a batch centroid","description":"To update a **batch centroid**, you need to PUT an object containing the fields that you want to update to the **batch centroid**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **batch centroid**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **batch centroid**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **batch centroid** up to 8192 characters long. **Example**: \"This is a description of my new batch centroid\""},"name":{"type":"string","description":"The name you want to give to the new **batch centroid**. **Example**: \"my new batch centroid\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **batch centroid**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new batch centroid","name":"my new batch centroid","tags":["tags_value"]}}}}},"delete":{"tags":["Batch Centroids"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/batchcentroids/","api_endpoint":"https://bigml.io/andromeda/batchcentroid/{id}"},"summary":"Delete a batch centroid","description":"To delete a **batch centroid**, you need to issue a HTTP DELETE request to the **batchcentroid/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/batchprediction":{"post":{"tags":["Batch Predictions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/batchpredictions/","api_endpoint":"https://bigml.io/andromeda/batchprediction"},"summary":"Create a batch prediction","description":"To create a new **batch prediction**, you need to POST to the **batch prediction** base URL an object containing a **supervised model id** that you want to use to make predictions and the **dataset/id** of the dataset that contains the input data that will be used to create predictions. **BigML.io** will create a prediction for each instance in that dataset. The **content-type*","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **batch prediction**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"all_fields":{"type":"boolean","description":"Whether all the fields from the dataset should be part of the generated csv file together with the predictions. **Example**: true","enum":[true,false]},"confidence":{"type":"boolean","description":"Whether the confidence for each prediction for the **model** or non-boosted **ensemble** should be added to the each csv file. For **logistic regressions**, it is accepted but deprecated in favor of **probability**. **Example**: true","enum":[true,false]},"confidence_bounds":{"type":"boolean","description":"Whether the confidence bounds (i.e., **confidence interval** and **prediction interval**) for each prediction for the **linear regression** should be added to the each csv file. **Example**: true","enum":[true,false]},"confidence_interval_name":{"type":"string","description":"The name of the column in the header of the generated file containing the confidence interval when a **linear regression** is used to create the **batch prediction**. Note that it will only have effect if **header** and **confidence_bounds** are **true**. **Example**: \"Confidence interval\""},"confidence_name":{"type":"string","description":"The name of the column in the header of the generated file containing the confidence when a **model** or non-boosted **ensemble** is used to create the **batch prediction**. For **logistic regressions**, it is accepted but deprecated in favor of **probability_name**. Note that it will only have effect if **header** is **true**. **Example**: \"Confidence\""},"confidences":{"type":"boolean","description":"Whether to include a column per class with its corresponding confidence for the batch prediction for the classification task. Note that for **logistic regressions** and **ensembles** with boosted trees, it take the same numeric values as **probabilities**. **Example**: true","enum":[true,false]},"dataset":{"type":"string","description":"A valid **dataset/id**. **Example**: \"dataset/{{ dataset_id }}\""},"deepnet":{"type":"string","description":"A valid **deepnet/id**. **Example**: \"deepnet/{{ deepnet_id }}\""},"default_numeric_value":{"type":"string","description":"It accepts any of the following strings to substitute missing numeric values across all the numeric fields in the dataset: **mean**, **median**, **minimum**, **maximum**, **zero**. **Example**: \"median\""},"description":{"type":"string","description":"A description of the **batch prediction** up to 8192 characters long. **Example**: \"This is a description of my new batch prediction\""},"ensemble":{"type":"string","description":"A valid **ensemble/id**. **Example**: \"ensemble/{{ ensemble_id }}\""},"excluded_fields":{"type":"array","description":"Specifies the fields in the dataset to be excluded to create the **batch prediction**. **Example**: [\"000000\", \"000002\"]","items":{"type":"string"}},"fields_map":{"type":"object","description":"A dictionary of identifiers of the fields to use from the **predictions** under test mapped to their corresponding identifiers in the input dataset. **Example**: {\"000000\":\"00000a\", \"000001\":\"000002\", \"000002\":\"000001\", \"000003\":\"000020\", \"000004\":\"000004\"}","properties":{}},"fusion":{"type":"string","description":"A valid **fusion/id**. **Example**: \"fusion/{{ fusion_id }}\""},"header":{"type":"boolean","description":"Whether the csv file should have a header with the name of each field. **Example**: true","enum":[true,false]},"importance":{"type":"boolean","description":"Whether to include a column for each of the field importances for **model**, **ensemble**, and **fusion** predictions. That will add a column per field, named \"\\ importance\". **Example**: true","enum":[true,false]},"input_fields":{"type":"array","description":"Specifies the fields to be considered to create the **batch prediction**. **Example**: [\"000001\", \"000003\"]","items":{"type":"string"}},"linearregression":{"type":"string","description":"A valid **linearregression/id**. **Example**: \"linearregression/{{ linearregression_id }}\""},"logisticregression":{"type":"string","description":"A valid **logisticregression/id**. **Example**: \"logisticregression/{{ logisticregression_id }}\""},"missing_strategy":{"type":"number","description":"Specifies the method that should be used when a missing split is found for a **model**, **ensemble** or **fusion**. That is, when a missing value is found in the input data for a decision node. The options are: 0: **last prediction** predicts based on the subset of the data which reached the parent of the missing split.; 1: **proportional** evaluates all the subtrees of a missing split and recombi"},"model":{"type":"string","description":"A valid model id of the supported supervised model. Alternatively, you can use **ensemble**, **linearregression**, **logisticregression**, **deepnet** or **fusion** arguments. **Example**: \"model/{{ model_id }}\""},"name":{"type":"string","description":"The name you want to give to the new **batch prediction**. **Example**: \"my new batch prediction\""},"newline":{"type":"string","description":"The new line character that you want to get as line break in the generated csv file: **\"LF\"**, **\"CRLF\"**. **Example**: \"CRLF\""},"node_id":{"type":"boolean","description":"Whether a column containing a unique id for the final tree node when making a prediction should be added. This is currently only available for single tree models and the ID may be null **missing_strategy** is 1 (proportional). If enabled, the column is added last. **Example**: true","enum":[true,false]},"operating_kind":{"type":"string","description":"The operating kind to perform the prediction. Note that **operating_point** can override its value. See **operating_point** for more information. **Example**: \"confidence\""},"operating_point":{"type":"object","description":"The specification of an operating point for classification problems to perform the prediction which consists of a **positive_class** (one of the categories of the model's objective field), and a **threshold** (a number between 0 and 1), and an optional field **kind** (**confidence**, **probability**, and for non-boosted ensembles, **votes**). When it presents, **BigML** will predict the positive_c","properties":{}},"output_dataset":{"type":"boolean","description":"Whether a dataset with the results should be automatically created or not. **Example**: true","enum":[true,false]},"output_fields":{"type":"array","description":"Specifies the fields to be included in the csv file. It can be a list of field ids or names. **Example**: [\"000001\", \"000003\", \"price\"]","items":{"type":"string"}},"prediction_interval_name":{"type":"string","description":"The name of the column in the header of the generated file containing the prediction interval when a **linear regression** is used to create the batch prediction. Note that it will only have effect if **header** and **confidence_bounds** are **true**. **Example**: \"Prediction interval\""},"prediction_name":{"type":"string","description":"The name of the column in the header of the generated file for the prediction. It will only have effect if **header** is **true**. **Example**: \"Prediction\""},"probabilities":{"type":"boolean","description":"Whether to include the predicted class and all other possible class values for the batch prediction for the classification task. **Example**: true","enum":[true,false]},"probability":{"type":"boolean","description":"Whether the probability for each prediction for the classification task should be added. **Example**: true","enum":[true,false]},"probability_name":{"type":"string","description":"The name of the column in the header of the generated file containing the probability for the classification task. If **probability** is set to true, then **probability_name** will set the column header. Note that it will only have effect if **header** is **true**. **Example**: \"Probability\""},"project":{"type":"string","description":"The **project/id** you want the **batch prediction** to belong to. **Example**: \"project/{{ project_id }}\""},"separator":{"type":"string","description":"The separator that you want to get between fields in the generated csv file. **Example**: \";\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **batch prediction**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"vote_count":{"type":"boolean","description":"Whether the vote_count, the fraction of ensembles voting for the given prediction, for each prediction for the classification ensemble task should be added. **Example**: true","enum":[true,false]},"vote_count_name":{"type":"string","description":"The name of the column in the header of the generated file containing the vote_count for the ensemble classification task. If **vote_count** is set to true, then **vote_count_name** is used to prefix for naming those columns. Note that it will only have effect if **header** is **true**. **Example**: \"Votes\""},"vote_counts":{"type":"boolean","description":"Whether the vote_counts, a list of fractions of votes, one per category for the batch prediction for the ensemble classification task should be added. **Example**: true","enum":[true,false]},"votes":{"type":"boolean","description":"Whether to include a column for each of the individual model predictions for the non-boosted **ensemble**. That will add a column per model, named \\ **_n** where **n** is the position of the model in the model list in the **ensemble**, starting at 1. **Example**: true","enum":[true,false]},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the [Section on Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"all_fields":true,"confidence":true,"confidence_bounds":true,"confidence_interval_name":"Confidence interval","confidence_name":"Confidence","confidences":true,"dataset":"dataset/{{ dataset_id }}","deepnet":"deepnet/{{ deepnet_id }}","default_numeric_value":"median","description":"This is a description of my new batch prediction","ensemble":"ensemble/{{ ensemble_id }}","excluded_fields":["excluded_fields_value"],"fields_map":{},"fusion":"fusion/{{ fusion_id }}","header":true,"importance":true,"input_fields":["input_fields_value"],"linearregression":"linearregression/{{ linearregression_id }}","logisticregression":"logisticregression/{{ logisticregression_id }}","missing_strategy":1,"model":"model/{{ model_id }}","name":"my new batch prediction","newline":"CRLF","node_id":true,"operating_kind":"confidence","operating_point":{},"output_dataset":true,"output_fields":["output_fields_value"],"prediction_interval_name":"Prediction interval","prediction_name":"Prediction","probabilities":true,"probability":true,"probability_name":"Probability","project":"project/{{ project_id }}","separator":";","tags":["tags_value"],"vote_count":true,"vote_count_name":"Votes","vote_counts":true,"votes":true,"webhook":{}}}}}},"get":{"tags":["Batch Predictions"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/batchpredictions/","api_endpoint":"https://bigml.io/andromeda/batchprediction"},"summary":"List batch predictions","description":"To list all the **batch predictions**, you can use the **batch prediction** base URL. By default, only the 20 most recent **batch predictions** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/batchprediction/{id}":{"get":{"tags":["Batch Predictions"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/batchpredictions/","api_endpoint":"https://bigml.io/andromeda/batchprediction/{id}"},"summary":"Retrieve a batch prediction","description":"Each **batch prediction** has a unique identifier in the form \"**batchprediction/id**\" where id is a string of 24 alpha-numeric characters that you can use to retrieve the **batch prediction**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Batch Predictions"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/batchpredictions/","api_endpoint":"https://bigml.io/andromeda/batchprediction/{id}"},"summary":"Update a batch prediction","description":"To update a **batch prediction**, you need to PUT an object containing the fields that you want to update to the **batch prediction**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **batch prediction**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **batch prediction**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **batch prediction** up to 8192 characters long. **Example**: \"This is a description of my new batch prediction\""},"name":{"type":"string","description":"The name you want to give to the new **batch prediction**. **Example**: \"my new batch prediction\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **batch prediction**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new batch prediction","name":"my new batch prediction","tags":["tags_value"]}}}}},"delete":{"tags":["Batch Predictions"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/batchpredictions/","api_endpoint":"https://bigml.io/andromeda/batchprediction/{id}"},"summary":"Delete a batch prediction","description":"To delete a **batch prediction**, you need to issue a HTTP DELETE request to the **batchprediction/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/batchprojection":{"post":{"tags":["Batch Projections"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/batchprojections/","api_endpoint":"https://bigml.io/andromeda/batchprojection"},"summary":"Create a batch projection","description":"To create a new **batch projection**, you need to POST to the **batch projection** base URL an object containing at least the **pca/id** that you want to use to compute projections and the **dataset/id** of the dataset that contains the input data that will be used to compute projections. **BigML.io** will compute a projection for each instance in that dataset. The **content-ty","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **batch projection**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"all_fields":{"type":"boolean","description":"Whether all the fields from the dataset should be part of the generated csv file together with the projections. **Example**: true","enum":[true,false]},"dataset":{"type":"string","description":"A valid **dataset/id**. **Example**: \"dataset/{{ dataset_id }}\""},"description":{"type":"string","description":"A description of the **batch projection** up to 8192 characters long. **Example**: \"This is a description of my new batch projection\""},"excluded_fields":{"type":"array","description":"Specifies the fields in the dataset to be excluded to create the **batch projection**. **Example**: [\"000000\", \"000002\"]","items":{"type":"string"}},"fields_map":{"type":"object","description":"A dictionary of identifiers of the fields to use from the **projections** under test mapped to their corresponding identifiers in the input dataset. **Example**: {\"000000\":\"00000a\", \"000001\":\"000002\", \"000002\":\"000001\", \"000003\":\"000020\", \"000004\":\"000004\"}","properties":{}},"header":{"type":"boolean","description":"Whether the csv file should have a header with the name of each field. **Example**: true","enum":[true,false]},"input_fields":{"type":"array","description":"Specifies the fields to be considered to create the **batch projection**. **Example**: [\"000001\", \"000003\"]","items":{"type":"string"}},"max_components":{"type":"number","description":"The maximum number of components to load for prediction. **Example**: 10"},"name":{"type":"string","description":"The name you want to give to the new **batch projection**. **Example**: \"my new batch projection\""},"newline":{"type":"string","description":"The new line character that you want to get as line break in the generated csv file: **\"LF\"**, **\"CRLF\"**. **Example**: \"CRLF\""},"output_dataset":{"type":"boolean","description":"Whether a dataset with the results should be automatically created or not. **Example**: true","enum":[true,false]},"output_fields":{"type":"array","description":"Specifies the fields to be included in the csv file. It can be a list of field ids or names. **Example**: [\"000001\", \"000003\", \"price\"]","items":{"type":"string"}},"pca":{"type":"string","description":"A valid **pca/id**. **Example**: \"pca/{{ pca_id }}\""},"project":{"type":"string","description":"The **project/id** you want the **batch projection** to belong to. **Example**: \"project/{{ project_id }}\""},"separator":{"type":"string","description":"The separator that you want to get between fields in the generated csv file. **Example**: \";\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **batch projection**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"variance_threshold":{"type":"string","description":"The prediction uses the minimum number of components such that the cumulative explained variance is greater than the given threshold. If both **max_components** and **variance_threshold** are given, the value for **max_components** will be used. **Example**: 0.95"},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the [Section on Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"all_fields":true,"dataset":"dataset/{{ dataset_id }}","description":"This is a description of my new batch projection","excluded_fields":["excluded_fields_value"],"fields_map":{},"header":true,"input_fields":["input_fields_value"],"max_components":10,"name":"my new batch projection","newline":"CRLF","output_dataset":true,"output_fields":["output_fields_value"],"pca":"pca/{{ pca_id }}","project":"project/{{ project_id }}","separator":";","tags":["tags_value"],"variance_threshold":"0.95","webhook":{}}}}}},"get":{"tags":["Batch Projections"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/batchprojections/","api_endpoint":"https://bigml.io/andromeda/batchprojection"},"summary":"List batch projections","description":"To list all the **batch projections**, you can use the **batch projection** base URL. By default, only the 20 most recent **batch projections** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/batchprojection/{id}":{"get":{"tags":["Batch Projections"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/batchprojections/","api_endpoint":"https://bigml.io/andromeda/batchprojection/{id}"},"summary":"Retrieve a batch projection","description":"Each **batch projection** has a unique identifier in the form \"**batchprojection/id**\" where id is a string of 24 alpha-numeric characters that you can use to retrieve the **batch projection**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Batch Projections"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/batchprojections/","api_endpoint":"https://bigml.io/andromeda/batchprojection/{id}"},"summary":"Update a batch projection","description":"To update a **batch projection**, you need to PUT an object containing the fields that you want to update to the **batch projection**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **batch projection**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **batch projection**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **batch projection** up to 8192 characters long. **Example**: \"This is a description of my new batch projection\""},"name":{"type":"string","description":"The name you want to give to the new **batch projection**. **Example**: \"my new batch projection\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **batch projection**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new batch projection","name":"my new batch projection","tags":["tags_value"]}}}}},"delete":{"tags":["Batch Projections"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/batchprojections/","api_endpoint":"https://bigml.io/andromeda/batchprojection/{id}"},"summary":"Delete a batch projection","description":"To delete a **batch projection**, you need to issue a HTTP DELETE request to the **batchprojection/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/batchtopicdistribution":{"post":{"tags":["Batch Topic Distributions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/batchtopicdistributions/","api_endpoint":"https://bigml.io/andromeda/batchtopicdistribution"},"summary":"Create a batch topic distribution","description":"To create a new **batch topic distribution**, you need to POST to the **batch topic distribution** base URL an object containing at least the **topicmodel/id** that you want to use to compute topic distributions and the **dataset/id** of the dataset that contains the input data that will be used to compute topic distributions. **BigML.io** will compute a topic distribution for ","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **batch topic distribution**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"all_fields":{"type":"boolean","description":"Whether all the fields from the dataset should be part of the generated csv file together with the topic distributions. **Example**: true","enum":[true,false]},"dataset":{"type":"string","description":"A valid **dataset/id**. **Example**: \"dataset/{{ dataset_id }}\""},"description":{"type":"string","description":"A description of the **batch topic distribution** up to 8192 characters long. **Example**: \"This is a description of my new batch topic distribution\""},"excluded_fields":{"type":"array","description":"Specifies the fields in the dataset to be excluded to create the **batch topic distribution**. **Example**: [\"000000\", \"000002\"]","items":{"type":"string"}},"fields_map":{"type":"object","description":"A dictionary of identifiers of the fields to use from the **topic distributions** under test mapped to their corresponding identifiers in the input dataset. **Example**: {\"000000\":\"00000a\", \"000001\":\"000002\", \"000002\":\"000001\", \"000003\":\"000020\", \"000004\":\"000004\"}","properties":{}},"header":{"type":"boolean","description":"Whether the csv file should have a header with the name of each field. **Example**: true","enum":[true,false]},"input_fields":{"type":"array","description":"Specifies the fields to be considered to create the **batch topic distribution**. **Example**: [\"000001\", \"000003\"]","items":{"type":"string"}},"name":{"type":"string","description":"The name you want to give to the new **batch topic distribution**. **Example**: \"my new batch topic distribution\""},"newline":{"type":"string","description":"The new line character that you want to get as line break in the generated csv file: **\"LF\"**, **\"CRLF\"**. **Example**: \"CRLF\""},"output_dataset":{"type":"boolean","description":"Whether a dataset with the results should be automatically created or not. **Example**: true","enum":[true,false]},"output_fields":{"type":"array","description":"Specifies the fields to be included in the csv file. It can be a list of field ids or names. **Example**: [\"000001\", \"000003\", \"price\"]","items":{"type":"string"}},"project":{"type":"string","description":"The **project/id** you want the **batch topic distribution** to belong to. **Example**: \"project/{{ project_id }}\""},"separator":{"type":"string","description":"The separator that you want to get between fields in the generated csv file. **Example**: \";\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **batch topic distribution**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"topicmodel":{"type":"string","description":"A valid **topicmodel/id**. **Example**: \"topicmodel/{{ topicmodel_id }}\""},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the [Section on Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"all_fields":true,"dataset":"dataset/{{ dataset_id }}","description":"This is a description of my new batch topic distribution","excluded_fields":["excluded_fields_value"],"fields_map":{},"header":true,"input_fields":["input_fields_value"],"name":"my new batch topic distribution","newline":"CRLF","output_dataset":true,"output_fields":["output_fields_value"],"project":"project/{{ project_id }}","separator":";","tags":["tags_value"],"topicmodel":"topicmodel/{{ topicmodel_id }}","webhook":{}}}}}},"get":{"tags":["Batch Topic Distributions"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/batchtopicdistributions/","api_endpoint":"https://bigml.io/andromeda/batchtopicdistribution"},"summary":"List batch topic distributions","description":"To list all the **batch topic distributions**, you can use the **batch topic distribution** base URL. By default, only the 20 most recent **batch topic distributions** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/batchtopicdistribution/{id}":{"get":{"tags":["Batch Topic Distributions"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/batchtopicdistributions/","api_endpoint":"https://bigml.io/andromeda/batchtopicdistribution/{id}"},"summary":"Retrieve a batch topic distribution","description":"Each **batch topic distribution** has a unique identifier in the form \"**batchtopicdistribution/id**\" where id is a string of 24 alpha-numeric characters that you can use to retrieve the **batch topic distribution**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Batch Topic Distributions"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/batchtopicdistributions/","api_endpoint":"https://bigml.io/andromeda/batchtopicdistribution/{id}"},"summary":"Update a batch topic distribution","description":"To update a **batch topic distribution**, you need to PUT an object containing the fields that you want to update to the **batch topic distribution**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **batch topic distribution*","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **batch topic distribution**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **batch topic distribution** up to 8192 characters long. **Example**: \"This is a description of my new batch topic distribution\""},"name":{"type":"string","description":"The name you want to give to the new **batch topic distribution**. **Example**: \"my new batch topic distribution\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **batch topic distribution**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new batch topic distribution","name":"my new batch topic distribution","tags":["tags_value"]}}}}},"delete":{"tags":["Batch Topic Distributions"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/batchtopicdistributions/","api_endpoint":"https://bigml.io/andromeda/batchtopicdistribution/{id}"},"summary":"Delete a batch topic distribution","description":"To delete a **batch topic distribution**, you need to issue a HTTP DELETE request to the **batchtopicdistribution/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/centroid":{"post":{"tags":["Centroids"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/centroids/","api_endpoint":"https://bigml.io/andromeda/centroid"},"summary":"Create a centroid","description":"To create a new **centroid**, you need to POST to the **centroid** base URL an object containing at least the **cluster/id** that you want to use to find the **centroid** and an instance without any missing values. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **centroid**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"cluster":{"type":"string","description":"A valid **cluster/id**. **Example**: \"cluster/{{ cluster_id }}\""},"description":{"type":"string","description":"A description of the **centroid** up to 8192 characters long. **Example**: \"This is a description of my new centroid\""},"input_data":{"type":"object","description":"An object with field's id/value or name/value pairs representing the instance you want to find the closest centroid for. You can use either field ids or field names as keys in your **input_data**. **Example**: {\"000000\": 5, \"000001\": 3}","properties":{}},"name":{"type":"string","description":"The name you want to give to the new **centroid**. **Example**: \"my new centroid\""},"project":{"type":"string","description":"The **project/id** you want the **centroid** to belong to. **Example**: \"project/{{ project_id }}\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **centroid**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"cluster":"cluster/{{ cluster_id }}","description":"This is a description of my new centroid","input_data":{},"name":"my new centroid","project":"project/{{ project_id }}","tags":["tags_value"],"webhook":{}}}}}},"get":{"tags":["Centroids"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/centroids/","api_endpoint":"https://bigml.io/andromeda/centroid"},"summary":"List centroids","description":"To list all the **centroids**, you can use the **centroid** base URL. By default, only the 20 most recent **centroids** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/centroid/{id}":{"get":{"tags":["Centroids"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/centroids/","api_endpoint":"https://bigml.io/andromeda/centroid/{id}"},"summary":"Retrieve a centroid","description":"Each **centroid** has a unique identifier in the form **\"centroid/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **centroid**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Centroids"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/centroids/","api_endpoint":"https://bigml.io/andromeda/centroid/{id}"},"summary":"Update a centroid","description":"To update a **centroid**, you need to PUT an object containing the fields that you want to update to the **centroid**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **centroid**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **centroid**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **centroid** up to 8192 characters long. **Example**: \"This is a description of my new centroid\""},"name":{"type":"string","description":"The name you want to give to the new **centroid**. **Example**: \"my new centroid\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **centroid**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new centroid","name":"my new centroid","tags":["tags_value"]}}}}},"delete":{"tags":["Centroids"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/centroids/","api_endpoint":"https://bigml.io/andromeda/centroid/{id}"},"summary":"Delete a centroid","description":"To delete a **centroid**, you need to issue a HTTP DELETE request to the **centroid/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/cluster":{"post":{"tags":["Clusters"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/clusters/","api_endpoint":"https://bigml.io/andromeda/cluster"},"summary":"Create a cluster","description":"To create a new **cluster**, you need to POST to the **cluster** base URL an object containing at least the **dataset/id** that you want to use to create the **cluster**. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **cluster**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"all_fields_preferred":{"type":"boolean","description":"Setting this parameter to **true** will set the preferred flag of all fields at once, instead of doing it one by one in a **fields** map. **Example**: true","enum":[true,false]},"balance_fields":{"type":"boolean","description":"When this parameter is enabled, all the numeric fields will be scaled so that their standard deviations are 1. This makes each field have roughly equivalent influence. **Example**: true","enum":[true,false]},"cluster_seed":{"type":"string","description":"A string to generate deterministic clusters. **Example**: \"My Seed\""},"critical_value":{"type":"number","description":"The clustering algorithm G-means is parameter free except for one, the **critical_value** parameter. G-means iteratively takes existing clusters and tests whether the cluster's neighborhood appears Gaussian. If it doesn't the cluster is split into two. The **critical_value** sets how strict the test is when deciding whether data looks Gaussian. The default is to 5, which seems to work well in most"},"dataset":{"type":"string","description":"A valid **dataset/id**. **Example**: dataset/{{ dataset_id }}"},"datasets":{"type":"array","description":"A list of dataset ids or objects to be used to build the new **cluster**. See the [Section on Multi-Datasets](datasets#multi-datasets) and [Section on Resources Accepting Multi-Datasets Input](datasets#resources-accepting-multi-datasets-input) for more details. **Example**: [{ \"id\": \"dataset/{{ dataset_id }}\", \"sample_rate\": 0.5, \"out_of_bag\": true }, { \"id\": \"dataset/603e20a91f386f43db000005\", \"s","items":{"type":"string"}},"deep":{"type":"boolean","description":"Clone the dataset used to build the **cluster** while cloning the original . Must be used along with the **origin** or **shared_hash** option. **Example**: true","enum":[true,false]},"default_numeric_value":{"type":"string","description":"It accepts any of the following strings to substitute missing numeric values across all the numeric fields in the dataset: **mean**, **median**, **minimum**, **maximum**, **zero**. **Example**: \"median\""},"description":{"type":"string","description":"A description of the **cluster** up to 8192 characters long. **Example**: \"This is a description of my new cluster\""},"excluded_fields":{"type":"array","description":"Specifies the fields that won't be included in the **cluster**. **Example**: [\"000000\", \"000002\"]","items":{"type":"string"}},"field_scales":{"type":"object","description":"With this argument you can pick your own scaling for each field. If a field isn't included in **field_scales**, BigML will treat the scale as 1 (no scale change). If both **balance_fields** and **field_scales** are present, then **balance_fields** will be applied first. This will make it easy for you do things like balancing age and salary, but then request that age be twice as important. **Exampl","properties":{}},"fields":{"type":"object","description":"This can be used to change the names of the fields in the cluster with respect to the original names in the dataset or to tell **BigML** that certain fields should be preferred. An entry keyed with the field id generated in the **source** for each field that you want the name updated. **Example**: { \"000001\": {\"name\": \"length_1\"}, \"000003\": {\"name\": \"length_2\"}, }","properties":{}},"fields_maps":{"type":"object","description":"A dictionary keyed by **dataset/id** and **object** values. Each entry maps fields in the first dataset to fields in the dataset referenced by the key. **Example**: { \"dataset/{{ dataset_id }}\": { \"000000\":\"000023\", \"000001\":\"000024\", \"000002\":\"00003a\"}, \"dataset/603e20a91f386f43db000005\": { \"000000\":\"000023\", \"000001\":\"000004\", \"000002\":\"00000f\" }","properties":{}},"include_extracted_features":{"type":"array","description":"Extracted image features to use as model inputs. Available options are: **true**: include all extracted features, unless explicitly excluded (this is the default for all non-deepnet models.); **false**: don't include any extracted features (this is the default for deepnet models, if not given.); **list of ids**: a explicit list of field ids, corresponding to extracted fields to add to the default ","items":{"type":"string"}},"input_fields":{"type":"array","description":"Specifies the fields to be considered to create the **cluster**. **Example**: [\"000001\", \"000003\"]","items":{"type":"string"}},"k":{"type":"number","description":"The number of clusters. Must be null or a number greater than or equal to 1 and less than or equal to 300. **Example**: 3"},"model_clusters":{"type":"boolean","description":"Whether a model for every cluster will be generated or not. Each model predicts whether or not an instance is part of its respective cluster. **Example**: true","enum":[true,false]},"name":{"type":"string","description":"The name you want to give to the new **cluster**. **Example**: \"my new cluster\""},"origin":{"type":"string","description":"The **cluster/id** of the cluster to be cloned. The price of the cluster must be 0 to be cloned via API. Set **deep** to **true** to clone the dataset used to build the cluster too. Note that the dataset can be cloned only if it is already in the public gallery and free. If multiple datasets have been used to create the cluster, only the first dataset will be cloned. **Example**: \"cluster/{{ clust"},"out_of_bag":{"type":"boolean","description":"Setting this parameter to **true** will return a sequence of the out-of-bag instances instead of the sampled instances. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: true","enum":[true,false]},"project":{"type":"string","description":"The **project/id** you want the **cluster** to belong to. **Example**: \"project/{{ project_id }}\""},"range":{"type":"array","description":"The range of successive instances to build the **cluster**. **Example**: [1, 150]","items":{"type":"string"}},"replacement":{"type":"boolean","description":"Whether sampling should be performed with or without replacement. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: true","enum":[true,false]},"sample_rate":{"type":"string","description":"A real number between 0 and 1 specifying the sample rate. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: 0.5"},"seed":{"type":"string","description":"A string to be hashed to generate deterministic samples. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: \"MySample\""},"shared_hash":{"type":"string","description":"The **shared hash** of the shared **cluster** to be cloned. Set **deep** to **true** to clone the dataset used to build the cluster too. Note that the dataset can be cloned only if it is already shared and set clonable. If multiple datasets have been used to create the cluster, only the first dataset will be cloned. **Example**: \"kpY46mNuNVReITw0Z1mAqoQ9ySW\""},"summary_fields":{"type":"array","description":"Specifies the ids for fields which will be included when generating the per cluster summaries/datasets, but will not be used for clustering. The **summary_fields** must be a strict subset of the input_fields, where the latter is adjusted before passing it to the model creation algorithm by setting it to all non-preferred fields if not provided explicitly, adding to it explicit **summary_fields**, ","items":{"type":"string"}},"tags":{"type":"array","description":"A list of strings that help classify and index your **cluster**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}},"weight_field":{"type":"string","description":"Any numeric field with no negative or missing values is valid as a weight field. Each instance will be weighted individually according to the weight field's value. For more information, see the [Weight Field](models#Weight-Field) section. **Example**: \"000005\""}}},"example":{"category":1,"all_fields_preferred":true,"balance_fields":true,"cluster_seed":"My Seed","critical_value":3,"dataset":"dataset/{{ dataset_id }}","datasets":["datasets_value"],"deep":true,"default_numeric_value":"median","description":"This is a description of my new cluster","excluded_fields":["excluded_fields_value"],"field_scales":{},"fields":{},"fields_maps":{},"include_extracted_features":["include_extracted_features_value"],"input_fields":["input_fields_value"],"k":3,"model_clusters":true,"name":"my new cluster","origin":"cluster/{{ cluster_id }}","out_of_bag":true,"project":"project/{{ project_id }}","range":["range_value"],"replacement":true,"sample_rate":"0.5","seed":"MySample","shared_hash":"kpY46mNuNVReITw0Z1mAqoQ9ySW","summary_fields":["summary_fields_value"],"tags":["tags_value"],"webhook":{},"weight_field":"000005"}}}}},"get":{"tags":["Clusters"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/clusters/","api_endpoint":"https://bigml.io/andromeda/cluster"},"summary":"List clusters","description":"To list all the **clusters**, you can use the **cluster** base URL. By default, only the 20 most recent **clusters** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/cluster/{id}":{"get":{"tags":["Clusters"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/clusters/","api_endpoint":"https://bigml.io/andromeda/cluster/{id}"},"summary":"Retrieve a cluster","description":"Each **cluster** has a unique identifier in the form **\"cluster/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **cluster**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Clusters"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/clusters/","api_endpoint":"https://bigml.io/andromeda/cluster/{id}"},"summary":"Update a cluster","description":"To update a **cluster**, you need to PUT an object containing the fields that you want to update to the **cluster**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **cluster**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **cluster**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **cluster** up to 8192 characters long. **Example**: \"This is a description of my new cluster\""},"fields":{"type":"object","description":"This can be used to change the names of the fields in the cluster with respect to the original names in the dataset or to tell **BigML** that certain fields should be preferred. An entry keyed with the field id generated in the **source** for each field that you want the name updated. **Example**: { \"000001\": {\"name\": \"length_1\"}, \"000003\": {\"name\": \"length_2\"}, }","properties":{}},"name":{"type":"string","description":"The name you want to give to the new **cluster**. **Example**: \"my new cluster\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **cluster**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new cluster","fields":{},"name":"my new cluster","tags":["tags_value"]}}}}},"delete":{"tags":["Clusters"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/clusters/","api_endpoint":"https://bigml.io/andromeda/cluster/{id}"},"summary":"Delete a cluster","description":"To delete a **cluster**, you need to issue a HTTP DELETE request to the **cluster/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/composite":{"post":{"tags":["Composites"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/composites/","api_endpoint":"https://bigml.io/andromeda/composite"},"summary":"Create a composite","description":"To create a new **composite**, you need to POST to the **composite** base URL an object containing at least a list of **model ids** that you want to use to create the **composite**. The content-type must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **composite**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **composite** up to 8192 characters long. **Example**: \"This is a description of my new composite\""},"models":{"type":"array","description":"A list with composite submodel resource/ids or or list of maps using the key **id** for each submodel resource/id, and any other key/values for additional meta-information on the model. Available submodel types are **anomaly**, **association**, **cluster**, **composite**, **deepnet**, **ensemble**, **fusion**, **model**, **linear regression**, **logistic regression**, **optiml**, **time series**, ","items":{"type":"string"}},"name":{"type":"string","description":"The name you want to give to the new **composite**. **Example**: \"my new composite\""},"project":{"type":"string","description":"The **project/id** you want the **composite** to belong to. **Example**: \"project/6034b1491f386f87c8000000\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **composite**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"description":"This is a description of my new composite","models":["models_value"],"name":"my new composite","project":"project/6034b1491f386f87c8000000","tags":["tags_value"],"webhook":{}}}}}},"get":{"tags":["Composites"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/composites/","api_endpoint":"https://bigml.io/andromeda/composite"},"summary":"List composites","description":"To list all the **composite**, you can use the **composite** base URL. By default, only the 20 most recent **composite** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/composite/{id}":{"get":{"tags":["Composites"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/composites/","api_endpoint":"https://bigml.io/andromeda/composite/{id}"},"summary":"Retrieve a composite","description":"Each **composite** has a unique identifier in the form **\"composite/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **composite**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Composites"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/composites/","api_endpoint":"https://bigml.io/andromeda/composite/{id}"},"summary":"Update a composite","description":"To update a **composite**, you need to PUT an object containing the fields that you want to update to the **composite**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **composite**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **composite**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **composite** up to 8192 characters long. **Example**: \"This is a description of my new composite\""},"name":{"type":"string","description":"The name you want to give to the new **composite**. **Example**: \"my new composite\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **composite**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new composite","name":"my new composite","tags":["tags_value"]}}}}},"delete":{"tags":["Composites"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/composites/","api_endpoint":"https://bigml.io/andromeda/composite/{id}"},"summary":"Delete a composite","description":"To delete a **composite**, you need to issue a HTTP DELETE request to the **composite/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/configuration":{"post":{"tags":["Configurations"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/configurations/","api_endpoint":"https://bigml.io/andromeda/configuration"},"summary":"Create a configuration","description":"To create a new **configuration**, you just need to POST the name you want to give to the new **configuration** and **configurations** that contains settings for individual or any resources to the **configuration** base URL.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **configuration**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"configurations":{"type":"object","description":"Default arguments for individual resources or any to apply the argument to all resources. For more information, see the [Configurations Object](#configurations-object) below. **Example**: { \"ensemble\": { \"number_of_models\": 10 }, \"any\": { \"tags\": [\"faq\"] } }","properties":{}},"description":{"type":"string","description":"A description of the **configuration** up to 8192 characters long. **Example**: \"This is a description of my new configuration\""},"name":{"type":"string","description":"The name you want to give to the new **configuration**. **Example**: \"my new configuration\""},"origin":{"type":"string","description":"The **configuration/id** of the configuration to be cloned. **Example**: \"configuration/{{ configuration_id }}\""},"project":{"type":"string","description":"The **project/id** you want the **configuration** to belong to. **Example**: \"project/{{ project_id }}\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **configuration**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"configurations":{},"description":"This is a description of my new configuration","name":"my new configuration","origin":"configuration/{{ configuration_id }}","project":"project/{{ project_id }}","tags":["tags_value"],"webhook":{}}}}}},"get":{"tags":["Configurations"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/configurations/","api_endpoint":"https://bigml.io/andromeda/configuration"},"summary":"List configurations","description":"To list all the **configurations**, you can use the **configuration** base URL. By default, only the 20 most recent **configurations** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/configuration/{id}":{"get":{"tags":["Configurations"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/configurations/","api_endpoint":"https://bigml.io/andromeda/configuration/{id}"},"summary":"Retrieve a configuration","description":"Each **configuration** has a unique identifier in the form **\"configuration/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **configuration**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Configurations"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/configurations/","api_endpoint":"https://bigml.io/andromeda/configuration/{id}"},"summary":"Update a configuration","description":"To update a **configuration**, you need to PUT an object containing the fields that you want to update to the **configuration**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **configuration**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **configuration**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"configurations":{"type":"object","description":"Default arguments for individual resources or any to apply the argument to all resources. For more information, see the [Configurations Object](#configurations-object) below. **Example**: { \"ensemble\": { \"number_of_models\": 10 }, \"any\": { \"tags\": [\"faq\"] } }","properties":{}},"description":{"type":"string","description":"A description of the **configuration** up to 8192 characters long. **Example**: \"This is a description of my new configuration\""},"name":{"type":"string","description":"The name you want to give to the new **configuration**. **Example**: \"my new configuration\""},"project":{"type":"string","description":"The **project/id** you want the **configuration** to belong to. **Example**: \"project/{{ project_id }}\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **configuration**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"configurations":{},"description":"This is a description of my new configuration","name":"my new configuration","project":"project/{{ project_id }}","tags":["tags_value"]}}}}},"delete":{"tags":["Configurations"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/configurations/","api_endpoint":"https://bigml.io/andromeda/configuration/{id}"},"summary":"Delete a configuration","description":"To delete a **configuration**, you need to issue a HTTP DELETE request to the **configuration/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/correlation":{"post":{"tags":["Correlations"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/correlations/","api_endpoint":"https://bigml.io/andromeda/correlation"},"summary":"Create a correlation","description":"To create a new **correlation**, you need to POST to the **correlation** base URL an object containing at least the **dataset/id** that you want to use to create the **correlation**. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Correlations"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/correlations/","api_endpoint":"https://bigml.io/andromeda/correlation"},"summary":"List correlations","description":"To list all the **correlation**, you can use the **correlation** base URL. By default, only the 20 most recent **correlations** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/correlation/{id}":{"get":{"tags":["Correlations"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/correlations/","api_endpoint":"https://bigml.io/andromeda/correlation/{id}"},"summary":"Retrieve a correlation","description":"Each **correlation** has a unique identifier in the form **\"correlation/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **correlation**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Correlations"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/correlations/","api_endpoint":"https://bigml.io/andromeda/correlation/{id}"},"summary":"Update a correlation","description":"To update a **correlation**, you need to PUT an object containing the fields that you want to update to the **correlation**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **correlation**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Correlations"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/correlations/","api_endpoint":"https://bigml.io/andromeda/correlation/{id}"},"summary":"Delete a correlation","description":"To delete a **correlation**, you need to issue a HTTP DELETE request to the **correlation/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/dataset":{"post":{"tags":["Datasets"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/datasets/","api_endpoint":"https://bigml.io/andromeda/dataset"},"summary":"Create a dataset","description":"To create a new **dataset**, you need to POST to the **dataset** base URL an object containing at least the **source/id** that you want to use to create the dataset. The content-type must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **dataset**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **dataset** up to 8192 characters long. **Example**: \"This is a description of my new dataset\""},"excluded_fields":{"type":"array","description":"Specifies the fields that won't be included in the **dataset**. **Example**: [\"000000\", \"000002\"]","items":{"type":"string"}},"fields":{"type":"object","description":"Updates the names, labels, and descriptions of the fields in the dataset with respect to the original names in the source. An entry keyed with the field id generated in the **source** for each field that you want the name updated. **Example**: { \"000001\": { \"name\": \"length_1\", \"label\": \"Length_1\" }, \"000002\": { \"name\": \"length_2\" }, }","properties":{}},"input_fields":{"type":"array","description":"Specifies the fields to be included in the **dataset**. **Example**: [\"000001\", \"000003\"]","items":{"type":"string"}},"json_filter":{"type":"array","description":"A JSON list representing a filter over the rows in the datasource. The first element is an operator and the rest of the elements its arguments. See the [section](#Filtering-Rows) below for more details. **Example**: [\">\", 3.14, [\"field\", \"000002\"]]","items":{"type":"string"}},"lisp_filter":{"type":"string","description":"A string representing a Lisp s-expression to filter rows from the datasource. **Example**: \"(> 3.14 (field 2))\""},"name":{"type":"string","description":"The name you want to give to the new **dataset**. **Example**: \"my new dataset\""},"objective_field":{"type":"object","description":"Specifies the default objective field. **Example**: {\"id\": \"000003\"}","properties":{}},"origin":{"type":"string","description":"The **dataset/id** of the gallery dataset to be cloned. The price of the dataset must be 0 to be cloned via API. **Example**: \"dataset/{{ dataset_id }}\""},"origin_dataset":{"type":"string","description":"The **dataset/id** of dataset to be transformed. See the [Section on Transformations](#transformations) for more details. **Example**: \"dataset/{{ dataset_id }}\""},"origin_datasets":{"type":"array","description":"A list of dataset ids or objects to be merged.See the [Section on Multi-Datasets](#Multi-Datasets ) for more details. **Example**: [{ \"id\": \"dataset/52bc7fc83c1920e4a3000012\", \"sample_rate\": 0.5, \"out_of_bag\": true }, { \"id\": \"dataset/52bc851b3c1920e4a3000022\", \"sample_rate\": 0.8, \"replacement\": true }]","items":{"type":"string"}},"project":{"type":"string","description":"The **project/id** you want the **dataset** to belong to. **Example**: \"project/{{ project_id }}\""},"refresh_field_types":{"type":"boolean","description":"Specifies whether field types need to recomputed or not. **Example**: true","enum":[true,false]},"refresh_objective":{"type":"boolean","description":"Specifies whether the default objective field of the dataset needs to be recomputed or not. **Example**: true","enum":[true,false]},"refresh_preferred":{"type":"boolean","description":"Specifies whether preferred field flags need to recomputed or not. **Example**: true","enum":[true,false]},"shared_hash":{"type":"string","description":"The **shared hash** of the shared model to be cloned. **Example**: \"kpY46mNuNVReITw0Z1mAqoQ9ySW\""},"size":{"type":"number","description":"The number of bytes from the source that you want to use. **Example**: 1073741824"},"source":{"type":"string","description":"A valid **source/id**. **Example**: \"source/{{ source_id }}\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **dataset**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"term_limit":{"type":"number","description":"The maximum total number of terms to be used in text analysis. **Example**: 500"},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"description":"This is a description of my new dataset","excluded_fields":["excluded_fields_value"],"fields":{},"input_fields":["input_fields_value"],"json_filter":["json_filter_value"],"lisp_filter":"(> 3.14 (field 2))","name":"my new dataset","objective_field":{},"origin":"dataset/{{ dataset_id }}","origin_dataset":"dataset/{{ dataset_id }}","origin_datasets":["origin_datasets_value"],"project":"project/{{ project_id }}","refresh_field_types":true,"refresh_objective":true,"refresh_preferred":true,"shared_hash":"kpY46mNuNVReITw0Z1mAqoQ9ySW","size":1073741824,"source":"source/{{ source_id }}","tags":["tags_value"],"term_limit":500,"webhook":{}}}}}},"get":{"tags":["Datasets"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/datasets/","api_endpoint":"https://bigml.io/andromeda/dataset"},"summary":"List datasets","description":"To list all the **dataset**, you can use the **dataset** base URL. By default, only the 20 most recent **datasets** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/dataset/{id}":{"get":{"tags":["Datasets"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/datasets/","api_endpoint":"https://bigml.io/andromeda/dataset/{id}"},"summary":"Retrieve a dataset","description":"Each **dataset** has a unique identifier in the form **\"dataset/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **dataset**. Notice that to download the dataset file in the CSV format, you will need to append **\"/download\"**, and in the Tableau tde format, append **\"/download?format=tde\"** to resource id.","security":[{"bearerAuth":[]}]},"put":{"tags":["Datasets"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/datasets/","api_endpoint":"https://bigml.io/andromeda/dataset/{id}"},"summary":"Update a dataset","description":"To update a **dataset**, you need to PUT an object containing the fields that you want to update to the **dataset**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **dataset**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **dataset**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **dataset** up to 8192 characters long. **Example**: \"This is a description of my new dataset\""},"name":{"type":"string","description":"The name you want to give to the new **dataset**. **Example**: \"my new dataset\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **dataset**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new dataset","name":"my new dataset","tags":["tags_value"]}}}}},"delete":{"tags":["Datasets"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/datasets/","api_endpoint":"https://bigml.io/andromeda/dataset/{id}"},"summary":"Delete a dataset","description":"To delete a **dataset**, you need to issue a HTTP DELETE request to the **dataset/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/deepnet":{"post":{"tags":["Deepnets"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/deepnets/","api_endpoint":"https://bigml.io/andromeda/deepnet"},"summary":"Create a deepnet","description":"To create a new **deepnet**, you need to POST to the **deepnet** base URL an object containing at least the **dataset/id** that you want to use to create the **deepnet**. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **deepnet**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"all_fields_preferred":{"type":"boolean","description":"Setting this parameter to **true** will set the preferred flag of all fields at once, instead of doing it one by one in a **fields** map. **Example**: true","enum":[true,false]},"balance_objective":{"type":"boolean","description":"Whether to balance classes proportionally to their category counts or not. For more information, see the [Automatic Balancing](models#Automatic-Balancing) section. **Example**: true","enum":[true,false]},"batch_normalization":{"type":"boolean","description":"Specifies whether to normalize the outputs of a network before being passed to the activation function or not. **Example**: true","enum":[true,false]},"beta1":{"type":"string","description":"A number between 0 and 1 specifying the exponential decay rate for the 1st moment estimates. Used in the **adam** algorithm. **Example**: 0.2"},"beta2":{"type":"string","description":"A number between 0 and 1 specifying the exponential decay rate for the 2nd moment estimates. Used in the **adam** algorithm. **Example**: 1.0"},"c":{"type":"string","description":"The regularization strength. Must be greater than 0. Used in the **ftrl** algorithm. **Example**: 2.0"},"dataset":{"type":"string","description":"A valid **dataset/id**. **Example**: dataset/{{ dataset_id }}"},"datasets":{"type":"array","description":"A list of dataset ids or objects to be used to build the new **deepnet**. See the [Section on Multi-Datasets](datasets#multi-datasets) and [Section on Resources Accepting Multi-Datasets Input](datasets#resources-accepting-multi-datasets-input) for more details. **Example**: [{ \"id\": \"dataset/{{ dataset_id }}\", \"sample_rate\": 0.5, \"out_of_bag\": true }, { \"id\": \"dataset/603e20a91f386f43db000005\", \"s","items":{"type":"string"}},"decay":{"type":"string","description":"A number between 0 and 1 specifying the decay computation. Used in the **rms_prop** algorithm. **Example**: 0.2"},"deep":{"type":"boolean","description":"Clone the dataset used to build the **deepnet** while cloning the original . Must be used along with the **origin** or **shared_hash** option. **Example**: true","enum":[true,false]},"deepnet_seed":{"type":"string","description":"A string to generate a deterministic ordering of training data, the initial network weights, and the behavior of dropout during training."},"default_numeric_value":{"type":"string","description":"It accepts any of the following strings to substitute missing numeric values across all the numeric fields in the dataset: **mean**, **median**, **minimum**, **maximum**, **zero**. **Example**: \"median\""},"default_regions_value":{"type":"array","description":"Available for object detection models, where the objective field is a regions field. It specifies the value to assign to missing objective values (string or positive number). A typical use case is when we know that all images whose regions are not set actually have no objects in them (in which case we'll set the default to the empty list). **Example**: [[\"class1\"]]","items":{"type":"string"}},"description":{"type":"string","description":"A description of the **deepnet** up to 8192 characters long. **Example**: \"This is a description of my new deepnet\""},"dropout_rate":{"type":"string","description":"A number between 0 and 1 specifying the rate at which to drop weights during training to control overfitting. **Example**: 0.2"},"epsilon":{"type":"string","description":"A number between 0 and 1 specifying a small constant for numerical stability. Used in the **adam** and **rms_prop** algorithms. **Example**: 1.0"},"excluded_fields":{"type":"array","description":"Specifies the fields that won't be included in the models of the **deepnet**. **Example**: [\"000000\", \"000002\"]","items":{"type":"string"}},"fields":{"type":"object","description":"This can be used to change the names of the fields in the deepnet with respect to the original names in the dataset or to tell **BigML** that certain fields should be preferred. An entry keyed with the field id generated in the **source** for each field that you want the name updated. **Example**: { \"000001\": {\"name\": \"length_1\"}, \"000003\": {\"name\": \"length_2\"}, }","properties":{}},"fields_maps":{"type":"object","description":"A dictionary keyed by **dataset/id** and **object** values. Each entry maps fields in the first dataset to fields in the dataset referenced by the key. **Example**: { \"dataset/{{ dataset_id }}\": { \"000000\":\"000023\", \"000001\":\"000024\", \"000002\":\"00003a\"}, \"dataset/603e20a91f386f43db000005\": { \"000000\":\"000023\", \"000001\":\"000004\", \"000002\":\"00000f\" }","properties":{}},"hidden_layers":{"type":"array","description":"A list of maps describing the number and type of layers in the network (other than the output layer, which is determined by the type of learning problem). The available keys are: number_of_nodes: An integer giving the number of nodes in the layer.; activation_function: The activation function applied to each node. Available activation functions are **\"identity\"**, **\"tanh\"**, **\"sigmoid\"**, **\"sof","items":{"type":"string"}},"image_augmentations":{"type":"array","description":"A list of augmentation strategies to use for image data. The available keys are: **\"flip_horizontal\"**, **\"flip_vertical\"**, **\"brightness\"**.","items":{"type":"string"}},"include_extracted_features":{"type":"array","description":"Extracted image features to use as model inputs. Available options are: **true**: include all extracted features, unless explicitly excluded (this is the default for all non-deepnet models.); **false**: don't include any extracted features (this is the default for deepnet models, if not given.); **list of ids**: a explicit list of field ids, corresponding to extracted fields to add to the default ","items":{"type":"string"}},"initial_accumulator_value":{"type":"string","description":"A positive number specifying the starting value for accumulators. Used in the **ftrl** and **adagrad** algorithms. **Example**: 0.3"},"input_fields":{"type":"array","description":"Specifies the fields to be considered to create the **deepnet**. **Example**: [\"000001\", \"000003\"]","items":{"type":"string"}},"input_image_shape":{"type":"array","description":"Three positive integers [width, height, 3] giving the width and height to which we should normalize the network images. Color channels is fixed at three for the time being.","items":{"type":"string"}},"learn_residuals":{"type":"boolean","description":"Specifies whether alternate layers should learn a representation of the residuals for a given layer rather than the layer itself or not. **Example**: true","enum":[true,false]},"learning_rate":{"type":"string","description":"A number between 0 and 1 specifying the learning rate. **Example**: 0.3"},"learning_rate_power":{"type":"string","description":"A number less or equal to zero. Used in the **ftrl** algorithm. **Example**: -0.6"},"max_iterations":{"type":"number","description":"A number between 100 and 100000 for the maximum number of gradient steps to take during the optimization. **Example**: 100"},"max_training_time":{"type":"number","description":"The maximum training time, in seconds, for which to train the network. Training may stop early if performance on a holdout set does not show improvement. Use -1 to deactivate the max training time. This value takes precedence over **training_duration** if specified. **Example**: 3600"},"missing_numerics":{"type":"boolean","description":"Whether to create an additional binary predictor each numeric field which denotes a missing value. If false, these predictors are not created, and rows containing missing numeric values are dropped. **Example**: false","enum":[true,false]},"momentum":{"type":"string","description":"A number between 0 and 1 specifying the momentum for the moving average. Used in the **rms_prop** and **momentum** algorithms. **Example**: 0.1"},"name":{"type":"string","description":"The name you want to give to the new **deepnet**. **Example**: \"my new deepnet\""},"number_of_cnn_candidates":{"type":"number","description":"Number of models to try in the model search. Maximum 6 models. **Example**: 5"},"number_of_hidden_layers":{"type":"number","description":"The number of hidden layers to use in the network. If the number is greater than the length of the list of **hidden_layers**, the list is **cycled** until the desired number is reached. If the number is smaller than the length of the list of **hidden_layers**, the list is **shortened**. **Example**: 3"},"number_of_model_candidates":{"type":"number","description":"Number of models try during the model search. Maximum 200 candidates. **Example**: 100"},"objective_field":{"type":"object","description":"Specifies the id of the field that the **deepnet** will predict. **Example**: \"000003\"","properties":{}},"objective_fields":{"type":"array","description":"Specifies the id of the field that you want to predict. Even if this an array **BigML.io** only accepts one **objective field** in the current version. If both **objective_field** and **objective_fields** are specified then, **objective_field** takes preference. The type of the fields must be numerical. **Example**: [\"000003\"]","items":{"type":"string"}},"objective_weights":{"type":"array","description":"A list of category and weight pairs. One per objective class. For more information, see the [Objective Weights](models#Objective-Weights) section. **Example**: [ [\"Iris-versicolor\", 2], [\"Iris-virginica\", 1], [\"Iris-setosa\", 1] ]","items":{"type":"string"}},"optimizer":{"type":"object","description":"Algorithm configuration used to calculate the **deepnet**. A map keyed by algorithm name, where available algorithms are **adam**, **adagrad**, **ftrl**, **momentum** and **rms_prop**. Each entry is map containing the specific parameters for the algorithm. See the [Optimizer Object](#Optimizer-Object) for more details. **Example**: { \"adam\": { \"beta1\": 0.9, \"beta2\": 0.999, \"epsilon\": 0.11 } }","properties":{}},"ordering":{"type":"number","description":"Specifies the type of ordering followed to build the models of the **deepnet**. There are three different types that you can specify: **0** Deterministic; **1** Linear; **2** Random; For more information, see the [Section on Shuffling](models#Shuffling-the-Rows-of-Your-Dataset). **Example**: 1"},"origin":{"type":"string","description":"The **deepnet/id** of the deepnet to be cloned. The price of the deepnet must be 0 to be cloned via API. Set **deep** to **true** to clone the dataset used to build the deepnet too. Note that the dataset can be cloned only if it is already in the public gallery and free. If multiple datasets have been used to create the deepnet, only the first dataset will be cloned. **Example**: \"deepnet/{{ deepn"},"out_of_bag":{"type":"boolean","description":"Setting this parameter to **true** will return a sequence of the out-of-bag instances instead of the sampled instances. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: true","enum":[true,false]},"project":{"type":"string","description":"The **project/id** you want the **deepnet** to belong to. **Example**: \"project/{{ project_id }}\""},"range":{"type":"array","description":"The range of successive instances to build the **deepnet**. **Example**: [1, 150]","items":{"type":"string"}},"regression_weight_ratio":{"type":"string","description":"A strictly positive value describing the learning penalty for above-objective errors in relation to below-objective errors. That is, if this value is 10, prediction errors above the objective will be penalized 10 times more during learning. **Example**: 10"},"regularization":{"type":"string","description":"Either **l1** or **l2**, which selects the norm to minimize when regularizing the solution. Regularizing with respect to the **l1** norm causes more coefficients to be zero, using the **l2** norm forces the magnitudes of all coefficients towards zero. Used in the **ftrl** algorithm. **Example**: \"l1\""},"replacement":{"type":"boolean","description":"Whether sampling should be performed with or without replacement. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: true","enum":[true,false]},"sample_rate":{"type":"string","description":"A real number between 0 and 1 specifying the sample rate. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: 0.5"},"search":{"type":"boolean","description":"During the **deepnet** creation, **BigML** trains and evaluates over all possible network configurations, returning the best networks found for the problem. The final **deepnet** returned by the search is a **compromise** between the top **n** networks found in the search. Since this option builds several networks, it may be significantly slower than the suggest_structure technique. When it is set","enum":[true,false]},"seed":{"type":"string","description":"A string to be hashed to generate deterministic samples. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: \"MySample\""},"shared_hash":{"type":"string","description":"The **shared hash** of the shared **deepnet** to be cloned. Set **deep** to **true** to clone the dataset used to build the deepnet too. Note that the dataset can be cloned only if it is already shared and set clonable. If multiple datasets have been used to create the deepnet, only the first dataset will be cloned. **Example**: \"kpY46mNuNVReITw0Z1mAqoQ9ySW\""},"suggest_structure":{"type":"boolean","description":"An alternative to the search technique that is usually a more efficient way to quickly train and iterate deepnets and it can reach similar results. BigML has learned some general rules about what makes one network structure better than another for a given dataset. Given your dataset, BigML will automatically suggest a structure and a set of parameter values that are likely to perform well for your","enum":[true,false]},"tags":{"type":"array","description":"A list of strings that help classify and index your **deepnet**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"training_duration":{"type":"number","description":"The user's preference for the amount of time they wish the optimization to take, where higher numbers indicate a willingness to wait, and lower numbers indicate impatience. If this is specified (and both **max_iterations** and **max_training_time** are not), the system uses this setting, along with the dataset size and field types to calculate a \"reasonable\" value for **max_training_time**. **Exam"},"tree_embedding":{"type":"boolean","description":"Specify whether to learn a tree-based representation of the data as engineered features along with the raw features, essentially by learning trees over slices of the input space and a small amount of the training data. The theory is that these engineered features will linearize obvious non-linear dependencies before training begins, and so make learning proceed more quickly. **Example**: true","enum":[true,false]},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}},"weight_field":{"type":"string","description":"Any numeric field with no negative or missing values is valid as a weight field. Each instance will be weighted individually according to the weight field's value. For more information, see the [Weight Field](models#Weight-Field) section. **Example**: \"000005\""}}},"example":{"category":1,"all_fields_preferred":true,"balance_objective":true,"batch_normalization":true,"beta1":"0.2","beta2":"1.0","c":"2.0","dataset":"dataset/{{ dataset_id }}","datasets":["datasets_value"],"decay":"0.2","deep":true,"deepnet_seed":"deepnet_seed_value","default_numeric_value":"median","default_regions_value":["default_regions_value_value"],"description":"This is a description of my new deepnet","dropout_rate":"0.2","epsilon":"1.0","excluded_fields":["excluded_fields_value"],"fields":{},"fields_maps":{},"hidden_layers":["hidden_layers_value"],"image_augmentations":["image_augmentations_value"],"include_extracted_features":["include_extracted_features_value"],"initial_accumulator_value":"0.3","input_fields":["input_fields_value"],"input_image_shape":["input_image_shape_value"],"learn_residuals":true,"learning_rate":"0.3","learning_rate_power":"-0.6","max_iterations":100,"max_training_time":3600,"missing_numerics":"","momentum":"0.1","name":"my new deepnet","number_of_cnn_candidates":5,"number_of_hidden_layers":3,"number_of_model_candidates":100,"objective_field":{},"objective_fields":["objective_fields_value"],"objective_weights":["objective_weights_value"],"optimizer":{},"ordering":1,"origin":"deepnet/{{ deepnet_id }}","out_of_bag":true,"project":"project/{{ project_id }}","range":["range_value"],"regression_weight_ratio":"10","regularization":"l1","replacement":true,"sample_rate":"0.5","search":true,"seed":"MySample","shared_hash":"kpY46mNuNVReITw0Z1mAqoQ9ySW","suggest_structure":true,"tags":["tags_value"],"training_duration":7,"tree_embedding":true,"webhook":{},"weight_field":"000005"}}}}},"get":{"tags":["Deepnets"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/deepnets/","api_endpoint":"https://bigml.io/andromeda/deepnet"},"summary":"List deepnets","description":"To list all the **deepnets**, you can use the **deepnet** base URL. By default, only the 20 most recent **deepnets** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/deepnet/{id}":{"get":{"tags":["Deepnets"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/deepnets/","api_endpoint":"https://bigml.io/andromeda/deepnet/{id}"},"summary":"Retrieve a deepnet","description":"Each **deepnet** has a unique identifier in the form **\"deepnet/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **deepnet**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Deepnets"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/deepnets/","api_endpoint":"https://bigml.io/andromeda/deepnet/{id}"},"summary":"Update a deepnet","description":"To update a **deepnet**, you need to PUT an object containing the fields that you want to update to the **deepnet**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **deepnet**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **deepnet**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **deepnet** up to 8192 characters long. **Example**: \"This is a description of my new deepnet\""},"name":{"type":"string","description":"The name you want to give to the new **deepnet**. **Example**: \"my new deepnet\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **deepnet**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new deepnet","name":"my new deepnet","tags":["tags_value"]}}}}},"delete":{"tags":["Deepnets"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/deepnets/","api_endpoint":"https://bigml.io/andromeda/deepnet/{id}"},"summary":"Delete a deepnet","description":"To delete a **deepnet**, you need to issue a HTTP DELETE request to the **deepnet/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/ensemble":{"post":{"tags":["Ensembles"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/ensembles/","api_endpoint":"https://bigml.io/andromeda/ensemble"},"summary":"Create an ensemble","description":"To create a new **ensemble**, you need to POST to the **ensemble** base URL an object containing at least the **dataset/id** that you want to use to create the **ensemble**. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **ensemble**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"all_fields_preferred":{"type":"boolean","description":"Setting this parameter to **true** will set the preferred flag of all fields at once, instead of doing it one by one in a **fields** map. **Example**: true","enum":[true,false]},"balance_objective":{"type":"boolean","description":"Whether to balance classes proportionally to their category counts or not. For more information, see the [Automatic Balancing](models#Automatic-Balancing ) section. **Example**: true","enum":[true,false]},"boosting":{"type":"object","description":"Gradient boosting options for the **ensemble**. Required to created an **ensemble** with boosted trees. See the [Gradient Boosting](#Gradient-Boosting) section for more information. **Example**: { \"iterations\": 5, \"learning_rate\": 0.75 }","properties":{}},"dataset":{"type":"string","description":"A valid **dataset/id**. **Example**: dataset/{{ dataset_id }}"},"datasets":{"type":"array","description":"A list of dataset ids or objects to be used to build the new **ensemble**. See the [Section on Multi-Datasets](datasets#multi-datasets) and [Section on Resources Accepting Multi-Datasets Input](datasets#resources-accepting-multi-datasets-input) for more details. **Example**: [{ \"id\": \"dataset/{{ dataset_id }}\", \"sample_rate\": 0.5, \"out_of_bag\": true }, { \"id\": \"dataset/603e20a91f386f43db000005\", \"","items":{"type":"string"}},"deep":{"type":"boolean","description":"Clone the dataset used to build the **ensemble** while cloning the original . Must be used along with the **origin** or **shared_hash** option. **Example**: true","enum":[true,false]},"default_numeric_value":{"type":"string","description":"It accepts any of the following strings to substitute missing numeric values across all the numeric fields in the dataset: **mean**, **median**, **minimum**, **maximum**, **zero**. **Example**: \"mean\""},"depth_threshold":{"type":"number","description":"When the depth in the tree exceeds this value, the tree stops growing. It has no effect if it's bigger than the **node_threshold**. **Example**: 128"},"description":{"type":"string","description":"A description of the **ensemble** up to 8192 characters long. **Example**: \"This is a description of my new ensemble\""},"ensemble_sample":{"type":"object","description":"The sampling to be used for each tree in the ensemble. It can contain a **rate** (default **1**), and **replacement** (default **true**), and **seed** parameters. Note that this is different from the **sample_rate**, **replacement**, and **seed** used in other models, predictions or datasets, where sampling is applied once to the input dataset; rather, it's applied multiple times to the input, in ","properties":{}},"excluded_fields":{"type":"array","description":"Specifies the fields that won't be included in the **ensemble**. **Example**: [\"000000\", \"000002\"]","items":{"type":"string"}},"fields":{"type":"object","description":"This can be used to change the names of the fields in the ensemble with respect to the original names in the dataset or to tell **BigML** that certain fields should be preferred. An entry keyed with the field id generated in the **source** for each field that you want the name updated. **Example**: { \"000001\": {\"name\": \"length_1\"}, \"000003\": {\"name\": \"length_2\"}, }","properties":{}},"fields_maps":{"type":"object","description":"A dictionary keyed by **dataset/id** and **object** values. Each entry maps fields in the first dataset to fields in the dataset referenced by the key. **Example**: { \"dataset/{{ dataset_id }}\": { \"000000\":\"000023\", \"000001\":\"000024\", \"000002\":\"00003a\"}, \"dataset/603e20a91f386f43db000005\": { \"000000\":\"000023\", \"000001\":\"000004\", \"000002\":\"00000f\" }","properties":{}},"focus_field":{"type":"string","description":"A field name or identifier for a categorical field. If set, the resulting tree will split first, in a cascade, on all categories of the given field. We are still splitting first on the field, but all nodes are kept binary (i.e., having two children). This is for the convenience of clients that don't know how to handle non-binary splits. **Example**: \"000001\""},"include_extracted_features":{"type":"array","description":"Extracted image features to use as model inputs. Available options are: **true**: include all extracted features, unless explicitly excluded (this is the default for all non-deepnet models.); **false**: don't include any extracted features (this is the default for deepnet models, if not given.); **list of ids**: a explicit list of field ids, corresponding to extracted fields to add to the default ","items":{"type":"string"}},"input_fields":{"type":"array","description":"Specifies the fields to be considered to create the **ensemble**. **Example**: [\"000001\", \"000003\"]","items":{"type":"string"}},"max_training_time":{"type":"number","description":"The maximum training time allowed for the optimization, in seconds, as a strictly positive integer. Applicable only when **optimize** is set to **true**. **Example**: 3600"},"missing_splits":{"type":"boolean","description":"Defines whether to explicitly include missing field values when choosing a split. When this option is enabled, generates predicates whose operators include an asterisk, such as >\\*, or missing \". So a split with the operator >* and the value 8 can be read as \" x > 8 or x is missing \". When using missing_splits there may also be predicates with operators = or !=, but with a null value. This means \"","enum":[true,false]},"name":{"type":"string","description":"The name you want to give to the new **ensemble**. **Example**: \"my new ensemble\""},"node_threshold":{"type":"number","description":"When the number of nodes in the tree exceeds this value, the tree stops growing. **Example**: 1000"},"number_of_model_candidates":{"type":"number","description":"The number of model candidates evaluated over the course of the optimization. Applicable only when **optimize** is set to **true**. Maximum 200 candidates. **Example**: 100"},"number_of_models":{"type":"number","description":"The number of models to build the **ensemble**. This parameter is ignored for **boosted trees**. See the [Gradient Boosting](#Gradient-Boosting) section for more information. **Example**: 100"},"objective_field":{"type":"object","description":"Specifies the id of the field that the **ensemble** will predict. **Example**: \"000003\"","properties":{}},"objective_fields":{"type":"array","description":"Specifies the id of the field that you want to predict. Even if this an array **BigML.io** only accepts one **objective field** in the current version. If both **objective_field** and **objective_fields** are specified then, **objective_field** takes preference. **Example**: [\"000003\"]","items":{"type":"string"}},"objective_weights":{"type":"array","description":"A list of category and weight pairs. One per objective class. For more information, see the [Objective Weights](models#Objective-Weights) section. **Example**: [ [\"Iris-versicolor\", 2], [\"Iris-virginica\", 1], [\"Iris-setosa\", 1] ]","items":{"type":"string"}},"operating_point":{"type":"object","description":"The specification of an operating point for classification problems. See [Prediction](predictions#Prediction-Arguments) or [Evaluation](evaluations#Evaluation-Arguments) for more information.","properties":{}},"optimize":{"type":"boolean","description":"Whether the ensemble should be built with the automatic optimization. When it is set to **true**, only the following modeling properties are applied: **default_numeric_value**, **excluded_fields**, **input_fields**, **max_training_time**, **missing_splits**, **number_of_model_candidates**, **objective_field**, **objective_weights**, **sample_rate**, and **weight_field**. **Example**: true","enum":[true,false]},"ordering":{"type":"number","description":"Specifies the type of ordering followed to build the **ensmeble**. There are three different types that you can specify: **0** Deterministic; **1** Linear; **2** Random; For more information, see the [Section on Shuffling](models#Shuffling-the-Rows-of-Your-Dataset). **Example**: 1"},"origin":{"type":"string","description":"The **ensemble/id** of the ensemble to be cloned. The price of the ensemble must be 0 to be cloned via API. Set **deep** to **true** to clone the dataset used to build the ensemble too. Note that the dataset can be cloned only if it is already in the public gallery and free. If multiple datasets have been used to create the ensemble, only the first dataset will be cloned. **Example**: \"ensemble/{{"},"out_of_bag":{"type":"boolean","description":"Setting this parameter to **true** will return a sequence of the out-of-bag instances instead of the sampled instances. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: true","enum":[true,false]},"project":{"type":"string","description":"The **project/id** you want the **ensemble** to belong to. **Example**: \"project/{{ project_id }}\""},"random_candidate_ratio":{"type":"string","description":"A real number between 0 and 1. When **randomize** is true and **random_candidate_ratio** is given, BigML randomizes the tree and uses _random_candidate_ratio * total fields_ (counting the number of terms in text fields as fields). To get the final number of candidate fields we round down to the nearest integer, but if the result is 0 we'll use 1 instead. If both **random_candidates** and **random_"},"random_candidates":{"type":"number","description":"Sets the number of random fields considered when **randomize** is **true**. **Example**: 10"},"randomize":{"type":"boolean","description":"Setting this parameter to **true** will consider only a subset of the possible fields when choosing a split. See the [Section on Random Decision Forests](models#Random-Decision-Forests) below. **Example**: true","enum":[true,false]},"range":{"type":"array","description":"The range of successive instances to build the **ensemble**. **Example**: [1, 150]","items":{"type":"string"}},"replacement":{"type":"boolean","description":"Whether sampling should be performed with or without replacement. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: true","enum":[true,false]},"sample_rate":{"type":"string","description":"A real number between 0 and 1 specifying the sample rate. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: 0.5"},"seed":{"type":"string","description":"A string to be hashed to generate deterministic samples. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: \"MySample\""},"shared_hash":{"type":"string","description":"The **shared hash** of the shared **ensmeble** to be cloned. Set **deep** to **true** to clone the dataset used to build the ensmeble too. Note that the dataset can be cloned only if it is already shared and set clonable. If multiple datasets have been used to create the ensmeble, only the first dataset will be cloned. **Example**: \"kpY46mNuNVReITw0Z1mAqoQ9ySW\""},"split_candidates":{"type":"number","description":"The number of split points that are considered whenever the tree evaluates a numeric field. Minimum 1 and maximum 1024. **Example**: 128"},"split_field":{"type":"string","description":"A field name or identifier for a categorical field. If set, the first split of the decision tree will use this field and have a children per category (i.e., if there are n categories, the first node will have n elements in its children). **Example**: \"000001\""},"stat_pruning":{"type":"boolean","description":"Activates statistical pruning on each decision tree model. It doesn't apply to boosted trees. **Example**: true","enum":[true,false]},"support_threshold":{"type":"string","description":"The parameter controls the minimum amount of support each child node must contain to be valid as a possible split. So, if it is 3, then a both children of a new split must have 3 instances supporting them. Since instances may have non-integer weights, non-integer values are valid. **Example**: 16"},"tags":{"type":"array","description":"A list of strings that help classify and index your **ensemble**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}},"weight_field":{"type":"string","description":"Any numeric field with no negative or missing values is valid as a weight field. Each instance will be weighted individually according to the weight field's value. For more information, see the [Weight Field](models#Weight-Field) section. **Example**: \"000001\""}}},"example":{"category":1,"all_fields_preferred":true,"balance_objective":true,"boosting":{},"dataset":"dataset/{{ dataset_id }}","datasets":["datasets_value"],"deep":true,"default_numeric_value":"mean","depth_threshold":128,"description":"This is a description of my new ensemble","ensemble_sample":{},"excluded_fields":["excluded_fields_value"],"fields":{},"fields_maps":{},"focus_field":"000001","include_extracted_features":["include_extracted_features_value"],"input_fields":["input_fields_value"],"max_training_time":3600,"missing_splits":"","name":"my new ensemble","node_threshold":1000,"number_of_model_candidates":100,"number_of_models":100,"objective_field":{},"objective_fields":["objective_fields_value"],"objective_weights":["objective_weights_value"],"operating_point":{},"optimize":true,"ordering":1,"origin":"ensemble/{{ ensemble_id }}","out_of_bag":true,"project":"project/{{ project_id }}","random_candidate_ratio":"0.2","random_candidates":10,"randomize":true,"range":["range_value"],"replacement":true,"sample_rate":"0.5","seed":"MySample","shared_hash":"kpY46mNuNVReITw0Z1mAqoQ9ySW","split_candidates":128,"split_field":"000001","stat_pruning":true,"support_threshold":"16","tags":["tags_value"],"webhook":{},"weight_field":"000001"}}}}},"get":{"tags":["Ensembles"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/ensembles/","api_endpoint":"https://bigml.io/andromeda/ensemble"},"summary":"List ensembles","description":"To list all the **ensembles**, you can use the **ensemble** base URL. By default, only the 20 most recent **ensembles** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/ensemble/{id}":{"get":{"tags":["Ensembles"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/ensembles/","api_endpoint":"https://bigml.io/andromeda/ensemble/{id}"},"summary":"Retrieve an ensemble","description":"Each **ensemble** has a unique identifier in the form **\"ensemble/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **ensemble**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Ensembles"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/ensembles/","api_endpoint":"https://bigml.io/andromeda/ensemble/{id}"},"summary":"Update an ensemble","description":"To update an **ensemble**, you need to PUT an object containing the fields that you want to update to the **ensemble**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **ensemble**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **ensemble**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **ensemble** up to 8192 characters long. **Example**: \"This is a description of my new ensemble\""},"name":{"type":"string","description":"The name you want to give to the new **ensemble**. **Example**: \"my new ensemble\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **ensemble**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new ensemble","name":"my new ensemble","tags":["tags_value"]}}}}},"delete":{"tags":["Ensembles"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/ensembles/","api_endpoint":"https://bigml.io/andromeda/ensemble/{id}"},"summary":"Delete an ensemble","description":"To delete an **ensemble**, you need to issue a HTTP DELETE request to the **ensemble/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/evaluation":{"post":{"tags":["Evaluations"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/evaluations/","api_endpoint":"https://bigml.io/andromeda/evaluation"},"summary":"Create an evaluation","description":"To create a new **evaluation**, you need to POST to the **evaluation** base URL an object containing a **supervised model id** that you want to evaluate and **dataset/id** of the dataset that contains the data that will be used to compute the performance of the model. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **evaluation**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"dataset":{"type":"string","description":"A valid **dataset/id**. **Example**: \"dataset/{{ dataset_id }}\""},"datasets":{"type":"array","description":"A list of dataset ids or objects to be used to build the new **evaluation**. See the [Section on Multi-Datasets](datasets#multi-datasets) and [Section on Resources Accepting Multi-Datasets Input](datasets#resources-accepting-multi-datasets-input) for more details. **Example**: [{ \"id\": \"dataset/{{ dataset_id }}\", \"sample_rate\": 0.5, \"out_of_bag\": true }, { \"id\": \"dataset/dataset/603e20a91f386f43db","items":{"type":"string"}},"deepnet":{"type":"string","description":"A valid **deepnet/id**. **Example**: \"deepnet/{{ deepnet_id }}\""},"default_numeric_value":{"type":"string","description":"It accepts any of the following strings to substitute missing numeric values across all the numeric fields in the dataset: **mean**, **median**, **minimum**, **maximum**, **zero**. **Example**: \"mean\""},"description":{"type":"string","description":"A description of the **evaluation** up to 8192 characters long. **Example**: \"This is a description of my new evaluation\""},"ensemble":{"type":"string","description":"A valid **ensemble/id**. **Example**: \"ensemble/{{ ensemble_id }}\""},"excluded_fields":{"type":"array","description":"Specifies the fields in the dataset to be excluded to create the **evaluation**. **Example**: [\"000000\", \"000002\"]","items":{"type":"string"}},"fields_map":{"type":"object","description":"A dictionary of identifiers of the fields to use from the model under test mapped to their corresponding identifiers in the input dataset. **Example**: {\"000000\":\"00000a\", \"000001\":\"000002\", \"000002\":\"000001\", \"000003\":\"000020\", \"000004\":\"000004\"}","properties":{}},"fusion":{"type":"string","description":"A valid **fusion/id**. **Example**: \"fusion/{{ fusion_id }}\""},"input_fields":{"type":"array","description":"Specifies the fields in the dataset to be considered to create the **evaluation**. **Example**: [\"000001\", \"000003\"]","items":{"type":"string"}},"linearregression":{"type":"string","description":"A valid **linearregression/id**. **Example**: \"linearregression/{{ linearregression_id }}\""},"logisticregression":{"type":"string","description":"A valid **logisticregression/id**. **Example**: \"logisticregression/{{ logisticregression_id }}\""},"missing_strategy":{"type":"number","description":"Specifies the method that should be used for the **model**, **ensemble** or **fusion** when a missing split is found. That is, when a missing value is found in the input data for a decision node. The options are: 0: **last prediction** predicts based on the subset of the data which reached the parent of the missing split.; 1: **proportional** evaluates all the subtrees of a missing split and recom"},"model":{"type":"string","description":"A valid model id of the supported supervised model. Alternatively, you can use **ensemble**, **linearregression**, **logisticregression**, **deepnet** or **fusion** arguments. **Example**: \"model/{{ model_id }}\""},"name":{"type":"string","description":"The name you want to give to the new **evaluation**. **Example**: \"my new evaluation\""},"operating_kind":{"type":"string","description":"The operating threshold kind corresponding to the confusion matrix to perform the evaluation. It also replaces **combiner** and its value can be **confidence**, **probability**, and for non-boosted ensembles, **votes**. **Example**: \"confidence\""},"operating_point":{"type":"object","description":"The specification of an operating point for classification problems to perform the evaluation which consists of a **positive_class** (one of the categories of the model's objective field), and a **threshold** (a number between 0 and 1), and an optional field **kind** (**confidence**, **probability**, and for non-boosted ensembles, **votes**). When it presents, **BigML** will predict the positive_c","properties":{}},"ordering":{"type":"number","description":"Specifies the type of ordering followed to build the **linear regression**. There are three different types that you can specify: **0** Deterministic; **1** Linear; **2** Random; For more information, see the [Section on Shuffling](models#Shuffling-the-Rows-of-Your-Dataset). **Example**: 1"},"out_of_bag":{"type":"boolean","description":"Setting this parameter to **true** will return a sequence of the out-of-bag instances instead of the sampled instances. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. Dataset sampling doesn't apply to evaluations for time series. **Example**: true","enum":[true,false]},"private":{"type":"boolean","description":"Whether you want your **evaluation** to be private or not. **Example**: false","enum":[true,false]},"project":{"type":"string","description":"The **evaluation/id** you want the **evaluation** to belong to. **Example**: \"project/{{ project_id }}\""},"range":{"type":"array","description":"The range of successive instances to evaluate the **model**. **Example**: [1, 150]","items":{"type":"string"}},"replacement":{"type":"boolean","description":"Whether sampling should be performed with or without replacement. SSee the [Section on Sampling](models#Sampling-Your-Dataset) for more details Dataset sampling doesn't apply to evaluations for time series. **Example**: true","enum":[true,false]},"sample_rate":{"type":"string","description":"A real number between 0 and 1 specifying the sample rate. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. Dataset sampling doesn't apply to evaluations for time series. **Example**: 0.5"},"seed":{"type":"string","description":"A string to be hashed to generate deterministic sample. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. Dataset sampling doesn't apply to evaluations for time series. **Example**: \"MySample\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **evaluation**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"timeseries":{"type":"string","description":"A valid **timeseries/id**. **Example**: \"timeseries/{{ timeseries_id }}\""},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"dataset":"dataset/{{ dataset_id }}","datasets":["datasets_value"],"deepnet":"deepnet/{{ deepnet_id }}","default_numeric_value":"mean","description":"This is a description of my new evaluation","ensemble":"ensemble/{{ ensemble_id }}","excluded_fields":["excluded_fields_value"],"fields_map":{},"fusion":"fusion/{{ fusion_id }}","input_fields":["input_fields_value"],"linearregression":"linearregression/{{ linearregression_id }}","logisticregression":"logisticregression/{{ logisticregression_id }}","missing_strategy":1,"model":"model/{{ model_id }}","name":"my new evaluation","operating_kind":"confidence","operating_point":{},"ordering":1,"out_of_bag":true,"private":"","project":"project/{{ project_id }}","range":["range_value"],"replacement":true,"sample_rate":"0.5","seed":"MySample","tags":["tags_value"],"timeseries":"timeseries/{{ timeseries_id }}","webhook":{}}}}}},"get":{"tags":["Evaluations"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/evaluations/","api_endpoint":"https://bigml.io/andromeda/evaluation"},"summary":"List evaluations","description":"To list all the **evaluations**, you can use the **evaluation** base URL. By default, only the 20 most recent **evaluations** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/evaluation/{id}":{"get":{"tags":["Evaluations"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/evaluations/","api_endpoint":"https://bigml.io/andromeda/evaluation/{id}"},"summary":"Retrieve an evaluation","description":"Each **evaluation** has a unique identifier in the form **\"evaluation/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **evaluation**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Evaluations"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/evaluations/","api_endpoint":"https://bigml.io/andromeda/evaluation/{id}"},"summary":"Update an evaluation","description":"To update an **evaluation**, you need to PUT an object containing the fields that you want to update to the **evaluation**' s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **evaluation**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **evaluation**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **evaluation** up to 8192 characters long. **Example**: \"This is a description of my new evaluation\""},"name":{"type":"string","description":"The name you want to give to the new **evaluation**. **Example**: \"my new evaluation\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **evaluation**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new evaluation","name":"my new evaluation","tags":["tags_value"]}}}}},"delete":{"tags":["Evaluations"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/evaluations/","api_endpoint":"https://bigml.io/andromeda/evaluation/{id}"},"summary":"Delete an evaluation","description":"To delete an **evaluation**, you need to issue a HTTP DELETE request to the **evaluation/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/externalconnector":{"post":{"tags":["External Connectors"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/external_connectors/","api_endpoint":"https://bigml.io/andromeda/externalconnector"},"summary":"Create an external connector","description":"To create a new **external connector**, you just need to POST to the **external connector** base URL.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **external connector**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"connection":{"type":"object","description":"Set of parameters that describes the connection to the data source to generate the **external connector**. See the [Creating a Source Using External Data](sources#Creating-a-Source-Using-External-Data) for more detail.","properties":{}},"description":{"type":"string","description":"A description of the **external connector** up to 8192 characters long. **Example**: \"This is a description of my new external connector\""},"engine":{"type":"string","description":"Name of the external data source to connect to. Available options are: \"elasticsearch\", \"postgresql\", \"mysql\", \"sqlserver\". **Example**: \"elasticsearch\""},"name":{"type":"string","description":"The name you want to give to the new **external connector**. **Example**: \"my new external connector\""},"project":{"type":"string","description":"The **project/id** you want the **external connector** to belong to. **Example**: \"project/{{ project_id }}\""},"public_in_organization":{"type":"boolean","description":"Whether the **external connector** is public within the organization. **Example**: true","enum":[true,false]},"tags":{"type":"array","description":"A list of strings that help classify and index your **external connector**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the [Section on Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"connection":{},"description":"This is a description of my new external connector","engine":"elasticsearch","name":"my new external connector","project":"project/{{ project_id }}","public_in_organization":true,"tags":["tags_value"],"webhook":{}}}}}},"get":{"tags":["External Connectors"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/external_connectors/","api_endpoint":"https://bigml.io/andromeda/externalconnector"},"summary":"List external connectors","description":"To list all the **external connectors**, you can use the **external connector** base URL. By default, only the 20 most recent **external connectors** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/externalconnector/{id}":{"get":{"tags":["External Connectors"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/external_connectors/","api_endpoint":"https://bigml.io/andromeda/externalconnector/{id}"},"summary":"Retrieve an external connector","description":"Each **external connector** has a unique identifier in the form \"**externalconnector/id**\" where id is a string of 24 alpha-numeric characters that you can use to retrieve the **external connector**.","security":[{"bearerAuth":[]}]},"put":{"tags":["External Connectors"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/external_connectors/","api_endpoint":"https://bigml.io/andromeda/externalconnector/{id}"},"summary":"Update an external connector","description":"To update an **external connector**, you need to PUT an object containing the fields that you want to update to the **external connector**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **external connector**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **external connector**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **external connector** up to 8192 characters long. **Example**: \"This is a description of my new external connector\""},"name":{"type":"string","description":"The name you want to give to the new **external connector**. **Example**: \"my new external connector\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **external connector**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new external connector","name":"my new external connector","tags":["tags_value"]}}}}},"delete":{"tags":["External Connectors"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/external_connectors/","api_endpoint":"https://bigml.io/andromeda/externalconnector/{id}"},"summary":"Delete an external connector","description":"To delete an **external connector**, you need to issue a HTTP DELETE request to the **externalconnector/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/forecast":{"post":{"tags":["Forecasts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/forecasts/","api_endpoint":"https://bigml.io/andromeda/forecast"},"summary":"Create a forecast","description":"To create a new **forecast**, you need to POST to the **forecast** base URL an object containing at least the **timeseries/id** that you want to use to create the **forecast** and an instance. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **forecast**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"criterion":{"type":"string","description":"One of \"aic\", \"aicc\", \"bic\". Together with limit, this specifies to use the best ETS model for this field when scored according to the given information criterion. **Example**: \"aicc\""},"description":{"type":"string","description":"A description of the **forecast** up to 8192 characters long. **Example**: \"This is a description of my new forecast\""},"indices":{"type":"array","description":"Select ETS models by directly indexing the ETS models list in the model resource. **Example**: [0, 1, 2]","items":{"type":"string"}},"input_data":{"type":"object","description":"A map keyed by objective ids, and values being maps containing the forecast horizon (number of future steps to predict), and a selector for the ETS models to use to compute the forecast.If the selector field is entirely absent, it will default to {\"criterion\":\"aic\", \"limit\":1}. See the [section](#ETS-Models) below for more details. **Example**: { \"000000\": { \"horizon\":30, \"ets_models\": { \"indices\"","properties":{}},"intervals":{"type":"boolean","description":"Include the lower and upper confidence bounds for the forecast that are calculated. **Example**: false","enum":[true,false]},"limit":{"type":"number","description":"The number of ETS models to use when selecting by information criterion.That is, sort the ETS models list by the criterion and return the top limit. **Example**: 10"},"name":{"type":"string","description":"The name you want to give to the new **forecast**. **Example**: \"my new forecast\""},"names":{"type":"array","description":"Select ETS models by name. Values are treated as regular expressions and all ETS models whose names match the regular expression are selected. **Example**: [\"A,A,N\"]","items":{"type":"string"}},"project":{"type":"string","description":"The **project/id** you want the **forecast** to belong to. **Example**: \"project/{{ project_id }}\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **forecast**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"timeseries":{"type":"string","description":"A valid **timeseries/id**. **Example**: \"timeseries/{{ timeseries_id }}\""},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"criterion":"aicc","description":"This is a description of my new forecast","indices":["indices_value"],"input_data":{},"intervals":"","limit":10,"name":"my new forecast","names":["names_value"],"project":"project/{{ project_id }}","tags":["tags_value"],"timeseries":"timeseries/{{ timeseries_id }}","webhook":{}}}}}},"get":{"tags":["Forecasts"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/forecasts/","api_endpoint":"https://bigml.io/andromeda/forecast"},"summary":"List forecasts","description":"To list all the **forecasts**, you can use the **forecast** base URL. By default, only the 20 most recent **forecasts** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/forecast/{id}":{"get":{"tags":["Forecasts"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/forecasts/","api_endpoint":"https://bigml.io/andromeda/forecast/{id}"},"summary":"Retrieve a forecast","description":"Each **forecast** has a unique identifier in the form **\"forecast/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **forecast**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Forecasts"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/forecasts/","api_endpoint":"https://bigml.io/andromeda/forecast/{id}"},"summary":"Update a forecast","description":"To update a **forecast**, you need to PUT an object containing the fields that you want to update to the **forecast**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **forecast**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **forecast**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **forecast** up to 8192 characters long. **Example**: \"This is a description of my new forecast\""},"name":{"type":"string","description":"The name you want to give to the new **forecast**. **Example**: \"my new forecast\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **forecast**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new forecast","name":"my new forecast","tags":["tags_value"]}}}}},"delete":{"tags":["Forecasts"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/forecasts/","api_endpoint":"https://bigml.io/andromeda/forecast/{id}"},"summary":"Delete a forecast","description":"To delete a **forecast**, you need to issue a HTTP DELETE request to the **forecast/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/fusion":{"post":{"tags":["Fusions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/fusions/","api_endpoint":"https://bigml.io/andromeda/fusion"},"summary":"Create a fusion","description":"To create a new **fusion**, you need to POST to the **fusion** base URL an object containing at least a list of **model ids** that you want to use to create the **fusion**. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **fusion**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **fusion** up to 8192 characters long. **Example**: \"This is a description of my new fusion\""},"fields_maps":{"type":"object","description":"A dictionary keyed by a submodel id and **object** values. Each entry maps fields in the submodel to fields in the fusion. **Example**: { \"model/6040a3451f386f1a8c000000\": { \"000000\":\"000023\", \"000001\":\"000024\", \"000002\":\"00003a\" }, \"ensemble/6045de7a1f386f0f73000000\": { \"000000\":\"000023\", \"000001\":\"000004\", \"000002\":\"00000f\" } }","properties":{}},"models":{"type":"array","description":"A list with fusion submodel resource/ids or or list of maps using the key **id** for each submodel resource/id, and any other key/values for additional meta-information on the model. Available submodel types are **deepnet**, **ensemble**, **fusion**, **model**, **linear regression**, and **logistic regression**. The maximum number of submodels is 1000. **Example**: [ \"model/6040a3451f386f1a8c00000","items":{"type":"string"}},"name":{"type":"string","description":"The name you want to give to the new **fusion**. **Example**: \"my new fusion\""},"project":{"type":"string","description":"The **project/id** you want the **fusion** to belong to. **Example**: \"project/{{ project_id }}\""},"shared_hash":{"type":"string","description":"The **shared hash** of the shared **fusion** to be cloned. **Example**: \"kpY46mNuNVReITw0Z1mAqoQ9ySW\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **fusion**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"description":"This is a description of my new fusion","fields_maps":{},"models":["models_value"],"name":"my new fusion","project":"project/{{ project_id }}","shared_hash":"kpY46mNuNVReITw0Z1mAqoQ9ySW","tags":["tags_value"],"webhook":{}}}}}},"get":{"tags":["Fusions"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/fusions/","api_endpoint":"https://bigml.io/andromeda/fusion"},"summary":"List fusions","description":"To list all the **fusions**, you can use the **fusion** base URL. By default, only the 20 most recent **fusion** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/fusion/{id}":{"get":{"tags":["Fusions"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/fusions/","api_endpoint":"https://bigml.io/andromeda/fusion/{id}"},"summary":"Retrieve a fusion","description":"Each **fusion** has a unique identifier in the form **\"fusion/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **fusion**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Fusions"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/fusions/","api_endpoint":"https://bigml.io/andromeda/fusion/{id}"},"summary":"Update a fusion","description":"To update a **fusion**, you need to PUT an object containing the fields that you want to update to the **fusion**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **fusion**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **fusion**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **fusion** up to 8192 characters long. **Example**: \"This is a description of my new fusion\""},"name":{"type":"string","description":"The name you want to give to the new **fusion**. **Example**: \"my new fusion\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **fusion**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new fusion","name":"my new fusion","tags":["tags_value"]}}}}},"delete":{"tags":["Fusions"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/fusions/","api_endpoint":"https://bigml.io/andromeda/fusion/{id}"},"summary":"Delete a fusion","description":"To delete a **fusion**, you need to issue a HTTP DELETE request to the **fusion/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/linearregression":{"post":{"tags":["Linear Regressions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/linear_regressions/","api_endpoint":"https://bigml.io/andromeda/linearregression"},"summary":"Create a linear regression","description":"To create a new **linear regression**, you need to POST to the **linear regression** base URL an object containing at least the **dataset/id** that you want to use to create the **linear regression**. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **linear regression**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"all_fields_preferred":{"type":"boolean","description":"Setting this parameter to **true** will set the preferred flag of all fields at once, instead of doing it one by one in a **fields** map. **Example**: true","enum":[true,false]},"bias":{"type":"boolean","description":"Whether to include the bias term from the solution. **Example**: false","enum":[true,false]},"dataset":{"type":"string","description":"A valid **dataset/id**. **Example**: dataset/{{ dataset_id }}"},"datasets":{"type":"array","description":"A list of dataset ids or objects to be used to build the new **linear regression**. See the [Section on Multi-Datasets](datasets#multi-datasets) and [Section on Resources Accepting Multi-Datasets Input](datasets#resources-accepting-multi-datasets-input) for more details. **Example**: [{ \"id\": \"dataset/{{ dataset_id }}\", \"sample_rate\": 0.5, \"out_of_bag\": true }, { \"id\": \"dataset/603e20a91f386f43db0","items":{"type":"string"}},"deep":{"type":"boolean","description":"Clone the dataset used to build the **linear regression** while cloning the original . Must be used along with the **origin** or **shared_hash** option. **Example**: true","enum":[true,false]},"default_numeric_value":{"type":"string","description":"It accepts any of the following strings to substitute missing numeric values across all the numeric fields in the dataset: **mean**, **median**, **minimum**, **maximum**, **zero**. **Example**: \"median\""},"description":{"type":"string","description":"A description of the **linear regression** up to 8192 characters long. **Example**: \"This is a description of my new linear regression\""},"excluded_fields":{"type":"array","description":"Specifies the fields that won't be included in the **linear regression**. **Example**: [\"000000\", \"000002\"]","items":{"type":"string"}},"field_codings":{"type":"string","description":"Coding schemes for categorical fields: **dummy**, **contrast**, or **other**. Value is a map between field identifiers and a coding scheme for that field. See the [Coding Categorical Fields](#Coding-Categorical-Fields) for more details. If not specified, one numeric variable is created per categorical value, plus one for missing values. **Example**: [{ \"field\": \"workclass\", \"coding\": \"other\", \"coe"},"fields":{"type":"object","description":"This can be used to change the names of the fields in the linear regression with respect to the original names in the dataset or to tell **BigML** that certain fields should be preferred. An entry keyed with the field id generated in the **source** for each field that you want the name updated. **Example**: { \"000001\": {\"name\": \"length_1\"}, \"000003\": {\"name\": \"length_2\"}, }","properties":{}},"fields_maps":{"type":"object","description":"A dictionary keyed by **dataset/id** and **object** values. Each entry maps fields in the first dataset to fields in the dataset referenced by the key. **Example**: { \"dataset/{{ dataset_id }}\": { \"000000\":\"000023\", \"000001\":\"000024\", \"000002\":\"00003a\"}, \"dataset/52bc80233c1920e4a300001a\": { \"000000\":\"000023\", \"000001\":\"000004\", \"000002\":\"00000f\" }","properties":{}},"include_extracted_features":{"type":"array","description":"Extracted image features to use as model inputs. Available options are: **true**: include all extracted features, unless explicitly excluded (this is the default for all non-deepnet models.); **false**: don't include any extracted features (this is the default for deepnet models, if not given.); **list of ids**: a explicit list of field ids, corresponding to extracted fields to add to the default ","items":{"type":"string"}},"input_fields":{"type":"array","description":"Specifies the fields to be considered to create the **linear regression**. **Example**: [\"000001\", \"000003\"]","items":{"type":"string"}},"max_training_time":{"type":"number","description":"The maximum training time allowed for the optimization, in seconds, as a strictly positive integer. Applicable only when **optimize** is set to **true**. **Example**: 3600"},"name":{"type":"string","description":"The name you want to give to the new **linear regression**. **Example**: \"my new linear regression\""},"number_of_model_candidates":{"type":"number","description":"The number of model candidates evaluated over the course of the optimization. Applicable only when **optimize** is set to **true**. Maximum 200 candidates. **Example**: 100"},"objective_field":{"type":"object","description":"Specifies the id of the field that you want to predict. The type of the field must be numerical. **Example**: \"000003\"","properties":{}},"objective_fields":{"type":"array","description":"Specifies the id of the field that you want to predict. Even if this an array **BigML.io** only accepts one **objective field** in the current version. If both **objective_field** and **objective_fields** are specified then, **objective_field** takes preference. The type of the fields must be numerical. **Example**: [\"000003\"]","items":{"type":"string"}},"optimize":{"type":"boolean","description":"Whether the linear regression should be built with the automatic optimization. When it is set to **true**, only the following modeling properties are applied: **default_numeric_value**, **excluded_fields**, **input_fields**, **max_training_time**, **missing_splits**, **number_of_model_candidates**, **objective_field**, **objective_weights**, **sample_rate**, and **weight_field**. **Example**: true","enum":[true,false]},"ordering":{"type":"number","description":"Specifies the type of ordering followed to build the **linear regression**. There are three different types that you can specify: **0** Deterministic; **1** Linear; **2** Random; For more information, see the [Section on Shuffling](models#Shuffling-the-Rows-of-Your-Dataset). **Example**: 1"},"origin":{"type":"string","description":"The **linearregression/id** of the linear regression to be cloned. The price of the linear regression must be 0 to be cloned via API. Set **deep** to **true** to clone the dataset used to build the linear regression too. Note that the dataset can be cloned only if it is already in the public gallery and free. If multiple datasets have been used to create the linear regression, only the first datas"},"out_of_bag":{"type":"boolean","description":"Setting this parameter to **true** will return a sequence of the out-of-bag instances instead of the sampled instances. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: true","enum":[true,false]},"project":{"type":"string","description":"The **project/id** you want the **linear regression** to belong to. **Example**: \"project/{{ project_id }}\""},"range":{"type":"array","description":"The range of successive instances to build the **linear regression**. **Example**: [1, 150]","items":{"type":"string"}},"replacement":{"type":"boolean","description":"Whether sampling should be performed with or without replacement. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: true","enum":[true,false]},"sample_rate":{"type":"string","description":"A real number between 0 and 1 specifying the sample rate. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: 0.5"},"seed":{"type":"string","description":"A string to be hashed to generate deterministic samples. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: \"MySample\""},"shared_hash":{"type":"string","description":"The **shared hash** of the shared linear regression to be cloned. Set **deep** to **true** to clone the dataset used to build the linear regression too. Note that the dataset can be cloned only if it is already shared and set clonable. If multiple datasets have been used to create the linear regression, only the first dataset will be cloned. **Example**: \"kpY46mNuNVReITw0Z1mAqoQ9ySW\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **linear regression**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}},"weight_field":{"type":"string","description":"Any numeric field with no negative or missing values is valid as a weight field. Each instance will be weighted individually according to the weight field's value. For more information, see the [Weight Field](models#Weight-Field) section. **Example**: \"000001\""},"white_box":{"type":"boolean","description":"Whether the **linear regression** is publicly shared as a white-box.","required":true,"enum":[true,false]}}},"example":{"category":1,"all_fields_preferred":true,"bias":"","dataset":"dataset/{{ dataset_id }}","datasets":["datasets_value"],"deep":true,"default_numeric_value":"median","description":"This is a description of my new linear regression","excluded_fields":["excluded_fields_value"],"field_codings":"field_codings_value","fields":{},"fields_maps":{},"include_extracted_features":["include_extracted_features_value"],"input_fields":["input_fields_value"],"max_training_time":3600,"name":"my new linear regression","number_of_model_candidates":100,"objective_field":{},"objective_fields":["objective_fields_value"],"optimize":true,"ordering":1,"origin":"linearregression/{{ linearregression_id }}","out_of_bag":true,"project":"project/{{ project_id }}","range":["range_value"],"replacement":true,"sample_rate":"0.5","seed":"MySample","shared_hash":"kpY46mNuNVReITw0Z1mAqoQ9ySW","tags":["tags_value"],"webhook":{},"weight_field":"000001","white_box":""}}}}},"get":{"tags":["Linear Regressions"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/linear_regressions/","api_endpoint":"https://bigml.io/andromeda/linearregression"},"summary":"List linear regressions","description":"To list all the **linear regressions**, you can use the **linear regression** base URL. By default, only the 20 most recent **linear regressions** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/linearregression/{id}":{"get":{"tags":["Linear Regressions"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/linear_regressions/","api_endpoint":"https://bigml.io/andromeda/linearregression/{id}"},"summary":"Retrieve a linear regression","description":"Each **linear regression** has a unique identifier in the form **\"linearregression/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **linear regression**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Linear Regressions"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/linear_regressions/","api_endpoint":"https://bigml.io/andromeda/linearregression/{id}"},"summary":"Update a linear regression","description":"To update a **linear regression**, you need to PUT an object containing the fields that you want to update to the **linear regression**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **linear regression**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **linear regression**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **linear regression** up to 8192 characters long. **Example**: \"This is a description of my new linear regression\""},"fields":{"type":"object","description":"This can be used to change the names of the fields in the linear regression with respect to the original names in the dataset or to tell **BigML** that certain fields should be preferred. An entry keyed with the field id generated in the **source** for each field that you want the name updated. **Example**: { \"000001\": {\"name\": \"length_1\"}, \"000003\": {\"name\": \"length_2\"}, }","properties":{}},"name":{"type":"string","description":"The name you want to give to the new **linear regression**. **Example**: \"my new linear regression\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **linear regression**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new linear regression","fields":{},"name":"my new linear regression","tags":["tags_value"]}}}}},"delete":{"tags":["Linear Regressions"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/linear_regressions/","api_endpoint":"https://bigml.io/andromeda/linearregression/{id}"},"summary":"Delete a linear regression","description":"To delete a **linear regression**, you need to issue a HTTP DELETE request to the **linearregression/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/logisticregression":{"post":{"tags":["Logistic Regressions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/logistic_regressions/","api_endpoint":"https://bigml.io/andromeda/logisticregression"},"summary":"Create a logistic regression","description":"To create a new **logistic regression**, you need to POST to the **logistic regression** base URL an object containing at least the **dataset/id** that you want to use to create the **logistic regression**. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **logistic regression**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"all_fields_preferred":{"type":"boolean","description":"Setting this parameter to **true** will set the preferred flag of all fields at once, instead of doing it one by one in a **fields** map. **Example**: true","enum":[true,false]},"balance_fields":{"type":"boolean","description":"Whether to scale each numeric field such that its values are zero mean with a standard deviation of 1, based on the field summary statistics at training time. **Example**: true","enum":[true,false]},"balance_objective":{"type":"boolean","description":"Whether to balance classes proportionally to their category counts or not. For more information, see the [Automatic Balancing](models#Automatic-Balancing) section. **Example**: true","enum":[true,false]},"bias":{"type":"boolean","description":"Whether to include the bias term from the solution. **Example**: false","enum":[true,false]},"c":{"type":"string","description":"The inverse of the regularization strength. Must be greater than 0. **Example**: 2"},"compute_stats":{"type":"boolean","description":"Whether to compute statistics and significance tests. **Example**: true","enum":[true,false]},"dataset":{"type":"string","description":"A valid **dataset/id**. **Example**: dataset/{{ dataset_id }}"},"datasets":{"type":"array","description":"A list of dataset ids or objects to be used to build the new **logistic regression**. See the [Section on Multi-Datasets](datasets#multi-datasets) and [Section on Resources Accepting Multi-Datasets Input](datasets#resources-accepting-multi-datasets-input) for more details. **Example**: [{ \"id\": \"dataset/{{ dataset_id }}\", \"sample_rate\": 0.5, \"out_of_bag\": true }, { \"id\": \"dataset/603e20a91f386f43d","items":{"type":"string"}},"deep":{"type":"boolean","description":"Clone the dataset used to build the **logistic regression** while cloning the original . Must be used along with the **origin** or **shared_hash** option. **Example**: true","enum":[true,false]},"default_numeric_value":{"type":"string","description":"It accepts any of the following strings to substitute missing numeric values across all the numeric fields in the dataset: **mean**, **median**, **minimum**, **maximum**, **zero**. **Example**: \"median\""},"description":{"type":"string","description":"A description of the **logistic regression** up to 8192 characters long. **Example**: \"This is a description of my new logistic regression\""},"eps":{"type":"string","description":"Stopping criteria for solver. If the difference between the results from the current and last iterations is less than eps, then the solver is finished. **Example**: 0.1"},"excluded_fields":{"type":"array","description":"Specifies the fields that won't be included in the **logistic regression**. **Example**: [\"000000\", \"000002\"]","items":{"type":"string"}},"field_codings":{"type":"string","description":"Coding schemes for categorical fields: **dummy**, **contrast**, or **other**. Value is a map between field identifiers and a coding scheme for that field. See the [Coding Categorical Fields](#Coding-Categorical-Fields) for more details. If not specified, one numeric variable is created per categorical value, plus one for missing values. **Example**: [ { \"field\": \"workclass\", \"coding\": \"other\", \"co"},"fields":{"type":"object","description":"This can be used to change the names of the fields in the logistic regression with respect to the original names in the dataset or to tell **BigML** that certain fields should be preferred. An entry keyed with the field id generated in the **source** for each field that you want the name updated. **Example**: { \"000001\": {\"name\": \"length_1\"}, \"000003\": {\"name\": \"length_2\"}, }","properties":{}},"fields_maps":{"type":"object","description":"A dictionary keyed by **dataset/id** and **object** values. Each entry maps fields in the first dataset to fields in the dataset referenced by the key. **Example**: { \"dataset/{{ dataset_id }}\": { \"000000\":\"000023\", \"000001\":\"000024\", \"000002\":\"00003a\"}, \"dataset/603e20a91f386f43db000005\": { \"000000\":\"000023\", \"000001\":\"000004\", \"000002\":\"00000f\" }","properties":{}},"include_extracted_features":{"type":"array","description":"Extracted image features to use as model inputs. Available options are: **true**: include all extracted features, unless explicitly excluded (this is the default for all non-deepnet models.); **false**: don't include any extracted features (this is the default for deepnet models, if not given.); **list of ids**: a explicit list of field ids, corresponding to extracted fields to add to the default ","items":{"type":"string"}},"input_fields":{"type":"array","description":"Specifies the fields to be considered to create the **logistic regression**. **Example**: [\"000001\", \"000003\"]","items":{"type":"string"}},"max_training_time":{"type":"number","description":"The maximum training time allowed for the optimization, in seconds, as a strictly positive integer. Applicable only when **optimize** is set to **true**. **Example**: 3600"},"missing_numerics":{"type":"boolean","description":"Whether to create an additional binary predictor each numeric field which denotes a missing value. If false, these predictors are not created, and rows containing missing numeric values are dropped. **Example**: false","enum":[true,false]},"name":{"type":"string","description":"The name you want to give to the new **logistic regression**. **Example**: \"my new logistic regression\""},"normallize":{"type":"boolean","description":"Whether to normalize feature vectors in training and predicting. **Example**: true","enum":[true,false]},"number_of_model_candidates":{"type":"number","description":"The number of model candidates evaluated over the course of the optimization. Applicable only when **optimize** is set to **true**. Maximum 200 candidates. **Example**: 100"},"objective_field":{"type":"object","description":"Specifies the id of the field that you want to predict. The type of the field must be categorical. **Example**: \"000003\"","properties":{}},"objective_fields":{"type":"array","description":"Specifies the id of the field that you want to predict. Even if this an array **BigML.io** only accepts one **objective field** in the current version. If both **objective_field** and **objective_fields** are specified then, **objective_field** takes preference. The type of the fields must be categorical. **Example**: [\"000003\"]","items":{"type":"string"}},"objective_weights":{"type":"array","description":"A list of category and weight pairs. One per objective class. For more information, see the [Objective Weights](models#Objective-Weights) section. **Example**: [ [\"Iris-versicolor\", 2], [\"Iris-virginica\", 1], [\"Iris-setosa\", 1] ]","items":{"type":"string"}},"optimize":{"type":"boolean","description":"Whether the **logistic regression** should be built with the automatic optimization. When it is set to **true**, only the following modeling properties are applied: **default_numeric_value**, **excluded_fields**, **input_fields**, **max_training_time**, **missing_splits**, **number_of_model_candidates**, **objective_field**, **objective_weights**, **sample_rate**, and **weight_field**. **Example**","enum":[true,false]},"ordering":{"type":"number","description":"Specifies the type of ordering followed to build the **logistic regression**. There are three different types that you can specify: **0** Deterministic; **1** Linear; **2** Random; For more information, see the [Section on Shuffling](models#Shuffling-the-Rows-of-Your-Dataset). **Example**: 1"},"origin":{"type":"string","description":"The **logisticregression/id** of the logistic regression to be cloned. The price of the logistic regression must be 0 to be cloned via API. Set **deep** to **true** to clone the dataset used to build the logistic regression too. Note that the dataset can be cloned only if it is already in the public gallery and free. If multiple datasets have been used to create the logistic regression, only the f"},"out_of_bag":{"type":"boolean","description":"Setting this parameter to **true** will return a sequence of the out-of-bag instances instead of the sampled instances. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: true","enum":[true,false]},"project":{"type":"string","description":"The **project/id** you want the **logistic regression** to belong to. **Example**: \"project/{{ project_id }}\""},"range":{"type":"array","description":"The range of successive instances to build the **logistic regression**. **Example**: [1, 150]","items":{"type":"string"}},"regularization":{"type":"string","description":"Either **l1** or **l2**, which selects the norm to minimize when regularizing the solution. Regularizing with respect to the **l1** norm causes more coefficients to be zero, using the **l2** norm forces the magnitudes of all coefficients towards zero. **Example**: \"l1\""},"replacement":{"type":"boolean","description":"Whether sampling should be performed with or without replacement. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: true","enum":[true,false]},"sample_rate":{"type":"string","description":"A real number between 0 and 1 specifying the sample rate. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: 0.5"},"seed":{"type":"string","description":"A string to be hashed to generate deterministic samples. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: \"MySample\""},"shared_hash":{"type":"string","description":"The **shared hash** of the shared **logistic regression** to be cloned. Set **deep** to **true** to clone the dataset used to build the logistic regression too. Note that the dataset can be cloned only if it is already shared and set clonable. If multiple datasets have been used to create the logistic regression, only the first dataset will be cloned. **Example**: \"kpY46mNuNVReITw0Z1mAqoQ9ySW\""},"stats_sample_seed":{"type":"string","description":"Random seed value used for stats sampling. **Example**: \"My stats seed\""},"stats_sample_size":{"type":"number","description":"The number of rows to sample for calculating statistics. If -1 is given, then the number of rows will be calculated such that (rows x coefficients) <= 1E+8. The minimum between that number and the total number of input rows will be used. **Example**: 100"},"tags":{"type":"array","description":"A list of strings that help classify and index your **logistic regression**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}},"weight_field":{"type":"string","description":"Any numeric field with no negative or missing values is valid as a weight field. Each instance will be weighted individually according to the weight field's value. For more information, see the [Weight Field](models#Weight-Field) section. **Example**: \"000001\""}}},"example":{"category":1,"all_fields_preferred":true,"balance_fields":true,"balance_objective":true,"bias":"","c":"2","compute_stats":true,"dataset":"dataset/{{ dataset_id }}","datasets":["datasets_value"],"deep":true,"default_numeric_value":"median","description":"This is a description of my new logistic regression","eps":"0.1","excluded_fields":["excluded_fields_value"],"field_codings":"field_codings_value","fields":{},"fields_maps":{},"include_extracted_features":["include_extracted_features_value"],"input_fields":["input_fields_value"],"max_training_time":3600,"missing_numerics":"","name":"my new logistic regression","normallize":true,"number_of_model_candidates":100,"objective_field":{},"objective_fields":["objective_fields_value"],"objective_weights":["objective_weights_value"],"optimize":true,"ordering":1,"origin":"logisticregression/{{ logisticregression_id }}","out_of_bag":true,"project":"project/{{ project_id }}","range":["range_value"],"regularization":"l1","replacement":true,"sample_rate":"0.5","seed":"MySample","shared_hash":"kpY46mNuNVReITw0Z1mAqoQ9ySW","stats_sample_seed":"My stats seed","stats_sample_size":100,"tags":["tags_value"],"webhook":{},"weight_field":"000001"}}}}},"get":{"tags":["Logistic Regressions"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/logistic_regressions/","api_endpoint":"https://bigml.io/andromeda/logisticregression"},"summary":"List logistic regressions","description":"To list all the **logistic regressions**, you can use the **logistic regression** base URL. By default, only the 20 most recent **logistic regressions** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/logisticregression/{id}":{"get":{"tags":["Logistic Regressions"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/logistic_regressions/","api_endpoint":"https://bigml.io/andromeda/logisticregression/{id}"},"summary":"Retrieve a logistic regression","description":"Each **logistic regression** has a unique identifier in the form **\"logisticregression/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **logistic regression**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Logistic Regressions"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/logistic_regressions/","api_endpoint":"https://bigml.io/andromeda/logisticregression/{id}"},"summary":"Update a logistic regression","description":"To update a **logistic regression**, you need to PUT an object containing the fields that you want to update to the **logistic regression**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **logistic regression**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **logistic regression**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **logistic regression** up to 8192 characters long. **Example**: \"This is a description of my new logistic regression\""},"fields":{"type":"object","description":"This can be used to change the names of the fields in the logistic regression with respect to the original names in the dataset or to tell **BigML** that certain fields should be preferred. An entry keyed with the field id generated in the **source** for each field that you want the name updated. **Example**: { \"000001\": {\"name\": \"length_1\"}, \"000003\": {\"name\": \"length_2\"}, }","properties":{}},"name":{"type":"string","description":"The name you want to give to the new **logistic regression**. **Example**: \"my new logistic regression\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **logistic regression**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new logistic regression","fields":{},"name":"my new logistic regression","tags":["tags_value"]}}}}},"delete":{"tags":["Logistic Regressions"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/logistic_regressions/","api_endpoint":"https://bigml.io/andromeda/logisticregression/{id}"},"summary":"Delete a logistic regression","description":"To delete a **logistic regression**, you need to issue a HTTP DELETE request to the **logisticregression/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/model":{"post":{"tags":["Models"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/models/","api_endpoint":"https://bigml.io/andromeda/model"},"summary":"Create a model","description":"To create a new **model**, you need to POST to the **model** base URL an object containing at least the **dataset/id** that you want to use to create the **model**. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **model**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"all_fields_preferred":{"type":"boolean","description":"Setting this parameter to **true** will set the preferred flag of all fields at once, instead of doing it one by one in a **fields** map. **Example**: true","enum":[true,false]},"balance_objective":{"type":"boolean","description":"Setting this parameter to **true** will specify weights for a classification objective which are proportional to their category counts. See this [Section](#Automatic-Balancing) for more information. **Example**: true","enum":[true,false]},"centroid":{"type":"string","description":"The **centroid/id** you want the **model** is associated to. **Example**: \"000000\""},"cluster":{"type":"string","description":"The **cluster/id** you want the **model** is associated to. **Example**: \"cluster/60363d8e1f386fc650000015\""},"dataset":{"type":"string","description":"A valid **dataset/id**. **Example**: dataset/{{ dataset_id }}"},"datasets":{"type":"array","description":"A list of dataset ids or objects to be used to build the new **model**. See the [Section on Multi-Datasets](datasets#multi-datasets) and [Section on Resources Accepting Multi-Datasets Input](datasets#resources-accepting-multi-datasets-input) for more details. **Example**: [{ \"id\": \"dataset/{{ dataset_id }}\", \"sample_rate\": 0.5, \"out_of_bag\": true }, { \"id\": \"dataset/603e20a91f386f43db000005\", \"sam","items":{"type":"string"}},"deep":{"type":"boolean","description":"Clone the dataset used to build the **model** while cloning the original . Must be used along with the **origin** or **shared_hash** option. **Example**: true","enum":[true,false]},"default_numeric_value":{"type":"string","description":"It accepts any of the following strings to substitute missing numeric values across all the numeric fields in the dataset: **mean**, **median**, **minimum**, **maximum**, **zero**. **Example**: \"median\""},"depth_threshold":{"type":"number","description":"When the depth in the tree exceeds this value, the tree stops growing. It has no effect if it's bigger than the **node_threshold**. **Example**: 128"},"description":{"type":"string","description":"A description of the **model** up to 8192 characters long. **Example**: \"This is a description of my new model\""},"excluded_fields":{"type":"array","description":"Specifies the fields that won't be included in the **model**. **Example**: [\"000000\", \"000002\"]","items":{"type":"string"}},"fields":{"type":"object","description":"This can be used to change the names of the fields in the model with respect to the original names in the dataset or to tell **BigML** that certain fields should be preferred. An entry keyed with the field id generated in the **source** for each field that you want the name updated. **Example**: { \"000001\": {\"name\": \"length_1\"}, \"000003\": {\"name\": \"length_2\"}, }","properties":{}},"fields_maps":{"type":"object","description":"A dictionary keyed by **dataset/id** and **object** values. Each entry maps fields in the first dataset to fields in the dataset referenced by the key. **Example**: { \"dataset/{{ dataset_id }}\": { \"000000\":\"000023\", \"000001\":\"000024\", \"000002\":\"00003a\"}, \"dataset/603e20a91f386f43db000005\": { \"000000\":\"000023\", \"000001\":\"000004\", \"000002\":\"00000f\" }","properties":{}},"focus_field":{"type":"string","description":"A field name or identifier for a categorical field. If set, the resulting tree will split first, in a cascade, on all categories of the given field. We are still splitting first on the field, but all nodes are kept binary (i.e., having two children). This is for the convenience of clients that don't know how to handle non-binary splits. **Example**: \"000001\""},"include_extracted_features":{"type":"array","description":"Extracted image features to use as model inputs. Available options are: **true**: include all extracted features, unless explicitly excluded (this is the default for all non-deepnet models.); **false**: don't include any extracted features (this is the default for deepnet models, if not given.); **list of ids**: a explicit list of field ids, corresponding to extracted fields to add to the default ","items":{"type":"string"}},"input_fields":{"type":"array","description":"Specifies the fields to be considered to create the **model**. **Example**: [\"000001\", \"000003\"]","items":{"type":"string"}},"max_training_time":{"type":"number","description":"The maximum training time allowed for the optimization, in seconds, as a strictly positive integer. Applicable only when **optimize** is set to **true**. **Example**: 3600"},"missing_splits":{"type":"boolean","description":"Defines whether to explicitly include missing field values when choosing a split. When this option is enabled, generates predicates whose operators include an asterisk, such as >\\*, \"or missing\" . So a split with the operator >* and the value 8 can be read as \" x > 8 or x is missing \". When using missing_splits there may also be predicates with operators = or !=, but with a null value. This means ","enum":[true,false]},"name":{"type":"string","description":"The name you want to give to the new **model**. **Example**: \"my new model\""},"node_threshold":{"type":"number","description":"When the number of nodes in the tree exceeds this value, the tree stops growing. **Example**: 1000"},"number_of_model_candidates":{"type":"number","description":"The number of model candidates evaluated over the course of the optimization. Applicable only when **optimize** is set to **true**. Maximum 200 candidates. **Example**: 100"},"objective_field":{"type":"object","description":"Specifies the id of the field that you want to predict. **Example**: \"000003\"","properties":{}},"objective_fields":{"type":"array","description":"Specifies the id of the field that you want to predict. Even if this an array **BigML.io** only accepts one **objective field** in the current version. If both **objective_field** and **objective_fields** are specified then, **objective_field** takes preference. **Example**: [\"000003\"]","items":{"type":"string"}},"objective_weights":{"type":"array","description":"See [Section on Weight](#Weights). Specific weight for each class in classification models. **Example**: [[\"Iris-versicolor\", 2], [\"Iris-virginica\", 1], [\"Iris-setosa\", 1]]","items":{"type":"string"}},"operating_point":{"type":"object","description":"The specification of an operating point for classification problems. See [Prediction](predictions#Prediction-Arguments) or [Evaluation](evaluations#Evaluation-Arguments) for more information.","properties":{}},"optimize":{"type":"boolean","description":"Whether the model should be built with the automatic optimization. When it is set to **true**, only the following modeling properties are applied: **default_numeric_value**, **excluded_fields**, **input_fields**, **max_training_time**, **missing_splits**, **number_of_model_candidates**, **objective_field**, **objective_weights**, **sample_rate**, and **weight_field**. **Example**: true","enum":[true,false]},"ordering":{"type":"number","description":"Specifies the type of ordering followed to build the **model**. There are three different types that you can specify: **0** Deterministic; **1** Linear; **2** Random; For more information, see the [Section on Shuffling](#Shuffling-the-Rows-of-Your-Dataset) your dataset below. **Example**: 1"},"origin":{"type":"string","description":"The **model/id** of the gallery model to be cloned. The price of the model must be 0 to be cloned via API. Set **deep** to **true** to clone the dataset used to build the model too. Note that the dataset can be cloned only if it is already in the public gallery and free. If multiple datasets have been used to create the model, only the first dataset will be cloned. **Example**: \"model/{{ model_id "},"out_of_bag":{"type":"boolean","description":"Setting this parameter to **true** will return a sequence of the out-of-bag instances instead of the sampled instances. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: true","enum":[true,false]},"project":{"type":"string","description":"The **project/id** you want the **model** to belong to. **Example**: \"project/{{ project_id }}\""},"random_candidate_ratio":{"type":"string","description":"A real number between 0 and 1. When **randomize** is true and **random_candidate_ratio** is given, BigML randomizes the tree and uses _random_candidate_ratio * total fields_ (counting the number of terms in text fields as fields). To get the final number of candidate fields we round down to the nearest integer, but if the result is 0 we'll use 1 instead. If both **random_candidates** and **random_"},"random_candidates":{"type":"number","description":"Sets the number of random fields considered when **randomize** is **true**. **Example**: 10"},"randomize":{"type":"boolean","description":"Setting this parameter to true will consider only a subset of the possible fields when choosing a split. See the [Section on Random Decision Forests](#Random-Decision-Forests) below. **Example**: true","enum":[true,false]},"range":{"type":"array","description":"The range of successive instances to build the **model**. **Example**: [1, 150]","items":{"type":"string"}},"replacement":{"type":"boolean","description":"Whether sampling should be performed with or without replacement. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: true","enum":[true,false]},"sample_rate":{"type":"string","description":"A real number between 0 and 1 specifying the sample rate. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: 0.5"},"seed":{"type":"string","description":"A string to be hashed to generate deterministic samples. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: \"MySample\""},"shared_hash":{"type":"string","description":"The **shared hash** of the shared model to be cloned. Set **deep** to **true** to clone the dataset used to build the model too. Note that the dataset can be cloned only if it is already shared and set clonable. If multiple datasets have been used to create the model, only the first dataset will be cloned. **Example**: \"kpY46mNuNVReITw0Z1mAqoQ9ySW\""},"split_candidates":{"type":"number","description":"The number of split points that are considered whenever the tree evaluates a numeric field. Minimum 1 and maximum 1024 **Example**: 128"},"split_field":{"type":"string","description":"A field name or identifier for a categorical field. If set, the first split of the decision tree will use this field and have a children per category (i.e., if there are n categories, the first node will have n elements in its children). **Example**: \"000001\""},"stat_pruning":{"type":"boolean","description":"Activates statistical pruning on your decision tree **model**. **Example**: true","enum":[true,false]},"support_threshold":{"type":"string","description":"The parameter controls the minimum amount of support each child node must contain to be valid as a possible split. So, if it is 3, then a both children of a new split must have 3 instances supporting them. Since instances may have non-integer weights, non-integer values are valid. **Example**: 16"},"tags":{"type":"array","description":"A list of strings that help classify and index your **model**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}},"weight_field":{"type":"string","description":"See [Section on Weight](#Weights). Numeric **field id** with no negative or missing values. **Example**: \"000001\""}}},"example":{"category":1,"all_fields_preferred":true,"balance_objective":true,"centroid":"000000","cluster":"cluster/60363d8e1f386fc650000015","dataset":"dataset/{{ dataset_id }}","datasets":["datasets_value"],"deep":true,"default_numeric_value":"median","depth_threshold":128,"description":"This is a description of my new model","excluded_fields":["excluded_fields_value"],"fields":{},"fields_maps":{},"focus_field":"000001","include_extracted_features":["include_extracted_features_value"],"input_fields":["input_fields_value"],"max_training_time":3600,"missing_splits":true,"name":"my new model","node_threshold":1000,"number_of_model_candidates":100,"objective_field":{},"objective_fields":["objective_fields_value"],"objective_weights":["objective_weights_value"],"operating_point":{},"optimize":true,"ordering":1,"origin":"model/{{ model_id }}","out_of_bag":true,"project":"project/{{ project_id }}","random_candidate_ratio":"0.2","random_candidates":10,"randomize":true,"range":["range_value"],"replacement":true,"sample_rate":"0.5","seed":"MySample","shared_hash":"kpY46mNuNVReITw0Z1mAqoQ9ySW","split_candidates":128,"split_field":"000001","stat_pruning":true,"support_threshold":"16","tags":["tags_value"],"webhook":{},"weight_field":"000001"}}}}},"get":{"tags":["Models"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/models/","api_endpoint":"https://bigml.io/andromeda/model"},"summary":"List models","description":"To list all the **models**, you can use the **model** base URL. By default, only the 20 most recent **models** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/model/{id}":{"get":{"tags":["Models"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/models/","api_endpoint":"https://bigml.io/andromeda/model/{id}"},"summary":"Retrieve a model","description":"Each **model** has a unique identifier in the form **\"model/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **model**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Models"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/models/","api_endpoint":"https://bigml.io/andromeda/model/{id}"},"summary":"Update a model","description":"To update a **model**, you need to PUT an object containing the fields that you want to update to the **model**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **model**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **model**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **model** up to 8192 characters long. **Example**: \"This is a description of my new model\""},"fields":{"type":"object","description":"This can be used to change the names of the fields in the model with respect to the original names in the dataset or to tell **BigML** that certain fields should be preferred. An entry keyed with the field id generated in the **source** for each field that you want the name updated. **Example**: { \"000001\": {\"name\": \"length_1\"}, \"000003\": {\"name\": \"length_2\"}, }","properties":{}},"name":{"type":"string","description":"The name you want to give to the new **model**. **Example**: \"my new model\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **model**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new model","fields":{},"name":"my new model","tags":["tags_value"]}}}}},"delete":{"tags":["Models"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/models/","api_endpoint":"https://bigml.io/andromeda/model/{id}"},"summary":"Delete a model","description":"To delete a **model**, you need to issue a HTTP DELETE request to the **model/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/optiml":{"post":{"tags":["OptiMLs"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/optimls/","api_endpoint":"https://bigml.io/andromeda/optiml"},"summary":"Create an optiml","description":"To create a new **OptiML**, you need to POST to the **OptiML** base URL an object containing at least the **dataset/id** that you want to use to create the **OptiML**. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **OptiML**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"all_fields_preferred":{"type":"boolean","description":"Setting this parameter to **true** will set the preferred flag of all fields at once, instead of doing it one by one in a **fields** map. **Example**: true","enum":[true,false]},"creation_defaults":{"type":"object","description":"A map of default parameters to be used for the created resources. The map contains the keys **all** and **all_models**. Properties under **all** will be applied to all resources that will be created, and properties under **all_models** to model type resources. Available properties for **all**: name, project; **all_models**: default_numeric_value, missing_numerics, missing_splits, sample_rate; Note","properties":{}},"dataset":{"type":"string","description":"A valid **dataset/id** to train the models. **Example**: dataset/{{ dataset_id }}"},"description":{"type":"string","description":"A description of the **OptiML** up to 8192 characters long. **Example**: \"This is a description of my new OptiML\""},"excluded_fields":{"type":"array","description":"Specifies the fields that won't be included in the models of the **OptiML**. **Example**: [\"000000\", \"000002\"]","items":{"type":"string"}},"fields":{"type":"object","description":"This can be used to change the names of the fields in the time series with respect to the original names in the dataset or to tell **BigML** that certain fields should be preferred. An entry keyed with the field id generated in the **source** for each field that you want the name updated. **Example**: { \"000001\": {\"name\": \"length_1\"}, \"000003\": {\"name\": \"length_2\"}, }","properties":{}},"input_fields":{"type":"array","description":"Specifies the fields in the dataset to be considered to create the **OptiML**. **Example**: [\"000001\", \"000003\"]","items":{"type":"string"}},"max_training_time":{"type":"number","description":"The maximum training time allowed for the optimization, in seconds, as a strictly positive integer. **Example**: 3600"},"metric":{"type":"string","description":"The metric used to evaluate models used. For classification problems, you can use one of these: accuracy, area_under_pr_curve, area_under_roc_curve, f_measure, kendalls_tau_b, ks_statistic, max_phi, phi_coefficient, precision, recall, and spearmans_rho. For regression problems, r_squared is the only supported metric. **Deepnet** optimization is an independent process that uses a combination of sev"},"metric_class":{"type":"string","description":"A particular class for which the metric should be taken for classification problems. **Deepnet** optimization is an independent process, hence it is not affected by the configuration of the metric class. **Example**: \"Yes\""},"model_types":{"type":"array","description":"A list of the types of model to create during the search. Available model types are **model**, **ensemble**, **linearregression**, **logisticregression**, **deepnet**. If not specified, all model types are explored according the objective field type. **Example**: [\"model\", \"ensemble\"]","items":{"type":"string"}},"name":{"type":"string","description":"The name you want to give to the new **OptiML**. **Example**: \"my new OptiML\""},"number_of_model_candidates":{"type":"number","description":"The number of model candidates evaluated over the course of the optimization. Maximum 200 candidates. **Example**: 100"},"objective_field":{"type":"object","description":"Specifies the id of the field that the **OptiML** will predict. **Example**: \"000003\"","properties":{}},"objective_weights":{"type":"array","description":"A list of category and weight pairs. One per objective class. For more information, see the [Objective Weights](models#Objective-Weights) section. **Example**: [ [\"Iris-versicolor\", 2], [\"Iris-virginica\", 1], [\"Iris-setosa\", 1] ]","items":{"type":"string"}},"project":{"type":"string","description":"The **project/id** you want the **OptiML** to belong to. **Example**: \"project/{{ project_id }}\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **OptiML**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"test_dataset":{"type":"string","description":"A valid **dataset/id** to test the models. If not provided, test datasets are created from the training **dataset**. **Deepnet** optimization is an independent process that always uses cross-validation, hence it is not affected by the configuration of a test dataset. **Example**: \"dataset/{{ dataset_id }}\""},"training_duration":{"type":"number","description":"The user's preference for the amount of time they wish the optimization to take, where higher numbers indicate a willingness to wait, and lower numbers indicate impatience. If this is specified and **max_training_time** is not, the system uses this setting, along with the dataset size and field types to calculate a \"reasonable\" value for **max_training_time**. **Example**: 7"},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}},"weight_field":{"type":"string","description":"Any numeric field with no negative or missing values is valid as a weight field. Each instance will be weighted individually according to the weight field's value. For more information, see the [Weight Field](models#Weight-Field) section. **Example**: \"000005\""}}},"example":{"category":1,"all_fields_preferred":true,"creation_defaults":{},"dataset":"dataset/{{ dataset_id }}","description":"This is a description of my new OptiML","excluded_fields":["excluded_fields_value"],"fields":{},"input_fields":["input_fields_value"],"max_training_time":3600,"metric":"f_measure","metric_class":"Yes","model_types":["model_types_value"],"name":"my new OptiML","number_of_model_candidates":100,"objective_field":{},"objective_weights":["objective_weights_value"],"project":"project/{{ project_id }}","tags":["tags_value"],"test_dataset":"dataset/{{ dataset_id }}","training_duration":7,"webhook":{},"weight_field":"000005"}}}}},"get":{"tags":["OptiMLs"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/optimls/","api_endpoint":"https://bigml.io/andromeda/optiml"},"summary":"List optimls","description":"To list all the **OptiMLs**, you can use the **OptiML** base URL. By default, only the 20 most recent **OptiMLs** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/optiml/{id}":{"get":{"tags":["OptiMLs"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/optimls/","api_endpoint":"https://bigml.io/andromeda/optiml/{id}"},"summary":"Retrieve an optiml","description":"Each **optiml** has a unique identifier in the form **\"optiml/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **optiml**.","security":[{"bearerAuth":[]}]},"put":{"tags":["OptiMLs"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/optimls/","api_endpoint":"https://bigml.io/andromeda/optiml/{id}"},"summary":"Update an optiml","description":"To update a **OptiML**, you need to PUT an object containing the fields that you want to update to the **OptiML**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **OptiML**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **OptiML**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **OptiML** up to 8192 characters long. **Example**: \"This is a description of my new OptiML\""},"name":{"type":"string","description":"The name you want to give to the new **OptiML**. **Example**: \"my new OptiML\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **OptiML**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new OptiML","name":"my new OptiML","tags":["tags_value"]}}}}},"delete":{"tags":["OptiMLs"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/optimls/","api_endpoint":"https://bigml.io/andromeda/optiml/{id}"},"summary":"Delete an optiml","description":"To delete an **OptiML**, you need to issue a HTTP DELETE request to the **optiml/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/pca":{"post":{"tags":["PCA"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/pcas/","api_endpoint":"https://bigml.io/andromeda/pca"},"summary":"Create a pca","description":"To create a new **pca**, you need to POST to the **pca** base URL an object containing at least the **dataset/id** that you want to use to create the **pca**. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **pca**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"all_fields_preferred":{"type":"boolean","description":"Setting this parameter to **true** will set the preferred flag of all fields at once, instead of doing it one by one in a **fields** map. **Example**: true","enum":[true,false]},"dataset":{"type":"string","description":"A valid **dataset/id**. **Example**: dataset/{{ dataset_id }}"},"datasets":{"type":"array","description":"A list of dataset ids or objects to be used to build the new **pca**. See the [Section on Multi-Datasets](datasets#multi-datasets) and [Section on Resources Accepting Multi-Datasets Input](datasets#resources-accepting-multi-datasets-input) for more details. **Example**: [{ \"id\": \"dataset/{{ dataset_id }}\", \"sample_rate\": 0.5, \"out_of_bag\": true }, { \"id\": \"dataset/603e20a91f386f43db000005\", \"sampl","items":{"type":"string"}},"deep":{"type":"boolean","description":"Clone the dataset used to build the **pca** while cloning the original . Must be used along with the **origin** or **shared_hash** option. **Example**: true","enum":[true,false]},"default_numeric_value":{"type":"string","description":"It accepts any of the following strings to substitute missing numeric values across all the numeric fields in the dataset: **mean**, **median**, **minimum**, **maximum**, **zero**. **Example**: \"median\""},"description":{"type":"string","description":"A description of the **deepcapnet** up to 8192 characters long. **Example**: \"This is a description of my new pca\""},"excluded_fields":{"type":"array","description":"Specifies the fields that won't be included in the **pca**. **Example**: [\"000000\", \"000002\"]","items":{"type":"string"}},"fields":{"type":"object","description":"This can be used to change the names of the fields in the pca with respect to the original names in the dataset or to tell **BigML** that certain fields should be preferred. An entry keyed with the field id generated in the **source** for each field that you want the name updated. **Example**: { \"000001\": {\"name\": \"length_1\"}, \"000003\": {\"name\": \"length_2\"}, }","properties":{}},"fields_maps":{"type":"object","description":"A dictionary keyed by **dataset/id** and **object** values. Each entry maps fields in the first dataset to fields in the dataset referenced by the key. **Example**: { \"dataset/{{ dataset_id }}\": { \"000000\":\"000023\", \"000001\":\"000024\", \"000002\":\"00003a\"}, \"dataset/603e20a91f386f43db000005\": { \"000000\":\"000023\", \"000001\":\"000004\", \"000002\":\"00000f\" }","properties":{}},"include_extracted_features":{"type":"array","description":"Extracted image features to use as model inputs. Available options are: **true**: include all extracted features, unless explicitly excluded (this is the default for all non-deepnet models.); **false**: don't include any extracted features (this is the default for deepnet models, if not given.); **list of ids**: a explicit list of field ids, corresponding to extracted fields to add to the default ","items":{"type":"string"}},"input_fields":{"type":"array","description":"Specifies the fields to be considered to create the **pca**. **Example**: [\"000001\", \"000003\"]","items":{"type":"string"}},"name":{"type":"string","description":"The name you want to give to the new **pca**. **Example**: \"my new pca\""},"ordering":{"type":"number","description":"Specifies the type of ordering followed to build the **pca**. There are three different types that you can specify: **0** Deterministic; **1** Linear; **2** Random; For more information, see the [Section on Shuffling](models#Shuffling-the-Rows-of-Your-Dataset). **Example**: 1"},"origin":{"type":"string","description":"The **pca/id** of the pca to be cloned. The price of the pca must be 0 to be cloned via API. Set **deep** to **true** to clone the dataset used to build the pca too. Note that the dataset can be cloned only if it is already in the public gallery and free. If multiple datasets have been used to create the pca, only the first dataset will be cloned. **Example**: \"pca/{{ pca_id }}\""},"out_of_bag":{"type":"boolean","description":"Setting this parameter to **true** will return a sequence of the out-of-bag instances instead of the sampled instances. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: true","enum":[true,false]},"pca_seed":{"type":"string","description":"With a seed, the **pca** is deterministic. **Example**: \"My Seed\""},"project":{"type":"string","description":"The **project/id** you want the **pca** to belong to. **Example**: \"project/{{ project_id }}\""},"range":{"type":"array","description":"The range of successive instances to build the **pca**. **Example**: [1, 150]","items":{"type":"string"}},"replacement":{"type":"boolean","description":"Whether sampling should be performed with or without replacement. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: true","enum":[true,false]},"sample_rate":{"type":"string","description":"A real number between 0 and 1 specifying the sample rate. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: 0.5"},"seed":{"type":"string","description":"A string to be hashed to generate deterministic samples. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: \"MySample\""},"shared_hash":{"type":"string","description":"The **shared hash** of the shared **pca** to be cloned. Set **deep** to **true** to clone the dataset used to build the pca too. Note that the dataset can be cloned only if it is already shared and set clonable. If multiple datasets have been used to create the pca, only the first dataset will be cloned. **Example**: \"kpY46mNuNVReITw0Z1mAqoQ9ySW\""},"standarized":{"type":"array","description":"Whether numeric inputs should be scaled to unit variance. Standardizing implies assigning equal importance to all variables. Otherwise, the inputs with higher variance will dominate the **pca** result. **Example**: false","items":{"type":"string"}},"tags":{"type":"boolean","description":"A list of strings that help classify and index your **pca**. **Example**: [\"best customers\", \"2021\"]","enum":[true,false]},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"all_fields_preferred":true,"dataset":"dataset/{{ dataset_id }}","datasets":["datasets_value"],"deep":true,"default_numeric_value":"median","description":"This is a description of my new pca","excluded_fields":["excluded_fields_value"],"fields":{},"fields_maps":{},"include_extracted_features":["include_extracted_features_value"],"input_fields":["input_fields_value"],"name":"my new pca","ordering":1,"origin":"pca/{{ pca_id }}","out_of_bag":true,"pca_seed":"My Seed","project":"project/{{ project_id }}","range":["range_value"],"replacement":true,"sample_rate":"0.5","seed":"MySample","shared_hash":"kpY46mNuNVReITw0Z1mAqoQ9ySW","standarized":["standarized_value"],"tags":"","webhook":{}}}}}},"get":{"tags":["PCA"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/pcas/","api_endpoint":"https://bigml.io/andromeda/pca"},"summary":"List pca","description":"To list all the **pca**, you can use the **pca** base URL. By default, only the 20 most recent **pca** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/pca/{id}":{"get":{"tags":["PCA"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/pcas/","api_endpoint":"https://bigml.io/andromeda/pca/{id}"},"summary":"Retrieve a pca","description":"Each **pca** has a unique identifier in the form **\"pca/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **pca**.","security":[{"bearerAuth":[]}]},"put":{"tags":["PCA"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/pcas/","api_endpoint":"https://bigml.io/andromeda/pca/{id}"},"summary":"Update a pca","description":"To update a **pca**, you need to PUT an object containing the fields that you want to update to the **pca**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **pca**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **pca**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **deepcapnet** up to 8192 characters long. **Example**: \"This is a description of my new pca\""},"fields":{"type":"object","description":"This can be used to change the names of the fields in the pca with respect to the original names in the dataset or to tell **BigML** that certain fields should be preferred. An entry keyed with the field id generated in the **source** for each field that you want the name updated. **Example**: { \"000001\": {\"name\": \"length_1\"}, \"000003\": {\"name\": \"length_2\"}, }","properties":{}},"name":{"type":"string","description":"The name you want to give to the new **pca**. **Example**: \"my new pca\""},"tags":{"type":"boolean","description":"A list of strings that help classify and index your **pca**. **Example**: [\"best customers\", \"2021\"]","enum":[true,false]}}},"example":{"category":1,"description":"This is a description of my new pca","fields":{},"name":"my new pca","tags":""}}}}},"delete":{"tags":["PCA"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/pcas/","api_endpoint":"https://bigml.io/andromeda/pca/{id}"},"summary":"Delete a pca","description":"To delete a **pca**, you need to issue a HTTP DELETE request to the **pca/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/prediction":{"post":{"tags":["Predictions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/predictions/","api_endpoint":"https://bigml.io/andromeda/prediction"},"summary":"Create a prediction","description":"To create a new **prediction**, you need to POST to the **prediction** base URL an object containing a **supervised model id** that you want to use to create the **prediction**. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **prediction**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"deepnet":{"type":"string","description":"A valid **deepnet/id**. **Example**: \"deepnet/{{ deepnet_id }}\""},"description":{"type":"string","description":"A description of the **prediction** up to 8192 characters long. **Example**: \"This is a description of my new prediction\""},"ensemble":{"type":"string","description":"A valid **ensemble/id**. **Example**: \"ensemble/{{ ensemble_id }}\""},"explain":{"type":"boolean","description":"Whether you want to request an explanation for the **prediction**. **Example**: true","enum":[true,false]},"fusion":{"type":"string","description":"A valid **fusion/id**. **Example**: \"fusion/{{ fusion_id }}\""},"input_data":{"type":"object","description":"An object with field's id/value or name/value pairs representing the instance you want to create a **prediction** for. For a **logistic regression**, input data for all numerical fields except the **objective field** must be provided. Missing **input_data** for categorical or text fields, or invalid values for categorical fields, or an empty value for text fields will be handled as missing values.","properties":{}},"linearregression":{"type":"string","description":"A valid **linearregression/id**. **Example**: \"linearregression/{{ linearregression_id }}\""},"logisticregression":{"type":"string","description":"A valid **logisticregression/id**. **Example**: \"logisticregression/{{ logisticregression_id }}\""},"missing_strategy":{"type":"number","description":"Specifies the method that should be used when a missing split is found for a **model**, **ensemble** or **fusion**. That is, when a missing value is found in the input data for a decision node. The options are: 0: **last prediction** predicts based on the subset of the data which reached the parent of the missing split.; 1: **proportional** evaluates all the subtrees of a missing split and recombi"},"model":{"type":"string","description":"A valid model id of the supported supervised model. Alternatively, you can use **ensemble**, **linearregression**, **logisticregression**, **deepnet** or **fusion** arguments. **Example**: \"model/{{ model_id }}\""},"name":{"type":"string","description":"The name you want to give to the new **prediction**. **Example**: \"my new prediction\""},"operating_kind":{"type":"string","description":"The operating kind to perform the prediction. Note that **operating_point** can override its value. See **operating_point** for more information. **Example**: \"confidence\""},"operating_point":{"type":"object","description":"The specification of an operating point for classification problems to perform the prediction which consists of a **positive_class** (one of the categories of the model's objective field), and a **threshold** (a number between 0 and 1), and an optional field **kind** (**confidence**, **probability**, and for non-boosted ensembles, **votes**). When it presents, **BigML** will predict the positive_c","properties":{}},"project":{"type":"string","description":"The **project/id** you want the **prediction** to belong to. **Example**: \"project/{{ project_id }}\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **prediction**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"vote_count":{"type":"string","description":"A number between 0 and 1, the fraction of trees that voted for the predicted class. Applicable only when **operating_kind** is **votes** or **kind** of **operating_point** is **votes**. **Example**: 0.5"},"vote_counts":{"type":"array","description":"An array of string-float pairs with each class and the corresponding fraction, between 0 and 1, of trees voting for it as elements. Applicable only when **operating_kind** is **votes** or **kind** of **operating_point** is **votes**. **Example**: [[\"Female\", 0.3], [\"Other\", 0.2]]","items":{"type":"string"}},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"deepnet":"deepnet/{{ deepnet_id }}","description":"This is a description of my new prediction","ensemble":"ensemble/{{ ensemble_id }}","explain":true,"fusion":"fusion/{{ fusion_id }}","input_data":{},"linearregression":"linearregression/{{ linearregression_id }}","logisticregression":"logisticregression/{{ logisticregression_id }}","missing_strategy":1,"model":"model/{{ model_id }}","name":"my new prediction","operating_kind":"confidence","operating_point":{},"project":"project/{{ project_id }}","tags":["tags_value"],"vote_count":"0.5","vote_counts":["vote_counts_value"],"webhook":{}}}}}},"get":{"tags":["Predictions"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/predictions/","api_endpoint":"https://bigml.io/andromeda/prediction"},"summary":"List predictions","description":"To list all the **predictions**, you can use the **prediction** base URL. By default, only the 20 most recent **predictions** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/prediction/{id}":{"get":{"tags":["Predictions"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/predictions/","api_endpoint":"https://bigml.io/andromeda/prediction/{id}"},"summary":"Retrieve a prediction","description":"Each **prediction** has a unique identifier in the form **\"prediction/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **prediction**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Predictions"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/predictions/","api_endpoint":"https://bigml.io/andromeda/prediction/{id}"},"summary":"Update a prediction","description":"To update a **prediction**, you need to PUT an object containing the fields that you want to update to the **prediction**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **prediction**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **prediction**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **prediction** up to 8192 characters long. **Example**: \"This is a description of my new prediction\""},"name":{"type":"string","description":"The name you want to give to the new **prediction**. **Example**: \"my new prediction\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **prediction**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new prediction","name":"my new prediction","tags":["tags_value"]}}}}},"delete":{"tags":["Predictions"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/predictions/","api_endpoint":"https://bigml.io/andromeda/prediction/{id}"},"summary":"Delete a prediction","description":"To delete a **prediction**, you need to issue a HTTP DELETE request to the **prediction/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/projection":{"post":{"tags":["Projections"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/projections/","api_endpoint":"https://bigml.io/andromeda/projection"},"summary":"Create a projection","description":"To create a new **projection**, you need to POST to the **projection** base URL an object containing at least the **pca/id** that you want to use to find the **projection** and an instance. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **projection**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **projection** up to 8192 characters long. **Example**: \"This is a description of my new projection\""},"input_data":{"type":"object","description":"An object with field's id/value or name/value pairs representing the instance you want to find the closest projection for. You can use either field ids or field names as keys in your **input_data**. **Example**: {\"00000a\": \"otisday\", \"00000d\": \"washington\"}","properties":{}},"max_components":{"type":"number","description":"The maximum number of components to load for prediction. **Example**: 10"},"name":{"type":"string","description":"The name you want to give to the new **projection**. **Example**: \"my new projection\""},"pca":{"type":"string","description":"A valid **pca/id**. **Example**: \"pca/{{ pca_id }}\""},"project":{"type":"string","description":"The **project/id** you want the **projection** to belong to. **Example**: \"project/{{ project_id }}\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **projection**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"description":"This is a description of my new projection","input_data":{},"max_components":10,"name":"my new projection","pca":"pca/{{ pca_id }}","project":"project/{{ project_id }}","tags":["tags_value"],"webhook":{}}}}}},"get":{"tags":["Projections"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/projections/","api_endpoint":"https://bigml.io/andromeda/projection"},"summary":"List projections","description":"To list all the **projections**, you can use the **projection** base URL. By default, only the 20 most recent **projections** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/projection/{id}":{"get":{"tags":["Projections"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/projections/","api_endpoint":"https://bigml.io/andromeda/projection/{id}"},"summary":"Retrieve a projection","description":"Each **projection** has a unique identifier in the form **\"projection/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **projection**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Projections"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/projections/","api_endpoint":"https://bigml.io/andromeda/projection/{id}"},"summary":"Update a projection","description":"To update a **projection**, you need to PUT an object containing the fields that you want to update to the **projection**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **projection**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **projection**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **projection** up to 8192 characters long. **Example**: \"This is a description of my new projection\""},"name":{"type":"string","description":"The name you want to give to the new **projection**. **Example**: \"my new projection\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **projection**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new projection","name":"my new projection","tags":["tags_value"]}}}}},"delete":{"tags":["Projections"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/projections/","api_endpoint":"https://bigml.io/andromeda/projection/{id}"},"summary":"Delete a projection","description":"To delete a **projection**, you need to issue a HTTP DELETE request to the **projection/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/project":{"post":{"tags":["Projects"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/projects/","api_endpoint":"https://bigml.io/andromeda/project"},"summary":"Create a project","description":"To create a new **project**, you just need to POST the name you want to give to the new project to the **project** base URL.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the project. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **project** up to 8192 characters long. **Example**: \"This is a description of my new project\""},"name":{"type":"number","description":"The name you want to give to the new **project**. **Example**: \"my new project\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **project**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the [Section on Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"description":"This is a description of my new project","name":1,"tags":["tags_value"],"webhook":{}}}}}},"get":{"tags":["Projects"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/projects/","api_endpoint":"https://bigml.io/andromeda/project"},"summary":"List projects","description":"To list all the **projects**, you can use the **projects** base URL. By default, only the 20 most recent **projects** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/project/{id}":{"get":{"tags":["Projects"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/projects/","api_endpoint":"https://bigml.io/andromeda/project/{id}"},"summary":"Retrieve a project","description":"Each **project** has a unique identifier in the form \"**project/id**\" where id is a string of 24 alpha-numeric characters that you can use to retrieve the **project**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Projects"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/projects/","api_endpoint":"https://bigml.io/andromeda/project/{id}"},"summary":"Update a project","description":"To update a **project**, you need to PUT an object containing the fields that you want to update to the **project**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **project**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the project. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **project** up to 8192 characters long. **Example**: \"This is a description of my new project\""},"name":{"type":"number","description":"The name you want to give to the new **project**. **Example**: \"my new project\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **project**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new project","name":1,"tags":["tags_value"]}}}}},"delete":{"tags":["Projects"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/projects/","api_endpoint":"https://bigml.io/andromeda/project/{id}"},"summary":"Delete a project","description":"To delete a **project**, you need to issue a HTTP DELETE request to the **project/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/sample":{"post":{"tags":["Samples"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/samples/","api_endpoint":"https://bigml.io/andromeda/sample"},"summary":"Create a sample","description":"To create a new **sample**, you need to POST to the **sample** base URL an object containing at least the **dataset/id** that you want to use to create the **sample**. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **sample**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"dataset":{"type":"string","description":"A valid **dataset/id**. **Example**: \"dataset/{{ dataset_id }}\""},"description":{"type":"string","description":"A description of the **sample** up to 8192 characters long. **Example**: \"This is a description of my new sample\""},"excluded_fields":{"type":"array","description":"Specifies the fields that won't be included in the **sample**. **Example**: [\"000000\", \"000002\"]","items":{"type":"string"}},"input_fields":{"type":"array","description":"Specifies the fields to be considered to create the **sample**. **Example**: [\"000001\", \"000003\"]","items":{"type":"string"}},"name":{"type":"string","description":"The name you want to give to the new **sample**. **Example**: \"my new sample\""},"project":{"type":"string","description":"The **project/id** you want the **sample** to belong to. **Example**: \"project/{{ project_id }}\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **sample**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"dataset":"dataset/{{ dataset_id }}","description":"This is a description of my new sample","excluded_fields":["excluded_fields_value"],"input_fields":["input_fields_value"],"name":"my new sample","project":"project/{{ project_id }}","tags":["tags_value"],"webhook":{}}}}}},"get":{"tags":["Samples"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/samples/","api_endpoint":"https://bigml.io/andromeda/sample"},"summary":"List samples","description":"To list all the **samplea**, you can use the **sample** base URL. By default, only the 20 most recent **sample** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/sample/{id}":{"get":{"tags":["Samples"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/samples/","api_endpoint":"https://bigml.io/andromeda/sample/{id}"},"summary":"Retrieve a sample","description":"Each **sample** has a unique identifier in the form **\"sample/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **sample**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Samples"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/samples/","api_endpoint":"https://bigml.io/andromeda/sample/{id}"},"summary":"Update a sample","description":"To update a **sample**, you need to PUT an object containing the fields that you want to update to the **sample**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **sample**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **sample**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **sample** up to 8192 characters long. **Example**: \"This is a description of my new sample\""},"name":{"type":"string","description":"The name you want to give to the new **sample**. **Example**: \"my new sample\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **sample**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new sample","name":"my new sample","tags":["tags_value"]}}}}},"delete":{"tags":["Samples"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/samples/","api_endpoint":"https://bigml.io/andromeda/sample/{id}"},"summary":"Delete a sample","description":"To delete a **sample**, you need to issue a HTTP DELETE request to the **sample/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/source":{"post":{"tags":["Sources"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/sources/","api_endpoint":"https://bigml.io/andromeda/source"},"summary":"Create a source from a local file","description":"Create a new source by uploading a local file as multipart/form-data (up to 64 GB; compressed archives are uploaded faster).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"file":{"type":"string","format":"binary","description":"File containing your data in csv format. It can be compressed, gzipped, or zipped if the archive contains only one file","required":true}}},"example":{"file":"file_value"}}}}},"get":{"tags":["Sources"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/sources/","api_endpoint":"https://bigml.io/andromeda/source"},"summary":"List sources","description":"To list all the **source**, you can use the **source** base URL. By default, only the 20 most recent **sources** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/source/{id}":{"get":{"tags":["Sources"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/sources/","api_endpoint":"https://bigml.io/andromeda/source/{id}"},"summary":"Retrieve a source","description":"Each **source** has a unique identifier in the form **\"source/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **source**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Sources"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/sources/","api_endpoint":"https://bigml.io/andromeda/source/{id}"},"summary":"Update a source","description":"To update a **source**, you need to PUT an object containing the fields that you want to update to the **source**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **source**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **source**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description for the new field. **Example**: \"This field is a label\""},"name":{"type":"string","description":"Name of the new field. **Example**: \"label\""},"source_parser":{"type":"object","description":"Set of parameters to parse the **source**. **Example**: { \"header\": true, \"locale\": \"en-US\", \"missing_tokens\": [\"?\"], \"quote\": \"'\", \"separator\": \",\", \"trim\": true }","properties":{}},"tags":{"type":"array","description":"A list of strings that help classify and index your **source**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This field is a label","name":"label","source_parser":{},"tags":["tags_value"]}}}}},"delete":{"tags":["Sources"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/sources/","api_endpoint":"https://bigml.io/andromeda/source/{id}"},"summary":"Delete a source","description":"To delete a **source**, you need to issue a HTTP DELETE request to the **source/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/statisticaltest":{"post":{"tags":["Statistical Tests"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/statisticaltests/","api_endpoint":"https://bigml.io/andromeda/statisticaltest"},"summary":"Create a statistical test","description":"To create a new **statistical test**, you need to POST to the **statistical test** base URL an object containing at least the **dataset/id** that you want to use to create the **statistical test**. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Statistical Tests"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/statisticaltests/","api_endpoint":"https://bigml.io/andromeda/statisticaltest"},"summary":"List statistical tests","description":"To list all the **statistical test**, you can use the **statistical test** base URL. By default, only the 20 most recent **statistical tests** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/statisticaltest/{id}":{"get":{"tags":["Statistical Tests"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/statisticaltests/","api_endpoint":"https://bigml.io/andromeda/statisticaltest/{id}"},"summary":"Retrieve a statistical test","description":"Each **statistical test** has a unique identifier in the form **\"statisticaltest/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **statistical test**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Statistical Tests"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/statisticaltests/","api_endpoint":"https://bigml.io/andromeda/statisticaltest/{id}"},"summary":"Update a statistical test","description":"To update a **statistical test**, you need to PUT an object containing the fields that you want to update to the **statistical test**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **statistical test**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Statistical Tests"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/statisticaltests/","api_endpoint":"https://bigml.io/andromeda/statisticaltest/{id}"},"summary":"Delete a statistical test","description":"To delete a **statistical test**, you need to issue a HTTP DELETE request to the **statisticaltest/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/timeseries":{"post":{"tags":["Time Series"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/timeseries/","api_endpoint":"https://bigml.io/andromeda/timeseries"},"summary":"Create a time serie","description":"To create a new **time series**, you need to POST to the **time series** base URL an object containing at least the **dataset/id** that you want to use to create the **time series**. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **time series**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"all_numeric_objectives":{"type":"boolean","description":"Whether to include all numeric fields in the input dataset in the objective fields list. **Example**: true","enum":[true,false]},"damped_trend":{"type":"boolean","description":"Whether to use a damped trend when **trend** is either 1 (**additive**) or 2 (**multiplicative**) to find the best models. If **trend** is 0 (**none**), then only **damped_trend=false** models will be considered. If ommitted, both damped and non-damped trends will be tried and the best models returned. **Example**: true","enum":[true,false]},"dataset":{"type":"string","description":"A valid **dataset/id**. **Example**: dataset/{{ dataset_id }}"},"datasets":{"type":"array","description":"A list of dataset ids or objects to be used to build the new **time series**. See the [Section on Multi-Datasets](datasets#multi-datasets) and [Section on Resources Accepting Multi-Datasets Input](datasets#resources-accepting-multi-datasets-input) for more details. **Example**: [{ \"id\": \"dataset/{{ dataset_id }}\", \"sample_rate\": 0.5, \"out_of_bag\": true }, { \"id\": \"dataset/603e20a91f386f43db000005\"","items":{"type":"string"}},"deep":{"type":"boolean","description":"Clone the dataset used to build the **time series** while cloning the original . Must be used along with the **origin** or **shared_hash** option. **Example**: true","enum":[true,false]},"default_numeric_value":{"type":"string","description":"It accepts any of the following strings to substitute missing numeric values across all the numeric fields in the dataset: **mean**, **median**, **minimum**, **maximum**, **zero**. **Example**: \"median\""},"description":{"type":"string","description":"A description of the **time series** up to 8192 characters long. **Example**: \"This is a description of my new timeseries\""},"error":{"type":"number","description":"Any of the following values to specify types of ETS models: 1 (**additive**), 2 (**multiplicative**). Multiplicative error models are only available when the objective field has strictly positive values (greater than 0). Ets_models with additive errors and multiplicative trends or seasonalities are not explored due to numeric stability issues. **Example**: 2"},"field_parameters":{"type":"object","description":"Field-specific ETS parameters used to optionally override the top-level parameters for a specific objective field. A map keyed by field id, where each entry is map containing the parameters **damped_trend**, **error**, **period**, **seasonality**, **time_range**, and **trend** for the corresponding field. **Example**: { \"000001\": { \"seasonality\": 2, \"period\": 24 }, \"000003\": { \"error\": 1, \"time_ra","properties":{}},"fields":{"type":"object","description":"This can be used to change the names of the fields in the time series with respect to the original names in the dataset or to tell **BigML** that certain fields should be preferred. An entry keyed with the field id generated in the **source** for each field that you want the name updated. **Example**: { \"000001\": {\"name\": \"length_1\"}, \"000003\": {\"name\": \"length_2\"}, }","properties":{}},"horizon":{"type":"number","description":"The **time series** model includes a forecast with intervals for all computed ETS models with this horizon. Max value: 400. **Example**: 100"},"include_extracted_features":{"type":"array","description":"Extracted image features to use as model inputs. Available options are: **true**: include all extracted features, unless explicitly excluded (this is the default for all non-deepnet models.); **false**: don't include any extracted features (this is the default for deepnet models, if not given.); **list of ids**: a explicit list of field ids, corresponding to extracted fields to add to the default ","items":{"type":"string"}},"name":{"type":"string","description":"The name you want to give to the new **time series**. **Example**: \"my new timeseries\""},"objective_field":{"type":"number","description":"The **time series field** you want to forecast. The type of the field must be numerical. Note that BigML assumes your instances are correctly ordered chronologically in your dataset and equally distributed in time. **Example**: \"000003\""},"objective_fields":{"type":"array","description":"One or more identifiers of numeric fields for which to fit ETS time series models. Non-numeric fields will be ignored, and if not present, the right-most valid field in the dataset will be used. **Example**: [\"000001\", \"000003\"]","items":{"type":"string"}},"origin":{"type":"string","description":"The **timeseries/id** of the time series to be cloned. The price of the time series must be 0 to be cloned via API. Set **deep** to **true** to clone the dataset used to build the time series too. Note that the dataset can be cloned only if it is already in the public gallery and free. If multiple datasets have been used to create the time series, only the first dataset will be cloned. **Example**"},"period":{"type":"number","description":"The number of data points per period. The period needs to be set taking into account the time interval of your instances and the seasonal frequency. For example, for monthly data and annual seasonality, the period should be 12, for daily data and weekly seasonality, the period should be 7. It can take values from 0 to 60. If the period is set to 1, there is no seasonality. If the period is 0, or n"},"project":{"type":"string","description":"The **project/id** you want the **time series** to belong to. **Example**: \"project/{{ project_id }}\""},"range":{"type":"array","description":"The range of successive instances to build the **time series**. **Example**: [1, 150]","items":{"type":"string"}},"seasonality":{"type":"number","description":"Any of the following values to specify types of ETS models: 0 (**none**), 1 (**additive**), 2 (**multiplicative**). Multiplicative seasonality models are only available when the objective field has strictly positive values (greater than 0). Ets_models with multiplicative trends and additive seasonality are not explored due to numeric stability issues. **Example**: 2"},"shared_hash":{"type":"string","description":"The **shared hash** of the shared time series to be cloned. Set **deep** to **true** to clone the dataset used to build the time series too. Note that the dataset can be cloned only if it is already shared and set clonable. If multiple datasets have been used to create the time series, only the first dataset will be cloned. **Example**: \"kpY46mNuNVReITw0Z1mAqoQ9ySW\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **time series**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"time_range":{"type":"object","description":"Default timing information of all objectives fields to be used to generate the timestamp field in the output datasets. Its value is a map with the following properties: **start**: the epoch, in milliseconds, to be assigned to the first objective field value.; **end**: the epoch, in milliseconds, to be assigned to the last objective field value.; **interval**: integer number that is associated to t","properties":{}},"trend":{"type":"number","description":"Any of the following values to specify types of ETS models: 0 (**none**), 1 (**additive**), 2 (**multiplicative**) **Example**: 2"},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"all_numeric_objectives":true,"damped_trend":true,"dataset":"dataset/{{ dataset_id }}","datasets":["datasets_value"],"deep":true,"default_numeric_value":"median","description":"This is a description of my new timeseries","error":2,"field_parameters":{},"fields":{},"horizon":100,"include_extracted_features":["include_extracted_features_value"],"name":"my new timeseries","objective_field":3,"objective_fields":["objective_fields_value"],"origin":"timeseries/{{ timeseries_id }}","period":12,"project":"project/{{ project_id }}","range":["range_value"],"seasonality":2,"shared_hash":"kpY46mNuNVReITw0Z1mAqoQ9ySW","tags":["tags_value"],"time_range":{},"trend":2,"webhook":{}}}}}},"get":{"tags":["Time Series"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/timeseries/","api_endpoint":"https://bigml.io/andromeda/timeseries"},"summary":"List time series","description":"To list all the **time series**, you can use the **time series** base URL. By default, only the 20 most recent **time series** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/timeseries/{id}":{"get":{"tags":["Time Series"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/timeseries/","api_endpoint":"https://bigml.io/andromeda/timeseries/{id}"},"summary":"Retrieve a time serie","description":"Each **time series** has a unique identifier in the form **\"timeseries/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **time series**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Time Series"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/timeseries/","api_endpoint":"https://bigml.io/andromeda/timeseries/{id}"},"summary":"Update a time serie","description":"To update a **time series**, you need to PUT an object containing the fields that you want to update to the **time series**' s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **time series**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **time series**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **time series** up to 8192 characters long. **Example**: \"This is a description of my new timeseries\""},"fields":{"type":"object","description":"This can be used to change the names of the fields in the time series with respect to the original names in the dataset or to tell **BigML** that certain fields should be preferred. An entry keyed with the field id generated in the **source** for each field that you want the name updated. **Example**: { \"000001\": {\"name\": \"length_1\"}, \"000003\": {\"name\": \"length_2\"}, }","properties":{}},"name":{"type":"string","description":"The name you want to give to the new **time series**. **Example**: \"my new timeseries\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **time series**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new timeseries","fields":{},"name":"my new timeseries","tags":["tags_value"]}}}}},"delete":{"tags":["Time Series"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/timeseries/","api_endpoint":"https://bigml.io/andromeda/timeseries/{id}"},"summary":"Delete a time serie","description":"To delete a **time series**, you need to issue a HTTP DELETE request to the **timeseries/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/topicmodel":{"post":{"tags":["Topic Models"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/topic_models/","api_endpoint":"https://bigml.io/andromeda/topicmodel"},"summary":"Create a topic model","description":"To create a new **topic model**, you need to POST to the **topic model** base URL an object containing at least the **dataset/id** that you want to use to create the **topic model**. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **topic model**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"all_fields_preferred":{"type":"boolean","description":"Setting this parameter to **true** will set the preferred flag of all fields at once, instead of doing it one by one in a **fields** map. **Example**: true","enum":[true,false]},"case_sensitive":{"type":"boolean","description":"Whether the analysis is case-sensitive or not. **Example**: true","enum":[true,false]},"dataset":{"type":"string","description":"A valid **dataset/id**. **Example**: dataset/{{ dataset_id }}"},"datasets":{"type":"array","description":"A list of dataset ids or objects to be used to build the new **topic model**. See the [Section on Multi-Datasets](datasets#multi-datasets) and [Section on Resources Accepting Multi-Datasets Input](datasets#resources-accepting-multi-datasets-input) for more details. **Example**: [{ \"id\": \"dataset/{{ dataset_id }}\", \"sample_rate\": 0.5, \"out_of_bag\": true }, { \"id\": \"dataset/60505b011f386f3ee4000005\"","items":{"type":"string"}},"deep":{"type":"boolean","description":"Clone the dataset used to build the **topic model** while cloning the original. Must be used along with the **origin** or **shared_hash** option. **Example**: true","enum":[true,false]},"default_numeric_value":{"type":"string","description":"It accepts any of the following strings to substitute missing numeric values across all the numeric fields in the dataset: **mean**, **median**, **minimum**, **maximum**, **zero**. **Example**: \"median\""},"description":{"type":"string","description":"A description of the **topic model** up to 8192 characters long. **Example**: \"This is a description of my new topic model\""},"excluded_fields":{"type":"array","description":"Specifies the fields that won't be included in the **topic model**. **Example**: [\"000000\", \"000002\"]","items":{"type":"string"}},"excluded_terms":{"type":"array","description":"Specifies a list of terms to ignore when performing term analysis. **Example**: [\"I\", \"he\", \"she\", \"it\", \"you\", \"they\", \"am\", \"is\", \"are\", \"a\", \"an\", \"the\"]","items":{"type":"string"}},"fields":{"type":"object","description":"This can be used to change the names of the fields in the topic model with respect to the original names in the dataset or to tell **BigML** that certain fields should be preferred. An entry keyed with the field id generated in the **source** for each field that you want the name updated. **Example**: { \"000001\": {\"name\": \"length_1\"}, \"000003\": {\"name\": \"length_2\"}, }","properties":{}},"fields_maps":{"type":"object","description":"A dictionary keyed by **dataset/id** and **object** values. Each entry maps fields in the first dataset to fields in the dataset referenced by the key. **Example**: { \"dataset/{{ dataset_id }}\": { \"000000\":\"000023\", \"000001\":\"000024\", \"000002\":\"00003a\"}, \"dataset/603e20a91f386f43db000005\": { \"000000\":\"000023\", \"000001\":\"000004\", \"000002\":\"00000f\" }","properties":{}},"include_extracted_features":{"type":"array","description":"Extracted image features to use as model inputs. Available options are: **true**: include all extracted features, unless explicitly excluded (this is the default for all non-deepnet models.); **false**: don't include any extracted features (this is the default for deepnet models, if not given.); **list of ids**: a explicit list of field ids, corresponding to extracted fields to add to the default ","items":{"type":"string"}},"input_fields":{"type":"array","description":"Specifies the fields to be considered to create the **topic model**. Each of the input_fields must be text fields. If multiple fields are given, the text field values for each row will be concatenated so that each row is still considered to be one document. **Example**: [\"000001\", \"000003\"]","items":{"type":"string"}},"language":{"type":"string","description":"The default language of text fields in a two-letter language code, which will change the resulting stemming and tokenization. Available options are: \"ar\", \"ca\", \"cs\", \"da\", \"de\", \"en\", \"es\", \"fa\", \"fi\", \"fr\", \"hu\", \"it\", \"ja\", \"ko\", \"nl\", \"pl\", \"pt\", \"ro\", \"ru\", \"sv\", \"tr\", \"zh\", \"none\", or null for auto-detect. **Example**: \"es\""},"minimum_name_terms":{"type":"number","description":"The minimum number of terms to be used to build topic names. If 0, the topic names will be generated as Topic 1, Topic 2, Topic 3, and so on. **Example**: 2"},"name":{"type":"string","description":"The name you want to give to the new **topic model**. **Example**: \"my new topic model\""},"ngrams":{"type":"number","description":"A positive integer n that specifies the use of all sequences of consecutive tokens of length n should be considered as terms, in addition to their constituent tokens (when separated by a single space and no stopwords). See [n-gram](https://en.wikipedia.org/wiki/N-gram) for more information.The minimum value is 1 and maximum value is 5. **Example**: 5"},"number_of_topics":{"type":"number","description":"The number of topics that **topic model** will generate. If it is unset, it will be chosen automatically based on the number documents (i.e., row count). The minimum value is 2 and maximum value is 64. **Example**: 32"},"origin":{"type":"string","description":"The **topicmodel/id** of the topic model to be cloned. The price of the topic model must be 0 to be cloned via API. Set **deep** to **true** to clone the dataset used to build the topic model too. Note that the dataset can be cloned only if it is already in the public gallery and free. If multiple datasets have been used to create the topic model, only the first dataset will be cloned. **Example**"},"out_of_bag":{"type":"boolean","description":"Setting this parameter to **true** will return a sequence of the out-of-bag instances instead of the sampled instances. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: true","enum":[true,false]},"project":{"type":"string","description":"The **project/id** you want the **topic model** to belong to. **Example**: \"project/{{ project_id }}\""},"range":{"type":"array","description":"The range of successive instances to build the **topic model**. **Example**: [1, 150]","items":{"type":"string"}},"replacement":{"type":"boolean","description":"Whether sampling should be performed with or without replacement. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: true","enum":[true,false]},"sample_rate":{"type":"string","description":"A real number between 0 and 1 specifying the sample rate. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: 0.5"},"seed":{"type":"string","description":"A string to be hashed to generate deterministic samples. See the [Section on Sampling](models#Sampling-Your-Dataset) for more details. **Example**: \"MySample\""},"shared_hash":{"type":"string","description":"The **shared hash** of the shared **topic model** to be cloned. Set **deep** to **true** to clone the dataset used to build the topic model too. Note that the dataset can be cloned only if it is already shared and set clonable. If multiple datasets have been used to create the topic model, only the first dataset will be cloned. **Example**: \"kpY46mNuNVReITw0Z1mAqoQ9ySW\""},"stem_words":{"type":"boolean","description":"Whether lemmatization (stemming) of terms should be done, according to linguistic rules in the provided language. Note that if the language is, for example, **zh**, even English words will not be lemmatized as with English rules. **Example**: true","enum":[true,false]},"stopword_diligence":{"type":"string","description":"The aggressiveness of stopword removal, where the levels are **light**, **normal** or **aggressive**, in order, where each level is a superset of words in the previous ones. The most common languages will add stopwords at each level, but less common languages may not. **Example**: \"light\""},"stopword_removal":{"type":"string","description":"A string or keyword specifying the type of stopword removal to perform. Available options are where it can be **none** (remove no stopwords), **selected_language** (remove stopwords from the provided language), and **all_languages** (remove stopwords from all languages). Note that this parameter supersedes **use_stopwords** if provided. Also note that the **null** language does have a non-empty st"},"tags":{"type":"array","description":"A list of strings that help classify and index your **topic model**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"term_filters":{"type":"array","description":"Filters that should be applied to the chosen terms. Available options are: **non_dictionary**: Filters all terms that are not dictionary words in the provided language.; **non_language_characters**: Filters any term containing a character not from the Unicode blocks common for words in the provided language. For example, if the language is ru (Russian), all terms containing non-Cyrillic characters","items":{"type":"string"}},"term_limit":{"type":"number","description":"The maximum number of terms used for the **topic model** vocabulary. Computation is linear with respect to this parameter. The minimum value is 128 and maximum value is 16384. **Example**: 1024"},"term_regexps":{"type":"array","description":"A list of strings specifying regular expressions to be matched against input documents. If present, these regular expressions will automatically be chosen for the final term list, and their per-document occurrence counts will be the number of matches of the expression in that document.","items":{"type":"string"}},"token_mode":{"type":"string","description":"Whether **tokens_only**, **full_terms_only** or **all** should be tokenized. **Example**: \"tokens_only\""},"top_n_terms":{"type":"number","description":"The size of the most influential terms recorded. The minimum value is 1 and maximum value is 128. **Example**: 32"},"topicmodel_seed":{"type":"string","description":"With a seed, the **topic model** is deterministic. **Example**: \"My Seed\""},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"all_fields_preferred":true,"case_sensitive":true,"dataset":"dataset/{{ dataset_id }}","datasets":["datasets_value"],"deep":true,"default_numeric_value":"median","description":"This is a description of my new topic model","excluded_fields":["excluded_fields_value"],"excluded_terms":["excluded_terms_value"],"fields":{},"fields_maps":{},"include_extracted_features":["include_extracted_features_value"],"input_fields":["input_fields_value"],"language":"es","minimum_name_terms":2,"name":"my new topic model","ngrams":5,"number_of_topics":32,"origin":"topicmodel/{{ topicmodel_id }}","out_of_bag":true,"project":"project/{{ project_id }}","range":["range_value"],"replacement":true,"sample_rate":"0.5","seed":"MySample","shared_hash":"kpY46mNuNVReITw0Z1mAqoQ9ySW","stem_words":true,"stopword_diligence":"light","stopword_removal":"all_languages","tags":["tags_value"],"term_filters":["term_filters_value"],"term_limit":1024,"term_regexps":["term_regexps_value"],"token_mode":"tokens_only","top_n_terms":32,"topicmodel_seed":"My Seed","webhook":{}}}}}},"get":{"tags":["Topic Models"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/topic_models/","api_endpoint":"https://bigml.io/andromeda/topicmodel"},"summary":"List topic models","description":"To list all the **topic models**, you can use the **topic model** base URL. By default, only the 20 most recent **topic models** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/topicmodel/{id}":{"get":{"tags":["Topic Models"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/topic_models/","api_endpoint":"https://bigml.io/andromeda/topicmodel/{id}"},"summary":"Retrieve a topic model","description":"Each **topic model** has a unique identifier in the form **\"topicmodel/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **topic model**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Topic Models"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/topic_models/","api_endpoint":"https://bigml.io/andromeda/topicmodel/{id}"},"summary":"Update a topic model","description":"To update a **topic model**, you need to PUT an object containing the fields that you want to update to the **topic model**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **topic model**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **topic model**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **topic model** up to 8192 characters long. **Example**: \"This is a description of my new topic model\""},"fields":{"type":"object","description":"This can be used to change the names of the fields in the topic model with respect to the original names in the dataset or to tell **BigML** that certain fields should be preferred. An entry keyed with the field id generated in the **source** for each field that you want the name updated. **Example**: { \"000001\": {\"name\": \"length_1\"}, \"000003\": {\"name\": \"length_2\"}, }","properties":{}},"name":{"type":"string","description":"The name you want to give to the new **topic model**. **Example**: \"my new topic model\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **topic model**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new topic model","fields":{},"name":"my new topic model","tags":["tags_value"]}}}}},"delete":{"tags":["Topic Models"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/topic_models/","api_endpoint":"https://bigml.io/andromeda/topicmodel/{id}"},"summary":"Delete a topic model","description":"To delete a **topic model**, you need to issue a HTTP DELETE request to the **topicmodel/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/topicdistribution":{"post":{"tags":["Topic Distributions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/topicdistributions/","api_endpoint":"https://bigml.io/andromeda/topicdistribution"},"summary":"Create a topic distribution","description":"To create a new **topic distribution**, you need to POST to the **topic distribution** base URL an object containing at least the **topicmodel/id** that you want to use to find the **topic distribution** and an instance. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **topic distribution**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **topic distribution** up to 8192 characters long. **Example**: \"This is a description of my new topic distribution\""},"input_data":{"type":"object","description":"An object with field's id/value pairs representing the instance you want to find the closest topic distribution for. You can use either field ids or field names as keys in your **input_data**. **Example**: {\"00000a\": \"otisday\", \"00000d\": \"washington\"}","properties":{}},"name":{"type":"string","description":"The name you want to give to the new **topic distribution**. **Example**: \"my new topic distribution\""},"project":{"type":"string","description":"The **project/id** you want the **topic distribution** to belong to. **Example**: \"project/{{ project_id }}\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **topic distribution**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"topicmodel":{"type":"string","description":"A valid **topicmodel/id**. **Example**: \"topicmodel/{{ topicmodel_id }}\""},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"description":"This is a description of my new topic distribution","input_data":{},"name":"my new topic distribution","project":"project/{{ project_id }}","tags":["tags_value"],"topicmodel":"topicmodel/{{ topicmodel_id }}","webhook":{}}}}}},"get":{"tags":["Topic Distributions"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/topicdistributions/","api_endpoint":"https://bigml.io/andromeda/topicdistribution"},"summary":"List topic distributions","description":"To list all the **topic distributions**, you can use the **topic distribution** base URL. By default, only the 20 most recent **topic distributions** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/topicdistribution/{id}":{"get":{"tags":["Topic Distributions"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/topicdistributions/","api_endpoint":"https://bigml.io/andromeda/topicdistribution/{id}"},"summary":"Retrieve a topic distribution","description":"Each **topic distribution** has a unique identifier in the form **\"topicdistribution/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **topic distribution**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Topic Distributions"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/topicdistributions/","api_endpoint":"https://bigml.io/andromeda/topicdistribution/{id}"},"summary":"Update a topic distribution","description":"To update a **topic distribution**, you need to PUT an object containing the fields that you want to update to the **topic distribution**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **topic distribution**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The category that best describes the **topic distribution**. See the [category codes](category_codes#category-codes-1) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **topic distribution** up to 8192 characters long. **Example**: \"This is a description of my new topic distribution\""},"name":{"type":"string","description":"The name you want to give to the new **topic distribution**. **Example**: \"my new topic distribution\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **topic distribution**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new topic distribution","name":"my new topic distribution","tags":["tags_value"]}}}}},"delete":{"tags":["Topic Distributions"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/topicdistributions/","api_endpoint":"https://bigml.io/andromeda/topicdistribution/{id}"},"summary":"Delete a topic distribution","description":"To delete a **topic distribution**, you need to issue a HTTP DELETE request to the **topicdistribution/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/execution":{"post":{"tags":["Executions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/whizzml_executions/","api_endpoint":"https://bigml.io/andromeda/execution"},"summary":"Create an execution","description":"To create a new **execution**, you need to POST to the execution base URL a string containing the **id of the sctipt** that will be executed, as well as the required input parameters defined in the source code. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The WhizzML category that best describes the **execution**. See the [WhizzML category codes](category_codes#whizzml-category-codes) for the complete list of categories. **Example**: 1"},"creation_defaults":{"type":"object","description":"A dictionary whose keys are resource type names (**dataset**, **model**, **prediction**, etc.) with a map of values for the corresponding defaults which will be used if the input values are not explicitly provided. **Example**: { \"source\": { \"project\": \"project/54d9553bf0a5ea5fc0000016\" }, \"ensemble\": { \"number_of_models\": 100, \"sample_rate\": 0.9 } }","properties":{}},"description":{"type":"string","description":"A description of the **execution** up to 8192 characters long. **Example**: \"This is a description of my new execution\""},"input_maps":{"type":"object","description":"A dictionary whose key is **script/id** and value is **inputs** below. This should be used instead of inputs when multiple **scripts** are provided. **Example**: { \"script/57361a3a10cb86ed59000152\": [ [\"a\", 10], [\"b\", 20] ], \"script/552328ae10cb8619aa00000f\" : [ [\"name\", \"Traffic data\"], [\"x\", 20] ] }","properties":{}},"inputs":{"type":"array","description":"A list of pairs of input parameters and their values associated to the **Example**: [ [\"remote_uri\" \"http\\://bigml.com/iris.csv\"], [\"timeout\" 2000] ]","items":{"type":"string"}},"name":{"type":"string","description":"The name you want to give to the new **execution**. **Example**: \"my new execution\""},"output_maps":{"type":"object","description":"A dictionary whose key is **script/id** and value is a list containing **outputs** below. This can be used along with **outputs**. **Example**: { \"script/57361a3a10cb86ed59000152\": [[\"a\", \"b\"]] }","properties":{}},"outputs":{"type":"array","description":"A list of variables, defined in the source code of script, that will conform the outputs of **execution**. **Example**: [\"a\", \"b\"]","items":{"type":"string"}},"project":{"type":"string","description":"The **project/id** you want the **execution** to belong to. **Example**: \"project/{{ project_id }}\""},"script":{"type":"string","description":"A valid **script/id**. **Example**: \"script/{{ script_id }}\""},"scripts":{"type":"array","description":"A list of valid **script** identifiers to be executed sequentially. **Example**: [\"script/{{ script_id }}\", \"script/6050c0001f386f6afd000001\"]","items":{"type":"string"}},"tags":{"type":"array","description":"A list of strings that help classify and index your **execution**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"creation_defaults":{},"description":"This is a description of my new execution","input_maps":{},"inputs":["inputs_value"],"name":"my new execution","output_maps":{},"outputs":["outputs_value"],"project":"project/{{ project_id }}","script":"script/{{ script_id }}","scripts":["scripts_value"],"tags":["tags_value"],"webhook":{}}}}}},"get":{"tags":["Executions"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/whizzml_executions/","api_endpoint":"https://bigml.io/andromeda/execution"},"summary":"List executions","description":"To list all the **executions**, you can use the **execution** base URL. By default, only the 20 most recent **executions** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/execution/{id}":{"get":{"tags":["Executions"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/whizzml_executions/","api_endpoint":"https://bigml.io/andromeda/execution/{id}"},"summary":"Retrieve an execution","description":"Each **execution** has a unique identifier in the form **\"execution/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **execution**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Executions"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/whizzml_executions/","api_endpoint":"https://bigml.io/andromeda/execution/{id}"},"summary":"Update an execution","description":"To update an **execution**, you need to PUT an object containing the fields that you want to update to the **execution**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **execution**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The WhizzML category that best describes the **execution**. See the [WhizzML category codes](category_codes#whizzml-category-codes) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **execution** up to 8192 characters long. **Example**: \"This is a description of my new execution\""},"name":{"type":"string","description":"The name you want to give to the new **execution**. **Example**: \"my new execution\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **execution**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new execution","name":"my new execution","tags":["tags_value"]}}}}},"delete":{"tags":["Executions"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/whizzml_executions/","api_endpoint":"https://bigml.io/andromeda/execution/{id}"},"summary":"Delete an execution","description":"To delete an **execution**, you need to issue a HTTP DELETE request to the **execution/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/library":{"post":{"tags":["Libraries"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/whizzml_libraries/","api_endpoint":"https://bigml.io/andromeda/library"},"summary":"Create a library","description":"To create a new **library**, you need to POST a string containing at least the **source code** that defines the functions and constants the library exports to the **library** base URL. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The WhizzML category that best describes the **library**. See the [WhizzML category codes](category_codes#whizzml-category-codes) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **library** up to 8192 characters long. **Example**: \"This is a description of my new library\""},"imports":{"type":"array","description":"A list of valid library identifiers. **Example**: [\"library/60509a611f386f3491000001\"]","items":{"type":"string"}},"name":{"type":"string","description":"The name you want to give to the new **library**. **Example**: \"my new library\""},"project":{"type":"string","description":"The **project/id** you want the **library** to belong to. **Example**: \"project/{{ project_id }}\""},"public_in_organization":{"type":"boolean","description":"Whether the **library** is public within the organization. **Example**: true","enum":[true,false]},"source_code":{"type":"string","description":"Code for the WhizzML **library**. See [WhizzML Reference Manual]({{api.doc_base_url}}BigML_WhizzML_Reference.pdf?ver=8d98e3c) for more information. **Example**: \"(define (avg a b c) ( (+ a b c) 3))\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **library**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"description":"This is a description of my new library","imports":["imports_value"],"name":"my new library","project":"project/{{ project_id }}","public_in_organization":true,"source_code":"(define (avg a b c) ( (+ a b c) 3))","tags":["tags_value"],"webhook":{}}}}}},"get":{"tags":["Libraries"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/whizzml_libraries/","api_endpoint":"https://bigml.io/andromeda/library"},"summary":"List libraries","description":"To list all the **libraries**, you can use the **library** base URL. By default, only the 20 most recent **libraries** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/library/{id}":{"get":{"tags":["Libraries"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/whizzml_libraries/","api_endpoint":"https://bigml.io/andromeda/library/{id}"},"summary":"Retrieve a library","description":"Each **library** has a unique identifier in the form **\"library/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **library**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Libraries"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/whizzml_libraries/","api_endpoint":"https://bigml.io/andromeda/library/{id}"},"summary":"Update a library","description":"To update a **library**, you need to PUT an object containing the fields that you want to update to the **library**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **library**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The WhizzML category that best describes the **library**. See the [WhizzML category codes](category_codes#whizzml-category-codes) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **library** up to 8192 characters long. **Example**: \"This is a description of my new library\""},"name":{"type":"string","description":"The name you want to give to the new **library**. **Example**: \"my new library\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **library**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new library","name":"my new library","tags":["tags_value"]}}}}},"delete":{"tags":["Libraries"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/whizzml_libraries/","api_endpoint":"https://bigml.io/andromeda/library/{id}"},"summary":"Delete a library","description":"To delete a **library**, you need to issue a HTTP DELETE request to the **library/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/andromeda/script":{"post":{"tags":["Scripts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/whizzml_scripts/","api_endpoint":"https://bigml.io/andromeda/script"},"summary":"Create a script","description":"To create a new **script**, you need to POST a string containing at least the **source code** to the **script** base URL. The **content-type** must always be **\"application/json\"**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The WhizzML category that best describes the **script**. See the [WhizzML category codes](category_codes#whizzml-category-codes) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **script** up to 8192 characters long. **Example**: \"This is a description of my new script\""},"imports":{"type":"array","description":"A list of valid **library** identifiers. **Example**: [\"library/60509a611f386f3491000001\"]","items":{"type":"string"}},"inputs":{"type":"array","description":"A list of inputs of the **script** with their name, type and optional default value and description. See the list of [available input types](#Available-Variable-Types-for-Inputs-and-Outputs). **Example**: [ {\"name\": \"remote_uri\", \"type\": \"string\"}, {\"name\": \"timeout\", \"type\": \"number\", \"default\": 10000, \"description\": \"Timeout in ms\"} ]","items":{"type":"string"}},"name":{"type":"string","description":"The name you want to give to the new **script**. **Example**: \"my new script\""},"origin":{"type":"string","description":"The **script/id** of the gallery script to be cloned. The price of the **script** must be 0 to be cloned via API. **Example**: \"script/{{ script_id }}\""},"outputs":{"type":"array","description":"A list of variables with their name, type, and optional description, defined in the source code of script, that will conform the outputs of execution. See the list of [available input types](#Available-Variable-Types-for-Inputs-and-Outputs). **Example**: [ {\"name\":\"normalized-dataset\",\"type\":\"dataset-id\"}, {\"name\":\"n\",\"type\":\"number\", \"description\": \"Number of anomalies\"} ]","items":{"type":"string"}},"project":{"type":"string","description":"The **project/id** you want the **script** to belong to. **Example**: \"project/{{ project_id }}\""},"public_in_organization":{"type":"boolean","description":"Whether the **script** is public within the organization. **Example**: true","enum":[true,false]},"shared_hash":{"type":"string","description":"The **shared hash** of the shared **script** to be cloned. **Example**: \"kpY46mNuNVReITw0Z1mAqoQ9ySW\""},"source_code":{"type":"string","description":"Code for the WhizzML **script**. See [WhizzML Reference Manual]({{api.doc_base_url}}BigML_WhizzML_Reference.pdf?ver=8d98e3c) for more information. **Example**: \"(define id (create-source {\"remote\" remote_uri})) (wait id timeout)\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **script**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}},"webhook":{"type":"object","description":"A webhook url and an optional secret phrase. See the Section on [Webhooks](requests#webhooks) for more details. **Example**: { \"url\": \"http ://myhost/path/to/webhook\", \"secret\": \"mysecret\" }","properties":{}}}},"example":{"category":1,"description":"This is a description of my new script","imports":["imports_value"],"inputs":["inputs_value"],"name":"my new script","origin":"script/{{ script_id }}","outputs":["outputs_value"],"project":"project/{{ project_id }}","public_in_organization":true,"shared_hash":"kpY46mNuNVReITw0Z1mAqoQ9ySW","source_code":"(define id (create-source {\"remote\" remote_uri})) (wait id t","tags":["tags_value"],"webhook":{}}}}}},"get":{"tags":["Scripts"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of resources to return. Default: the 20 most recent resources.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How far off from the first resource the returned page starts (pagination offset).","required":false,"schema":{"type":"number","example":""}},{"name":"order_by","in":"query","description":"Sort order: name of a sortable field, prefixed with '-' for descending. Default '-created'.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/whizzml_scripts/","api_endpoint":"https://bigml.io/andromeda/script"},"summary":"List scripts","description":"To list all the **scripts**, you can use the **script** base URL. By default, only the 20 most recent **scripts** will be returned. You can see below how to change this number using the **limit** parameter.","security":[{"bearerAuth":[]}]}},"/andromeda/script/{id}":{"get":{"tags":["Scripts"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/whizzml_scripts/","api_endpoint":"https://bigml.io/andromeda/script/{id}"},"summary":"Retrieve a script","description":"Each **script** has a unique identifier in the form **\"script/id\"** where id is a string of 24 alpha-numeric characters that you can use to retrieve the **script**.","security":[{"bearerAuth":[]}]},"put":{"tags":["Scripts"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/whizzml_scripts/","api_endpoint":"https://bigml.io/andromeda/script/{id}"},"summary":"Update a script","description":"To update a **script**, you need to PUT an object containing the fields that you want to update to the **script**'s base URL. The content-type must always be: **\"application/json\"**. If the request succeeds, **BigML.io** will return with an [HTTP 202](status_codes#http-status-code-summary) response with the updated **script**.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The WhizzML category that best describes the **script**. See the [WhizzML category codes](category_codes#whizzml-category-codes) for the complete list of categories. **Example**: 1"},"description":{"type":"string","description":"A description of the **script** up to 8192 characters long. **Example**: \"This is a description of my new script\""},"name":{"type":"string","description":"The name you want to give to the new **script**. **Example**: \"my new script\""},"tags":{"type":"array","description":"A list of strings that help classify and index your **script**. **Example**: [\"best customers\", \"2021\"]","items":{"type":"string"}}}},"example":{"category":1,"description":"This is a description of my new script","name":"my new script","tags":["tags_value"]}}}}},"delete":{"tags":["Scripts"],"parameters":[{"name":"id","in":"path","description":"The resource id: the 24-character hex string in the resource's 'type/id' identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://bigml.com/api/whizzml_scripts/","api_endpoint":"https://bigml.io/andromeda/script/{id}"},"summary":"Delete a script","description":"To delete a **script**, you need to issue a HTTP DELETE request to the **script/id** to be deleted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}