v1

latestSwagger 2.0Apache 2.02026-07-1717518.3 KB
Data Providers

Add data provider to data providers list

post/data-providers

Request body

namestring

Name display to the user

typestring

Type of the data provider (enum of supported ?)

tagsstring[]

List of tags associated to the project)

Example request

{
  "metadata": [
    {
      "version": "data provider version",
      "external_url": "Optional external URL to access the data provider",
      "url_key": "Optional url_key in the debiai front to access the data provider api",
      "s3_bucket": "If S3 use to read parquet files by front",
      "s3_access_key": "S3 access key needed to access directly parquet from front in readonly",
      "s3_secret_id": "S3 access key needed to access directly parquet from front in readonly - use https with such informations",
      "selections_path": "local path or S3 to read selection parquet ($path/$selection_id)",
      "models_path": "local path or S3 to read model parquet ($path/$model_id)",
      "project_path": "local path or S3 to read project parquets"
    }
  ],
  "metrics": [
    {
      "maxSampleIdByRequest": "Max sample id per request",
      "maxSampleDataByRequest": "Max sample data per request",
      "maxResultByRequest": "Max results per request"
    }
  ]
}

Response

Data provider added to the list