@automattic/jetpack-ai-client NPM

Jetpack AI Client

JavaScript client for consuming Jetpack AI services. This client provides functionalities to fetch images and request completions from the Jetpack AI API as well as managing authentication tokens for the Jetpack AI streaming completion API.

Installation

To install the Jetpack AI Client, clone the repository to your local machine and install the dependencies with npm:

npm install @automattic/jetpack-ai-client

Libraries & Components

Requesting

askQuestion helper

Async function that sends a question and optional configurations, retrieves a JWT token, and returns a SuggestionsEventSource instance.

SuggestionsEventSouce Class

Class that connects to an AI model to receive and emit suggestion streams, using EventTarget for handling data chunks.

useAiSuggestions hook

A custom React hook that obtains suggestions from an AI by hitting a specific query endpoint.

JWT helper

Library to manage JWT tokens for Jetpack AI across various site types, handling acquisition, caching in localStorage, expiration, and customization of request options.

Data Flow implementation

Data Flow offers a streamlined way to manage an AI Assistant's state and functionality within a React app, using React context, HOCs, and custom hooks to handle suggestions, errors, and requests.

Components

AIControl

AiStatusIndicator

Icons

Contribute

React components useful for when you need to create some UI implementations.

We welcome contributions from the community. Please submit your pull requests on the GitHub repository.

Get Help

If you encounter any issues or have any questions, please open an issue on the GitHub repository.

Using this package in your WordPress plugin

If you plan on using this package in your WordPress plugin, we would recommend that you use Jetpack Autoloader as your autoloader. This will allow for maximum interoperability with other plugins that use this package as well.