Class ObservableAgentsActionClient

Index

Constructors

Methods

generate transform translate

Constructors

constructor

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

Methods

generate

generate<DocumentShape extends Record<string, any>>(
    request: GenerateInstruction<DocumentShape>,
): Observable<
    { [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 Observable<
    { [key: string]: any } & { _id: string } & { [key: string]: any } & {
        _type: string;
    } & DocumentShape,
>
- Defined in src/agent/actions/AgentActionsClient.ts:24

transform

transform<DocumentShape extends Record<string, any>>(
    request: TransformDocument<T>,
): Observable<
    { [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 Observable<
    { [key: string]: any } & { _id: string } & { [key: string]: any } & {
        _type: string;
    } & DocumentShape,
>
- Defined in src/agent/actions/AgentActionsClient.ts:38

translate

translate<DocumentShape extends Record<string, any>>(
    request: TranslateDocument<T>,
): Observable<
    { [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 Observable<
    { [key: string]: any } & { _id: string } & { [key: string]: any } & {
        _type: string;
    } & DocumentShape,
>
- Defined in src/agent/actions/AgentActionsClient.ts:52