@nemesis-oss/ollama-sdk 1.0.0 → 1.3.0

package/dist/{compose-DC11aDJn.d.cts → compose-CDWq8oxJ.d.cts}

@@ -28,7 +28,12 @@ interface ToolCall {
 interface Message {
     readonly role: Role;
     readonly content: string;
-    readonly images?: readonly string[] | undefined;
+    /**
+     * Base64-encoded image strings, or raw `Uint8Array` image bytes. `Uint8Array` entries
+     * are base64-encoded automatically (see {@link encodeImage}) before the request reaches
+     * the wire — Ollama's REST API only ever accepts base64 strings.
+     */
+    readonly images?: readonly (string | Uint8Array)[] | undefined;
     readonly tool_calls?: readonly ToolCall[] | undefined;
     /** Set on a `role: 'tool'` message to identify which {@link ToolCall.id} this answers. */
     readonly tool_call_id?: string | undefined;
@@ -56,6 +61,21 @@ interface ToolDefinition {
     readonly function: ToolFunctionDefinition;
 }
 type FormatOption = 'json' | Record<string, unknown>;
+/** One alternative token considered at a generated position, and its log probability. */
+interface LogprobToken {
+    readonly token: string;
+    readonly logprob: number;
+    readonly bytes?: readonly number[] | undefined;
+}
+/**
+ * Log probability info for one generated token, returned when `logprobs: true` is set on
+ * a `/api/chat` or `/api/generate` request. `top_logprobs` holds the `top_logprobs` most
+ * likely alternative tokens considered at this position (see `top_logprobs` on
+ * {@link ChatRequestOptions}/{@link GenerateRequestOptions}).
+ */
+interface Logprob extends LogprobToken {
+    readonly top_logprobs?: readonly LogprobToken[] | undefined;
+}
 interface ModelOptions {
     readonly num_keep?: number | undefined;
     readonly seed?: number | undefined;
@@ -99,6 +119,10 @@ interface ChatRequestOptions extends RequestCancellationOptions {
     readonly stream?: boolean | undefined;
     readonly keep_alive?: string | number | undefined;
     readonly think?: boolean | 'low' | 'medium' | 'high' | 'max' | undefined;
+    /** Whether to return log probabilities of the output tokens. See {@link ChatResponse.logprobs}. */
+    readonly logprobs?: boolean | undefined;
+    /** Number of most likely alternative tokens to return at each position. Requires `logprobs: true`. */
+    readonly top_logprobs?: number | undefined;
 }
 interface ChatResponse {
     readonly model: string;
@@ -112,6 +136,8 @@ interface ChatResponse {
     readonly prompt_eval_duration?: number | undefined;
     readonly eval_count?: number | undefined;
     readonly eval_duration?: number | undefined;
+    /** Present when the request set `logprobs: true`. */
+    readonly logprobs?: readonly Logprob[] | undefined;
 }
 interface GenerateRequestOptions extends RequestCancellationOptions {
     readonly model: string;
@@ -123,10 +149,19 @@ interface GenerateRequestOptions extends RequestCancellationOptions {
     readonly stream?: boolean | undefined;
     readonly raw?: boolean | undefined;
     readonly format?: FormatOption | undefined;
-    readonly images?: readonly string[] | undefined;
+    /**
+     * Base64-encoded image strings, or raw `Uint8Array` image bytes. `Uint8Array` entries
+     * are base64-encoded automatically (see {@link encodeImage}) before the request reaches
+     * the wire — Ollama's REST API only ever accepts base64 strings.
+     */
+    readonly images?: readonly (string | Uint8Array)[] | undefined;
     readonly options?: ModelOptions | undefined;
     readonly keep_alive?: string | number | undefined;
     readonly think?: boolean | 'low' | 'medium' | 'high' | 'max' | undefined;
+    /** Whether to return log probabilities of the output tokens. See {@link GenerateResponse.logprobs}. */
+    readonly logprobs?: boolean | undefined;
+    /** Number of most likely alternative tokens to return at each position. Requires `logprobs: true`. */
+    readonly top_logprobs?: number | undefined;
 }
 interface GenerateResponse {
     readonly model: string;
@@ -142,6 +177,8 @@ interface GenerateResponse {
     readonly eval_count?: number | undefined;
     readonly eval_duration?: number | undefined;
     readonly thinking?: string | undefined;
+    /** Present when the request set `logprobs: true`. */
+    readonly logprobs?: readonly Logprob[] | undefined;
 }
 interface EmbedRequestOptions extends RequestCancellationOptions {
     readonly model: string;
@@ -225,12 +262,29 @@ interface PushRequestOptions extends RequestCancellationOptions {
 }
 interface CreateRequestOptions extends RequestCancellationOptions {
     readonly model: string;
+    /**
+     * @deprecated Not part of the official `/api/create` REST payload — Ollama's server
+     * only ever accepted this in older client tooling that assembled a Modelfile string
+     * client-side. Use the discrete fields below instead (`from`, `files`, `adapters`,
+     * `template`, `system`, `parameters`, `license`, `messages`), which map 1:1 onto the
+     * documented Modelfile instructions and are validated server-side. Kept for backward
+     * compatibility with existing callers; not read by this SDK, but still forwarded as-is
+     * in the request body for any server/proxy that inspects it.
+     */
     readonly modelfile?: string | undefined;
     readonly stream?: boolean | undefined;
     readonly quantize?: string | undefined;
     readonly from?: string | undefined;
     readonly files?: Record<string, string> | undefined;
     readonly adapters?: Record<string, string> | undefined;
+    readonly template?: string | undefined;
+    readonly renderer?: string | undefined;
+    readonly parser?: string | undefined;
+    readonly license?: string | readonly string[] | undefined;
+    readonly system?: string | undefined;
+    /** Modelfile `PARAMETER` instructions, e.g. `{ temperature: 0.7, stop: ['\n'] }`. */
+    readonly parameters?: Record<string, unknown> | undefined;
+    readonly messages?: readonly Message[] | undefined;
 }
 interface DeleteRequestOptions extends RequestCancellationOptions {
     readonly model: string;
@@ -248,23 +302,45 @@ interface VersionResponse {
 interface PsResponse {
     readonly models: readonly ModelResponse[];
 }
+/**
+ * `webSearch`/`webFetch` call Ollama's hosted web tools at `https://ollama.com` — a
+ * fixed cloud service, unrelated to any locally-configured `baseUrl`/`endpoints` — and
+ * require an Ollama account API key (`apiKey`/`OLLAMA_API_KEY`). See
+ * {@link OllamaClient.webSearch}.
+ */
 interface WebSearchRequestOptions extends RequestCancellationOptions {
     readonly query: string;
+    /** Max results to return (server default 5, max 10). */
+    readonly max_results?: number | undefined;
+    /**
+     * @deprecated Not a field the Ollama web search API recognizes (`max_results` is).
+     * Kept for backward compatibility with earlier (non-functional) versions of this
+     * method; mapped to `max_results` when `max_results` itself isn't set.
+     */
     readonly count?: number | undefined;
 }
 interface WebSearchResult {
     readonly title: string;
     readonly url: string;
-    readonly snippet: string;
+    readonly content: string;
+    /**
+     * @deprecated Not a field the Ollama web search API returns (`content` is) — kept, and
+     * populated by the SDK as a mirror of `content`, for backward compatibility with
+     * earlier (non-functional, wrong-endpoint) versions of `webSearch`. Use `content`.
+     */
+    readonly snippet?: string | undefined;
 }
 interface WebSearchResponse {
     readonly results: readonly WebSearchResult[];
 }
+/** See {@link WebSearchRequestOptions} — same fixed Ollama Cloud endpoint and auth. */
 interface WebFetchRequestOptions extends RequestCancellationOptions {
     readonly url: string;
 }
 interface WebFetchResponse {
+    readonly title?: string | undefined;
     readonly content: string;
+    readonly links?: readonly string[] | undefined;
 }
 
 /**
@@ -427,4 +503,4 @@ interface AppliedSkillResult {
  */
 declare function applySkill(skill: Skill, options: ApplySkillOptions): AppliedSkillResult;
 
-export { parseFrontmatter as $, type AnyTool as A, type Role as B, type ChatResponse as C, type DeleteRequestOptions as D, type EmbedRequestOptions as E, type FormatOption as F, type GenerateResponse as G, type Skill as H, type SkillFrontmatter as I, type SkillSummary as J, type ToolCallFunction as K, type ListResponse as L, type Message as M, type ToolExecutionContext as N, type ToolExecutionFailure as O, type ProgressResponse as P, type ToolExecutionSuccess as Q, type RequestCancellationOptions as R, type ShowRequestOptions as S, type ToolCall as T, type ToolFunctionDefinition as U, type VersionResponse as V, type WebSearchRequestOptions as W, type ToolProperty as X, type ToolRegistryOptions as Y, type WebSearchResult as Z, applySkill as _, type ModelResponse as a, type ShowResponse as b, type PullRequestOptions as c, type PushRequestOptions as d, type CreateRequestOptions as e, type StatusResponse as f, type CopyRequestOptions as g, type PsResponse as h, type ChatRequestOptions as i, type GenerateRequestOptions as j, type EmbedResponse as k, type EmbeddingsRequestOptions as l, type EmbeddingsResponse as m, type WebSearchResponse as n, type WebFetchRequestOptions as o, type WebFetchResponse as p, type ToolHandler as q, type Tool as r, ToolRegistry as s, type ToolExecutionResult as t, type ModelOptions as u, type ToolDefinition as v, type AppliedSkillResult as w, type ApplySkillOptions as x, type ModelDetails as y, type ParsedFrontmatter as z };
+export { type WebSearchResult as $, type AnyTool as A, type ModelDetails as B, type ChatResponse as C, type DeleteRequestOptions as D, type EmbedRequestOptions as E, type FormatOption as F, type GenerateResponse as G, type ParsedFrontmatter as H, type Role as I, type Skill as J, type SkillFrontmatter as K, type ListResponse as L, type Message as M, type SkillSummary as N, type ToolCallFunction as O, type ProgressResponse as P, type ToolExecutionContext as Q, type RequestCancellationOptions as R, type ShowRequestOptions as S, type ToolCall as T, type ToolExecutionFailure as U, type VersionResponse as V, type WebSearchRequestOptions as W, type ToolExecutionSuccess as X, type ToolFunctionDefinition as Y, type ToolProperty as Z, type ToolRegistryOptions as _, type ModelResponse as a, applySkill as a0, parseFrontmatter as a1, type ShowResponse as b, type PullRequestOptions as c, type PushRequestOptions as d, type CreateRequestOptions as e, type StatusResponse as f, type CopyRequestOptions as g, type PsResponse as h, type ChatRequestOptions as i, type GenerateRequestOptions as j, type EmbedResponse as k, type EmbeddingsRequestOptions as l, type EmbeddingsResponse as m, type WebSearchResponse as n, type WebFetchRequestOptions as o, type WebFetchResponse as p, type ToolHandler as q, type Tool as r, ToolRegistry as s, type ToolExecutionResult as t, type ModelOptions as u, type ToolDefinition as v, type AppliedSkillResult as w, type ApplySkillOptions as x, type Logprob as y, type LogprobToken as z };

package/dist/{compose-DC11aDJn.d.ts → compose-CDWq8oxJ.d.ts}

@@ -28,7 +28,12 @@ interface ToolCall {
 interface Message {
     readonly role: Role;
     readonly content: string;
-    readonly images?: readonly string[] | undefined;
+    /**
+     * Base64-encoded image strings, or raw `Uint8Array` image bytes. `Uint8Array` entries
+     * are base64-encoded automatically (see {@link encodeImage}) before the request reaches
+     * the wire — Ollama's REST API only ever accepts base64 strings.
+     */
+    readonly images?: readonly (string | Uint8Array)[] | undefined;
     readonly tool_calls?: readonly ToolCall[] | undefined;
     /** Set on a `role: 'tool'` message to identify which {@link ToolCall.id} this answers. */
     readonly tool_call_id?: string | undefined;
@@ -56,6 +61,21 @@ interface ToolDefinition {
     readonly function: ToolFunctionDefinition;
 }
 type FormatOption = 'json' | Record<string, unknown>;
+/** One alternative token considered at a generated position, and its log probability. */
+interface LogprobToken {
+    readonly token: string;
+    readonly logprob: number;
+    readonly bytes?: readonly number[] | undefined;
+}
+/**
+ * Log probability info for one generated token, returned when `logprobs: true` is set on
+ * a `/api/chat` or `/api/generate` request. `top_logprobs` holds the `top_logprobs` most
+ * likely alternative tokens considered at this position (see `top_logprobs` on
+ * {@link ChatRequestOptions}/{@link GenerateRequestOptions}).
+ */
+interface Logprob extends LogprobToken {
+    readonly top_logprobs?: readonly LogprobToken[] | undefined;
+}
 interface ModelOptions {
     readonly num_keep?: number | undefined;
     readonly seed?: number | undefined;
@@ -99,6 +119,10 @@ interface ChatRequestOptions extends RequestCancellationOptions {
     readonly stream?: boolean | undefined;
     readonly keep_alive?: string | number | undefined;
     readonly think?: boolean | 'low' | 'medium' | 'high' | 'max' | undefined;
+    /** Whether to return log probabilities of the output tokens. See {@link ChatResponse.logprobs}. */
+    readonly logprobs?: boolean | undefined;
+    /** Number of most likely alternative tokens to return at each position. Requires `logprobs: true`. */
+    readonly top_logprobs?: number | undefined;
 }
 interface ChatResponse {
     readonly model: string;
@@ -112,6 +136,8 @@ interface ChatResponse {
     readonly prompt_eval_duration?: number | undefined;
     readonly eval_count?: number | undefined;
     readonly eval_duration?: number | undefined;
+    /** Present when the request set `logprobs: true`. */
+    readonly logprobs?: readonly Logprob[] | undefined;
 }
 interface GenerateRequestOptions extends RequestCancellationOptions {
     readonly model: string;
@@ -123,10 +149,19 @@ interface GenerateRequestOptions extends RequestCancellationOptions {
     readonly stream?: boolean | undefined;
     readonly raw?: boolean | undefined;
     readonly format?: FormatOption | undefined;
-    readonly images?: readonly string[] | undefined;
+    /**
+     * Base64-encoded image strings, or raw `Uint8Array` image bytes. `Uint8Array` entries
+     * are base64-encoded automatically (see {@link encodeImage}) before the request reaches
+     * the wire — Ollama's REST API only ever accepts base64 strings.
+     */
+    readonly images?: readonly (string | Uint8Array)[] | undefined;
     readonly options?: ModelOptions | undefined;
     readonly keep_alive?: string | number | undefined;
     readonly think?: boolean | 'low' | 'medium' | 'high' | 'max' | undefined;
+    /** Whether to return log probabilities of the output tokens. See {@link GenerateResponse.logprobs}. */
+    readonly logprobs?: boolean | undefined;
+    /** Number of most likely alternative tokens to return at each position. Requires `logprobs: true`. */
+    readonly top_logprobs?: number | undefined;
 }
 interface GenerateResponse {
     readonly model: string;
@@ -142,6 +177,8 @@ interface GenerateResponse {
     readonly eval_count?: number | undefined;
     readonly eval_duration?: number | undefined;
     readonly thinking?: string | undefined;
+    /** Present when the request set `logprobs: true`. */
+    readonly logprobs?: readonly Logprob[] | undefined;
 }
 interface EmbedRequestOptions extends RequestCancellationOptions {
     readonly model: string;
@@ -225,12 +262,29 @@ interface PushRequestOptions extends RequestCancellationOptions {
 }
 interface CreateRequestOptions extends RequestCancellationOptions {
     readonly model: string;
+    /**
+     * @deprecated Not part of the official `/api/create` REST payload — Ollama's server
+     * only ever accepted this in older client tooling that assembled a Modelfile string
+     * client-side. Use the discrete fields below instead (`from`, `files`, `adapters`,
+     * `template`, `system`, `parameters`, `license`, `messages`), which map 1:1 onto the
+     * documented Modelfile instructions and are validated server-side. Kept for backward
+     * compatibility with existing callers; not read by this SDK, but still forwarded as-is
+     * in the request body for any server/proxy that inspects it.
+     */
     readonly modelfile?: string | undefined;
     readonly stream?: boolean | undefined;
     readonly quantize?: string | undefined;
     readonly from?: string | undefined;
     readonly files?: Record<string, string> | undefined;
     readonly adapters?: Record<string, string> | undefined;
+    readonly template?: string | undefined;
+    readonly renderer?: string | undefined;
+    readonly parser?: string | undefined;
+    readonly license?: string | readonly string[] | undefined;
+    readonly system?: string | undefined;
+    /** Modelfile `PARAMETER` instructions, e.g. `{ temperature: 0.7, stop: ['\n'] }`. */
+    readonly parameters?: Record<string, unknown> | undefined;
+    readonly messages?: readonly Message[] | undefined;
 }
 interface DeleteRequestOptions extends RequestCancellationOptions {
     readonly model: string;
@@ -248,23 +302,45 @@ interface VersionResponse {
 interface PsResponse {
     readonly models: readonly ModelResponse[];
 }
+/**
+ * `webSearch`/`webFetch` call Ollama's hosted web tools at `https://ollama.com` — a
+ * fixed cloud service, unrelated to any locally-configured `baseUrl`/`endpoints` — and
+ * require an Ollama account API key (`apiKey`/`OLLAMA_API_KEY`). See
+ * {@link OllamaClient.webSearch}.
+ */
 interface WebSearchRequestOptions extends RequestCancellationOptions {
     readonly query: string;
+    /** Max results to return (server default 5, max 10). */
+    readonly max_results?: number | undefined;
+    /**
+     * @deprecated Not a field the Ollama web search API recognizes (`max_results` is).
+     * Kept for backward compatibility with earlier (non-functional) versions of this
+     * method; mapped to `max_results` when `max_results` itself isn't set.
+     */
     readonly count?: number | undefined;
 }
 interface WebSearchResult {
     readonly title: string;
     readonly url: string;
-    readonly snippet: string;
+    readonly content: string;
+    /**
+     * @deprecated Not a field the Ollama web search API returns (`content` is) — kept, and
+     * populated by the SDK as a mirror of `content`, for backward compatibility with
+     * earlier (non-functional, wrong-endpoint) versions of `webSearch`. Use `content`.
+     */
+    readonly snippet?: string | undefined;
 }
 interface WebSearchResponse {
     readonly results: readonly WebSearchResult[];
 }
+/** See {@link WebSearchRequestOptions} — same fixed Ollama Cloud endpoint and auth. */
 interface WebFetchRequestOptions extends RequestCancellationOptions {
     readonly url: string;
 }
 interface WebFetchResponse {
+    readonly title?: string | undefined;
     readonly content: string;
+    readonly links?: readonly string[] | undefined;
 }
 
 /**
@@ -427,4 +503,4 @@ interface AppliedSkillResult {
  */
 declare function applySkill(skill: Skill, options: ApplySkillOptions): AppliedSkillResult;
 
-export { parseFrontmatter as $, type AnyTool as A, type Role as B, type ChatResponse as C, type DeleteRequestOptions as D, type EmbedRequestOptions as E, type FormatOption as F, type GenerateResponse as G, type Skill as H, type SkillFrontmatter as I, type SkillSummary as J, type ToolCallFunction as K, type ListResponse as L, type Message as M, type ToolExecutionContext as N, type ToolExecutionFailure as O, type ProgressResponse as P, type ToolExecutionSuccess as Q, type RequestCancellationOptions as R, type ShowRequestOptions as S, type ToolCall as T, type ToolFunctionDefinition as U, type VersionResponse as V, type WebSearchRequestOptions as W, type ToolProperty as X, type ToolRegistryOptions as Y, type WebSearchResult as Z, applySkill as _, type ModelResponse as a, type ShowResponse as b, type PullRequestOptions as c, type PushRequestOptions as d, type CreateRequestOptions as e, type StatusResponse as f, type CopyRequestOptions as g, type PsResponse as h, type ChatRequestOptions as i, type GenerateRequestOptions as j, type EmbedResponse as k, type EmbeddingsRequestOptions as l, type EmbeddingsResponse as m, type WebSearchResponse as n, type WebFetchRequestOptions as o, type WebFetchResponse as p, type ToolHandler as q, type Tool as r, ToolRegistry as s, type ToolExecutionResult as t, type ModelOptions as u, type ToolDefinition as v, type AppliedSkillResult as w, type ApplySkillOptions as x, type ModelDetails as y, type ParsedFrontmatter as z };
+export { type WebSearchResult as $, type AnyTool as A, type ModelDetails as B, type ChatResponse as C, type DeleteRequestOptions as D, type EmbedRequestOptions as E, type FormatOption as F, type GenerateResponse as G, type ParsedFrontmatter as H, type Role as I, type Skill as J, type SkillFrontmatter as K, type ListResponse as L, type Message as M, type SkillSummary as N, type ToolCallFunction as O, type ProgressResponse as P, type ToolExecutionContext as Q, type RequestCancellationOptions as R, type ShowRequestOptions as S, type ToolCall as T, type ToolExecutionFailure as U, type VersionResponse as V, type WebSearchRequestOptions as W, type ToolExecutionSuccess as X, type ToolFunctionDefinition as Y, type ToolProperty as Z, type ToolRegistryOptions as _, type ModelResponse as a, applySkill as a0, parseFrontmatter as a1, type ShowResponse as b, type PullRequestOptions as c, type PushRequestOptions as d, type CreateRequestOptions as e, type StatusResponse as f, type CopyRequestOptions as g, type PsResponse as h, type ChatRequestOptions as i, type GenerateRequestOptions as j, type EmbedResponse as k, type EmbeddingsRequestOptions as l, type EmbeddingsResponse as m, type WebSearchResponse as n, type WebFetchRequestOptions as o, type WebFetchResponse as p, type ToolHandler as q, type Tool as r, ToolRegistry as s, type ToolExecutionResult as t, type ModelOptions as u, type ToolDefinition as v, type AppliedSkillResult as w, type ApplySkillOptions as x, type Logprob as y, type LogprobToken as z };