The service offers multiple summary types and customization options while preserving important context and meaning from the original text.

Overview

The Text Summary Service provides advanced text summarization capabilities powered by Mistral's language models. It can analyze text thoroughly, maintain original meaning and important context, and deliver summaries in various formats based on your needs. The service supports different summary types including brief, detailed, bullet points, and executive summaries, each with its own style and word count target.

The service uses professional language, preserves critical data points, and maintains an objective tone. You can customize requirements, maximum word count, output format, and even the underlying model used for summarization.

Endpoints

Here is an overview of the endpoints that are available for this service.

Summarize

The summarize endpoint generates professional summaries with configurable options.

API Endpoint

Endpoint Parameters

Here is an overview of the parameters that are used by the endpoint for the summarization process.

Request

text (string, required) - The text to summarize.

summary_type (string, optional, default: "brief") - Type of summary to generate. Options: "brief", "detailed", "bullet_points", "executive".

custom_requirements (array, optional) - List of custom requirements for the summary.

max_words (integer, optional) - Override default maximum words limit for the summary.

output_format (string, optional, default: "paragraph") - Desired output format. Options: "paragraph", "bullets", "json".

model_id (string, optional, default: "ministral-8b-2410") - Specific model to use for summarization.

options (object, optional) - Additional options for the model.

Response

status (string) - Status of the summarization process.

summary (string) - The generated summary text.

metadata (object)

Additional information about the summary:

• model: Model used for summarization
• created_at: Timestamp of creation
• original_length: Word count of original text
• summary_length: Word count of summary
• processing_time: Processing timestamp
• usage: Model usage information

error (string) - Error message if summarization failed.

Examples

Below are examples demonstrating how to use the Text Summary Service.

Request

Basic Summarization (Brief)

Detailed Summarization with Custom Word Count

Executive Summary in Bullet Points

Response

Successful Summarization

Error Response