AskSQL API Reference (core v0.10.0)
    Preparing search index...

    Interface MongoAskEngine

    interface MongoAskEngine {
        ask(question: string, opts?: MongoAskOptions): Promise<MongoAskResult>;
        catalog(): Promise<SchemaCatalog>;
        execute(
            pipelineJson: string,
            collection: string,
            opts?: ExecuteOptions,
        ): Promise<ResultSet>;
        explain(
            pipelineJson: string,
            opts?: { signal?: AbortSignal },
        ): Promise<string>;
        explainSchema(
            question: string,
            opts?: { context?: readonly MongoContextTurn[]; signal?: AbortSignal },
        ): Promise<SchemaAnswer>;
        invalidateCatalog(): void;
    }
    Index
    • Parameters

      • pipelineJson: string
      • Optionalopts: { signal?: AbortSignal }

      Returns Promise<string>