# @focus-reactive/sanity-ai-sdk

Latest version **0.0.5** (published 2024-03-22) · 0 weekly downloads

## Install

```sh
npm install @focus-reactive/sanity-ai-sdk
pnpm add @focus-reactive/sanity-ai-sdk
yarn add @focus-reactive/sanity-ai-sdk
bun add @focus-reactive/sanity-ai-sdk
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2024-03-22 |
| First published | 2023-12-20 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 151.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | dogfrogfog, mcfrid, pixelscommander, operatino, usulpro, alex_hramovich |

## Links

- npm: https://www.npmjs.com/package/@focus-reactive/sanity-ai-sdk
- npm.io page: https://npm.io/package/@focus-reactive/sanity-ai-sdk

## Dependencies (4)

- [react](https://npm.io/package/react.md) ^18.2.0
- [react-dom](https://npm.io/package/react-dom.md) ^18.2.0
- [vite-plugin-dts](https://npm.io/package/vite-plugin-dts.md) ^3.6.3
- [@focus-reactive/content-ai-sdk](https://npm.io/package/@focus-reactive/content-ai-sdk.md) 0.0.3

## Recent versions

- 0.0.5 (latest) — 2024-03-22
- 0.0.4 — 2024-03-22
- 0.0.3 — 2023-12-20
- 0.0.2 — 2023-12-20
- 0.0.1 — 2023-12-20

## README

<a  href="https://focusreactive.com/"  align="center">
		<img width="25%" height="auto" src="https://cdn.sanity.io/images/vftxng62/production/25e191578a3c3d4ddfaf69c5f6f7070aead0bff4-507x168.png?auto=format"  alt="FocusReactive logo">
</a>

# Sanity AI SDK

### Install

```sh
yarn add @focus-reactive/sanity-ai-sdk
```

### How to use it

#### Initialisation

```typescript
// 1. Import the configration function
import { initSDK } from "@focus-reactive/content-ai-sdk";
import { SanityClient } from "sanity";

interface IConfig {
  client: SanityClient;
  openAiKey: string;
}

const config: IConfig = {
  client: new SanityClient(),
  openAiKey: YOUR_OPENAI_KEY,
};

// 2. Initialize the SDK with the OpenAI token
initSDK(config);
```

## Documentation

### Translations

We implemented several features that you can use in your projects to work with localisations.

#### Function **`transalateSelectedDocumentFields`**

**Parameters**

```typescript
interface TranslateSelectedDocumentFieldsProps {
  fieldNames: string[];
  documentId: string;
  targetLanguage: string;
  newDocumentConfig?: NewDocumentprops;
}

interface NewDocumentprops {
  titleFieldName: string;
  additionalFields?: Record<string, unknown>;
}
```

- `fieldNames` - Array of field names that should be translated. Should match the document schema. Can with any type of content (string, JSON, etc.)
- `documentId` - Id of the document that we need to process.
- `targetLanguage` - Language to which we need to translate the content.
- `newDocumentConfig` - Optional. If you want to create a new document with the translated content, you can pass the config here.
- `titleFieldName` - Field that should be used to create a new document title based on it's value.
- `additionalFields` - Optional. Additional fields that should be added to the new document.

**Usage**

```javascript
// 1. Import the function
import { transalateSelectedDocumentFields } from "@focus-reactive/sanity-ai-sdk";

// 2. Call the function
const translatedFileds = await transalateSelectedDocumentFields({
  fieldNames: ["movieTitle", "description", "actors"],
  targetLanguage: "german",
  documentId: DOCUMENT_ID,
});
```

### Categorisation

#### Function **`findRelevantTags`**

**Parameters**

```typescript
interface FindRelevantTagsProps {
  documentId: string;
  tags: Tag[];
  contentTitle: string;
}

interface Tag {
  id: string;
  title: string;
  description?: string;
}
```

- `documentId` - Id of the document that we need to process.
- `tags` - Array of tags that should be used to categorise the document.
- `contentTitle` - Title of the document that should be used to set a logical context.

**Usage**

```javascript
// 1. Import the function
import { findRelevantTags } from "@focus-reactive/sanity-ai-sdk";

// 2. Call the function
const result = await findRelevantTags({
  documentId: "documentId",
  contentTitle: "Batman movie",
  tags: [],
});
```

### Summarisation

#### Function **`summariseDocument`**

**Parameters**

```typescript
interface SummariseDocumentProps {
  documentId: string;
  contentTitle: string;
  promptModifier?: string;
}
```

- `documentId` - Id of the document that we need to process.
- `tags` - Array of tags that should be used to categorise the document.
- `promptModifier` - Optional. If you want to a modifier to the prompt, you can pass the modifier here.

**Usage**

```javascript
// 1. Import the function
import { summariseDocument } from "@focus-reactive/sanity-ai-sdk";

// 2. Call the function
const result = await summariseDocument({
  documentId: "documentId",
  contentTitle: "Batman movie",
});
```

---
_Source: https://npm.io/package/@focus-reactive/sanity-ai-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._