Class DocsContextProvider

core/context/providers/DocsContextProvider.ts:15–184

import { INSTRUCTIONS_BASE_ITEM } from "./utils";

class DocsContextProvider extends BaseContextProvider {
  static nRetrieve = 30;
  static nFinal = 15;
  static description: ContextProviderDescription = {
    title: "docs",
    displayTitle: "Docs",
    description: "Type to search docs",
    type: "submenu",
    // Todo: consider a different renderInline so that when multiple docs are referenced in one message,
    // Or the doc has an odd name unrelated to the content
    // The name of the doc itself doesn't skew the embedding results
    renderInlineAs: "",
  };

  constructor(options: any) {
    super(options);
    const docsService = DocsService.getSingleton();
    docsService?.setGithubToken(this.options?.githubToken);
  }

  private async _rerankChunks(
    chunks: Chunk[],
    reranker: NonNullable<ContextProviderExtras["reranker"]>,
    fullInput: ContextProviderExtras["fullInput"],
    ide: IDE,
  ) {
    let chunksCopy = [...chunks];

    try {
      const scores = await reranker.rerank(fullInput, chunksCopy);

      if (Array.isArray(scores)) {
        // reranker model has returned a valid array
        chunksCopy.sort(
          (a, b) =>
            scores[chunksCopy.indexOf(b)] - scores[chunksCopy.indexOf(a)],
        );
      }

      chunksCopy = chunksCopy.splice(
        0,
        this.options?.nFinal ?? DocsContextProvider.nFinal,
      );
    } catch (e) {
      void ide.showToast("warning", `Failed to rerank retrieval results\n${e}`);

      chunksCopy = chunksCopy.splice(
        0,
        this.options?.nFinal ?? DocsContextProvider.nFinal,
      );
    }

    return chunksCopy;
  }

  private _sortAlphabetically(
    submenuItems: ContextSubmenuItem[],
  ): ContextSubmenuItem[] {