@sanity/embeddings-index-ui 1.1.2 → 1.1.4

package/README.md

@@ -1,10 +1,11 @@
-# @sanity/embeddings-index-ui
+# Sanity Embeddings Index UI
 
-> This package contains plugins for **Sanity Studio v3**.
+> Using this feature requires Sanity to send data to OpenAI[.]com, and Pinecone[.]io for storing vector interpretations of documents.
 
-Sanity Studio plugins that interact with the `/embeddings-index` HTTP API.
+Sanity Studio v3 plugins that interact with the `/embeddings-index` HTTP API.
+
+The Embeddings Index API enables the creation, management, and search of named embeddings vector indexes.
 
-The embeddings index API allows the creation of named embeddings vector indexes.
 An embeddings index contains embeddings for all Sanity documents matching a configured [GROQ filter](https://www.sanity.io/docs/how-queries-work) in a dataset.
 A [GROQ projection](https://www.sanity.io/docs/query-cheat-sheet) is applied to matching documents before vectorization.
 
@@ -15,8 +16,6 @@ Creating an index can take time, depending on the number of existing documents a
 
 For a CLI alternative, check out the [Embeddings Index CLI](https://github.com/sanity-io/embeddings-index-cli) package.
 
-> Using this feature requires Sanity to send data to OpenAI.com, and Pinecone.io for storing vector interpretations of documents.
-
 ## Installation
 
 ```sh
@@ -28,19 +27,17 @@ npm install @sanity/embeddings-index-ui
 * [embeddingsIndexReferenceInput](#embeddings-index-reference-input): semantic search mode for reference inputs
 * [embeddingsIndexDashboard](#embeddings-index-dashboard): manage indexes in a Sanity Studio UI tool
 
-For more information about how to use the plugins, see the relevant sections below.
+For more information about using the plugins, see the relevant sections below.
 
-## Embeddings index reference input
+## Semantic reference search input
 
 <img width="619" alt="image" src="https://github.com/sanity-io/sanity/assets/835514/55d372fe-c5fe-40dd-882b-10c6e8794442">
 
-The `embeddingsIndexReferenceInput` plugin allows reference fields to opt in to embeddings index search.
-This enables users to search for references using natural language, and to retrieve documents based on semantic meaning,
-rather than exact word matches.
+The Embeddings Index UI ships with a Semantic reference search input component. This enables you to search for [references](https://www.sanity.io/docs/connected-content) using natural language and to retrieve documents based on semantic meaning rather than exact string matches.
 
 ### Usage
 
-Add `embeddingsIndexReferenceInput` as a plugin to `sanity.config.ts` (or `.js`):
+You can add the semantic reference search input by importing and adding `embeddingsIndexReferenceInput` as a plugin to `sanity.config.ts` (or `.js`):
 
 ```ts
 import {defineConfig} from 'sanity'
@@ -63,7 +60,7 @@ defineField({
   options: {
     embeddingsIndex: {
       indexName: 'my-index', // Name of the embeddings index
-      maxResults: 10, // Max. number of returned results per request. Default: 10
+      maxResults: 10, // Maximum number of returned results per request. Default: 10
       searchMode: 'embeddings' // Sets default search mode for the field. Enables toggling between 'embeddings' (semantic search) and 'default' (default search based on GROQ filter)
     }
   }
@@ -112,10 +109,10 @@ defineField({
 })
 ```
 
-## Embeddings index dashboard
+## Embeddings Index API dashboard for Sanity Studio
 
-A UI alternative to the [Embeddings ˆndex CLI](https://github.com/sanity-io/embeddings-index-cli) to
-manage embeddings indexes in a Studio dashboard.
+A UI alternative to the [Embeddings Index CLI](https://github.com/sanity-io/embeddings-index-cli) to
+manage embeddings indexes in a Studio dashboard. It also lets you test semantic search on the indexes.
 
 <img width="1227" alt="image" src="https://github.com/sanity-io/sanity/assets/835514/279b03b8-d2c0-4cc1-bbe6-9d335937f25a">
 
@@ -137,7 +134,7 @@ export default defineConfig({
 })
 ```
 
-This adds the Embeddings Index tool to the studio navigation bar, but only when the studio is running in developer mode (`localhost`).
+This adds the Embeddings Index API tool to the studio navigation bar, but only when the studio is running in developer mode (`localhost`).
 
 If you want to enable the tool based on user access roles:
 

package/dist/index.esm.js

@@ -1,4 +1,4 @@
-import { useClient, useSchema, DefaultPreview, useDocumentPreviewStore, SanityDefaultPreview, getPreviewValueWithFallback, getPreviewStateObservable, typed, unset, setIfMissing, set, definePlugin, isObjectInputProps } from 'sanity';
+import { useClient, useProjectId, useSchema, DefaultPreview, useDocumentPreviewStore, SanityDefaultPreview, getPreviewValueWithFallback, getPreviewStateObservable, typed, unset, setIfMissing, set, definePlugin, isObjectInputProps } from 'sanity';
 import { jsx, jsxs, Fragment } from 'react/jsx-runtime';
 import { Card, Text, Button, Box, Autocomplete, Flex, Spinner, Stack, Label, TextInput, TextArea, Dialog, Heading, MenuButton, Menu, MenuItem } from '@sanity/ui';
 import { ErrorOutlineIcon, EarthGlobeIcon, LinkIcon, AddIcon, EllipsisVerticalIcon, TrashIcon, UndoIcon } from '@sanity/icons';
@@ -38,17 +38,19 @@ function FeatureEnabledProvider(props) {
 function useIsFeatureEnabledContext() {
   return useContext(FeatureEnabledContext);
 }
-function FeatureDisabledNotice() {
+function FeatureDisabledNotice(props) {
+  var _a;
+  const projectId = useProjectId();
   return /* @__PURE__ */jsx(Card, {
     tone: "primary",
     border: true,
-    padding: 2,
+    padding: 4,
     children: /* @__PURE__ */jsxs(Text, {
       size: 1,
-      children: ["Embeddings index APIs are only available on the", " ", /* @__PURE__ */jsx("a", {
-        href: "https://sanity.io/pricing",
-        children: "Team tier and above"
-      }), ". Please upgrade to enable access."]
+      children: ["\u{1F48E} Unlock semantic search with Embeddings Index APIs \u2014 available on Team, Business, and Enterprise plans.", " ", /* @__PURE__ */jsx("a", {
+        href: "https://www.sanity.io/manage/project/".concat(projectId, "/plan").concat((_a = props.urlSuffix) != null ? _a : ""),
+        children: "Upgrade now \u2192"
+      })]
     })
   });
 }
@@ -2129,7 +2131,9 @@ function SemanticSearchReferenceInput(props) {
     children: [semantic && featureState == "loading" ? /* @__PURE__ */jsx(Box, {
       padding: 2,
       children: /* @__PURE__ */jsx(Spinner, {})
-    }) : null, semantic && featureState == "disabled" ? /* @__PURE__ */jsx(FeatureDisabledNotice, {}) : null, /* @__PURE__ */jsx(Box, {
+    }) : null, semantic && featureState == "disabled" ? /* @__PURE__ */jsx(FeatureDisabledNotice, {
+      urlSuffix: "?ref=embeddings-ref"
+    }) : null, /* @__PURE__ */jsx(Box, {
       flex: 1,
       style: {
         maxHeight: 36,
@@ -2737,10 +2741,15 @@ function IndexStatus(_ref4) {
 function EmbeddingsIndexTool() {
   const featureState = useIsFeatureEnabled();
   return /* @__PURE__ */jsx(Card, {
-    children: /* @__PURE__ */jsx(Flex, {
+    children: /* @__PURE__ */jsxs(Flex, {
       justify: "center",
       flex: 1,
-      children: /* @__PURE__ */jsxs(Card, {
+      children: [featureState == "disabled" ? /* @__PURE__ */jsx(Box, {
+        padding: 4,
+        children: /* @__PURE__ */jsx(FeatureDisabledNotice, {
+          urlSuffix: "?ref=embeddings-tab"
+        })
+      }) : null, /* @__PURE__ */jsxs(Card, {
         flex: 1,
         style: {
           maxWidth: 1200
@@ -2749,8 +2758,8 @@ function EmbeddingsIndexTool() {
         children: [featureState == "loading" ? /* @__PURE__ */jsx(Box, {
           padding: 2,
           children: /* @__PURE__ */jsx(Spinner, {})
-        }) : null, featureState == "disabled" ? /* @__PURE__ */jsx(FeatureDisabledNotice, {}) : null, featureState == "enabled" ? /* @__PURE__ */jsx(Indexes, {}) : null]
-      })
+        }) : null, featureState == "enabled" ? /* @__PURE__ */jsx(Indexes, {}) : null]
+      })]
     })
   });
 }