0.14.3 • Published 9 months ago

c64-web-support v0.14.3

Weekly downloads
-
License
MIT
Repository
-
Last release
9 months ago

@markprompt/web

A prebuilt version of the Markprompt dialog, based on @markprompt/react, built with Preact for bundle-size savings. Viable for use from vanilla JavaScript or any framework.

Installation

Install the package from NPM:

npm add @markprompt/web @markprompt/css

Usage

Include the CSS on your page, via a link tag or by importing it in your JavaScript:

<!-- load from a CDN: -->
<link rel="stylesheet" href="https://esm.sh/@markprompt/css@0.5.1?css" />
import '@markprompt/css';

Call the markprompt function with your project key:

import { markprompt } from '@markprompt/web';

const markpromptEl = document.querySelector('#markprompt');

markprompt('YOUR-PROJECT-KEY', markpromptEl, {
  references: {
    getHref: (reference) => reference.file.path.replace(/\.[^.]+$/, '');
    getLabel: (reference) => {
      return reference.meta?.leadHeading?.value || reference.file?.title;
    }
  },
});

where YOUR-PROJECT-KEY can be obtained in your project settings on Markprompt.com.

Options are optional and allow you to configure the texts and links used in the component to some extent. You will most likely want to pass references.getHref and reference.getLabel to transform your prompt references into links to your corresponding documentation, and search.getHref to transform search result paths into links to your documentation.

import {
  type SubmitPromptOptions,
  type SubmitSearchQueryOptions,
} from '@markprompt/core';

type MarkpromptOptions = {
  /**
   * Display format.
   * @default "dialog"
   **/
  display?: 'plain' | 'dialog';
  close?: {
    /**
     * `aria-label` for the close modal button
     * @default "Close Markprompt"
     **/
    label?: string;
  };
  description?: {
    /**
     * Visually hide the description
     * @default true
     **/
    hide?: boolean;
    /**
     * Description text
     **/
    text?: string;
  };
  prompt?: SubmitPromptOptions & {
    /**
     * Label for the prompt input
     * @default "Ask AI"
     **/
    label?: string;
    /**
     * Placeholder for the prompt input
     * @default "Ask AI…"
     **/
    placeholder?: string;
  };
  references?: {
    /** Callback to transform a reference into an href */
    getHref?: (reference: FileSectionReference) => string;
    /** Callback to transform a reference into a label */
    getLabel?: (reference: FileSectionReference) => string;
    /** Loading text, default: `Fetching relevant pages…` */
    loadingText?: string;
    /**
     * Heading above the references
     * @default "Answer generated from the following sources:"
     **/
    heading?: string;
  };
  /**
   * Enable and configure search functionality
   */
  search?: SubmitSearchQueryOptions & {
    /**
     * Enable search
     * @default false
     **/
    enabled?: boolean;
    /** Callback to transform a search result into an href */
    getHref?: (
      reference: SearchResult | AlgoliaDocSearchHit,
    ) => string | undefined;
    /** Callback to transform a search result into a heading */
    getHeading?: (
      reference: SearchResult | AlgoliaDocSearchHit,
      query: string,
    ) => string | undefined;
    /** Callback to transform a search result into a title */
    getTitle?: (
      reference: SearchResult | AlgoliaDocSearchHit,
      query: string,
    ) => string | undefined;
    /** Callback to transform a search result into a subtitle */
    getSubtitle?: (
      reference: SearchResult | AlgoliaDocSearchHit,
      query: string,
    ) => string | undefined;
  };
  trigger?: {
    /**
     * `aria-label` for the open button
     * @default "Open Markprompt"
     **/
    label?: string;
    /**
     * Placeholder text for non-floating element.
     * @default "Ask docs"
     **/
    placeholder?: string;
    /**
     * Should the trigger button be displayed as a floating button at the bottom right of the page?
     * Setting this to false will display a trigger button in the element passed
     * to the `markprompt` function.
     */
    floating?: boolean;
  };
  title?: {
    /**
     * Visually hide the title
     * @default true
     **/
    hide?: boolean;
    /**
     * Text for the title
     * @default "Ask AI"
     **/
    text?: string;
  };
};

Styles are easily overridable for customization via targeting classes. Additionally, see the styling section in our documentation for a full list of variables.

Usage via <script> tag

Besides initializing the Markprompt component yourselves from JavaScript, you can load the script from a CDN. You can attach the options for the Markprompt component to the window prior to loading our script:

<link rel="stylesheet" href="https://esm.sh/@markprompt/css@0.5.1?css" />
<script>
  window.markprompt = {
    projectKey: `YOUR-PROJECT-KEY`,
    container: `#markprompt`,
    options: {
      references: {
        getHref: (reference) => reference.file?.path?.replace(/\.[^.]+$/, ''),
        getLabel: (reference) => {
          return reference.meta?.leadHeading?.value || reference.file?.title;
        },
      },
    },
  };
</script>
<script
  async
  type="module"
  src="https://esm.sh/@markprompt/web@0.9.4/init"
></script>

API

markprompt(projectKey, container, options?)

Render a Markprompt dialog button.

Arguments

  • projectKey (string): Your Markprompt project key.
  • container (HTMLElement | string): The element or selector to render Markprompt into.
  • options (object): Options for customizing Markprompt.

Options

  • projectKey (string): The project key associated to your project. It can be obtained in the project settings on Markprompt.com under "Project key"
  • display (plain | dialog): The way to display the prompt (Default: dialog)
  • close (object): Options for the close modal button
  • close.label (string): aria-label for the close modal button (Default: Close Markprompt)
  • close.visible (boolean): Show the close button (Default: true)
  • description (object): Options for the description
  • description.hide (boolean): Visually hide the description (Default: true)
  • description.text (string): Description text
  • prompt (object): Options for the prompt
  • prompt.label (string): Label for the prompt input (Default: Ask AI)
  • prompt.tabLabel (string): Label for the tab bar (Default: Ask AI)
  • prompt.placeholder (string): Placeholder for the prompt input (Default: Ask AI…)
  • prompt.apiUrl (string): URL at which to fetch completions. (Default: https://api.markprompt.com/v1/completions)
  • prompt.iDontKnowMessage (string): Message returned when the model does not have an answer. (Default: Sorry, I am not sure how to answer that.)
  • prompt.model (string): The OpenAI model to use. (Default: gpt-3.5-turbo)
  • prompt.promptTemplate (string): The prompt template. (Default: You are a very enthusiastic company representative who loves to help people! Given the following sections from the documentation (preceded by a section id), answer the question using only that information, outputted in Markdown format. If you are unsure and the answer is not explicitly written in the documentation, say \"{{I_DONT_KNOW}}\".\n\nContext sections:\n---\n{{CONTEXT}}\n\nQuestion: \"{{PROMPT}}\"\n\nAnswer (including related code snippets if available):\n)
  • prompt.temperature (number): The model temperature. (Default: 0.1)
  • prompt.topP (number): The model top P. (Default: 1)
  • prompt.frequencyPenalty (number): The model frequency penalty. (Default: 0)
  • prompt.presencePenalty (number): The model presence penalty. (Default: 0)
  • prompt.maxTokens (number): The max number of tokens to include in the response. (Default: 500)
  • prompt.sectionsMatchCount (number): The number of sections to include in the prompt context. (Default: 10)
  • prompt.sectionsMatchThreshold (number): The similarity threshold between the input question and selected sections. (Default: 0.5)
  • prompt.signal (AbortSignal): AbortController signal
  • references (object): Options for the references
  • references.getHref (function): Callback to transform a reference into an href
  • references.getLabel (function): Callback to transform a reference into an label to show for the link
  • references.loadingText (string): Loading text (Default: Fetching relevant pages…)
  • references.heading (string): Heading for the references panel (Default: Answer generated from the following sources:)
  • search (object): Options for search
  • search.enabled (boolean): Whether or not to enable search. (Default: true)
  • search.getHref (function): Callback to transform a search result into an href
  • search.getHref (function): Callback to transform a search result into an href
  • search.getHeading (function): Callback to transform a search result into a heading
  • search.getTitle (function): Callback to transform a search result into a title
  • search.getSubtitle (function): Callback to transform a search result into a subtitle
  • search.label (string): Label for the search input, not shown but used for aria-label (Default: Search docs…)
  • search.tabLabel (string): Label for the tab bar (Default: Search)
  • search.placeholder (string): Placeholder for the search input (Default: Search docs…)
  • search.limit (number): Maximum amount of results to return. (Default: 5)
  • search.apiUrl (string): URL at which to fetch search results. (Default: https://api.markprompt.com/v1/search)
  • search.provider (object): A custom search provider configuration, such as Algolia
  • search.signal (AbortSignal): AbortController signal
  • trigger (object): Options for the trigger
  • trigger.customElement (boolean): Use a custom element as the trigger. Will disable rendering any trigger element. Use openMarkprompt() to trigger the Markprompt dialog. (Default: false)
  • trigger.label (string): aria-label for the open button (Default: Open Markprompt)
  • trigger.placeholder (string): Placeholder text for non-floating element (Default: Ask docs)
  • title (object): Options for the title
  • title.hide (boolean): Visually hide the title (Default: true)
  • title.text (string): Title text (Default: Ask AI)

When rendering the Markprompt component, it will render a search input-like button by default. You have two other options:

  • set trigger.floating = true to render a floating button
  • set trigger.customElement = true, then import { openMarkprompt } from '@markprompt/react' and call openMarkprompt() from your code. This gives you the flexibility to render your own trigger element and attach whatever event handlers you would like and/or open the Markprompt dialog programmatically.

Documentation

The full documentation for @markprompt/web can be found on the Markprompt docs.

Community

Authors

This library is created by the team behind Markprompt (@markprompt).

License

MIT © Markprompt

@c64chat/react
@everything-registry/sub-chunk-1282
0.14.3

9 months ago