@fgv/ts-extras-transformers 5.1.0-30 → 5.1.0-31

package/temp/ts-extras-transformers.api.json

@@ -178,7 +178,7 @@
   },
   "kind": "Package",
   "canonicalReference": "@fgv/ts-extras-transformers!",
-  "docComment": "/**\n * `@fgv/ts-extras-transformers` — Result-integration boundary over `@huggingface/transformers` (Node-side).\n *\n * A thin facade that wraps `@huggingface/transformers` calls in `Result<T>` from `@fgv/ts-utils`, mirroring the discipline established by `@fgv/ts-extras-webauthn`: one-line `captureAsyncResult` wrappers around upstream primitives with **no opinionated orchestration** above the boundary.\n *\n * **In scope:** `loadPipeline`, `classify`, `classifyAll`, `embed` — the surface needed by the B-3/B-4a local-classifier and embedding scenarios. `generate` is explicitly deferred until a concrete consumer use case surfaces (see `phase-b2-result.md`).\n *\n * **Explicitly NOT in scope:** - Pipeline cache / lifecycle management - Model registry or download management - GPU/CPU device selection policy - Quantization selection - Embedding-store integration - Classifier label allowlists - Request batching - Pipeline dispose semantics\n *\n * For any of the above, use `@huggingface/transformers` directly (with `captureAsyncResult` for your own Result wrapping).\n *\n * @packageDocumentation\n */\n",
+  "docComment": "/**\n * `@fgv/ts-extras-transformers` — Result-integration boundary over `@huggingface/transformers` (Node-side).\n *\n * A thin facade that wraps `@huggingface/transformers` calls in `Result<T>` from `@fgv/ts-utils`, mirroring the discipline established by `@fgv/ts-extras-webauthn`: one-line `captureAsyncResult` wrappers around upstream primitives with **no opinionated orchestration** above the boundary.\n *\n * **In scope:** `loadPipeline`, `classify`, `classifyAll`, `embed`, `summarize` — the task types exercised by real consumers so far. The general `generate` primitive is explicitly deferred until a concrete consumer use case surfaces (summarization is its own task-specific primitive).\n *\n * **Explicitly NOT in scope:** - Pipeline cache / lifecycle management - Model registry or download management - GPU/CPU device selection policy - Quantization selection - Embedding-store integration - Classifier label allowlists - Request batching - Pipeline dispose semantics\n *\n * For any of the above, use `@huggingface/transformers` directly (with `captureAsyncResult` for your own Result wrapping).\n *\n * @packageDocumentation\n */\n",
   "name": "@fgv/ts-extras-transformers",
   "preserveMemberOrder": false,
   "members": [
@@ -668,6 +668,121 @@
             }
           ],
           "name": "loadPipeline"
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@fgv/ts-extras-transformers!summarize:function(1)",
+          "docComment": "/**\n * Result-integration wrapper that invokes a `SummarizationPipeline` on a single text input. Returns the upstream `SummarizationOutput` Result-wrapped (an array of `{ summary_text }` entries; one for a single-string input).\n *\n * Callers should retrieve the summarizer via `loadPipeline('summarization', modelId)` — e.g. `Xenova/distilbart-cnn-6-6` for a small, local-friendly model. This facade applies no opinionated orchestration (no length policy, no local-vs-cloud routing) — `options` are passed through verbatim and the caller owns any escalation decision.\n *\n * Returns `Promise<Result<SummarizationOutput>>`; upstream errors (inference failures, tokenisation errors) are captured as `Failure` with the original message.\n *\n * @param summarizer - A `SummarizationPipeline` obtained from `loadPipeline`.\n *\n * @param text - The text to summarize.\n *\n * @param options - Optional upstream summarization options (e.g. `min_length`, `max_length`, `max_new_tokens`). Passed through verbatim to the pipeline call.\n *\n * @see\n *\n * https://huggingface.co/docs/transformers.js\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function summarize(summarizer: "
+            },
+            {
+              "kind": "Reference",
+              "text": "SummarizationPipeline",
+              "canonicalReference": "@huggingface/transformers!SummarizationPipeline:class"
+            },
+            {
+              "kind": "Content",
+              "text": ", text: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ", options?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Parameters",
+              "canonicalReference": "!Parameters:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "SummarizationPipeline",
+              "canonicalReference": "@huggingface/transformers!SummarizationPipeline:class"
+            },
+            {
+              "kind": "Content",
+              "text": ">[1]"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "Promise",
+              "canonicalReference": "!Promise:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Result",
+              "canonicalReference": "@fgv/ts-utils!Result:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "SummarizationOutput",
+              "canonicalReference": "@huggingface/transformers!SummarizationOutput:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">>"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/index.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 10,
+            "endIndex": 16
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "summarizer",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "text",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "options",
+              "parameterTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 9
+              },
+              "isOptional": true
+            }
+          ],
+          "name": "summarize"
         }
       ]
     }

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

@@ -10,6 +10,8 @@ import { pipeline } from '@huggingface/transformers';
 import { PipelineType } from '@huggingface/transformers';
 import { PretrainedModelOptions } from '@huggingface/transformers';
 import { Result } from '@fgv/ts-utils';
+import { SummarizationOutput } from '@huggingface/transformers';
+import { SummarizationPipeline } from '@huggingface/transformers';
 import { Tensor } from '@huggingface/transformers';
 import { TextClassificationOutput } from '@huggingface/transformers';
 import { TextClassificationPipeline } from '@huggingface/transformers';
@@ -34,6 +36,13 @@ export { PipelineType }
 
 export { PretrainedModelOptions }
 
+export { SummarizationOutput }
+
+export { SummarizationPipeline }
+
+// @public
+export function summarize(summarizer: SummarizationPipeline, text: string, options?: Parameters<SummarizationPipeline>[1]): Promise<Result<SummarizationOutput>>;
+
 export { Tensor }
 
 export { TextClassificationOutput }