API - Corsair

Every bigml.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Anomalies

list

anomalies.list List anomaly resources Risk: read

await corsair.bigml.api.anomalies.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Anomaly Scores

list

anomalyScores.list List anomaly score resources Risk: read

await corsair.bigml.api.anomalyScores.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Associations

list

associations.list List association resources Risk: read

await corsair.bigml.api.associations.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Association Sets

list

associationSets.list List association set resources Risk: read

await corsair.bigml.api.associationSets.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Batch Anomaly Scores

list

batchAnomalyScores.list List batch anomaly score resources Risk: read

await corsair.bigml.api.batchAnomalyScores.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Batch Centroids

list

batchCentroids.list List batch centroid resources Risk: read

await corsair.bigml.api.batchCentroids.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Batch Predictions

list

batchPredictions.list List batch prediction resources Risk: read

await corsair.bigml.api.batchPredictions.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Batch Projections

list

batchProjections.list List batch projection resources Risk: read

await corsair.bigml.api.batchProjections.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Batch Topic Distributions

list

batchTopicDistributions.list List batch topic distribution resources Risk: read

await corsair.bigml.api.batchTopicDistributions.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Centroids

list

centroids.list List centroid resources Risk: read

await corsair.bigml.api.centroids.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Clusters

list

clusters.list List cluster resources Risk: read

await corsair.bigml.api.clusters.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Composites

list

composites.list List composite resources Risk: read

await corsair.bigml.api.composites.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Configurations

get

configurations.get Retrieve a saved configuration Risk: read

await corsair.bigml.api.configurations.get({});

Input

Name	Type	Required	Description
`configurationId`	`string`	Yes	—

Output

Name	Type	Required	Description
`category`	`number`	No	—
`code`	`number`	No	—
`created`	`string`	No	—
`creator`	`string`	No	—
`description`	`string`	No	—
`execution_id`	`string`	No	—
`execution_status`	`boolean`	No	—
`name`	`string`	No	—
`name_options`	`string`	No	—
`private`	`boolean`	No	—
`project`	`string`	No	—
`resource`	`string`	Yes	—
`shared`	`boolean`	No	—
`status`	`object`	No	—
`subscription`	`boolean`	No	—
`tags`	`string[]`	No	—
`updated`	`string`	No	—
`webhook`	`object`	No	—
`configurations`	`object`	No	—
`type`	`number`	No	—

status full type

{
  code?: number | null,
  elapsed?: number | null,
  message?: string | null,
  progress?: number | null
}

webhook full type

{
  url?: string | null
}

configurations full type

{
}

list

configurations.list List saved configurations Risk: read

await corsair.bigml.api.configurations.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  configurations?: {
  } | null,
  type?: number | null
}[]

Correlations

list

correlations.list List correlation resources Risk: read

await corsair.bigml.api.correlations.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Datasets

list

datasets.list List dataset resources Risk: read

await corsair.bigml.api.datasets.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Deepnets

list

deepnets.list List deepnet resources Risk: read

await corsair.bigml.api.deepnets.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Ensembles

list

ensembles.list List ensemble resources Risk: read

await corsair.bigml.api.ensembles.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Evaluations

list

evaluations.list List evaluation resources Risk: read

await corsair.bigml.api.evaluations.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Executions

list

executions.list List execution resources Risk: read

await corsair.bigml.api.executions.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

External Connectors

create

externalConnectors.create Create an external data connector Risk: write

await corsair.bigml.api.externalConnectors.create({});

Input

Name	Type	Required	Description
`source`	`string`	No	—
`engine`	`string`	No	—
`connection`	`object`	Yes	—
`name`	`string`	No	—
`category`	`number`	No	—
`description`	`string`	No	—
`tags`	`string[]`	No	—
`project`	`string`	No	—

connection full type

{
  host?: string,
  hosts?: string[],
  port?: number,
  database?: string,
  use_ssl?: boolean,
  verify_certs?: boolean,
  user?: string,
  password?: string,
  http_auth?: string,
  sslmode?: string,
  master?: string,
  timeout?: number,
  indice?: string
}

Output

Name	Type	Required	Description
`category`	`number`	No	—
`code`	`number`	No	—
`created`	`string`	No	—
`creator`	`string`	No	—
`description`	`string`	No	—
`execution_id`	`string`	No	—
`execution_status`	`boolean`	No	—
`name`	`string`	No	—
`name_options`	`string`	No	—
`private`	`boolean`	No	—
`project`	`string`	No	—
`resource`	`string`	Yes	—
`shared`	`boolean`	No	—
`status`	`object`	No	—
`subscription`	`boolean`	No	—
`tags`	`string[]`	No	—
`updated`	`string`	No	—
`webhook`	`object`	No	—
`connection`	`object`	No	—
`engine`	`string`	No	—
`public_in_organization`	`boolean`	No	—
`source`	`string`	No	—
`type`	`number`	No	—

status full type

{
  code?: number | null,
  elapsed?: number | null,
  message?: string | null,
  progress?: number | null
}

webhook full type

{
  url?: string | null
}

connection full type

{
}

get

externalConnectors.get Retrieve an external data connector Risk: read

await corsair.bigml.api.externalConnectors.get({});

Input

Name	Type	Required	Description
`externalConnectorId`	`string`	Yes	—

Output

Name	Type	Required	Description
`category`	`number`	No	—
`code`	`number`	No	—
`created`	`string`	No	—
`creator`	`string`	No	—
`description`	`string`	No	—
`execution_id`	`string`	No	—
`execution_status`	`boolean`	No	—
`name`	`string`	No	—
`name_options`	`string`	No	—
`private`	`boolean`	No	—
`project`	`string`	No	—
`resource`	`string`	Yes	—
`shared`	`boolean`	No	—
`status`	`object`	No	—
`subscription`	`boolean`	No	—
`tags`	`string[]`	No	—
`updated`	`string`	No	—
`webhook`	`object`	No	—
`connection`	`object`	No	—
`engine`	`string`	No	—
`public_in_organization`	`boolean`	No	—
`source`	`string`	No	—
`type`	`number`	No	—

status full type

{
  code?: number | null,
  elapsed?: number | null,
  message?: string | null,
  progress?: number | null
}

webhook full type

{
  url?: string | null
}

connection full type

{
}

Forecasts

list

forecasts.list List forecast resources Risk: read

await corsair.bigml.api.forecasts.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Fusions

list

fusions.list List fusion resources Risk: read

await corsair.bigml.api.fusions.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Libraries

list

libraries.list List library resources Risk: read

await corsair.bigml.api.libraries.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Linear Regressions

list

linearRegressions.list List linear regression resources Risk: read

await corsair.bigml.api.linearRegressions.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Logistic Regressions

list

logisticRegressions.list List logistic regression resources Risk: read

await corsair.bigml.api.logisticRegressions.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Models

list

models.list List model resources Risk: read

await corsair.bigml.api.models.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Optimls

list

optimls.list List optiml resources Risk: read

await corsair.bigml.api.optimls.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Pcas

list

pcas.list List pca resources Risk: read

await corsair.bigml.api.pcas.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Predictions

list

predictions.list List prediction resources Risk: read

await corsair.bigml.api.predictions.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Projections

list

projections.list List projection resources Risk: read

await corsair.bigml.api.projections.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Projects

create

projects.create Create a project Risk: write

await corsair.bigml.api.projects.create({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`description`	`string`	No	—
`tags`	`string[]`	No	—
`category`	`number`	No	—

Output

Name	Type	Required	Description
`category`	`number`	No	—
`code`	`number`	No	—
`created`	`string`	No	—
`creator`	`string`	No	—
`description`	`string`	No	—
`execution_id`	`string`	No	—
`execution_status`	`boolean`	No	—
`name`	`string`	No	—
`name_options`	`string`	No	—
`private`	`boolean`	No	—
`project`	`string`	No	—
`resource`	`string`	Yes	—
`shared`	`boolean`	No	—
`status`	`object`	No	—
`subscription`	`boolean`	No	—
`tags`	`string[]`	No	—
`updated`	`string`	No	—
`webhook`	`object`	No	—
`configuration`	`string`	No	—
`configuration_status`	`boolean`	No	—
`manage_permission`	`any[]`	No	—
`stats`	`object`	No	—
`type`	`number`	No	—
`user_metadata`	`object`	No	—

status full type

{
  code?: number | null,
  elapsed?: number | null,
  message?: string | null,
  progress?: number | null
}

webhook full type

{
  url?: string | null
}

stats full type

{
}

user_metadata full type

{
}

delete

projects.delete Permanently delete a project Risk: destructive

await corsair.bigml.api.projects.delete({});

Input

Name	Type	Required	Description
`projectId`	`string`	Yes	—

Output: void

get

projects.get Retrieve a project Risk: read

await corsair.bigml.api.projects.get({});

Input

Name	Type	Required	Description
`projectId`	`string`	Yes	—

Output

Name	Type	Required	Description
`category`	`number`	No	—
`code`	`number`	No	—
`created`	`string`	No	—
`creator`	`string`	No	—
`description`	`string`	No	—
`execution_id`	`string`	No	—
`execution_status`	`boolean`	No	—
`name`	`string`	No	—
`name_options`	`string`	No	—
`private`	`boolean`	No	—
`project`	`string`	No	—
`resource`	`string`	Yes	—
`shared`	`boolean`	No	—
`status`	`object`	No	—
`subscription`	`boolean`	No	—
`tags`	`string[]`	No	—
`updated`	`string`	No	—
`webhook`	`object`	No	—
`configuration`	`string`	No	—
`configuration_status`	`boolean`	No	—
`manage_permission`	`any[]`	No	—
`stats`	`object`	No	—
`type`	`number`	No	—
`user_metadata`	`object`	No	—

status full type

{
  code?: number | null,
  elapsed?: number | null,
  message?: string | null,
  progress?: number | null
}

webhook full type

{
  url?: string | null
}

stats full type

{
}

user_metadata full type

{
}

list

projects.list List projects Risk: read

await corsair.bigml.api.projects.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  configuration?: string | null,
  configuration_status?: boolean | null,
  manage_permission?: any[] | null,
  stats?: {
  } | null,
  type?: number | null,
  user_metadata?: {
  } | null
}[]

Samples

list

samples.list List sample resources Risk: read

await corsair.bigml.api.samples.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Scripts

list

scripts.list List script resources Risk: read

await corsair.bigml.api.scripts.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Sources

get

sources.get Retrieve a data source Risk: read

await corsair.bigml.api.sources.get({});

Input

Name	Type	Required	Description
`sourceId`	`string`	Yes	—

Output

Name	Type	Required	Description
`category`	`number`	No	—
`code`	`number`	No	—
`created`	`string`	No	—
`creator`	`string`	No	—
`description`	`string`	No	—
`execution_id`	`string`	No	—
`execution_status`	`boolean`	No	—
`name`	`string`	No	—
`name_options`	`string`	No	—
`private`	`boolean`	No	—
`project`	`string`	No	—
`resource`	`string`	Yes	—
`shared`	`boolean`	No	—
`status`	`object`	No	—
`subscription`	`boolean`	No	—
`tags`	`string[]`	No	—
`updated`	`string`	No	—
`webhook`	`object`	No	—
`charset`	`string`	No	—
`closed`	`boolean`	No	—
`configuration`	`string`	No	—
`configuration_status`	`boolean`	No	—
`content_type`	`string`	No	—
`disable_autolabel`	`boolean`	No	—
`disable_datetime`	`boolean`	No	—
`field_types`	`object`	No	—
`fields`	`object`	No	—
`fields_meta`	`object`	No	—
`fields_preview`	`object`	No	—
`file_name`	`string`	No	—
`format`	`string`	No	—
`formats`	`object`	No	—
`height`	`number`	No	—
`image_analysis`	`object`	No	—
`image_id`	`string`	No	—
`item_analysis`	`object`	No	—
`md5`	`string`	No	—
`new_fields`	`any[]`	No	—
`number_of_anomalies`	`number`	No	—
`number_of_anomalyscores`	`number`	No	—
`number_of_associations`	`number`	No	—
`number_of_associationsets`	`number`	No	—
`number_of_centroids`	`number`	No	—
`number_of_clusters`	`number`	No	—
`number_of_correlations`	`number`	No	—
`number_of_datasets`	`number`	No	—
`number_of_deepnets`	`number`	No	—
`number_of_ensembles`	`number`	No	—
`number_of_forecasts`	`number`	No	—
`number_of_linearregressions`	`number`	No	—
`number_of_logisticregressions`	`number`	No	—
`number_of_models`	`number`	No	—
`number_of_optimls`	`number`	No	—
`number_of_pca`	`number`	No	—
`number_of_predictions`	`number`	No	—
`number_of_projections`	`number`	No	—
`number_of_statisticaltests`	`number`	No	—
`number_of_timeseries`	`number`	No	—
`number_of_topicdistributions`	`number`	No	—
`number_of_topicmodels`	`number`	No	—
`origin`	`string`	No	—
`original_height`	`number`	No	—
`original_format`	`string`	No	—
`original_size`	`number`	No	—
`original_width`	`number`	No	—
`parent_sources`	`string[]`	No	—
`remote`	`string`	No	—
`shared_clonable`	`boolean`	No	—
`shared_hash`	`string`	No	—
`sharing_key`	`string`	No	—
`size`	`number`	No	—
`source_csv`	`string`	No	—
`source_parser`	`object`	No	—
`sources`	`string[]`	No	—
`sources_count`	`number`	No	—
`synthetic`	`object`	No	—
`term_analysis`	`object`	No	—
`type`	`number`	No	—
`types`	`string[]`	No	—
`width`	`number`	No	—

status full type

{
  code?: number | null,
  elapsed?: number | null,
  message?: string | null,
  progress?: number | null
}

webhook full type

{
  url?: string | null
}

field_types full type

{
  auto_generated?: {
  } | null,
  categorical?: number | null,
  datetime?: number | null,
  image?: number | null,
  items?: number | null,
  numeric?: number | null,
  path?: number | null,
  regions?: number | null,
  text?: number | null,
  total?: number | null
}

fields full type

{
}

fields_meta full type

{
  count?: number | null,
  limit?: number | null,
  offset?: number | null,
  query_total?: number | null,
  total?: number | null
}

fields_preview full type

{
}

formats full type

{
}

image_analysis full type

{
}

item_analysis full type

{
}

source_parser full type

{
  header?: boolean | null,
  json_fields?: string[] | null,
  json_key?: string | null,
  locale?: string | null,
  missing_tokens?: string[] | null,
  quote?: string | null,
  separator?: string | null,
  trim?: boolean | null
}

synthetic full type

{
}

term_analysis full type

{
}

list

sources.list List data sources Risk: read

await corsair.bigml.api.sources.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  charset?: string | null,
  closed?: boolean | null,
  configuration?: string | null,
  configuration_status?: boolean | null,
  content_type?: string | null,
  disable_autolabel?: boolean | null,
  disable_datetime?: boolean | null,
  field_types?: {
    auto_generated?: {
    } | null,
    categorical?: number | null,
    datetime?: number | null,
    image?: number | null,
    items?: number | null,
    numeric?: number | null,
    path?: number | null,
    regions?: number | null,
    text?: number | null,
    total?: number | null
  } | null,
  fields?: {
  } | null,
  fields_meta?: {
    count?: number | null,
    limit?: number | null,
    offset?: number | null,
    query_total?: number | null,
    total?: number | null
  } | null,
  fields_preview?: {
  } | null,
  file_name?: string | null,
  format?: string | null,
  formats?: {
  } | null,
  height?: number | null,
  image_analysis?: {
  } | null,
  image_id?: string | null,
  item_analysis?: {
  } | null,
  md5?: string | null,
  new_fields?: any[] | null,
  number_of_anomalies?: number | null,
  number_of_anomalyscores?: number | null,
  number_of_associations?: number | null,
  number_of_associationsets?: number | null,
  number_of_centroids?: number | null,
  number_of_clusters?: number | null,
  number_of_correlations?: number | null,
  number_of_datasets?: number | null,
  number_of_deepnets?: number | null,
  number_of_ensembles?: number | null,
  number_of_forecasts?: number | null,
  number_of_linearregressions?: number | null,
  number_of_logisticregressions?: number | null,
  number_of_models?: number | null,
  number_of_optimls?: number | null,
  number_of_pca?: number | null,
  number_of_predictions?: number | null,
  number_of_projections?: number | null,
  number_of_statisticaltests?: number | null,
  number_of_timeseries?: number | null,
  number_of_topicdistributions?: number | null,
  number_of_topicmodels?: number | null,
  origin?: string | null,
  original_height?: number | null,
  original_format?: string | null,
  original_size?: number | null,
  original_width?: number | null,
  parent_sources?: string[] | null,
  remote?: string | null,
  shared_clonable?: boolean | null,
  shared_hash?: string | null,
  sharing_key?: string | null,
  size?: number | null,
  source_csv?: string | null,
  source_parser?: {
    header?: boolean | null,
    json_fields?: string[] | null,
    json_key?: string | null,
    locale?: string | null,
    missing_tokens?: string[] | null,
    quote?: string | null,
    separator?: string | null,
    trim?: boolean | null
  } | null,
  sources?: string[] | null,
  sources_count?: number | null,
  synthetic?: {
  } | null,
  term_analysis?: {
  } | null,
  type?: number | null,
  types?: string[] | null,
  width?: number | null
}[]

update

sources.update Update a data source’s name, description, tags, parsing configuration, or per-field properties Risk: write

await corsair.bigml.api.sources.update({});

Input

Name	Type	Required	Description
`sourceId`	`string`	Yes	—
`name`	`string`	No	—
`description`	`string`	No	—
`tags`	`string[]`	No	—
`sourceParser`	`object`	No	—
`fields`	`object`	No	—

sourceParser full type

{
  header?: boolean,
  jsonFields?: string[],
  jsonKey?: string,
  locale?: string,
  missingTokens?: string[],
  quote?: string,
  separator?: string,
  trim?: boolean
}

fields full type

{
}

Output

Name	Type	Required	Description
`category`	`number`	No	—
`code`	`number`	No	—
`created`	`string`	No	—
`creator`	`string`	No	—
`description`	`string`	No	—
`execution_id`	`string`	No	—
`execution_status`	`boolean`	No	—
`name`	`string`	No	—
`name_options`	`string`	No	—
`private`	`boolean`	No	—
`project`	`string`	No	—
`resource`	`string`	Yes	—
`shared`	`boolean`	No	—
`status`	`object`	No	—
`subscription`	`boolean`	No	—
`tags`	`string[]`	No	—
`updated`	`string`	No	—
`webhook`	`object`	No	—
`charset`	`string`	No	—
`closed`	`boolean`	No	—
`configuration`	`string`	No	—
`configuration_status`	`boolean`	No	—
`content_type`	`string`	No	—
`disable_autolabel`	`boolean`	No	—
`disable_datetime`	`boolean`	No	—
`field_types`	`object`	No	—
`fields`	`object`	No	—
`fields_meta`	`object`	No	—
`fields_preview`	`object`	No	—
`file_name`	`string`	No	—
`format`	`string`	No	—
`formats`	`object`	No	—
`height`	`number`	No	—
`image_analysis`	`object`	No	—
`image_id`	`string`	No	—
`item_analysis`	`object`	No	—
`md5`	`string`	No	—
`new_fields`	`any[]`	No	—
`number_of_anomalies`	`number`	No	—
`number_of_anomalyscores`	`number`	No	—
`number_of_associations`	`number`	No	—
`number_of_associationsets`	`number`	No	—
`number_of_centroids`	`number`	No	—
`number_of_clusters`	`number`	No	—
`number_of_correlations`	`number`	No	—
`number_of_datasets`	`number`	No	—
`number_of_deepnets`	`number`	No	—
`number_of_ensembles`	`number`	No	—
`number_of_forecasts`	`number`	No	—
`number_of_linearregressions`	`number`	No	—
`number_of_logisticregressions`	`number`	No	—
`number_of_models`	`number`	No	—
`number_of_optimls`	`number`	No	—
`number_of_pca`	`number`	No	—
`number_of_predictions`	`number`	No	—
`number_of_projections`	`number`	No	—
`number_of_statisticaltests`	`number`	No	—
`number_of_timeseries`	`number`	No	—
`number_of_topicdistributions`	`number`	No	—
`number_of_topicmodels`	`number`	No	—
`origin`	`string`	No	—
`original_height`	`number`	No	—
`original_format`	`string`	No	—
`original_size`	`number`	No	—
`original_width`	`number`	No	—
`parent_sources`	`string[]`	No	—
`remote`	`string`	No	—
`shared_clonable`	`boolean`	No	—
`shared_hash`	`string`	No	—
`sharing_key`	`string`	No	—
`size`	`number`	No	—
`source_csv`	`string`	No	—
`source_parser`	`object`	No	—
`sources`	`string[]`	No	—
`sources_count`	`number`	No	—
`synthetic`	`object`	No	—
`term_analysis`	`object`	No	—
`type`	`number`	No	—
`types`	`string[]`	No	—
`width`	`number`	No	—

status full type

{
  code?: number | null,
  elapsed?: number | null,
  message?: string | null,
  progress?: number | null
}

webhook full type

{
  url?: string | null
}

field_types full type

{
  auto_generated?: {
  } | null,
  categorical?: number | null,
  datetime?: number | null,
  image?: number | null,
  items?: number | null,
  numeric?: number | null,
  path?: number | null,
  regions?: number | null,
  text?: number | null,
  total?: number | null
}

fields full type

{
}

fields_meta full type

{
  count?: number | null,
  limit?: number | null,
  offset?: number | null,
  query_total?: number | null,
  total?: number | null
}

fields_preview full type

{
}

formats full type

{
}

image_analysis full type

{
}

item_analysis full type

{
}

source_parser full type

{
  header?: boolean | null,
  json_fields?: string[] | null,
  json_key?: string | null,
  locale?: string | null,
  missing_tokens?: string[] | null,
  quote?: string | null,
  separator?: string | null,
  trim?: boolean | null
}

synthetic full type

{
}

term_analysis full type

{
}

Statistical Tests

list

statisticalTests.list List statistical test resources Risk: read

await corsair.bigml.api.statisticalTests.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Time Series

list

timeSeries.list List time series resources Risk: read

await corsair.bigml.api.timeSeries.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Topic Distributions

list

topicDistributions.list List topic distribution resources Risk: read

await corsair.bigml.api.topicDistributions.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

Topic Models

list

topicModels.list List topic model resources Risk: read

await corsair.bigml.api.topicModels.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`offset`	`number`	No	—
`orderBy`	`string`	No	—
`filter`	`object`	No	—

filter full type

{
}

Output

Name	Type	Required	Description
`meta`	`object`	Yes	—
`objects`	`object[]`	Yes	—

meta full type

{
  limit?: number | null,
  offset?: number | null,
  total_count?: number | null,
  next?: string | null,
  previous?: string | null
}

objects full type

{
  category?: number | null,
  code?: number | null,
  created?: string | null,
  creator?: string | null,
  description?: string | null,
  execution_id?: string | null,
  execution_status?: boolean | null,
  name?: string | null,
  name_options?: string | null,
  private?: boolean | null,
  project?: string | null,
  resource: string,
  shared?: boolean | null,
  status?: {
    code?: number | null,
    elapsed?: number | null,
    message?: string | null,
    progress?: number | null
  } | null,
  subscription?: boolean | null,
  tags?: string[] | null,
  updated?: string | null,
  webhook?: {
    url?: string | null
  } | null,
  type?: number | null
}[]

​Anomalies

​list

​Anomaly Scores

​list

​Associations

​list

​Association Sets

​list

​Batch Anomaly Scores

​list

​Batch Centroids

​list

​Batch Predictions

​list

​Batch Projections

​list

​Batch Topic Distributions

​list

​Centroids

​list

​Clusters

​list

​Composites

​list

​Configurations

​get

​list

​Correlations

​list

​Datasets

​list

​Deepnets

​list

​Ensembles

​list

​Evaluations

​list

​Executions

​list

​External Connectors

​create

​get

​Forecasts

​list

​Fusions

​list

​Libraries

​list

​Linear Regressions

​list

​Logistic Regressions

​list

​Models

​list

​Optimls

​list

​Pcas

​list

​Predictions

​list

​Projections

​list

​Projects

​create

​delete

​get

​list

​Samples

​list

​Scripts

​list

​Sources

​get

​list

​update

​Statistical Tests

​list

​Time Series

​list

​Topic Distributions

Anomalies

list

Anomaly Scores

list

Associations

list

Association Sets

list

Batch Anomaly Scores

list

Batch Centroids

list

Batch Predictions

list

Batch Projections

list

Batch Topic Distributions

list

Centroids

list

Clusters

list

Composites

list

Configurations

get

list

Correlations

list

Datasets

list

Deepnets

list

Ensembles

list

Evaluations

list

Executions

list

External Connectors

create

get

Forecasts

list

Fusions

list

Libraries

list

Linear Regressions

list

Logistic Regressions

list

Models

list

Optimls

list

Pcas

list

Predictions

list

Projections

list

Projects

create

delete

get

list

Samples

list

Scripts

list

Sources

get

list

update

Statistical Tests

list

Time Series

list

Topic Distributions