Create Generate Descriptions

LLM-friendly URL

POST

https://api.luzmo.com/0.1.0/generate_descriptions

API call form

Examples

Let Luzmo AI generate descriptions for your datasets, their columns and formulas.

Request parameters

Response schema

Can be executed by:

Dataset editor

Can be associated to:

Did this page help you?

Yes

Language

Shell

Node

Java

.NET

Python

PHP

Install

npm install @luzmo/nodejs-sdk

Example Request

import Luzmo from '@luzmo/nodejs-sdk';
const client = new Luzmo({
  api_key: '<your Luzmo API key>',
  api_token: '<your Luzmo API token>',
  host: 'https://api.luzmo.com'
});


const response = await client.create('generate_descriptions',
  {
    datasets: [
      {
        id: "<your dataset id>",
        generate_dataset_description: true,
        columns: "all",
        formulas: "all"
      }
    ]
  }
);

Example Response

200

400

500

{
  "properties": {
    "datasets": [
      {
        "id": "<your dataset id>",
        "description": {
          "en": "English description"
        },
        "columns": [
          {
            "id": "<your column id>",
            "description": {
              "en": "English description"
            }
          },
          {
            "id": "<another column id>",
            "description": {
              "en": "English description"
            }
          }
        ],
        "formulas": [
          {
            "id": "<your formula id>",
            "description": {
              "en": "English description"
            }
          },
          {
            "id": "<another formula id>",
            "description": {
              "en": "English description"
            }
          }
        ]
      }
    ]
  }
}