Interface GenieAgentExampleQuestionSql

An example question paired with the SQL that answers it.

interface GenieAgentExampleQuestionSql {
    id?: string;
    parameters?: GenieAgentSqlParameter[];
    question?: string;
    sql?: string;
    usageGuidance?: string;
}

Index

Properties

id? parameters? question? sql? usageGuidance?

Properties

`Optional`id

id?: string

Identifier of the example: 32 lowercase hexadecimal characters, unique within the Genie Agent.

`Optional`parameters

parameters?: GenieAgentSqlParameter[]

Parameters used in the SQL, in the order given.

`Optional`question

question?: string

The question.

`Optional`sql

sql?: string

The SQL that answers the question.

`Optional`usageGuidance

usageGuidance?: string

Guidance on when to use this example.