README.md

Sitecore Marketplace SDK - ai package

The ai package extends the Client SDK and provides type-safe interfaces for interacting with the following AI skills APIs:

• Brand Review REST API - using AI-powered analysis, evaluate whether input content and assets comply with the guidelines defined in a brand kit.

Prerequisites

• Node.js 16 or later. Check your installed version by using the node --version command.
• npm 10 or later. Check your installed version by using the npm --version command.
• A Stream subscription.

Installation

npm install @sitecore-marketplace-sdk/ai

Initialization

Before you use queries or mutations, you must initialize the AI module.

1. Update the code where you initialized the Client SDK by importing AI and adding it to config:

// utils/hooks/useMarketplaceClient.ts
import { AI } from '@sitecore-marketplace-sdk/ai';

// ...
const config = {
  // ...
  modules: [AI] // Extend Client SDK with `AI`
};

Usage

Make a mutation

Use the mutate method to trigger changes in Sitecore (the host). Pass a value to the method depending on the change you want to make.

For example, to generate a brand review using the AI skills API:

const generateBrandReview = async () => {
  await client?.mutate('ai.skills.generateBrandReview', {
    body: {
      brandkitId: 'your-brand-kit-id',
      input: { text: 'Content to review' },
    },
  });
};

For an overview of all the possible values, refer to the MutationMap interface.

Note

Behind the scenes, the Host SDK (integrated via the internal core package) attaches the required user token and performs the HTTP request on behalf of the Marketplace app (the client).

Documentation

For more information, refer to the reference documentation in the /docs folder.

License

This package is part of the Sitecore Marketplace SDK, licensed under the Apache 2.0 License. Refer to the LICENSE file in the repository root.

Status

The client package is actively maintained as part of the Sitecore Marketplace SDK.