Skip to main content

AI API

AI-powered assistance and metadata generation endpoints.

Endpoints Overview​

MethodEndpointDescription
POST/ai/generate-descriptionGenerate product description
POST/ai/generate-field-descriptionGenerate field description
POST/ai/suggest-tagsSuggest tags for product

Generate Product Description​

POST /ai/generate-description

Request Body​

{
  "product_name": "customer_events",
  "fields": ["user_id", "event_type", "timestamp", "properties"],
  "context": "Part of the analytics warehouse"
}

Response​

{
  "description": "Captures user interaction events from the web and mobile applications. Contains event metadata including user identification, event categorization, and custom properties for behavioral analysis.",
  "confidence": 0.85
}

Generate Field Description​

POST /ai/generate-field-description
{
  "field_name": "customer_lifetime_value",
  "data_type": "DECIMAL",
  "table_name": "customers",
  "sample_values": ["150.00", "2500.50", "89.99"]
}

Response​

{
  "description": "The total revenue attributed to a customer over their entire relationship with the business, calculated as the sum of all purchases.",
  "confidence": 0.78
}

Suggest Tags​

POST /ai/suggest-tags
{
  "product_name": "order_transactions",
  "description": "Contains all order records from the e-commerce platform"
}

Response​

{
  "tags": ["commerce", "transactions", "orders", "revenue"],
  "confidence": 0.82
}