@fgv/ts-extras-ollama 5.1.0-34

package/temp/ts-extras-ollama.api.md

@@ -0,0 +1,139 @@
+## API Report File for "@fgv/ts-extras-ollama"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { JsonSchema } from '@fgv/ts-json-base';
+import { JsonValue } from '@fgv/ts-json-base';
+import { Ollama } from 'ollama';
+import { Result } from '@fgv/ts-utils';
+
+// @public
+export function chatStructured<T>(client: IOllamaClient, params: IChatStructuredParams<T>): Promise<Result<IOllamaChatStructuredResult<T>>>;
+
+// @public
+export function createOllamaClient(params?: ICreateOllamaClientParams): Result<IOllamaClient>;
+
+// @public
+export function deleteModel(client: IOllamaClient, model: string): Promise<Result<IOllamaDeleteResult>>;
+
+// @public
+export interface IChatStructuredParams<T> {
+    readonly keepAlive?: string | number;
+    readonly messages: ReadonlyArray<IOllamaChatMessage>;
+    readonly model: string;
+    readonly options?: Readonly<Record<string, JsonValue>>;
+    readonly schema: JsonSchema.ISchemaValidator<T>;
+    readonly signal?: AbortSignal;
+}
+
+// @public
+export interface ICreateOllamaClientParams {
+    readonly fetch?: typeof fetch;
+    readonly headers?: Record<string, string>;
+    readonly host?: string;
+}
+
+// @public
+export interface IOllamaChatMessage {
+    readonly content: string;
+    readonly images?: ReadonlyArray<string>;
+    readonly role: 'system' | 'user' | 'assistant' | 'tool';
+}
+
+// @public
+export interface IOllamaChatStructuredResult<T> {
+    readonly doneReason?: string;
+    readonly model: string;
+    readonly raw: string;
+    readonly value: T;
+}
+
+// @public
+export type IOllamaClient = Ollama;
+
+// @public
+export interface IOllamaDeleteResult {
+    readonly deleted: true;
+    readonly model: string;
+}
+
+// @public
+export interface IOllamaModel extends IOllamaModelBase {
+    readonly modifiedAt: Date;
+}
+
+// @public
+export interface IOllamaModelBase {
+    readonly details: IOllamaModelDetail;
+    readonly digest: string;
+    readonly model: string;
+    readonly name: string;
+    readonly size: number;
+}
+
+// @public
+export interface IOllamaModelDetail {
+    readonly families?: ReadonlyArray<string>;
+    readonly family?: string;
+    readonly format?: string;
+    readonly parameterSize?: string;
+    readonly parentModel?: string;
+    readonly quantizationLevel?: string;
+}
+
+// @public
+export interface IOllamaModelInfo {
+    readonly capabilities?: ReadonlyArray<string>;
+    readonly details: IOllamaModelDetail;
+    readonly modelfile?: string;
+    readonly modelInfo?: Readonly<Record<string, JsonValue>>;
+    readonly parameters?: string;
+    readonly template?: string;
+}
+
+// @public
+export interface IOllamaPullProgress {
+    readonly completed?: number;
+    readonly digest?: string;
+    readonly status: string;
+    readonly total?: number;
+}
+
+// @public
+export interface IOllamaPullResult {
+    readonly chunkCount: number;
+    readonly finalStatus: string;
+    readonly model: string;
+}
+
+// @public
+export interface IOllamaRunningModel extends IOllamaModelBase {
+    readonly expiresAt: Date;
+    readonly sizeVram: number;
+}
+
+// @public
+export interface IPullModelParams {
+    readonly insecure?: boolean;
+    readonly model: string;
+    readonly onProgress?: (progress: IOllamaPullProgress) => void;
+    readonly signal?: AbortSignal;
+}
+
+// @public
+export function listModels(client: IOllamaClient): Promise<Result<ReadonlyArray<IOllamaModel>>>;
+
+// @public
+export function listRunning(client: IOllamaClient): Promise<Result<ReadonlyArray<IOllamaRunningModel>>>;
+
+// @public
+export function pullModel(client: IOllamaClient, params: IPullModelParams): Promise<Result<IOllamaPullResult>>;
+
+// @public
+export function showModel(client: IOllamaClient, model: string, options?: {
+    readonly verbose?: boolean;
+}): Promise<Result<IOllamaModelInfo>>;
+
+```

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./node_modules/@rushstack/heft-node-rig/profiles/default/tsconfig-base.json",
+  "compilerOptions": {
+    "types": ["heft-jest", "node"],
+    "lib": ["es2018", "DOM"],
+    "skipLibCheck": true
+  }
+}