@sanity/embeddings-index-ui 1.0.2 → 1.1.0

package/README.md

@@ -67,7 +67,7 @@ defineField({
 })
 ```
 
-Setting `options.embeddings.indexName` on a reference field will allow enabled searching into the named index.
+Setting `options.embedembeddingsIndexdings.indexName` on a reference field will allow enabled searching into the named index.
 
 This will add a "search mode" toggle button to the field.
 
@@ -78,6 +78,38 @@ that the types the reference field expects actually exist in the index
 *Caveats*:
 `options.filter` is not respected by the semantic search.
 
+### Default embeddings index config
+
+Default config for the reference inputs can be enabled using plugin configuration:
+
+```ts
+import {defineConfig} from 'sanity'
+import {embeddingsIndexReferenceInput} from '@sanity/embeddings-index-ui'
+
+export default defineConfig({
+  //...
+  plugins: [embeddingsIndexReferenceInput({
+    indexName: 'my-index', // inputs will use 'my-index' as indexName by default
+    maxResults: 15, // now 15 will be the default maxResult for inputs,
+    searchMode: 'embeddings' // now 'embeddings' will be the default searchMode for inputs
+  })],
+})
+```
+
+When the plugin has a default indexName set like this, the embeddings search can also
+be enabled using `options.embeddingsIndex: true` for a reference field:
+
+```ts
+defineField({
+  name: 'myField',
+  type: 'reference',
+  to: [{type: 'myType'}],
+  options: {
+    embeddingsIndex: true
+  }
+})
+```
+
 ## Embeddings index dashboard
 An UI alternative to the [Embeddings index CLI](https://github.com/sanity-io/embeddings-index-cli)
 Manage embeddings indexes in a Studio dashboard.

package/dist/index.d.ts

@@ -3,9 +3,23 @@ import {SanityClient} from 'sanity'
 
 export declare function deleteIndex(indexName: string, client: SanityClient): Promise<IndexState>
 
+declare interface EmbeddingsIndexConfig {
+  /**
+   * Name of the index
+   */
+  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
+   */
+  searchMode?: 'embeddings' | 'default'
+}
+
 export declare const embeddingsIndexDashboard: Plugin_2<void>
 
-export declare const embeddingsIndexReferenceInput: Plugin_2<void>
+export declare const embeddingsIndexReferenceInput: Plugin_2<void | EmbeddingsIndexConfig>
 
 export declare function getIndexes(client: SanityClient): Promise<IndexState[]>
 
@@ -50,18 +64,11 @@ export {}
 
 declare module 'sanity' {
   interface ReferenceBaseOptions {
-    embeddingsIndex?: {
-      /**
-       * Name of the index
-       */
-      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
-       */
-      searchMode?: 'embeddings' | 'default'
-    }
+    /**
+     * 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)
+     */
+    embeddingsIndex?: true | EmbeddingsIndexConfig
   }
 }