Interface AIService

interface AIService {
    chat(req, options?): Promise<TextResponse | ReadableStream<TextResponse>>;
    embed(req, options?): Promise<EmbedResponse>;
    getEmbedModelInfo(): undefined | Readonly<TextModelInfo>;
    getFeatures(): {
        functions: boolean;
    };
    getModelConfig(): Readonly<TextModelConfig>;
    getModelInfo(): Readonly<TextModelInfo & {
        provider: string;
    }>;
    getName(): string;
    getTraceRequest(): undefined | Readonly<TextRequestBuilder>;
    getTraceResponse(): undefined | Readonly<TextResponseBuilder>;
    logTrace(): void;
    setOptions(options): void;
    traceExists(): boolean;
}

Index

Methods

chat embed getEmbedModelInfo getFeatures getModelConfig getModelInfo getName getTraceRequest getTraceResponse logTrace setOptions traceExists

Methods

chat

chat(req, options?): Promise<TextResponse | ReadableStream<TextResponse>>
Parameters
- req: Readonly<AITextChatRequest>
- Optional options: Readonly<AIPromptConfig & AIServiceActionOptions>
Returns Promise<TextResponse | ReadableStream<TextResponse>>
- Defined in src/text/types.ts:98

embed

embed(req, options?): Promise<EmbedResponse>
Parameters
- req: Readonly<AITextEmbedRequest>
- Optional options: Readonly<AIServiceActionOptions>
Returns Promise<EmbedResponse>
- Defined in src/text/types.ts:102

getEmbedModelInfo

getEmbedModelInfo(): undefined | Readonly<TextModelInfo>
Returns undefined | Readonly<TextModelInfo>
- Defined in src/text/types.ts:89

getFeatures

getFeatures(): {
functions: boolean;
}
Returns {
functions: boolean;
}
- functions: boolean
- Defined in src/text/types.ts:91

getModelConfig

getModelConfig(): Readonly<TextModelConfig>
Returns Readonly<TextModelConfig>
- Defined in src/text/types.ts:90

getModelInfo

getModelInfo(): Readonly<TextModelInfo & {
provider: string;
}>
Returns Readonly<TextModelInfo & {
provider: string;
}>
- Defined in src/text/types.ts:88

getName

getName(): string
Returns string
- Defined in src/text/types.ts:87

getTraceRequest

getTraceRequest(): undefined | Readonly<TextRequestBuilder>
Returns undefined | Readonly<TextRequestBuilder>
- Defined in src/text/types.ts:112

getTraceResponse

getTraceResponse(): undefined | Readonly<TextResponseBuilder>
Returns undefined | Readonly<TextResponseBuilder>
- Defined in src/text/types.ts:113

logTrace

logTrace(): void
Returns void
- Defined in src/text/types.ts:115

setOptions

setOptions(options): void
Parameters
- options: Readonly<AIServiceOptions>
Returns void
- Defined in src/text/types.ts:111

traceExists

traceExists(): boolean
Returns boolean
- Defined in src/text/types.ts:114