Classify Collection

Detect personal or sensitive information within a structured data set.

post

/v1/classifyCollection

Authorizations

Body

content_typestring · default: string

column type (e.g int64, string)

contentstring[] · default: ["John","Chris","Tanner","Dave"]]

set of rows to classify for a given column

metadatastring[] · default: ["first_name","users","users_production"]]

context to take into consideration, such as column name, table name, database name, etc.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.scanner.demo-001.teleskope.ai/v1/classifyCollection' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"content_type":"string","content":["[\"John\"","\"Chris\"","\"Tanner\"","\"Dave\"]]"],"metadata":["[\"first_name\"","\"users\"","\"users_production\"]]"]}'

200

400

200

{
	"classifications": [
		{
			"data_element": "FIRST_NAME",
      "category": "PERSONAL",
			"star_char": 15,
			"char_size": 4,
      "row_index": 2000,
		},
		{
			"data_element": "LAST_NAME",
      "category": "PERSONAL",
			"star_char": 20,
			"char_size": 3,
      "row_index": 2002,
		},
		{
			"data_element": "EMAIL",
      "category": "PERSONAL",
			"star_char": 45,
			"char_size": 18,
      "row_index": 2005,
		}
	]
}

200