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

@xrpl/ai-core

v0.19.0

Published

`@xrpl/ai-core` is the core library for XRPL AI, a conversational AI component for your website, trained on your data.

Downloads

4

Readme

@xrpl/ai-core

@xrpl/ai-core is the core library for XRPL AI, a conversational AI component for your website, trained on your data.

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

Installation

npm install @xrpl/ai-core

~~In browsers with esm.sh:~~

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

Usage

import { submitChat } from '@xrpl/ai-core';

// User input
const prompt = 'What is XRPL AI?';
// Can be obtained in your project settings on markprompt.com
const projectKey = 'YOUR-PROJECT-KEY';

// Called when a new answer chunk is available
// Should be concatenated to previous chunks
function onAnswerChunk(chunk) {
  // Process an answer chunk
}

// Called when references are available
function onReferences(references) {
  // Process references
}

function onConversationId(conversationId) {
  // Store conversationId for future use
}

function onPromptId(promptId) {
  // Store promptId for future use
}

// Called when submitChat encounters an error
function onError(error) {
  // Handle errors
}

// Optional parameters, defaults displayed
const options = {
  model: 'gpt-3.5-turbo', // Supports all OpenAI models
  iDontKnowMessage: 'Sorry, I am not sure how to answer that.',
  apiUrl: 'https://api.ai.xrpl.org/v1/completions', // Or your own completions API endpoint
};

await submitChat(
  [{ content: prompt, role: 'user' }],
  projectKey,
  onAnswerChunk,
  onReferences,
  onConversationId,
  onPromptId,
  onError,
  options,
);

API

submitChat(messages: ChatMessage[], projectKey: string, onAnswerChunk, onReferences, onConversationId, onPromptId, onError, options?)

Submit a prompt to the XRPL AI Completions API.

Arguments

  • messages (ChatMessage[]): Chat messages to submit to the model
  • projectKey (string): Project key for the project
  • onAnswerChunk (function(chunk: string)): Answers come in via streaming. This function is called when a new chunk arrives. Chunks should be concatenated to previous chunks of the same answer response.
  • onReferences (function(references: FileSectionReference[])): This function is called when receiving the list of references from which the response was created.
  • onConversationId (function(conversationId: string)): This function is called with the conversation ID returned by the API. Used to keep track of conversations.
  • onPromptId (function(promptId: string)): This function is called with the prompt ID returned by the API. Used to submit feedback.
  • onError (function): called when an error occurs
  • options (SubmitChatOptions): Optional parameters

Options

All options are optional.

  • apiUrl (string): URL at which to fetch completions
  • conversationId (string): Conversation 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 input question and selected sections
  • signal (AbortSignal): AbortController signal

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

  • apiUrl (string): URL at which to fetch search results
  • 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"): Vote
  • feedback.promptId (string): Prompt ID
  • projectKey (string): Project key for the project
  • options (object): Optional parameters
  • options.apiUrl (string): URL at which to post feedback
  • 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.

License

MIT © XRPL AI Devs