Class AgentActionsClient

Index

Constructors

Methods

generate patch prompt transform translate

Constructors

constructor

new AgentActionsClient(
client: SanityClient,
httpRequest: HttpRequest,
): AgentActionsClient
Parameters
- client: SanityClient
- httpRequest: HttpRequest
Returns AgentActionsClient
- Defined in src/agent/actions/AgentActionsClient.ts:67

Methods

generate

generate<DocumentShape extends Record<string, any>>(
    request: GenerateInstruction<DocumentShape>,
): Promise<
    { [key: string]: any } & { _id: string } & { [key: string]: any } & {
        _type: string;
    } & DocumentShape,
>
Run an instruction to generate content in a target document.
Type Parameters
- DocumentShape extends Record<string, any>
Parameters
- request: GenerateInstruction<DocumentShape>
  instruction request
Returns Promise<
    { [key: string]: any } & { _id: string } & { [key: string]: any } & {
        _type: string;
    } & DocumentShape,
>
- Defined in src/agent/actions/AgentActionsClient.ts:76

patch

patch<DocumentShape extends Record<string, any>>(
    request: PatchDocument<DocumentShape>,
): Promise<
    { [key: string]: any } & { _id: string } & { [key: string]: any } & {
        _type: string;
    } & DocumentShape,
>
Patch a document using a schema aware API. Does not use an LLM, but uses the schema to ensure paths and values matches the schema.
Type Parameters
- DocumentShape extends Record<string, any>
Parameters
- request: PatchDocument<DocumentShape>
  instruction request
Returns Promise<
    { [key: string]: any } & { _id: string } & { [key: string]: any } & {
        _type: string;
    } & DocumentShape,
>
- Defined in src/agent/actions/AgentActionsClient.ts:129

prompt

prompt<const DocumentShape extends Record<string, any>>(
request: PromptRequest<DocumentShape>,
): Promise<string>
Run a raw instruction and return the result either as text or json
Type Parameters
- const DocumentShape extends Record<string, any>
Parameters
- request: PromptRequest<DocumentShape>
  prompt request
Returns Promise<string>
- Defined in src/agent/actions/AgentActionsClient.ts:118

transform

transform<DocumentShape extends Record<string, any>>(
    request: TransformDocument<T>,
): Promise<
    { [key: string]: any } & { _id: string } & { [key: string]: any } & {
        _type: string;
    } & DocumentShape,
>
Transform a target document based on a source.
Type Parameters
- DocumentShape extends Record<string, any>
Parameters
- request: TransformDocument<T>
  translation request
Returns Promise<
    { [key: string]: any } & { _id: string } & { [key: string]: any } & {
        _type: string;
    } & DocumentShape,
>
- Defined in src/agent/actions/AgentActionsClient.ts:90

translate

translate<DocumentShape extends Record<string, any>>(
    request: TranslateDocument<T>,
): Promise<
    { [key: string]: any } & { _id: string } & { [key: string]: any } & {
        _type: string;
    } & DocumentShape,
>
Translate a target document based on a source.
Type Parameters
- DocumentShape extends Record<string, any>
Parameters
- request: TranslateDocument<T>
  translation request
Returns Promise<
    { [key: string]: any } & { _id: string } & { [key: string]: any } & {
        _type: string;
    } & DocumentShape,
>
- Defined in src/agent/actions/AgentActionsClient.ts:104