Infer dataset description

Ask an agent to infer a data description based on sampled data.

POST /infer/description

Infer dataset description

cURL

curl --request POST \
  --url https://api.datalinks.com/api/v1/infer/description \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sample": [
    {}
  ],
  "model": "<string>",
  "provider": "<string>",
  "currentValue": {
    "description": "<string>",
    "schema": {}
  }
}
'

200

{
  "description": "<string>"
}

Authorizations

bearerAuthopenId

Authorization · string · header · required

Use a Bearer token for authentication. Submit the token using the Authorization header: Authorization: Bearer <token>.

Body

application/json

sample · object[] · required

Array of ontology data objects retrieved from queries.

model · string

The inference model to use.

provider · string

Provider offering the model.

currentValue · object

Show child attributes

Response

200

application/json

Returns an inferred description.

Wrapper object containing the inferred description.

description · string · required

The inferred description text.