UNPKG

contentful-management

Version:
114 lines (113 loc) • 4.18 kB
import type { DefaultElements, Link, MakeRequest, MetaSysProps } from '../common-types'; import { type AiActionInvocationType, type AiActionInvocation } from './ai-action-invocation'; export type AiActionVariableType = 'ResourceLink' | 'Text' | 'StandardInput' | 'Locale' | 'MediaReference' | 'Reference' | 'SmartContext'; export type AiActionReferenceVariableConfiguration = { allowedEntities: Array<'Entry'>; }; export type LocaleVariableConfiguration = { localeType: 'Target' | 'Source'; }; export type AiActionVariableConfiguration = { strict: boolean; in: Array<string>; } | AiActionReferenceVariableConfiguration | LocaleVariableConfiguration; export type AiActionVariable = { configuration?: AiActionVariableConfiguration; description?: string; name?: string; type: AiActionVariableType; id: string; }; export declare const AiActionScope: { readonly Entry: "Entry"; readonly EntryField: "EntryField"; }; export type AiActionScopeType = (typeof AiActionScope)[keyof typeof AiActionScope]; export declare const AiActionOutputType: { readonly Transform: "Transform"; readonly Suggestion: "Suggestion"; }; export type AiActionOutputTypeValue = (typeof AiActionOutputType)[keyof typeof AiActionOutputType]; export type AiActionCondition = { id: string; variable: string; } & ({ operator: 'eq' | 'neq'; value: string; } | { operator: 'in' | 'nin'; value: string[]; }); export type AiActionInstruction = { variables: Array<AiActionVariable>; template: string; conditions?: Array<AiActionCondition>; }; export type AiActionConfiguration = { modelType: string; modelTemperature: number; scope?: AiActionScopeType; outputType?: AiActionOutputTypeValue; }; /** @deprecated Use `AiActionVariableType` instead. */ export type VariableType = AiActionVariableType; /** @deprecated Use `AiActionReferenceVariableConfiguration` instead. */ export type ReferenceVariableConfiguration = AiActionReferenceVariableConfiguration; /** @deprecated Use `AiActionVariableConfiguration` instead. */ export type VariableConfiguration = AiActionVariableConfiguration; /** @deprecated Use `AiActionVariable` instead. */ export type Variable = AiActionVariable; /** @deprecated Use `AiActionInstruction` instead. */ export type Instruction = AiActionInstruction; /** @deprecated Use `AiActionConfiguration` instead. */ export type Configuration = AiActionConfiguration; export type AiActionTestCase = { type?: 'Text'; value?: string; } | { type?: 'Reference'; value?: { entityPath?: string; entityType?: 'Entry'; entityId?: string; }; }; export interface AiActionQueryOptions { limit?: number; skip?: number; status?: 'all' | 'published'; } export type AiActionProps = { sys: MetaSysProps & { type: 'AiAction'; space: { sys: { id: string; }; }; publishedBy?: Link<'User'> | Link<'AppDefinition'>; updatedBy: Link<'User'> | Link<'AppDefinition'>; createdBy: Link<'User'> | Link<'AppDefinition'>; publishedVersion?: number; version: number; publishedAt?: string; updatedAt: string; createdAt: string; id: string; }; name: string; description: string; configuration: AiActionConfiguration; instruction: AiActionInstruction; testCases?: Array<AiActionTestCase>; }; export type CreateAiActionProps = Pick<Omit<AiActionProps, 'sys'>, 'name' | 'description' | 'configuration' | 'instruction' | 'testCases'>; export interface AiAction extends AiActionProps, DefaultElements<AiActionProps> { update(): Promise<AiAction>; delete(): Promise<void>; publish(): Promise<AiAction>; unpublish(): Promise<AiAction>; invoke(environmentId: string, payload: AiActionInvocationType): Promise<AiActionInvocation>; } export declare function wrapAiAction(makeRequest: MakeRequest, data: AiActionProps): AiAction; export declare const wrapAiActionCollection: (makeRequest: MakeRequest, data: import("..").CollectionProp<AiActionProps>) => import("..").Collection<AiAction, AiActionProps>;