Summarization

import os
import orbitalsai
 
client = orbitalsai.Client(api_key=os.environ["ORBITALSAI_API_KEY"])
 
summary = client.summarize(
    text="Customer reported a failed transfer. The agent confirmed a reversal within 24 hours.",
    language="English",
    style="short",
)
 
print(summary.text)

The customer reported a failed transfer. The agent confirmed that it will be reversed within 24 hours.

Perigee-1-text accepts source text in any of the 19 supported text languages. Summaries are returned in English.

REST request

curl -X POST "https://api.orbitalsai.com/api/v1/text/summarize" \
  -H "Authorization: Bearer $ORBITALSAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Paste the transcript or document text here.",
    "language": "Swahili",
    "style": "short",
    "stream": false
  }'

Summary styles

Style	Output
`short`	A concise two-to-four-sentence summary.
`detailed`	A fuller five-to-eight-sentence summary.
`structured`	A JSON object for operational use.

Structured output contains summary, customer_issue, sentiment, resolution_status, next_action, and important_entities. It is returned in result_structured; short and detailed summaries use result.

All summaries are produced in English. Structured summaries do not stream.

Parameter	Required	Description
`text`	Yes	Transcript or document text.
`language`	Yes	Source language.
`style`	No	`short`, `detailed`, or `structured`; defaults to `short`.
`domain`	No	Optional vocabulary context.
`stream`	No	Supported for `short` and `detailed`, not `structured`.

REST request

Summary styles

Next steps

On this page