@sanity/client 7.15.0 → 7.16.0

package/src/datasets/DatasetsClient.ts

@@ -2,7 +2,15 @@ import {lastValueFrom, type Observable} from 'rxjs'
 
 import {_request} from '../data/dataMethods'
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'
-import type {DatasetAclMode, DatasetResponse, DatasetsResponse, HttpRequest} from '../types'
+import type {
+  DatasetCreateOptions,
+  DatasetEditOptions,
+  DatasetResponse,
+  DatasetsResponse,
+  EmbeddingsSettings,
+  EmbeddingsSettingsBody,
+  HttpRequest,
+} from '../types'
 import * as validate from '../validators'
 
 /** @internal */
@@ -18,9 +26,9 @@ export class ObservableDatasetsClient {
    * Create a new dataset with the given name
    *
    * @param name - Name of the dataset to create
-   * @param options - Options for the dataset
+   * @param options - Options for the dataset, including optional embeddings configuration
    */
-  create(name: string, options?: {aclMode?: DatasetAclMode}): Observable<DatasetResponse> {
+  create(name: string, options?: DatasetCreateOptions): Observable<DatasetResponse> {
     return _modify<DatasetResponse>(this.#client, this.#httpRequest, 'PUT', name, options)
   }
 
@@ -30,7 +38,7 @@ export class ObservableDatasetsClient {
    * @param name - Name of the dataset to edit
    * @param options - New options for the dataset
    */
-  edit(name: string, options?: {aclMode?: DatasetAclMode}): Observable<DatasetResponse> {
+  edit(name: string, options?: DatasetEditOptions): Observable<DatasetResponse> {
     return _modify<DatasetResponse>(this.#client, this.#httpRequest, 'PATCH', name, options)
   }
 
@@ -60,6 +68,37 @@ export class ObservableDatasetsClient {
       tag: null,
     })
   }
+
+  /**
+   * Get embeddings settings for a dataset
+   *
+   * @param name - Name of the dataset
+   */
+  getEmbeddingsSettings(name: string): Observable<EmbeddingsSettings> {
+    validate.resourceGuard('dataset', this.#client.config())
+    validate.dataset(name)
+    return _request<EmbeddingsSettings>(this.#client, this.#httpRequest, {
+      uri: _embeddingsSettingsUri(this.#client, name),
+      tag: null,
+    })
+  }
+
+  /**
+   * Edit embeddings settings for a dataset
+   *
+   * @param name - Name of the dataset
+   * @param settings - Embeddings settings to apply
+   */
+  editEmbeddingsSettings(name: string, settings: EmbeddingsSettingsBody): Observable<void> {
+    validate.resourceGuard('dataset', this.#client.config())
+    validate.dataset(name)
+    return _request<void>(this.#client, this.#httpRequest, {
+      method: 'PUT',
+      uri: _embeddingsSettingsUri(this.#client, name),
+      body: settings,
+      tag: null,
+    })
+  }
 }
 
 /** @internal */
@@ -75,9 +114,9 @@ export class DatasetsClient {
    * Create a new dataset with the given name
    *
    * @param name - Name of the dataset to create
-   * @param options - Options for the dataset
+   * @param options - Options for the dataset, including optional embeddings configuration
    */
-  create(name: string, options?: {aclMode?: DatasetAclMode}): Promise<DatasetResponse> {
+  create(name: string, options?: DatasetCreateOptions): Promise<DatasetResponse> {
     validate.resourceGuard('dataset', this.#client.config())
     return lastValueFrom(
       _modify<DatasetResponse>(this.#client, this.#httpRequest, 'PUT', name, options),
@@ -90,7 +129,7 @@ export class DatasetsClient {
    * @param name - Name of the dataset to edit
    * @param options - New options for the dataset
    */
-  edit(name: string, options?: {aclMode?: DatasetAclMode}): Promise<DatasetResponse> {
+  edit(name: string, options?: DatasetEditOptions): Promise<DatasetResponse> {
     validate.resourceGuard('dataset', this.#client.config())
     return lastValueFrom(
       _modify<DatasetResponse>(this.#client, this.#httpRequest, 'PATCH', name, options),
@@ -123,6 +162,52 @@ export class DatasetsClient {
       _request<DatasetsResponse>(this.#client, this.#httpRequest, {uri, tag: null}),
     )
   }
+
+  /**
+   * Get embeddings settings for a dataset
+   *
+   * @param name - Name of the dataset
+   */
+  getEmbeddingsSettings(name: string): Promise<EmbeddingsSettings> {
+    validate.resourceGuard('dataset', this.#client.config())
+    validate.dataset(name)
+    return lastValueFrom(
+      _request<EmbeddingsSettings>(this.#client, this.#httpRequest, {
+        uri: _embeddingsSettingsUri(this.#client, name),
+        tag: null,
+      }),
+    )
+  }
+
+  /**
+   * Edit embeddings settings for a dataset
+   *
+   * @param name - Name of the dataset
+   * @param settings - Embeddings settings to apply
+   */
+  editEmbeddingsSettings(name: string, settings: EmbeddingsSettingsBody): Promise<void> {
+    validate.resourceGuard('dataset', this.#client.config())
+    validate.dataset(name)
+    return lastValueFrom(
+      _request<void>(this.#client, this.#httpRequest, {
+        method: 'PUT',
+        uri: _embeddingsSettingsUri(this.#client, name),
+        body: settings,
+        tag: null,
+      }),
+    )
+  }
+}
+
+function _embeddingsSettingsUri(
+  client: SanityClient | ObservableSanityClient,
+  name: string,
+): string {
+  const config = client.config()
+  if (config.useProjectHostname === false) {
+    return `/projects/${config.projectId}/datasets/${name}/settings/embeddings`
+  }
+  return `/datasets/${name}/settings/embeddings`
 }
 
 function _modify<R = unknown>(
@@ -130,7 +215,7 @@ function _modify<R = unknown>(
   httpRequest: HttpRequest,
   method: 'DELETE' | 'PATCH' | 'PUT',
   name: string,
-  options?: {aclMode?: DatasetAclMode},
+  options?: DatasetCreateOptions | DatasetEditOptions,
 ) {
   validate.resourceGuard('dataset', client.config())
   validate.dataset(name)

package/src/types.ts

@@ -463,6 +463,33 @@ export type AuthProviderResponse = {providers: AuthProvider[]}
 /** @public */
 export type DatasetAclMode = 'public' | 'private' | 'custom'
 
+/** @public */
+export type DatasetCreateOptions = {
+  aclMode?: DatasetAclMode
+  embeddings?: {
+    enabled: boolean
+    projection?: string
+  }
+}
+
+/** @public */
+export type DatasetEditOptions = {
+  aclMode?: DatasetAclMode
+}
+
+/** @public */
+export type EmbeddingsSettings = {
+  enabled: boolean
+  projection?: string
+  status: string
+}
+
+/** @public */
+export type EmbeddingsSettingsBody = {
+  enabled: boolean
+  projection?: string
+}
+
 /** @public */
 export type DatasetResponse = {datasetName: string; aclMode: DatasetAclMode}
 /** @public */

package/umd/sanityClient.js

@@ -3495,7 +3495,7 @@ ${selectionOpts}`);
      * Create a new dataset with the given name
      *
      * @param name - Name of the dataset to create
-     * @param options - Options for the dataset
+     * @param options - Options for the dataset, including optional embeddings configuration
      */
     create(name, options) {
       return _modify(this.#client, this.#httpRequest, "PUT", name, options);
@@ -3529,6 +3529,31 @@ ${selectionOpts}`);
         tag: null
       });
     }
+    /**
+     * Get embeddings settings for a dataset
+     *
+     * @param name - Name of the dataset
+     */
+    getEmbeddingsSettings(name) {
+      return resourceGuard("dataset", this.#client.config()), dataset(name), _request(this.#client, this.#httpRequest, {
+        uri: _embeddingsSettingsUri(this.#client, name),
+        tag: null
+      });
+    }
+    /**
+     * Edit embeddings settings for a dataset
+     *
+     * @param name - Name of the dataset
+     * @param settings - Embeddings settings to apply
+     */
+    editEmbeddingsSettings(name, settings) {
+      return resourceGuard("dataset", this.#client.config()), dataset(name), _request(this.#client, this.#httpRequest, {
+        method: "PUT",
+        uri: _embeddingsSettingsUri(this.#client, name),
+        body: settings,
+        tag: null
+      });
+    }
   }
   class DatasetsClient {
     #client;
@@ -3540,7 +3565,7 @@ ${selectionOpts}`);
      * Create a new dataset with the given name
      *
      * @param name - Name of the dataset to create
-     * @param options - Options for the dataset
+     * @param options - Options for the dataset, including optional embeddings configuration
      */
     create(name, options) {
       return resourceGuard("dataset", this.#client.config()), lastValueFrom(
@@ -3577,6 +3602,39 @@ ${selectionOpts}`);
         _request(this.#client, this.#httpRequest, { uri, tag: null })
       );
     }
+    /**
+     * Get embeddings settings for a dataset
+     *
+     * @param name - Name of the dataset
+     */
+    getEmbeddingsSettings(name) {
+      return resourceGuard("dataset", this.#client.config()), dataset(name), lastValueFrom(
+        _request(this.#client, this.#httpRequest, {
+          uri: _embeddingsSettingsUri(this.#client, name),
+          tag: null
+        })
+      );
+    }
+    /**
+     * Edit embeddings settings for a dataset
+     *
+     * @param name - Name of the dataset
+     * @param settings - Embeddings settings to apply
+     */
+    editEmbeddingsSettings(name, settings) {
+      return resourceGuard("dataset", this.#client.config()), dataset(name), lastValueFrom(
+        _request(this.#client, this.#httpRequest, {
+          method: "PUT",
+          uri: _embeddingsSettingsUri(this.#client, name),
+          body: settings,
+          tag: null
+        })
+      );
+    }
+  }
+  function _embeddingsSettingsUri(client, name) {
+    const config = client.config();
+    return config.useProjectHostname === false ? `/projects/${config.projectId}/datasets/${name}/settings/embeddings` : `/datasets/${name}/settings/embeddings`;
   }
   function _modify(client, httpRequest, method, name, options) {
     return resourceGuard("dataset", client.config()), dataset(name), _request(client, httpRequest, {