@sanity/client 6.28.3-instruct.0 → 6.28.3-instruct.1

package/dist/stega.d.cts

@@ -33,6 +33,18 @@ export declare interface ActionErrorItem {
   index: number
 }
 
+/** @public */
+declare class AiClient {
+  #private
+  constructor(client: SanityClient, httpRequest: HttpRequest)
+  instruct(request: InstructAsyncInstruction): Promise<{
+    _id: string
+  }>
+  instruct<DocumentShape extends Record<string, Any>>(
+    request: InstructSyncInstruction<DocumentShape>,
+  ): Promise<IdentifiedSanityDocumentStub & DocumentShape>
+}
+
 /** @internal */
 export declare type AllDocumentIdsMutationOptions = BaseMutationOptions & {
   returnFirst: false
@@ -110,117 +122,6 @@ export declare class AssetsClient {
   ): Promise<SanityAssetDocument | SanityImageAssetDocument>
 }
 
-/** @beta */
-export declare type AssistAsyncInstruction<T extends Record<string, Any> = Record<string, Any>> = (
-  | ExistingDocumentRequest
-  | CreateDocumentRequest<T>
-) &
-  AssistRequestBase &
-  Async
-
-/** @public */
-declare class AssistClient {
-  #private
-  constructor(client: SanityClient, httpRequest: HttpRequest)
-  instruct(request: AssistAsyncInstruction): Promise<{
-    _id: string
-  }>
-  instruct<DocumentShape extends Record<string, Any>>(
-    request: AssistSyncInstruction<DocumentShape>,
-  ): Promise<IdentifiedSanityDocumentStub & DocumentShape>
-}
-
-/** @beta */
-export declare type AssistInstruction<T extends Record<string, Any> = Record<string, Any>> =
-  | AssistSyncInstruction<T>
-  | AssistAsyncInstruction<T>
-
-declare interface AssistRequestBase {
-  /** schemaId as reported by sanity deploy / sanity schema store */
-  schemaId: string
-  /** string template using $variable – more on this below under "Dynamic instruction" */
-  instruction: string
-  /** param values for the string template, keys are the variable name, ie if the template has "$variable", one key must be "variable" */
-  instructionParams?: InstructionParams
-  /**
-   *  Optional document path output target for the instruction.
-   *  When provided, the instruction will apply to this path in the document and its children.
-   *
-   *  ## Examples
-   *  - `path: 'title'` will output to the title field in the document
-   * - `path: 'array[_key="xx"]'` will output to the item with `_key: 'xx'` in the array field
-   */
-  path?: string
-  /**
-   * Controls sub-paths in the document that can be output to.
-   *
-   * The string-paths are relative to the `path` param
-   *
-   * Note: these path strings are less strictly validated than the `path` param itself:
-   * if an relative-path does not exist or is invalid, it will be silently ignored.
-   *
-   * @see AssistRequestBase#conditionalPaths
-   * @see AssistRequestBase#outputTypes
-   */
-  relativeOutputPaths?:
-    | {
-        include: string[]
-      }
-    | {
-        exclude: string[]
-      }
-  /**
-   * Controls which types the instruction is allowed to output to.
-   *
-   * @see AssistRequestBase#relativeOutputPaths
-   * @see AssistRequestBase#conditionalPaths
-   */
-  outputTypes?:
-    | {
-        include: string[]
-      }
-    | {
-        exclude: string[]
-      }
-  /**
-   * When a type or field in the schema has a function set for `hidden` or `readOnly`, it is conditional.
-   *
-   * By default, AI Assist will not output to conditional `readOnly` and `hidden` fields,
-   * ie, they are considered to resolve to `readOnly: true` / `hidden: true`.
-   *
-   * `conditionalPaths` param allows setting the default conditional value for
-   * `hidden` and `readOnly` to false,
-   * or individually set `hidden` and `readOnly` state for individual document paths.
-   *
-   *
-   * Note: fields and types with explicit readOnly: true or hidden: true in the schema, are not available to AI Assist,
-   * and cannot be changed via conditionalPaths.
-   *
-   * conditionalPaths state only apply to fields and types that have conditional `hidden` or `readOnly` in their schema definition.
-   *
-   * @see AssistRequestBase#relativeOutputPaths
-   * @see AssistRequestBase#outputTypes
-   */
-  conditionalPaths?: {
-    defaultReadOnly?: boolean
-    defaultHidden?: boolean
-    paths?: {
-      /** path here is not a relative path: it must be the full document path, regardless of `path` param on the request itself */
-      path: string
-      readOnly: boolean
-      hidden: boolean
-    }[]
-  }
-}
-
-/** @beta */
-export declare type AssistSyncInstruction<T extends Record<string, Any> = Record<string, Any>> = (
-  | ExistingDocumentRequest
-  | CreateDocumentRequest<T>
-) &
-  AssistRequestBase &
-  Sync
-
 declare interface Async {
   /**
    * When async: true, requests responds with status 201 and {_id} as response body as soon as the request is validated.
@@ -578,12 +479,6 @@ export declare class ConnectionFailedError extends Error {
   readonly name = 'ConnectionFailedError'
 }
 
-/** @beta */
-export declare interface ConstantInstructionParam {
-  type: 'constant'
-  value: string
-}
-
 /** @public */
 export declare interface ContentSourceMap {
   mappings: ContentSourceMapMappings
@@ -1040,23 +935,6 @@ declare interface ExistingDocumentRequest {
   documentId: string
 }
 
-/**
- *
- * Includes a LLM-friendly version of the field value in the instruction
- * @beta
- * */
-export declare interface FieldInstructionParam {
-  type: 'field'
-  /**
-   * Examples: 'title', 'array[_key=="key"].field
-   */
-  path: string
-  /**
-   * If omitted, implicitly uses the documentId of the instruction target
-   */
-  documentId?: string
-}
-
 /** @public */
 export declare type FilterDefault = (props: {
   /**
@@ -1172,13 +1050,6 @@ export declare type FirstDocumentMutationOptions = BaseMutationOptions & {
   returnDocuments?: true
 }
 
-/** @beta */
-export declare interface GroqInstructionParam {
-  type: 'groq'
-  query: string
-  params?: Record<string, string>
-}
-
 /** @public */
 export declare type HttpRequest = {
   (options: RequestOptions, requester: Requester): ReturnType<Requester>
@@ -1250,15 +1121,143 @@ export declare type InsertPatch =
     }
 
 /** @beta */
-export declare type InstructionParam =
+export declare type InstructAsyncInstruction<T extends Record<string, Any> = Record<string, Any>> =
+  (ExistingDocumentRequest | CreateDocumentRequest<T>) & InstructRequestBase & Async
+
+/** @beta */
+export declare interface InstructConstantInstructionParam {
+  type: 'constant'
+  value: string
+}
+
+/**
+ *
+ * Includes a LLM-friendly version of the field value in the instruction
+ * @beta
+ * */
+export declare interface InstructFieldInstructionParam {
+  type: 'field'
+  /**
+   * Examples: 'title', 'array[_key=="key"].field'
+   */
+  path: string
+  /**
+   * If omitted, implicitly uses the documentId of the instruction target
+   */
+  documentId?: string
+}
+
+/**
+ * Includes a LLM-friendly version of GROQ query result in the instruction
+ * @beta
+ * */
+export declare interface InstructGroqInstructionParam {
+  type: 'groq'
+  query: string
+  params?: Record<string, string>
+}
+
+/** @beta */
+export declare type InstructInstruction<T extends Record<string, Any> = Record<string, Any>> =
+  | InstructSyncInstruction<T>
+  | InstructAsyncInstruction<T>
+
+/** @beta */
+export declare type InstructInstructionParam =
   | string
-  | ConstantInstructionParam
-  | FieldInstructionParam
+  | InstructConstantInstructionParam
+  | InstructFieldInstructionParam
   | DocumentInstructionParam
-  | GroqInstructionParam
+  | InstructGroqInstructionParam
+
+/** @beta */
+export declare type InstructInstructionParams = Record<string, InstructInstructionParam>
+
+declare interface InstructRequestBase {
+  /** schemaId as reported by sanity deploy / sanity schema store */
+  schemaId: string
+  /** string template using $variable – more on this below under "Dynamic instruction" */
+  instruction: string
+  /** param values for the string template, keys are the variable name, ie if the template has "$variable", one key must be "variable" */
+  instructionParams?: InstructInstructionParams
+  /**
+   *  Optional document path output target for the instruction.
+   *  When provided, the instruction will apply to this path in the document and its children.
+   *
+   *  ## Examples
+   *  - `path: 'title'` will output to the title field in the document
+   * - `path: 'array[_key="xx"]'` will output to the item with `_key: 'xx'` in the array field
+   */
+  path?: string
+  /**
+   * Controls sub-paths in the document that can be output to.
+   *
+   * The string-paths are relative to the `path` param
+   *
+   * Note: these path strings are less strictly validated than the `path` param itself:
+   * if an relative-path does not exist or is invalid, it will be silently ignored.
+   *
+   * @see InstructRequestBase#conditionalPaths
+   * @see InstructRequestBase#outputTypes
+   */
+  relativeOutputPaths?:
+    | {
+        include: string[]
+      }
+    | {
+        exclude: string[]
+      }
+  /**
+   * Controls which types the instruction is allowed to output to.
+   *
+   * @see InstructRequestBase#relativeOutputPaths
+   * @see InstructRequestBase#conditionalPaths
+   */
+  outputTypes?:
+    | {
+        include: string[]
+      }
+    | {
+        exclude: string[]
+      }
+  /**
+   * When a type or field in the schema has a function set for `hidden` or `readOnly`, it is conditional.
+   *
+   * By default, AI Instruct will not output to conditional `readOnly` and `hidden` fields,
+   * ie, they are considered to resolve to `readOnly: true` / `hidden: true`.
+   *
+   * `conditionalPaths` param allows setting the default conditional value for
+   * `hidden` and `readOnly` to false,
+   * or individually set `hidden` and `readOnly` state for individual document paths.
+   *
+   *
+   * Note: fields and types with explicit readOnly: true or hidden: true in the schema, are not available to AI Instruct,
+   * and cannot be changed via conditionalPaths.
+   *
+   * conditionalPaths state only apply to fields and types that have conditional `hidden` or `readOnly` in their schema definition.
+   *
+   * @see InstructRequestBase#relativeOutputPaths
+   * @see InstructRequestBase#outputTypes
+   */
+  conditionalPaths?: {
+    defaultReadOnly?: boolean
+    defaultHidden?: boolean
+    paths?: {
+      /** path here is not a relative path: it must be the full document path, regardless of `path` param on the request itself */
+      path: string
+      readOnly: boolean
+      hidden: boolean
+    }[]
+  }
+}
 
 /** @beta */
-export declare type InstructionParams = Record<string, InstructionParam>
+export declare type InstructSyncInstruction<T extends Record<string, Any> = Record<string, Any>> = (
+  | ExistingDocumentRequest
+  | CreateDocumentRequest<T>
+) &
+  InstructRequestBase &
+  Sync
 
 /**
  * Set up a listener that will be notified when mutations occur on documents matching the provided query/filter.
@@ -1627,6 +1626,18 @@ export declare type MutationSelectionQueryParams = {
   [key: string]: Any
 }
 
+/** @public */
+declare class ObservableAiClient {
+  #private
+  constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
+  instruct(request: InstructAsyncInstruction): Observable<{
+    _id: string
+  }>
+  instruct<DocumentShape extends Record<string, Any>>(
+    request: InstructSyncInstruction<DocumentShape>,
+  ): Observable<IdentifiedSanityDocumentStub & DocumentShape>
+}
+
 /** @internal */
 export declare class ObservableAssetsClient {
   #private
@@ -1681,18 +1692,6 @@ export declare class ObservableAssetsClient {
   >
 }
 
-/** @public */
-declare class ObservableAssistClient {
-  #private
-  constructor(client: ObservableSanityClient, httpRequest: HttpRequest)
-  instruct(request: AssistAsyncInstruction): Observable<{
-    _id: string
-  }>
-  instruct<DocumentShape extends Record<string, Any>>(
-    request: AssistSyncInstruction<DocumentShape>,
-  ): Observable<IdentifiedSanityDocumentStub & DocumentShape>
-}
-
 /** @internal */
 export declare class ObservableDatasetsClient {
   #private
@@ -1816,7 +1815,7 @@ export declare class ObservableSanityClient {
   live: LiveClient
   projects: ObservableProjectsClient
   users: ObservableUsersClient
-  assist: ObservableAssistClient
+  ai: ObservableAiClient
   /**
    * Instance properties
    */
@@ -2748,7 +2747,7 @@ export declare class SanityClient {
   live: LiveClient
   projects: ProjectsClient
   users: UsersClient
-  assist: AssistClient
+  ai: AiClient
   /**
    * Observable version of the Sanity client, with the same configuration as the promise-based one
    */