@genkit-ai/flow/lib/steps.d.ts

Genkit AI framework workflow APIs.

import { Action } from '@genkit-ai/core';
import * as z from 'zod';

/**
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * A flow steap that executes an action with provided input and memoizes the output.
 */
declare function runAction<I extends z.ZodTypeAny, O extends z.ZodTypeAny>(action: Action<I, O>, input: z.infer<I>): Promise<z.infer<O>>;
declare function run<T>(name: string, func: () => Promise<T>): Promise<T>;
declare function run<T>(name: string, input: any, func: () => Promise<T>): Promise<T>;
/**
 * A helper that takes an array of inputs and maps each input to a run step.
 */
declare function runMap<I, O>(stepName: string, input: I[], fn: (i: I) => Promise<O>): Promise<O[]>;

export { run, runAction, runMap };