npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@markprompt/core

v0.41.0

Published

`@markprompt/core` is the core library for Markprompt, a conversational AI component for your website, trained on your data.

Downloads

74,415

Readme

Markprompt Core

@markprompt/core is the core library for Markprompt, a conversational AI component for your website, trained on your data.

It contains core functionality for Markprompt and allows you to build abstractions on top of it.

Installation

npm install @markprompt/core

In browsers with esm.sh:

<script type="module">
  import {
    submitChat,
    submitSearchQuery,
    submitFeedback,
  } from 'https://esm.sh/@markprompt/core';
</script>

Usage

import { submitChat } from '@markprompt/core/chat';

for await (const chunk of submitChat(
  [{ content: 'What is Markprompt?', role: 'user' }],
  'YOUR-PROJECT-KEY',
  {
    model: 'gpt-4o',
    systemPrompt: 'You are a helpful AI assistant'
  }
)) {
  console.debug(chunk);
}

API

submitChat(messages: ChatMessage[], projectKey: string, options?)

Submit a prompt to the Markprompt Completions API.

Arguments

  • messages (ChatMessage[]): Chat messages to submit to the model
  • projectKey (string): Project key for the project
  • options (SubmitChatOptions): Optional parameters

Options

All options are optional.

  • threadId (string): Thread ID
  • iDontKnowMessage (string): Message returned when the model does not have an answer
  • model (OpenAIModelId): The OpenAI model to use
  • systemPrompt (string): The prompt template
  • temperature (number): The model temperature
  • topP (number): The model top P
  • frequencyPenalty (number): The model frequency penalty
  • presencePenalty (number): The model present penalty
  • maxTokens (number): The max number of tokens to include in the response
  • sectionsMatchCount (number): The number of sections to include in the prompt context
  • sectionsMatchThreshold (number): The similarity threshold between the
  • signal (AbortSignal): AbortController signal
  • tools: (OpenAI.ChatCompletionTool[]): A list of tools the model may call
  • toolChoice: (OpenAI.ChatCompletionToolChoiceOption): Controls which (if any) function is called by the model

Returns

A promise that resolves when the response is fully handled.

submitSearchQuery(query, projectKey, options?)

Submit a search query to the Markprompt Search API.

Arguments

  • query (string): Search query
  • projectKey (string): Project key for the project
  • options (object): Optional parameters

Options

  • limit (number): Maximum amount of results to return
  • signal (AbortSignal): AbortController signal

Returns

A list of search results.

submitFeedback(feedback, projectKey, options?)

Submit feedback to the Markprompt Feedback API about a specific prompt.

Arguments

  • feedback (object): Feedback to submit
  • feedback.feedback (object): Feedback data
  • feedback.feedback.vote ("1" | "-1" | "escalated"): Vote
  • feedback.messageId (string): Message ID
  • projectKey (string): Project key for the project
  • options (object): Optional parameters
  • options.onFeedbackSubmitted (function): Callback function when feedback is submitted
  • options.signal (AbortSignal): AbortController signal

Returns

A promise that resolves when the feedback is submitted. Has no return value.

Documentation

The full documentation for the package can be found on the Markprompt docs.

Community

Authors

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

License

MIT © Markprompt