Interface GenerateAiDescriptionsForDataSchemaRequest<SchemaType>

Request for generating AI descriptions for a data schema.

interface GenerateAiDescriptionsForDataSchemaRequest<
    SchemaType = Record<string, any>,
> {
    collections?: string[];
    instructions?: string;
    schema: SchemaType;
}

Properties

collections?: string[]

List of collection names to generate descriptions for. If not provided or empty, descriptions will be generated for all collections.

instructions?: string

Optional instructions to guide the AI in generating descriptions. For example: "Focus on business context" or "Use technical terminology".

The current schema of the integration containing collections and their fields.