@genkit-ai/dotprompt/lib/index.d.mts

Genkit AI framework `.prompt` file format and management library.

import { Registry } from '@genkit-ai/core/registry';
import { Dotprompt, DotpromptRef } from './prompt.mjs';
export { PromptGenerateOptions, defineDotprompt } from './prompt.mjs';
export { loadPromptFolder } from './registry.mjs';
export { PromptMetadata } from './metadata.mjs';
export { defineHelper, definePartial } from './template.mjs';
import '@genkit-ai/ai';
import '@genkit-ai/ai/model';
import '@genkit-ai/ai/retriever';
import '@genkit-ai/core';
import '@genkit-ai/ai/tool';
import '@genkit-ai/core/schema';
import 'handlebars';

/**
 * 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.
 */

interface DotpromptPluginOptions {
    dir: string;
}
declare function prompt<Variables = unknown>(registry: Registry, name: string, options?: {
    variant?: string;
    dir?: string;
}): Promise<Dotprompt<Variables>>;
declare function promptRef<Variables = unknown>(name: string, options?: {
    variant?: string;
    dir?: string;
}): DotpromptRef<Variables>;
declare function loadPromptFile(registry: Registry, path: string): Dotprompt;
declare function loadPromptUrl(registry: Registry, name: string, url: string): Promise<Dotprompt>;

export { Dotprompt, type DotpromptPluginOptions, loadPromptFile, loadPromptUrl, prompt, promptRef };