@guard-sdk/vercel-ai API

This spec is generated from package entry exports and updates on every website build.

Need package context first? Visit @guard-sdk/vercel-ai package docs.

Exported Symbols

Kind Name Source
type VercelUsageLike entry
type VercelGenerateTextResultLike entry
type VercelStreamResultLike entry
type VercelGenerateTextParams entry
type VercelStreamTextParams entry
type VercelFunctionsLike entry
type VercelAIGuardConfig entry
function createVercelAIGuard entry

Export Declarations

export type VercelUsageLike = { promptTokens?: number;
export type VercelGenerateTextResultLike = { usage?: VercelUsageLike;
export type VercelStreamResultLike = { text?: PromiseLike<string>;
export type VercelGenerateTextParams = { model?: string;
export type VercelStreamTextParams = { model?: string;
export type VercelFunctionsLike<TGenerateTextParams extends VercelGenerateTextParams, TGenerateTextResult extends VercelGenerateTextResultLike, TStreamTextParams extends VercelStreamTextParams, TStreamResult extends VercelStreamResultLike> = { generateText: (params: TGenerateTextParams) => Promise<TGenerateTextResult>;
export type VercelAIGuardConfig = Omit<GuardConfig, "provider" | "model"> & { model?: string;
export declare function createVercelAIGuard<TGenerateTextParams extends VercelGenerateTextParams, TGenerateTextResult extends VercelGenerateTextResultLike, TStreamTextParams extends VercelStreamTextParams, TStreamResult extends VercelStreamResultLike>(functions: VercelFunctionsLike<TGenerateTextParams, TGenerateTextResult, TStreamTextParams, TStreamResult>, defaultConfig?: VercelAIGuardConfig): { generateText: (params: TGenerateTextParams, overrides?: VercelAIGuardConfig) => Promise<TGenerateTextResult>;

JSON Spec

{
  "package": "@guard-sdk/vercel-ai",
  "version": "0.5.0",
  "exports": [
    {
      "kind": "type",
      "name": "VercelUsageLike",
      "source": null
    },
    {
      "kind": "type",
      "name": "VercelGenerateTextResultLike",
      "source": null
    },
    {
      "kind": "type",
      "name": "VercelStreamResultLike",
      "source": null
    },
    {
      "kind": "type",
      "name": "VercelGenerateTextParams",
      "source": null
    },
    {
      "kind": "type",
      "name": "VercelStreamTextParams",
      "source": null
    },
    {
      "kind": "type",
      "name": "VercelFunctionsLike",
      "source": null
    },
    {
      "kind": "type",
      "name": "VercelAIGuardConfig",
      "source": null
    },
    {
      "kind": "function",
      "name": "createVercelAIGuard",
      "source": null
    }
  ]
}