MariTalk API provides access to Maritaca's large language models, specifically optimized for Portuguese. It offers a hosted API with a pay-as-you-go credit system and a local deployment option for on-premises use. The service targets developers and organizations needing advanced Portuguese NLP capabilities, with the benefit of OpenAI API compatibility for easier integration.

How It Works

The API exposes Maritaca's "Sabiá" family of language models. Users interact via a Python library or direct HTTP requests, specifying models like "sabia-3". The system supports standard chat interactions with role-based messages (system, user, assistant) and few-shot prompting for improved task-specific performance. It also offers streaming capabilities via generators and async generators for more responsive applications.

Quick Start & Requirements

• Install via pip: pip install maritalk
• Requires an API key from platform.maritaca.ai.
• OpenAI compatibility: pip install openai, set base_url to https://chat.maritaca.ai/api.
• Documentation: https://docs.maritaca.ai

Highlighted Details

• OpenAI API compatibility allows seamless integration with existing OpenAI-powered applications.
• Supports streaming responses for long-form content generation.
• Offers both chat and non-chat modes, with guidance on parameter tuning (temperature, sampling) for different tasks.
• Includes a count_tokens utility for estimating request costs.

Maintenance & Community

• The project's documentation is actively being updated, with a deprecation notice for the current README.
• Citation details for the Sabiá-2 models are provided via a technical report.

Licensing & Compatibility

• The README does not explicitly state a license for the code or models.
• The service is pre-paid, requiring credits purchased via credit card or bank slip.

Limitations & Caveats

• The current documentation linked in the README is deprecated.
• The legacy API will be discontinued on December 31, 2024.
• The service operates on a pre-paid credit system, with a minimum recharge of R$5.