AskSQL API Reference (core v0.10.0)
GitHub
Preparing search index...
@asksql/core
Module
Classes
AskSqlError
MemoryFewShotStore
MemoryHistoryStore
Interfaces
AskOptions
AskResult
AskSqlConfig
AskSqlEngine
AskSqlErrorOptions
CapabilityFlags
CatalogOptions
ColumnInfo
Connector
CustomModelRequest
DialectInfo
EnumTypeInfo
ExecuteEngineOptions
ExecuteOptions
ExplainOptions
ExplainSchemaOptions
Extraction
FewShotExample
FewShotStore
ForeignKeyInfo
GlossaryEntry
GroundingOptions
GuardInput
GuardPolicy
GuardVerdict
HistoryEntry
HistoryPage
HistoryStore
IndexInfo
LlmCallInput
LlmCallResult
LlmSettings
LlmUsage
PromptSettings
PruneResult
PrunerSettings
RepairPromptInput
ResultColumn
ResultSet
RoutineInfo
SchemaAnswer
SchemaCatalog
SequenceInfo
SqlPromptInput
SuggestFixOptions
TableInfo
TriggerInfo
Type Aliases
CellValue
ColumnKind
CustomModel
EngineEvent
EngineKind
EngineStage
ErrorCode
GuardGrammar
ModelLike
Variables
DEFAULT_GUARD_POLICY
DUCKDB_DIALECT
HINT_VALUE_CAP
JSON_SAMPLE_ROWS
MAX_HINT_PROBES
MAX_HINT_PROBES_PER_TABLE
MYSQL_DIALECT
OFF_TOPIC_SENTINEL
ORACLE_DIALECT
POSTGRES_DIALECT
SQLITE_DIALECT
VALUE_SAMPLE_MAX_DISTINCT
Functions
buildExplainSystem
buildExplainUser
buildRepairUser
buildSchemaAnswerRepairUser
buildSchemaAnswerScopeRepairUser
buildSchemaAnswerSystem
buildSchemaAnswerUser
buildSqlSystem
buildSqlUser
callModel
catalogQueryHint
classifyColumnKind
classifyLlmError
closestTableName
createAskSql
createReasoningFilter
danglingReference
epochUnitOf
estimateTokens
extractImpossible
extractSql
firstUnknownTable
formatCatalogForPrompt
guardSql
hasMultipleStatements
hintProbesPerTable
isCapabilityQuestion
isDatabaseOverviewQuestion
isJsonCandidateColumn
isMetadataQuestion
isMomentColumn
isOffTopic
isPromptInjection
isRelationshipQuestion
isSchemaAdviceQuestion
isSchemaProposalQuestion
isWriteRequest
joinGraph
jsonArrayElementOf
jsonHint
jsonShapeOf
looksDatabaseRelated
offTopicAnswer
pruneCatalog
resolveGuardPolicy
stripCommentsAndStrings
unknownReferencesInProse
withoutReasoning
References
assertBaseUrl
→
assertBaseUrl
PROVIDER_API_HOST
→
PROVIDER_API_HOST
ProviderConfig
→
ProviderConfig
ProviderName
→
ProviderName
resolveModel
→
resolveModel
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Classes
Ask
Sql
Error
Memory
Few
Shot
Store
Memory
History
Store
Interfaces
Ask
Options
Ask
Result
Ask
Sql
Config
Ask
Sql
Engine
Ask
Sql
Error
Options
Capability
Flags
Catalog
Options
Column
Info
Connector
Custom
Model
Request
Dialect
Info
Enum
Type
Info
Execute
Engine
Options
Execute
Options
Explain
Options
Explain
Schema
Options
Extraction
Few
Shot
Example
Few
Shot
Store
Foreign
Key
Info
Glossary
Entry
Grounding
Options
Guard
Input
Guard
Policy
Guard
Verdict
History
Entry
History
Page
History
Store
Index
Info
Llm
Call
Input
Llm
Call
Result
Llm
Settings
Llm
Usage
Prompt
Settings
Prune
Result
Pruner
Settings
Repair
Prompt
Input
Result
Column
Result
Set
Routine
Info
Schema
Answer
Schema
Catalog
Sequence
Info
Sql
Prompt
Input
Suggest
Fix
Options
Table
Info
Trigger
Info
Type Aliases
Cell
Value
Column
Kind
Custom
Model
Engine
Event
Engine
Kind
Engine
Stage
Error
Code
Guard
Grammar
Model
Like
Variables
DEFAULT_
GUARD_
POLICY
DUCKDB_
DIALECT
HINT_
VALUE_
CAP
JSON_
SAMPLE_
ROWS
MAX_
HINT_
PROBES
MAX_
HINT_
PROBES_
PER_
TABLE
MYSQL_
DIALECT
OFF_
TOPIC_
SENTINEL
ORACLE_
DIALECT
POSTGRES_
DIALECT
SQLITE_
DIALECT
VALUE_
SAMPLE_
MAX_
DISTINCT
Functions
build
Explain
System
build
Explain
User
build
Repair
User
build
Schema
Answer
Repair
User
build
Schema
Answer
Scope
Repair
User
build
Schema
Answer
System
build
Schema
Answer
User
build
Sql
System
build
Sql
User
call
Model
catalog
Query
Hint
classify
Column
Kind
classify
Llm
Error
closest
Table
Name
create
Ask
Sql
create
Reasoning
Filter
dangling
Reference
epoch
Unit
Of
estimate
Tokens
extract
Impossible
extract
Sql
first
Unknown
Table
format
Catalog
For
Prompt
guard
Sql
has
Multiple
Statements
hint
Probes
Per
Table
is
Capability
Question
is
Database
Overview
Question
is
Json
Candidate
Column
is
Metadata
Question
is
Moment
Column
is
Off
Topic
is
Prompt
Injection
is
Relationship
Question
is
Schema
Advice
Question
is
Schema
Proposal
Question
is
Write
Request
join
Graph
json
Array
Element
Of
json
Hint
json
Shape
Of
looks
Database
Related
off
Topic
Answer
prune
Catalog
resolve
Guard
Policy
strip
Comments
And
Strings
unknown
References
In
Prose
without
Reasoning
References
assert
Base
Url
PROVIDER_
API_
HOST
Provider
Config
Provider
Name
resolve
Model
GitHub
AskSQL API Reference (core v0.10.0)
Loading...