Metadata-Version: 2.1
Name: maritalk
Version: 0.0.3
Summary: Client library for the MariTalk API
Author-email: Maritaca AI <info@maritaca.ai>
License: The MIT License
        
        Copyright (c) Maritaca AI (https://maritaca.ai)
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
        THE SOFTWARE.
Project-URL: Homepage, https://github.com/maritaca-ai/maritalk-api
Project-URL: Bug Tracker, https://github.com/maritaca-ai/maritalk-api/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests

# Introduction
This repository contains the code and documentation explaining how to use the MariTalk API.
MariTalk is a chatbot based on a language model that has been specially trained to understand Portuguese well.
It is able to follow instructions in a zero-shot manner, like ChatGPT. 

# Usage Example
This Google Colab contains an example showing how to use the API, which is similar to ChatGPT's API:

[Google Colab Example](https://colab.research.google.com/drive/13tieiQdQqYDQGHI8aLtlqoBWMpJ2elyo?usp=sharing)

You will also find in the colab an example of how to use the model in a few-shot manner.

You can find more details about the API at https://chat.maritaca.ai/docs

# Technical Aspects

### Is it free?
The API is available for free to all users. We plan to introduce a paid version in the future that will offer increased throughput and reliability. 

### Rate Limit
At the moment, there is a limit of 4 requests per minute to ensure that everyone has the opportunity to test the model. If your request is denied due to exceeding this limit, you will receive an HTTP 429 error.

### Maximum sequence length 
Currently, we support a maximum sequence length of 2048 tokens, which is equivalent to approximately 1000 words in Portuguese. We will soon support 8196 tokens.

### Throughput
It takes about 1 to 2 seconds to generate the first token given a sequence of 1000 tokens as input.
After that, new tokens are generated at a rate of 10 to 15 tokens/sec.

# Web Interface
Try the Web interface at:
[chat.maritaca.ai](chat.maritaca.ai)

<img src="imgs/web_interface.png" width="600">
