contentful-management
Version:
Client for Contentful's Content Management API
91 lines (90 loc) • 2.99 kB
TypeScript
import type { DefaultElements, MakeRequest, SysLink } from '../common-types';
import type { Document as RichTextDocument } from '@contentful/rich-text-types';
export declare enum InvocationStatus {
Scheduled = "SCHEDULED",
InProgress = "IN_PROGRESS",
Failed = "FAILED",
Completed = "COMPLETED",
Cancelled = "CANCELLED"
}
export declare enum InvocationResultType {
Text = "text"
}
export declare const AiActionOutputFormat: {
readonly RichText: "RichText";
readonly Markdown: "Markdown";
readonly PlainText: "PlainText";
};
export type AiActionOutputFormatType = (typeof AiActionOutputFormat)[keyof typeof AiActionOutputFormat];
export type AiActionInvocationMetadata = {
invocationResult?: {
modelProvider?: string;
modelId?: string;
wordCount?: number;
outputFormat?: AiActionOutputFormatType;
};
statusChangedDates?: {
status: InvocationStatus;
date: string;
}[];
};
export interface InvocationResult {
content: string | RichTextDocument;
type: InvocationResultType;
metadata: AiActionInvocationMetadata;
}
export type AiActionInvocationProps = {
sys: {
id: string;
type: 'AiActionInvocation';
space: SysLink;
environment: SysLink;
aiAction: SysLink;
status: InvocationStatus;
errorCode?: string;
};
result?: InvocationResult;
};
export type AiActionInvocationType = {
outputFormat: 'RichText' | 'Markdown' | 'PlainText';
variables?: Array<{
value: string;
id: string;
} | {
value: {
entityPath: string;
entityType: 'Entry' | 'Asset' | 'ResourceLink';
entityId: string;
};
id: string;
} | {
value: {
entityPaths: Array<string>;
entityType: 'Entry';
entityId: string;
};
id: string;
}>;
};
/**
* The AI Action Invocation entity.
* This entity is read-only and primarily used to inspect the result of an AI action invocation.
*/
export interface AiActionInvocation extends AiActionInvocationProps, DefaultElements<AiActionInvocationProps> {
}
/**
* Wraps raw AI Action Invocation data with SDK helper methods.
*
* @param makeRequest - Function to make API requests.
* @param data - Raw AI Action Invocation data.
* @returns The AI Action Invocation entity.
*/
export declare function wrapAiActionInvocation(makeRequest: MakeRequest, data: AiActionInvocationProps): AiActionInvocation;
/**
* Wraps a collection of raw AI Action Invocation data.
*
* @param makeRequest - Function to make API requests.
* @param data - Raw collection data.
* @returns A collection of AI Action Invocation entities.
*/
export declare const wrapAiActionInvocationCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<AiActionInvocationProps>) => import("../common-types").Collection<AiActionInvocation, AiActionInvocationProps>;