text-summarize/module.yaml
flemming-it 04d663a86f
Some checks failed
CI / Linux x86_64 (Forgejo) (push) Failing after 2s
feat: schema_version 3 with DE/EN field descriptions
Signed-off-by: flemming-it <sf@flemming.it>
2026-06-01 22:13:33 +02:00

92 lines
2.4 KiB
YAML

schema_version: 3
provider: fai
name: text-summarize
version: 0.1.0
# Capability provided by this module.
provides:
- capability: text.summarize
version: 0.1.0
# Inputs the invoke function accepts.
inputs:
text:
type: text
description:
en: Source text to summarise.
de: Quelltext, der zusammengefasst werden soll.
style:
type: text
description:
en: |
Style / shape of the summary, e.g. "one paragraph",
"three bullet points", "a tweet". Defaults to
"one paragraph" when omitted.
de: |
Stil/Form der Zusammenfassung, z. B. "ein Absatz",
"drei Bulletpoints", "ein Tweet". Default ist
"ein Absatz".
language:
type: text
description:
en: |
Optional output language hint, e.g. "German", "ja-JP".
Empty = same language as the source.
de: |
Optionale Ausgabesprache, z. B. "German", "ja-JP".
Leer = gleiche Sprache wie die Quelle.
endpoint:
type: text
description:
en: Ollama-shaped /api/chat endpoint.
de: Ollama-kompatibler /api/chat-Endpunkt.
model:
type: text
description:
en: Model identifier (e.g. "qwen2.5:14b").
de: Modell-Identifier (z. B. "qwen2.5:14b").
api_key:
type: text
description:
en: Optional bearer token for cloud-hosted endpoints.
de: Optionaler Bearer-Token für Cloud-Endpunkte.
# Outputs produced.
outputs:
summary:
type: text
description:
en: The summary text.
de: Die zusammengefasste Antwort.
style:
type: text
description:
en: Echo of the style input for downstream audit.
de: Echo des Style-Inputs für Downstream-Audit.
language:
type: text
description:
en: Echo of the language input.
de: Echo des Language-Inputs.
model_endpoint:
type: text
description:
en: Endpoint the summary was generated against.
de: Endpunkt, gegen den die Zusammenfassung erzeugt wurde.
model_name:
type: text
description:
en: Model identifier as supplied to the LLM API.
de: An die LLM-API übergebenes Modell.
model_digest:
type: text
description:
en: SHA-256 digest of the served Ollama model (when reachable).
de: SHA-256-Digest des bedienten Ollama-Modells (wenn erreichbar).
# Permissions required.
permissions:
- "net: localhost"
- "net: 127.0.0.1"
- "net: api.openai.com"
- "net: api.anthropic.com"