@genkit-ai/anthropic/lib/utils.d.ts

Genkit AI framework plugin for Anthropic APIs.

import { CacheControlEphemeral } from '@anthropic-ai/sdk/resources/messages';

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

/**
 * Creates a cache control metadata object for prompt caching.
 * Returns `{ cache_control: ... }` so it can be spread into metadata.
 *
 * @param options - Cache control options. Type defaults to 'ephemeral'.
 * @returns Object with cache_control property to spread into part metadata.
 *
 * @example
 * ```ts
 * import { anthropic, cacheControl } from '@genkit-ai/anthropic';
 *
 * const response = await ai.generate({
 *   model: anthropic.model('claude-sonnet-4-5'),
 *   system: {
 *     text: longSystemPrompt,
 *     metadata: { ...cacheControl() }  // default ephemeral
 *   },
 *   messages: [{ role: 'user', content: [{ text: 'Hello' }] }]
 * });
 *
 * // Or with explicit TTL:
 * metadata: { ...cacheControl({ ttl: '1h' }) }
 * ```
 */
declare function cacheControl(options?: Partial<CacheControlEphemeral>): {
    cache_control: CacheControlEphemeral;
};
/**
 * Strips the 'anthropic/' namespace prefix if present.
 * Throws if the model name is missing.
 */
declare function checkModelName(name?: string): string;
declare function removeUndefinedProperties<T>(obj: T): T;
declare function isKnownKey<T extends object>(key: string | number | symbol, obj: T): key is keyof T;

export { cacheControl, checkModelName, isKnownKey, removeUndefinedProperties };