@sanity/embeddings-index-ui 3.0.1 → 4.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Sanity
+Copyright (c) 2026 Sanity
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,11 +1,20 @@
 # Sanity Embeddings Index UI
 
-> Using this feature requires Sanity to send data to OpenAI.com, and Pinecone.io for storing vector interpretations of documents.
+> ⚠️ **Deprecation Notice**
+>
+> The Embeddings Index API is deprecated and will be sunset in a future release. We recommend migrating to the new **Embeddings** feature, now natively available within Sanity datasets.
+>
+> The new Embeddings feature offers a more integrated experience with improved performance and full support going forward. **No new features or fixes will be made to this package.**
+>
+> If you have questions or need migration support, please [open an issue](https://github.com/sanity-io/plugins/issues) or reach out via [Sanity Community Discord](https://discord.com/servers/sanity-1304483263171264613).
+---
 
-Sanity Studio v3 plugins that interact with the `/embeddings-index` HTTP API.
+Sanity Studio plugins that interact with the `/embeddings-index` HTTP API.
 
 The Embeddings Index API enables the creation, management, and search of named embeddings vector indexes.
 
+> Using this feature requires Sanity to send data to OpenAI.com, and Pinecone.io for storing vector interpretations of documents.
+
 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.
 
@@ -22,10 +31,10 @@ For a CLI alternative, check out the [Embeddings Index CLI](https://github.com/s
 npm install @sanity/embeddings-index-ui
 ```
 
-`@sanity/embeddings-index-ui` contains the following Sanity Studio plugins: 
+`@sanity/embeddings-index-ui` contains the following Sanity Studio plugins:
 
-* [embeddingsIndexReferenceInput](#embeddings-index-reference-input): semantic search mode for reference inputs
-* [embeddingsIndexDashboard](#embeddings-index-dashboard): manage indexes in a Sanity Studio UI tool
+- [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 using the plugins, see the relevant sections below.
 
@@ -61,19 +70,19 @@ defineField({
     embeddingsIndex: {
       indexName: 'my-index', // Name of the embeddings index
       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)
-    }
-  }
+      searchMode: 'embeddings', // Sets default search mode for the field. Enables toggling between 'embeddings' (semantic search) and 'default' (default search based on GROQ filter)
+    },
+  },
 })
 ```
 
 Setting `options.embeddings.indexName` on a reference field enables searching into the named index.
 
-*Note*: the search uses `to` types as a filter for the index. Therefore, the types that the
+_Note_: the search uses `to` types as a filter for the index. Therefore, the types that the
 the reference field expects must exist in the index: the GROQ query specified in the embeddings index
 `filter` must include one or more documents that are relevant to the reference field.
 
-*Caveats*: the semantic search functionality does not honor `options.filter`.
+_Caveats_: the semantic search functionality does not honor `options.filter`.
 
 ### Default embeddings index configuration
 
@@ -87,11 +96,13 @@ import {embeddingsIndexReferenceInput} from '@sanity/embeddings-index-ui'
 
 export default defineConfig({
   //...
-  plugins: [embeddingsIndexReferenceInput({
-    indexName: 'my-index', // Inputs use 'my-index' as the default index
-    maxResults: 15, // Inputs return max. 15 results per request
-    searchMode: 'embeddings' // Semantic search is the default search mode
-  })],
+  plugins: [
+    embeddingsIndexReferenceInput({
+      indexName: 'my-index', // Inputs use 'my-index' as the default index
+      maxResults: 15, // Inputs return max. 15 results per request
+      searchMode: 'embeddings', // Semantic search is the default search mode
+    }),
+  ],
 })
 ```
 
@@ -104,8 +115,8 @@ defineField({
   type: 'reference',
   to: [{type: 'myType'}],
   options: {
-    embeddingsIndex: true
-  }
+    embeddingsIndex: true,
+  },
 })
 ```
 
@@ -126,10 +137,10 @@ import {embeddingsIndexDashboard} from '@sanity/embeddings-index-ui'
 
 export default defineConfig({
   //...
-  plugins: [    
+  plugins: [
     process.env.NODE_ENV === 'development'
-    ? embeddingsIndexDashboard()
-    : {name: 'embeddings-index-dashboard-disabled'}
+      ? embeddingsIndexDashboard()
+      : {name: 'embeddings-index-dashboard-disabled'},
   ],
 })
 ```
@@ -159,18 +170,3 @@ export default defineConfig({
 ## License
 
 [MIT](LICENSE) © Sanity
-
-## Develop and test
-
-This plugin uses [@sanity/plugin-kit](https://github.com/sanity-io/plugin-kit)
-with default configuration for build and watch scripts.
-
-See [Testing a plugin in Sanity Studio](https://github.com/sanity-io/plugin-kit#testing-a-plugin-in-sanity-studio)
-on how to run this plugin with hot reload in the studio.
-
-### Release new version
-
-Run ["CI & Release" workflow](https://github.com/sanity-io/embeddings-plugin/actions/workflows/main.yml).
-Make sure to select the main branch and check "Release new version".
-
-Semantic release will only release on configured branches, so it is safe to run release on any branch.

package/dist/index.d.ts

@@ -1,74 +1,63 @@
-import {Plugin as Plugin_2} from 'sanity'
-import {SanityClient} from 'sanity'
-
-export declare function deleteIndex(indexName: string, client: SanityClient): Promise<IndexState>
-
-declare interface EmbeddingsIndexConfig {
+import { SanityClient } from "sanity";
+interface EmbeddingsIndexConfig {
   /**
    * Name of the index
    */
-  indexName: string
-  maxResults?: number
+  indexName: string;
+  maxResults?: number;
   /**
-   * Determines if which search mode is enabled by default for the reference field.
-   * Default is the studio default search, while 'embeddings' enables
-   * Defaults to 'default' behaviour
+   * Determines which search mode is enabled by default for the reference field.
+   *
+   * - 'default': Studio's standard reference search
+   * - 'embeddings': Semantic search backed by the embeddings index
+   *
+   * Defaults to 'default'.
    */
-  searchMode?: 'embeddings' | 'default'
+  searchMode?: 'embeddings' | 'default';
 }
-
-export declare const embeddingsIndexDashboard: Plugin_2<void>
-
-export declare const embeddingsIndexReferenceInput: Plugin_2<void | EmbeddingsIndexConfig>
-
-export declare function getIndexes(client: SanityClient): Promise<IndexState[]>
-
-export declare interface IndexState extends NamedIndex {
-  status: string
-  startDocumentCount: number
-  remainingDocumentCount: number
-  failedDocumentCount: number
-}
-
-export declare interface NamedIndex {
-  indexName: string
-  dataset: string
-  project: string
-  projection: string
-  filter: string
-}
-
-export declare interface QueryConfig {
-  query: string
-  indexName: string
-  maxResults?: number
-  filter?: {
-    type?: string | string[]
-  }
-}
-
-export declare function queryIndex(
-  queryConfig: QueryConfig,
-  client: SanityClient,
-): Promise<QueryResult[]>
-
-export declare interface QueryResult {
-  score: number
-  value: {
-    documentId: string
-    type: string
-  }
-}
-
-export {}
-
 declare module 'sanity' {
   interface ReferenceBaseOptions {
     /**
      * Enables toggleable semantic search for a reference field.
      *
-     * When `true`: will use default plugin configuration (if no config has been for the plugin provided ,this will throw an error)
+     * When set to `true`, the plugin will use the default plugin configuration.
+     * If no default configuration is provided, an error will be thrown.
      */
-    embeddingsIndex?: true | EmbeddingsIndexConfig
+    embeddingsIndex?: true | EmbeddingsIndexConfig;
   }
+} //# sourceMappingURL=typeDefExtensions.d.ts.map
+declare const embeddingsIndexDashboard: import("sanity").Plugin<void>;
+declare const embeddingsIndexReferenceInput: import("sanity").Plugin<void | EmbeddingsIndexConfig>;
+interface NamedIndex {
+  indexName: string;
+  dataset: string;
+  project: string;
+  projection: string;
+  filter: string;
+}
+interface IndexState extends NamedIndex {
+  status: string;
+  startDocumentCount: number;
+  remainingDocumentCount: number;
+  failedDocumentCount: number;
+}
+interface QueryResult {
+  score: number;
+  value: {
+    documentId: string;
+    type: string;
+  };
+}
+interface QueryConfig {
+  query: string;
+  indexName: string;
+  maxResults?: number;
+  filter?: {
+    type?: string | string[];
+  };
 }
+declare function queryIndex(queryConfig: QueryConfig, client: SanityClient): Promise<QueryResult[]>;
+declare function getIndexes(client: SanityClient): Promise<IndexState[]>;
+declare function deleteIndex(indexName: string, client: SanityClient): Promise<IndexState>;
+export { IndexState, NamedIndex, QueryConfig, QueryResult, deleteIndex, embeddingsIndexDashboard, embeddingsIndexReferenceInput, getIndexes, queryIndex };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/schemas/typeDefExtensions.ts","../src/embeddingsIndexDashboard/dashboardPlugin.ts","../src/referenceInput/referencePlugin.tsx","../src/api/embeddingsApi.ts"],"mappings":";UAEiB,qBAAA;EAAA;;;EAIf,SAAA;EACA,UAAA;EAAA;;;AASU;AACX;;;;EADC,UAAA;AAAA;AAAA;EAAA,UAKU,oBAAA;IAOsC;AAAA;;AChBlD;;;IDgBI,eAAA,UAAyB,qBAAqB;EAAA;AAAA;AAAA,cChBrC,wBAAA,mBAAwB,MAAA;AAAA,cCLxB,6BAAA,mBAA6B,MAAA,QAAA,qBAAA;AAAA,UCLzB,UAAA;EACf,SAAA;EACA,OAAA;EACA,OAAA;EACA,UAAA;EACA,MAAA;AAAA;AAAA,UAGe,UAAA,SAAmB,UAAU;EAC5C,MAAA;EACA,kBAAA;EACA,sBAAA;EACA,mBAAA;AAAA;AAAA,UAGe,WAAA;EACf,KAAA;EACA,KAAA;IACE,UAAA;IACA,IAAA;EAAA;AAAA;AAAA,UAIa,WAAA;EACf,KAAA;EACA,SAAA;EACA,UAAA;EACA,MAAA;IACE,IAAA;EAAA;AAAA;AAAA,iBAIY,UAAA,CAAW,WAAA,EAAa,WAAA,EAAa,MAAA,EAAQ,YAAA,GAAe,OAAA,CAAQ,WAAA;AAAA,iBAiBpE,UAAA,CAAW,MAAA,EAAQ,YAAA,GAAe,OAAA,CAAQ,UAAA;AAAA,iBAS1C,WAAA,CAAY,SAAA,UAAmB,MAAA,EAAQ,YAAA,GAAe,OAAA,CAAQ,UAAA"}