@meilisearch/cli 0.0.0-stage → 0.0.0

package/dist/commands/multi-search.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"multi-search.js","sourceRoot":"","sources":["../../src/commands/multi-search.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,OAAO,EAAY,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,WAAW;IAClD,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,oBAAoB,CAAC,CAAC;IAEvC,MAAM,CAAC,UAAU,GAAG,CAAC,QAAQ,CAAC,CAAC;IAE/B,MAAM,CAAU,WAAW,GACzB,wJAAwJ,CAAC;IAE3J,MAAM,CAAU,QAAQ,GAAG;QACzB,+IAA+I;QAC/I,wHAAwH;QACxH,sKAAsK;QACtK,gFAAgF;KACjF,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC;YACpB,WAAW,EACT,uIAAuI;YACzI,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC;YACvB,WAAW,EACT,iKAAiK;YACnK,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,GAAG,WAAW,CAAC,cAAc;KAC9B,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAChD,6FAA6F;QAC7F,MAAM,MAAM,GAAG,EAAE,GAAG,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;QAChD,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS;YAAE,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACxE,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS;YAAE,MAAM,CAAC,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAEjF,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,MAA2B,CAAC,CAAC,CAAC;IACrF,CAAC;CACF"}

package/dist/commands/schema.js

@@ -0,0 +1,95 @@
+import { Flags, toConfiguredId } from "@oclif/core";
+import { BaseCommand } from "../lib/base-command.js";
+import { closestCommand, MeiliCliError } from "../lib/errors.js";
+/** The global flags, projected once: the index prints them, a command never repeats them. */
+const GLOBAL_FLAGS = Object.entries(BaseCommand.baseFlags).map(([name, flag]) => describeFlag(name, flag));
+export default class Schema extends BaseCommand {
+    static api = "none";
+    static description = "Print one line per command, or one command in full with --command, from the oclif manifest.";
+    static examples = [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --output json",
+        '<%= config.bin %> <%= command.id %> --command "get indexes"',
+        "<%= config.bin %> <%= command.id %> | jq '.commands[].id'",
+    ];
+    static flags = {
+        command: Flags.string({
+            description: "Print this command in full instead of the index: its API, its routes, its key actions, the flags it declares itself and its examples.",
+            helpValue: "<command>",
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(Schema);
+        const commands = this.config.commands.filter((command) => command.hidden !== true);
+        if (flags.command === undefined) {
+            await this.output({
+                name: this.config.bin,
+                version: this.config.version,
+                globalFlags: GLOBAL_FLAGS,
+                commands: commands
+                    .map((command) => ({
+                    id: toConfiguredId(command.id, this.config),
+                    // The first paragraph only: what follows is a warning the detail carries.
+                    description: (command.description ?? "").split("\n\n")[0],
+                    routes: omitEmpty(command.routes),
+                }))
+                    .sort((a, b) => a.id.localeCompare(b.id)),
+            });
+            return;
+        }
+        const found = commands.find((command) => toConfiguredId(command.id, this.config) === flags.command);
+        if (found === undefined) {
+            const closest = closestCommand(flags.command, commands.map((command) => toConfiguredId(command.id, this.config)));
+            throw new MeiliCliError("cli_usage", `\`${flags.command}\` is not a command of meili.`, {
+                hint: closest === undefined
+                    ? "Run `meili schema` to see every command."
+                    : `Did you mean \`meili schema --command "${closest}"\`?`,
+            });
+        }
+        await this.output(await this.describe(found));
+    }
+    /**
+     * One command in full. The manifest describes it, except for the flags: the
+     * class separates the flags the command declares itself from the global ones
+     * it inherits, which the index already prints. `JSON.stringify` drops the
+     * undefined fields.
+     */
+    async describe(command) {
+        const id = toConfiguredId(command.id, this.config);
+        // A command with no flags of its own does not set the static at all.
+        const own = (await command.load()).flags ?? {};
+        return {
+            id,
+            description: command.description ?? "",
+            api: command.api,
+            routes: omitEmpty(command.routes),
+            async: Object.keys(BaseCommand.waitFlags).every((name) => name in own) || undefined,
+            keyActions: omitEmpty(command.keyActions),
+            flags: Object.entries(own)
+                .filter(([, flag]) => flag.hidden !== true)
+                .map(([name, flag]) => describeFlag(name, flag)),
+            examples: (command.examples ?? []).map((example) => (typeof example === "string" ? example : example.command)
+                .replaceAll("<%= config.bin %>", this.config.bin)
+                .replaceAll("<%= command.id %>", id)),
+        };
+    }
+}
+/** An empty list is absent from the output rather than printed as `[]`. */
+function omitEmpty(list) {
+    return list.length === 0 ? undefined : list;
+}
+/** The fields of a flag an agent needs. Absent means false, empty or not applicable. */
+function describeFlag(name, flag) {
+    return {
+        name,
+        type: flag.type,
+        char: flag.char,
+        required: flag.required === true || undefined,
+        description: flag.description,
+        helpValue: flag.type === "option" ? flag.helpValue : undefined,
+        options: flag.type === "option" ? flag.options : undefined,
+        dependsOn: flag.dependsOn,
+        exclusive: flag.exclusive,
+    };
+}
+//# sourceMappingURL=schema.js.map

package/dist/commands/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../src/commands/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAClE,OAAO,EAAY,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AASjE,6FAA6F;AAC7F,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,CAC9E,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CACzB,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,WAAW;IAC7C,MAAM,CAAC,GAAG,GAAQ,MAAM,CAAC;IAEzB,MAAM,CAAU,WAAW,GACzB,6FAA6F,CAAC;IAEhG,MAAM,CAAU,QAAQ,GAAG;QACzB,qCAAqC;QACrC,mDAAmD;QACnD,6DAA6D;QAC7D,2DAA2D;KAC5D,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC;YACpB,WAAW,EACT,uIAAuI;YACzI,SAAS,EAAE,WAAW;SACvB,CAAC;KACH,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC3C,MAAM,QAAQ,GAAI,IAAI,CAAC,MAAM,CAAC,QAAuB,CAAC,MAAM,CAC1D,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,CACrC,CAAC;QAEF,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,IAAI,CAAC,MAAM,CAAC;gBAChB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG;gBACrB,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO;gBAC5B,WAAW,EAAE,YAAY;gBACzB,QAAQ,EAAE,QAAQ;qBACf,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;oBACjB,EAAE,EAAE,cAAc,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC;oBAC3C,0EAA0E;oBAC1E,WAAW,EAAE,CAAC,OAAO,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;oBACzD,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC;iBAClC,CAAC,CAAC;qBACF,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;aAC5C,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CACzB,CAAC,OAAO,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,KAAK,CAAC,OAAO,CACvE,CAAC;QACF,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,OAAO,GAAG,cAAc,CAC5B,KAAK,CAAC,OAAO,EACb,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CACnE,CAAC;YACF,MAAM,IAAI,aAAa,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,OAAO,+BAA+B,EAAE;gBACtF,IAAI,EACF,OAAO,KAAK,SAAS;oBACnB,CAAC,CAAC,0CAA0C;oBAC5C,CAAC,CAAC,0CAA0C,OAAO,MAAM;aAC9D,CAAC,CAAC;QACL,CAAC;QACD,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAChD,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,QAAQ,CAAC,OAAiB;QACtC,MAAM,EAAE,GAAG,cAAc,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACnD,qEAAqE;QACrE,MAAM,GAAG,GAAG,CAAC,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;QAC/C,OAAO;YACL,EAAE;YACF,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,EAAE;YACtC,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC;YACjC,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,SAAS;YACnF,UAAU,EAAE,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC;YACzC,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC;iBACvB,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC;iBAC1C,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAClD,QAAQ,EAAE,CAAC,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CACjD,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;iBACtD,UAAU,CAAC,mBAAmB,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;iBAChD,UAAU,CAAC,mBAAmB,EAAE,EAAE,CAAC,CACvC;SACF,CAAC;IACJ,CAAC;CACF;AAED,2EAA2E;AAC3E,SAAS,SAAS,CAAC,IAAuB;IACxC,OAAO,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC;AAC9C,CAAC;AAED,wFAAwF;AACxF,SAAS,YAAY,CAAC,IAAY,EAAE,IAAsB;IACxD,OAAO;QACL,IAAI;QACJ,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,QAAQ,EAAE,IAAI,CAAC,QAAQ,KAAK,IAAI,IAAI,SAAS;QAC7C,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,SAAS,EAAE,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;QAC9D,OAAO,EAAE,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;QAC1D,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,SAAS,EAAE,IAAI,CAAC,SAAS;KAC1B,CAAC;AACJ,CAAC"}

package/dist/commands/search.js

@@ -0,0 +1,164 @@
+import { Flags } from "@oclif/core";
+import { BaseCommand } from "../lib/base-command.js";
+import { readBodyWithFields } from "../lib/input.js";
+import { asJson, asNumber } from "../lib/values.js";
+export default class Search extends BaseCommand {
+    static api = "meilisearch";
+    static routes = ["POST /indexes/{index_uid}/search"];
+    static keyActions = ["search"];
+    static description = "Search the documents of an index, with --q and the search parameters of the route.";
+    static examples = [
+        "<%= config.bin %> <%= command.id %> --project prod --index movies --q nosferatu",
+        "<%= config.bin %> <%= command.id %> --project prod --index movies --q nosferatu --output json",
+        "<%= config.bin %> <%= command.id %> --project prod --index movies --q horror --filter 'rating > 4' --sort rating:desc --limit 5",
+        "<%= config.bin %> <%= command.id %> --project prod --index movies --facets genres --attributes-to-retrieve id,title",
+        '<%= config.bin %> <%= command.id %> --project prod --index movies --data \'{"q":"nosferatu","hybrid":{"embedder":"default","semanticRatio":0.5}}\'',
+    ];
+    static flags = {
+        ...BaseCommand.connectionFlags,
+        index: Flags.string({
+            required: true,
+            description: "The index to search in.",
+            helpValue: "<index>",
+        }),
+        q: Flags.string({
+            description: "The search terms. Omit it for a placeholder search, which returns everything.",
+            helpValue: "<query>",
+        }),
+        offset: Flags.integer({
+            description: "Number of documents to skip. Ignored when --page or --hits-per-page is given.",
+            helpValue: "<n>",
+        }),
+        limit: Flags.integer({
+            description: "Maximum number of documents to return, 20 by default. Ignored when --page or --hits-per-page is given.",
+            helpValue: "<n>",
+        }),
+        page: Flags.integer({
+            description: "Page to return, 1-indexed. The response then carries totalHits and totalPages instead of estimatedTotalHits.",
+            helpValue: "<n>",
+        }),
+        "hits-per-page": Flags.integer({
+            description: "Number of documents per page, used with --page. 0 counts without returning any.",
+            helpValue: "<n>",
+        }),
+        "attributes-to-retrieve": Flags.string({
+            description: "Document attributes to return, comma-separated. Defaults to the displayed ones.",
+            helpValue: "<fields>",
+        }),
+        "attributes-to-crop": Flags.string({
+            description: "Attributes to crop in _formatted, comma-separated, each optionally as `attribute:length`.",
+            helpValue: "<fields>",
+        }),
+        "crop-length": Flags.integer({
+            description: "Maximum number of words in a cropped value, 10 by default.",
+            helpValue: "<n>",
+        }),
+        "crop-marker": Flags.string({
+            description: "String marking where a cropped value was cut, `…` by default.",
+            helpValue: "<string>",
+        }),
+        "attributes-to-highlight": Flags.string({
+            description: "Attributes to highlight in _formatted, comma-separated.",
+            helpValue: "<fields>",
+        }),
+        "highlight-pre-tag": Flags.string({
+            description: "String inserted before each highlighted term, `<em>` by default.",
+            helpValue: "<string>",
+        }),
+        "highlight-post-tag": Flags.string({
+            description: "String inserted after each highlighted term, `</em>` by default.",
+            helpValue: "<string>",
+        }),
+        "show-matches-position": Flags.boolean({
+            description: "Add _matchesPosition to each hit, the byte offset of every matched term.",
+        }),
+        filter: Flags.string({
+            description: "Filter expression, for example `rating > 4`. Its array-of-arrays form goes through --data.",
+            helpValue: "<filter>",
+        }),
+        sort: Flags.string({
+            description: "Attributes to sort on, comma-separated, each as `attribute:asc` or `:desc`.",
+            helpValue: "<sort>",
+        }),
+        distinct: Flags.string({
+            description: "Return one document per value of this attribute, which must be filterable.",
+            helpValue: "<attribute>",
+        }),
+        facets: Flags.string({
+            description: "Attributes to count in facetDistribution, comma-separated. Patterns such as `*` are accepted.",
+            helpValue: "<facets>",
+        }),
+        "matching-strategy": Flags.option({
+            options: ["last", "all", "frequency"],
+            description: "How query terms are relaxed when there are not enough results.",
+        })(),
+        "attributes-to-search-on": Flags.string({
+            description: "Restrict the search to these searchable attributes, comma-separated.",
+            helpValue: "<fields>",
+        }),
+        "ranking-score-threshold": Flags.string({
+            description: "Drop the hits whose ranking score is below this value, between 0.0 and 1.0.",
+            helpValue: "<number>",
+        }),
+        locales: Flags.string({
+            description: "ISO-639 locales of the query, comma-separated, instead of auto-detection.",
+            helpValue: "<locales>",
+        }),
+        hybrid: Flags.string({
+            description: 'Hybrid search as JSON, for example `{"embedder":"default","semanticRatio":0.5}`.',
+            helpValue: "<json>",
+        }),
+        vector: Flags.string({
+            description: "Query vector for a user-provided embedder, comma-separated numbers.",
+            helpValue: "<numbers>",
+        }),
+        "retrieve-vectors": Flags.boolean({
+            description: "Add _vectors to each hit, the embeddings of the document.",
+        }),
+        "show-ranking-score": Flags.boolean({
+            description: "Add _rankingScore to each hit, between 0.0 and 1.0.",
+        }),
+        "show-ranking-score-details": Flags.boolean({
+            description: "Add _rankingScoreDetails to each hit, the score of every ranking rule.",
+        }),
+        "show-performance-details": Flags.boolean({
+            description: "Add performanceDetails to the response, a timing breakdown of the query.",
+        }),
+        ...BaseCommand.bodyInputFlags,
+    };
+    async run() {
+        const { flags } = await this.parse(Search);
+        const fromFlags = {
+            q: flags.q,
+            offset: flags.offset,
+            limit: flags.limit,
+            page: flags.page,
+            hitsPerPage: flags["hits-per-page"],
+            attributesToRetrieve: flags["attributes-to-retrieve"]?.split(","),
+            attributesToCrop: flags["attributes-to-crop"]?.split(","),
+            cropLength: flags["crop-length"],
+            cropMarker: flags["crop-marker"],
+            attributesToHighlight: flags["attributes-to-highlight"]?.split(","),
+            highlightPreTag: flags["highlight-pre-tag"],
+            highlightPostTag: flags["highlight-post-tag"],
+            showMatchesPosition: flags["show-matches-position"] ? true : undefined,
+            filter: flags.filter,
+            sort: flags.sort?.split(","),
+            distinct: flags.distinct,
+            facets: flags.facets?.split(","),
+            matchingStrategy: flags["matching-strategy"],
+            attributesToSearchOn: flags["attributes-to-search-on"]?.split(","),
+            rankingScoreThreshold: asNumber(flags["ranking-score-threshold"]),
+            locales: flags.locales?.split(","),
+            hybrid: asJson(flags.hybrid),
+            vector: flags.vector?.split(",").map(asNumber),
+            retrieveVectors: flags["retrieve-vectors"] ? true : undefined,
+            showRankingScore: flags["show-ranking-score"] ? true : undefined,
+            showRankingScoreDetails: flags["show-ranking-score-details"] ? true : undefined,
+            showPerformanceDetails: flags["show-performance-details"] ? true : undefined,
+        };
+        const params = readBodyWithFields(flags, fromFlags);
+        await this.output(await this.meilisearch.index(flags.index).search(undefined, params));
+    }
+}
+//# sourceMappingURL=search.js.map

package/dist/commands/search.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.js","sourceRoot":"","sources":["../../src/commands/search.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,OAAO,EAAY,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEpD,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,WAAW;IAC7C,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,kCAAkC,CAAC,CAAC;IAErD,MAAM,CAAC,UAAU,GAAG,CAAC,QAAQ,CAAC,CAAC;IAE/B,MAAM,CAAU,WAAW,GACzB,oFAAoF,CAAC;IAEvF,MAAM,CAAU,QAAQ,GAAG;QACzB,iFAAiF;QACjF,+FAA+F;QAC/F,iIAAiI;QACjI,qHAAqH;QACrH,oJAAoJ;KACrJ,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;YAClB,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,yBAAyB;YACtC,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC;YACd,WAAW,EAAE,+EAA+E;YAC5F,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC;YACpB,WAAW,EAAE,+EAA+E;YAC5F,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC;YACnB,WAAW,EACT,wGAAwG;YAC1G,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC;YAClB,WAAW,EACT,8GAA8G;YAChH,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,eAAe,EAAE,KAAK,CAAC,OAAO,CAAC;YAC7B,WAAW,EACT,iFAAiF;YACnF,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,wBAAwB,EAAE,KAAK,CAAC,MAAM,CAAC;YACrC,WAAW,EACT,iFAAiF;YACnF,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC;YACjC,WAAW,EACT,2FAA2F;YAC7F,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,aAAa,EAAE,KAAK,CAAC,OAAO,CAAC;YAC3B,WAAW,EAAE,4DAA4D;YACzE,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC;YAC1B,WAAW,EAAE,+DAA+D;YAC5E,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,yBAAyB,EAAE,KAAK,CAAC,MAAM,CAAC;YACtC,WAAW,EAAE,yDAAyD;YACtE,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,mBAAmB,EAAE,KAAK,CAAC,MAAM,CAAC;YAChC,WAAW,EAAE,kEAAkE;YAC/E,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC;YACjC,WAAW,EAAE,kEAAkE;YAC/E,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,uBAAuB,EAAE,KAAK,CAAC,OAAO,CAAC;YACrC,WAAW,EAAE,0EAA0E;SACxF,CAAC;QACF,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;YACnB,WAAW,EACT,4FAA4F;YAC9F,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC;YACjB,WAAW,EAAE,6EAA6E;YAC1F,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC;YACrB,WAAW,EAAE,4EAA4E;YACzF,SAAS,EAAE,aAAa;SACzB,CAAC;QACF,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;YACnB,WAAW,EACT,+FAA+F;YACjG,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,mBAAmB,EAAE,KAAK,CAAC,MAAM,CAAC;YAChC,OAAO,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,WAAW,CAAU;YAC9C,WAAW,EAAE,gEAAgE;SAC9E,CAAC,EAAE;QACJ,yBAAyB,EAAE,KAAK,CAAC,MAAM,CAAC;YACtC,WAAW,EAAE,sEAAsE;YACnF,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,yBAAyB,EAAE,KAAK,CAAC,MAAM,CAAC;YACtC,WAAW,EAAE,6EAA6E;YAC1F,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC;YACpB,WAAW,EAAE,2EAA2E;YACxF,SAAS,EAAE,WAAW;SACvB,CAAC;QACF,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;YACnB,WAAW,EACT,kFAAkF;YACpF,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;YACnB,WAAW,EAAE,qEAAqE;YAClF,SAAS,EAAE,WAAW;SACvB,CAAC;QACF,kBAAkB,EAAE,KAAK,CAAC,OAAO,CAAC;YAChC,WAAW,EAAE,2DAA2D;SACzE,CAAC;QACF,oBAAoB,EAAE,KAAK,CAAC,OAAO,CAAC;YAClC,WAAW,EAAE,qDAAqD;SACnE,CAAC;QACF,4BAA4B,EAAE,KAAK,CAAC,OAAO,CAAC;YAC1C,WAAW,EAAE,wEAAwE;SACtF,CAAC;QACF,0BAA0B,EAAE,KAAK,CAAC,OAAO,CAAC;YACxC,WAAW,EAAE,0EAA0E;SACxF,CAAC;QACF,GAAG,WAAW,CAAC,cAAc;KAC9B,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC3C,MAAM,SAAS,GAAiB;YAC9B,CAAC,EAAE,KAAK,CAAC,CAAC;YACV,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,WAAW,EAAE,KAAK,CAAC,eAAe,CAAC;YACnC,oBAAoB,EAAE,KAAK,CAAC,wBAAwB,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC;YACjE,gBAAgB,EAAE,KAAK,CAAC,oBAAoB,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC;YACzD,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC;YAChC,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC;YAChC,qBAAqB,EAAE,KAAK,CAAC,yBAAyB,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC;YACnE,eAAe,EAAE,KAAK,CAAC,mBAAmB,CAAC;YAC3C,gBAAgB,EAAE,KAAK,CAAC,oBAAoB,CAAC;YAC7C,mBAAmB,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;YACtE,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC;YAC5B,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC;YAChC,gBAAgB,EAAE,KAAK,CAAC,mBAAmB,CAAC;YAC5C,oBAAoB,EAAE,KAAK,CAAC,yBAAyB,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC;YAClE,qBAAqB,EAAE,QAAQ,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAuB;YACvF,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,GAAG,CAAC;YAClC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAA6B;YACxD,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAyB;YACtE,eAAe,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;YAC7D,gBAAgB,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;YAChE,uBAAuB,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;YAC/E,sBAAsB,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;SAC7E,CAAC;QAEF,MAAM,MAAM,GAAG,kBAAkB,CAAC,KAAK,EAAE,SAAS,CAAiB,CAAC;QAEpE,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;IACzF,CAAC;CACF"}

package/dist/commands/similar.js

@@ -0,0 +1,86 @@
+import { Flags } from "@oclif/core";
+import { BaseCommand } from "../lib/base-command.js";
+import { readBodyWithFields } from "../lib/input.js";
+import { asNumber } from "../lib/values.js";
+export default class Similar extends BaseCommand {
+    static api = "meilisearch";
+    static routes = ["POST /indexes/{index_uid}/similar"];
+    static keyActions = ["search"];
+    static description = "Find the documents an index holds that are closest to one of its documents, named by --id and compared with --embedder.";
+    static examples = [
+        "<%= config.bin %> <%= command.id %> --project prod --index movies --id 143 --embedder default",
+        "<%= config.bin %> <%= command.id %> --project prod --index movies --id 143 --embedder default --output json",
+        "<%= config.bin %> <%= command.id %> --project prod --index movies --id 143 --embedder default --filter 'genres = horror' --limit 5",
+        '<%= config.bin %> <%= command.id %> --project prod --index movies --data \'{"id":143,"embedder":"default","retrieveVectors":true}\'',
+    ];
+    static flags = {
+        ...BaseCommand.connectionFlags,
+        index: Flags.string({
+            required: true,
+            description: "The index to search in.",
+            helpValue: "<index>",
+        }),
+        id: Flags.string({
+            description: "The document to compare with, by its primary key value.",
+            helpValue: "<id>",
+        }),
+        embedder: Flags.string({
+            description: "The embedder the similarity is computed with, one of those the index settings configure.",
+            helpValue: "<embedder>",
+        }),
+        offset: Flags.integer({
+            description: "Number of documents to skip.",
+            helpValue: "<n>",
+        }),
+        limit: Flags.integer({
+            description: "Maximum number of documents to return, 20 by default.",
+            helpValue: "<n>",
+        }),
+        filter: Flags.string({
+            description: "Filter expression, for example `genres = horror`. Its array-of-arrays form goes through --data.",
+            helpValue: "<filter>",
+        }),
+        "attributes-to-retrieve": Flags.string({
+            description: "Document attributes to return, comma-separated. Defaults to the displayed ones.",
+            helpValue: "<fields>",
+        }),
+        "retrieve-vectors": Flags.boolean({
+            description: "Add _vectors to each hit, the embeddings of the document.",
+        }),
+        "show-ranking-score": Flags.boolean({
+            description: "Add _rankingScore to each hit, between 0.0 and 1.0.",
+        }),
+        "show-ranking-score-details": Flags.boolean({
+            description: "Add _rankingScoreDetails to each hit, the score of every ranking rule.",
+        }),
+        "show-performance-details": Flags.boolean({
+            description: "Add performanceDetails to the response, a timing breakdown of the query.",
+        }),
+        "ranking-score-threshold": Flags.string({
+            description: "Drop the hits whose ranking score is below this value, between 0.0 and 1.0.",
+            helpValue: "<number>",
+        }),
+        ...BaseCommand.bodyInputFlags,
+    };
+    async run() {
+        const { flags } = await this.parse(Similar);
+        // Not typed against SearchSimilarDocumentsParams, unlike the flag object of `search`:
+        // the SDK type has no retrieveVectors, which SimilarQuery of the document declares.
+        const fromFlags = {
+            id: flags.id,
+            embedder: flags.embedder,
+            offset: flags.offset,
+            limit: flags.limit,
+            filter: flags.filter,
+            attributesToRetrieve: flags["attributes-to-retrieve"]?.split(","),
+            retrieveVectors: flags["retrieve-vectors"] ? true : undefined,
+            showRankingScore: flags["show-ranking-score"] ? true : undefined,
+            showRankingScoreDetails: flags["show-ranking-score-details"] ? true : undefined,
+            showPerformanceDetails: flags["show-performance-details"] ? true : undefined,
+            rankingScoreThreshold: asNumber(flags["ranking-score-threshold"]),
+        };
+        const params = readBodyWithFields(flags, fromFlags);
+        await this.output(await this.meilisearch.index(flags.index).searchSimilarDocuments(params));
+    }
+}
+//# sourceMappingURL=similar.js.map

package/dist/commands/similar.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"similar.js","sourceRoot":"","sources":["../../src/commands/similar.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,OAAO,EAAY,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,WAAW;IAC9C,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,mCAAmC,CAAC,CAAC;IAEtD,MAAM,CAAC,UAAU,GAAG,CAAC,QAAQ,CAAC,CAAC;IAE/B,MAAM,CAAU,WAAW,GACzB,yHAAyH,CAAC;IAE5H,MAAM,CAAU,QAAQ,GAAG;QACzB,+FAA+F;QAC/F,6GAA6G;QAC7G,oIAAoI;QACpI,qIAAqI;KACtI,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;YAClB,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,yBAAyB;YACtC,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC;YACf,WAAW,EAAE,yDAAyD;YACtE,SAAS,EAAE,MAAM;SAClB,CAAC;QACF,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC;YACrB,WAAW,EACT,0FAA0F;YAC5F,SAAS,EAAE,YAAY;SACxB,CAAC;QACF,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC;YACpB,WAAW,EAAE,8BAA8B;YAC3C,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC;YACnB,WAAW,EAAE,uDAAuD;YACpE,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;YACnB,WAAW,EACT,iGAAiG;YACnG,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,wBAAwB,EAAE,KAAK,CAAC,MAAM,CAAC;YACrC,WAAW,EACT,iFAAiF;YACnF,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,kBAAkB,EAAE,KAAK,CAAC,OAAO,CAAC;YAChC,WAAW,EAAE,2DAA2D;SACzE,CAAC;QACF,oBAAoB,EAAE,KAAK,CAAC,OAAO,CAAC;YAClC,WAAW,EAAE,qDAAqD;SACnE,CAAC;QACF,4BAA4B,EAAE,KAAK,CAAC,OAAO,CAAC;YAC1C,WAAW,EAAE,wEAAwE;SACtF,CAAC;QACF,0BAA0B,EAAE,KAAK,CAAC,OAAO,CAAC;YACxC,WAAW,EAAE,0EAA0E;SACxF,CAAC;QACF,yBAAyB,EAAE,KAAK,CAAC,MAAM,CAAC;YACtC,WAAW,EAAE,6EAA6E;YAC1F,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,GAAG,WAAW,CAAC,cAAc;KAC9B,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC5C,sFAAsF;QACtF,oFAAoF;QACpF,MAAM,SAAS,GAAG;YAChB,EAAE,EAAE,KAAK,CAAC,EAAE;YACZ,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,oBAAoB,EAAE,KAAK,CAAC,wBAAwB,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC;YACjE,eAAe,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;YAC7D,gBAAgB,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;YAChE,uBAAuB,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;YAC/E,sBAAsB,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;YAC5E,qBAAqB,EAAE,QAAQ,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;SAClE,CAAC;QAEF,MAAM,MAAM,GAAG,kBAAkB,CAAC,KAAK,EAAE,SAAS,CAAiC,CAAC;QAEpF,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9F,CAAC;CACF"}