@genesislcap/foundation-ai 14.408.0 → 14.409.0

package/docs/api/foundation-ai.serveraiconfig.md

@@ -1,66 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ServerAIConfig](./foundation-ai.serveraiconfig.md)
-
-## ServerAIConfig interface
-
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-Server-proxy AI configuration (client calls your server; server calls the provider).
-
-**Signature:**
-
-```typescript
-export interface ServerAIConfig extends AIProviderConfig 
-```
-**Extends:** AIProviderConfig
-
-## Remarks
-
-API key stays on the server. URL is derived from API\_HOST at /ai-service/chat-completions. Use provider to select backend (openai, anthropic, etc.).
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[provider](./foundation-ai.serveraiconfig.provider.md)
-
-
-</td><td>
-
-
-</td><td>
-
-ServerAIProviderType
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-ai.serveraiconfig.provider.md

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ServerAIConfig](./foundation-ai.serveraiconfig.md) &gt; [provider](./foundation-ai.serveraiconfig.provider.md)
-
-## ServerAIConfig.provider property
-
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-**Signature:**
-
-```typescript
-provider: ServerAIProviderType;
-```

package/docs/api/foundation-ai.startspeechrecognition.md

@@ -1,71 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [startSpeechRecognition](./foundation-ai.startspeechrecognition.md)
-
-## startSpeechRecognition() function
-
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-Starts continuous speech recognition, calling `onResult` with each transcript update. Returns a stop function, or null if speech recognition is unavailable.
-
-**Signature:**
-
-```typescript
-export declare function startSpeechRecognition(onResult: SpeechRecognitionResultHandler, onError?: SpeechRecognitionErrorHandler): (() => void) | null;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-onResult
-
-
-</td><td>
-
-SpeechRecognitionResultHandler
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-onError
-
-
-</td><td>
-
-SpeechRecognitionErrorHandler
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-(() =&gt; void) \| null
-

package/docs/api/index.md

@@ -1,30 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md)
-
-## API Reference
-
-## Packages
-
-<table><thead><tr><th>
-
-Package
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[@genesislcap/foundation-ai](./foundation-ai.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api-report.md.api.md

@@ -1,317 +0,0 @@
-## API Report File for "@genesislcap/foundation-ai"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-import { InterfaceSymbol } from '@microsoft/fast-foundation';
-
-// @public
-export const AI_FEATURE_FLAG = "ai";
-
-// @beta
-export type AIConfig = ServerAIConfig | ChromeAIConfig | GeminiAIConfig;
-
-// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "AIProvider" because one of its declarations is marked as @internal
-//
-// @beta
-export interface AIProvider {
-    chat?(history: ChatMessage[], userMessage: string, options?: ChatRequestOptions): Promise<ChatMessage>;
-    getStatus?(): Promise<AIStatus | null>;
-    // (undocumented)
-    interpretCriteria?(input: string, context: CriteriaInterpretContext): Promise<CriteriaInterpretationResult | null>;
-    streamChat?(history: ChatMessage[], userMessage: string, options?: ChatRequestOptions): AsyncIterable<ChatStreamChunk>;
-    triggerDownload?(): Promise<void>;
-}
-
-// @internal
-export const AIProvider: InterfaceSymbol<AIProvider>;
-
-// @beta
-export type AIProviderType = 'openai' | 'chrome' | 'gemini' | 'none';
-
-// @beta
-export interface AIStatus {
-    // (undocumented)
-    chromeAvailability?: ChromeAvailability;
-    // (undocumented)
-    model: string;
-    // (undocumented)
-    provider: AIProviderType;
-}
-
-// @beta
-export interface ChatAnimationsConfig {
-    enabled?: string[];
-    userConfigurable: boolean;
-}
-
-// @beta
-export interface ChatAttachment {
-    // (undocumented)
-    content: string;
-    // (undocumented)
-    mimeType: string;
-    // (undocumented)
-    name: string;
-}
-
-// @beta
-export interface ChatConfig {
-    acceptedFiles?: string;
-    allowDebugDownload?: boolean;
-    animations?: ChatAnimationsConfig;
-    loadingDelay?: number;
-    maxToolIterations?: number;
-    showThinkingSteps?: boolean | null;
-    showToolCalls?: boolean | null;
-}
-
-// @beta
-export interface ChatInteraction {
-    // (undocumented)
-    componentName: string;
-    // (undocumented)
-    data: any;
-    // (undocumented)
-    interactionId: string;
-    resolved?: boolean;
-}
-
-// @beta
-export interface ChatMessage {
-    // (undocumented)
-    attachments?: ChatAttachment[];
-    // (undocumented)
-    content: string;
-    // (undocumented)
-    interaction?: ChatInteraction;
-    // (undocumented)
-    role: ChatRole;
-    // (undocumented)
-    thinking?: boolean;
-    // (undocumented)
-    toolCalls?: ChatToolCall[];
-    // (undocumented)
-    toolResult?: ChatToolResult;
-}
-
-// @beta
-export interface ChatRequestOptions {
-    // (undocumented)
-    attachments?: ChatAttachment[];
-    // (undocumented)
-    signal?: AbortSignal;
-    // (undocumented)
-    systemPrompt?: string;
-    // (undocumented)
-    tools?: ChatToolDefinition[];
-}
-
-// @beta
-export type ChatRole = 'user' | 'assistant' | 'system' | 'tool';
-
-// @beta
-export interface ChatStreamChunk {
-    // (undocumented)
-    delta: string;
-    // (undocumented)
-    done: boolean;
-    // (undocumented)
-    toolCalls?: ChatToolCall[];
-}
-
-// @beta
-export interface ChatToolCall {
-    // (undocumented)
-    args: Record<string, unknown>;
-    // (undocumented)
-    id: string;
-    // (undocumented)
-    name: string;
-}
-
-// @beta
-export interface ChatToolDefinition {
-    // (undocumented)
-    description: string;
-    // (undocumented)
-    name: string;
-    // (undocumented)
-    parameters: Record<string, unknown>;
-}
-
-// @beta
-export type ChatToolHandlers = Record<string, (args: Record<string, unknown>, context: {
-    requestInteraction: <T = unknown>(componentName: string, data: any) => Promise<T>;
-}) => Promise<unknown>>;
-
-// @beta
-export interface ChatToolResult {
-    // (undocumented)
-    content: string;
-    // (undocumented)
-    toolCallId: string;
-}
-
-// @beta
-export interface ChatTransport {
-    // (undocumented)
-    sendChatMessage(history: ChatMessage[], userMessage: string, options?: ChatRequestOptions): Promise<ChatMessage>;
-    // (undocumented)
-    streamChatMessage?(history: ChatMessage[], userMessage: string, options?: ChatRequestOptions): AsyncIterable<ChatStreamChunk>;
-}
-
-// Warning: (ae-forgotten-export) The symbol "AIProviderConfig" needs to be exported by the entry point index.d.ts
-//
-// @beta
-export interface ChromeAIConfig extends AIProviderConfig {
-    // (undocumented)
-    providerType?: 'chrome';
-    // (undocumented)
-    temperature?: number;
-    // (undocumented)
-    topK?: number;
-}
-
-// @beta
-export type ChromeAvailability = 'available' | 'downloading' | 'downloadable' | 'unavailable';
-
-// @beta
-export function createAIProvider(config?: AIConfig | null): AIProvider;
-
-// @beta
-export interface CriteriaClauseResult {
-    // (undocumented)
-    field: string;
-    // (undocumented)
-    operator: string;
-    // (undocumented)
-    value: string | number | boolean | null;
-}
-
-// @beta
-export interface CriteriaGroupResult {
-    // (undocumented)
-    clauses: CriteriaClauseResult[];
-    // (undocumented)
-    logic: 'and' | 'or';
-    // (undocumented)
-    negated?: boolean;
-}
-
-// @beta
-export interface CriteriaInterpretationResult {
-    // (undocumented)
-    groups: CriteriaGroupResult[];
-}
-
-// @beta
-export interface CriteriaInterpretContext {
-    // (undocumented)
-    fields?: FieldLike[];
-}
-
-// @beta
-export type FieldLike = string | {
-    name?: string;
-    field?: string;
-    label?: string;
-    NAME?: string;
-};
-
-// @beta
-export interface GeminiAIConfig extends AIProviderConfig {
-    // (undocumented)
-    apiKey?: string;
-    // (undocumented)
-    model?: string;
-    // (undocumented)
-    providerType: 'gemini';
-    // (undocumented)
-    serverEndpoint?: string;
-}
-
-// @beta
-export class GeminiProvider implements AIProvider {
-    // Warning: (ae-forgotten-export) The symbol "GeminiProviderConfig" needs to be exported by the entry point index.d.ts
-    constructor(config: GeminiProviderConfig, transport: GeminiTransport);
-    // (undocumented)
-    chat(history: ChatMessage[], userMessage: string, options?: ChatRequestOptions): Promise<ChatMessage>;
-    // (undocumented)
-    getStatus(): Promise<AIStatus>;
-    // (undocumented)
-    interpretCriteria(input: string, context: CriteriaInterpretContext): Promise<CriteriaInterpretationResult | null>;
-    // (undocumented)
-    streamChat(history: ChatMessage[], userMessage: string, options?: ChatRequestOptions): AsyncIterable<ChatStreamChunk>;
-}
-
-// Warning: (ae-forgotten-export) The symbol "AITransport" needs to be exported by the entry point index.d.ts
-//
-// @beta
-export class GeminiTransport implements AITransport, ChatTransport {
-    // Warning: (ae-forgotten-export) The symbol "GeminiTransportConfig" needs to be exported by the entry point index.d.ts
-    constructor(config?: GeminiTransportConfig);
-    // (undocumented)
-    getConfig(): {
-        provider: 'gemini';
-        model: string;
-    };
-    // (undocumented)
-    sendChatMessage(history: ChatMessage[], userMessage: string, options?: ChatRequestOptions): Promise<ChatMessage>;
-    // Warning: (ae-forgotten-export) The symbol "StructuredPromptOptions" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    sendStructuredPrompt(options: StructuredPromptOptions): Promise<string>;
-}
-
-// @beta
-export function getAIProvider(): AIProvider;
-
-// @beta
-export type InteractionResult<T = unknown> = {
-    status: 'approved' | 'rejected';
-    payload?: T;
-    message?: string;
-};
-
-// @public
-export const isAIFeatureEnabled: () => boolean;
-
-// @beta
-export function isSpeechRecognitionAvailable(): boolean;
-
-// @beta
-export class MalformedFunctionCallError extends Error {
-    constructor(finishMessage?: string);
-    // (undocumented)
-    readonly finishMessage?: string;
-}
-
-// @beta
-export function resolveAIConfig(options?: ResolveAIConfigOptions): Promise<AIConfig | null>;
-
-// @beta
-export interface ResolveAIConfigOptions {
-    model?: string;
-    preferChrome?: boolean;
-    provider?: 'openai' | 'gemini';
-}
-
-// @beta
-export interface ServerAIConfig extends AIProviderConfig {
-    // Warning: (ae-forgotten-export) The symbol "ServerAIProviderType" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    provider: ServerAIProviderType;
-}
-
-// Warning: (ae-forgotten-export) The symbol "SpeechRecognitionResultHandler" needs to be exported by the entry point index.d.ts
-// Warning: (ae-forgotten-export) The symbol "SpeechRecognitionErrorHandler" needs to be exported by the entry point index.d.ts
-//
-// @beta
-export function startSpeechRecognition(onResult: SpeechRecognitionResultHandler, onError?: SpeechRecognitionErrorHandler): (() => void) | null;
-
-// (No @packageDocumentation comment for this package)
-
-```