falaai-api 1.21.47 → 1.21.49

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3381038826725700d977c7fa6fa28f2f6ee14c5432bb3bfb490573763752f17f
-  data.tar.gz: 39803b031fa1bd7d247fd98e7dfd22c3ebe60b69081c9b23150ad98e99b68a67
+  metadata.gz: cd424a4222684b15b8858c2545873748ae0186905e13df8b87edb5b9cc7a0176
+  data.tar.gz: 36d4614309d8ddeaa0b647fb7a9f141a4ed102fbb7761faafa8b3fb106e3cb54
 SHA512:
-  metadata.gz: 677fbbf0ba09380ef989b37a05cc9a9ba049377d750f36ee9187fcb98bdc4a1004e4622c6596aff24d06d9f7af59ea376a2f2b76ed4fdeccc5934c22d5bf5e38
-  data.tar.gz: a10e570c6bce24ceae199beb013566355677787c6d0b293f8c63419c74030287ccba5182365044dc792a0aa01b06aaf09712155cb8a9641660febc57e76a8df8
+  metadata.gz: 4eab457d32570575ae15027dd0e4499330d3aeb7fc6447bc67674c5ace493a6aca993c590155b596efae744bfdb65079f2f631f745bd14e1898e86b61c673926
+  data.tar.gz: da26196663d8efa3e9f4fa79d124739c698ca455187fd84e510fc6a0c08a41581d7b691cc07595f711a2f95c24cfc71932da0bd9af1a3a3b077a0b4d97757b30

data/README.md

@@ -1,205 +1,239 @@
-# falaai-api
-
-FalaAI - the Ruby gem for the FalaAI API
-
-Transcribe, diagnose and score calls with 3 simple endpoints.
-
-**Endpoints:**
-- `POST /v1/audio/transcriptions` — Audio to text
-- `POST /v1/analyze/diagnostic` — Conversation analysis
-- `POST /v1/analyze/auditoriaRisco` — Compliance audit
-
-**Complete flow (Python):**
-```python
-import httpx
-
-API = 'https://api.fala.ai'
-KEY = 'fai_xxx'
-HD = {'Authorization': f'Bearer {KEY}'}
-
-# 1. Transcribe
-files = {'file': open('call.mp3', 'rb')}
-resp = httpx.post(f'{API}/v1/audio/transcriptions', headers=HD, files=files, data={'model': 'falaai-transcribe-1', 'language': 'pt'})
-tr = resp.json()
-print(f'Text: {tr[\"text\"][:100]}...')
-
-# 2. Diagnose
-resp = httpx.post(f'{API}/v1/analyze/diagnostic', headers=HD, json={'dialog': tr['dialog'], 'language': 'pt-BR', 'duration_seconds': tr['duration_seconds']})
-diag = resp.json()
-print(f'Sentiment: {diag[\"analysis\"][\"sentiment\"][\"list_choice\"]}')
-print(f'Summary: {diag[\"analysis\"][\"dialogue_summary\"][\"explanation\"][:100]}...')
-
-# 3. Audit
-resp = httpx.post(f'{API}/v1/analyze/auditoriaRisco', headers=HD, json={'dialogo': tr['dialog'], 'duration_seconds': tr['duration_seconds']})
-audit = resp.json()
-print(f'Score: {audit[\"audit_score\"]} | Verdict: {audit[\"verdict\"]}')
-print(f'Detections: {audit[\"total_detections\"]} | Violations: {len(audit[\"violations\"])} | Positives: {len(audit[\"positives\"])}')
-```
+# falaai-api — Ruby SDK for Conversation Intelligence, Speech Analytics & Compliance
+
+[![Gem version](https://img.shields.io/gem/v/falaai-api)](https://rubygems.org/gems/falaai-api)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green)](LICENSE)
+[![CI](https://github.com/ActionTecBr/falaai-api-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/ActionTecBr/falaai-api-ruby/actions/workflows/ci.yml)
+[![Docs](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://actiontecbr.github.io/falaai-api-ruby/)
 
-**Authentication:** All endpoints require an API Key in the `Authorization` header: `Bearer fai_xxx`
+Official **Ruby SDK** for the **FalaAI API** — transcribe audio, analyze conversations and audit compliance (COPC CX, ISO 18295-1). **Use each API independently or combine them into your own pipeline.**
 
-Get your API Key at [falaai.action.tec.br/api](https://falaai.action.tec.br/api)
+> Analyze calls, contact-center recordings, voice notes, chat and email. Get speaker-separated transcripts, summaries, reasons, actions, sentiment and a **compliance risk score**.
 
-This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+## Use any FalaAI API independently
 
-- API version: 1.21.47
-- Package version: 1.0.0
-- Generator version: 7.25.0
-- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+FalaAI is a set of **independent REST APIs**. You **do not** need FalaAI Transcription to use FalaAI analysis or compliance auditing. If your application already has a transcript, send that text straight to the analysis APIs.
 
-## Installation
+| If you have... | Use |
+|---|---|
+| Audio but no transcript | `FalaAI::SpeechApi` — Transcription |
+| An existing transcript | `FalaAI::AnalysisApi` — Diagnostic |
+| A transcript needing compliance analysis | `FalaAI::AnalysisApi` — Risk Audit |
+| An existing transcript needing both | Diagnostic + Risk Audit |
+| Your own STT provider (Whisper, Deepgram...) | Skip FalaAI Transcription |
+
+```text
+Your STT                             ->  FalaAI Diagnostic  ->  FalaAI Risk Audit
+Telegram voice -> your STT           ->  FalaAI Risk Audit
+3CX / Asterisk / Genesys transcript  ->  FalaAI Diagnostic  ->  FalaAI Risk Audit
+CRM conversation                     ->  FalaAI Risk Audit
+```
 
-### Build a gem
+## Use the APIs the way you want
 
-To build the Ruby code into a gem:
+Every FalaAI API is **independent and optional** — chain any subset, in any combination.
 
-```shell
-gem build falaai-api.gemspec
+```mermaid
+flowchart LR
+  A["Audio"] -.->|optional| T["Transcribe"]
+  T --> X["Text / dialog"]
+  S["Your own STT / CRM / chat / existing transcript"] --> X
+  X -.->|optional| D["Diagnostic"]
+  X -.->|optional| R["Risk Audit"]
+  D --> O["Structured intelligence + auditable report"]
+  R --> O
 ```
 
-Then either install the gem locally:
+> Skip **Transcribe** if you already have text. Call only **Diagnostic**, only **Risk Audit**, or both.
 
-```shell
-gem install ./falaai-api-1.0.0.gem
+## Install
+
+```bash
+gem install falaai-api
 ```
 
-(for development, run `gem install --dev ./falaai-api-1.0.0.gem` to install the development dependencies)
+Requires **Ruby 2.7+**.
 
-or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+## Quickstart
 
-Finally add this to the Gemfile:
+### 1. Get an API key
+Create a free account and copy your `fai_` key: <https://falaai.action.tec.br/api/auth> (or the [Dashboard](https://falaai.action.tec.br/api/dashboard)).
 
-    gem 'falaai-api', '~> 1.0.0'
+### 2. Set environment variables
 
-### Install from Git
+```bash
+FALAAI_BASE_URL=https://api01-falaai.action.tec.br
+FALAAI_API_KEY=fai_xxxxxxxx
+```
 
-If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+### 3. Transcribe a call (audio -> text)
 
-    gem 'falaai-api', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+```ruby
+require 'falaai-api'
+
+config = FalaAI::Configuration.new
+config.host = ENV.fetch('FALAAI_BASE_URL', 'https://api01-falaai.action.tec.br')
+config.access_token = ENV['FALAAI_API_KEY']
+client = FalaAI::ApiClient.new(config)
 
-### Include the Ruby code directly
+transcription, _status = FalaAI::SpeechApi.new(client).create_transcription_v1_audio_transcriptions_post_with_http_info(
+  File.open('call.mp3'),
+  { model: 'falaai-transcribe-1', language: 'pt', client_reference_id: 'call_202609271408' }
+)
 
-Include the Ruby code directly using `-I` as follows:
+puts JSON.pretty_generate(transcription)
+```
 
-```shell
-ruby -Ilib script.rb
+Expected response (abridged):
+
+```json
+{
+  "id": "tr-...",
+  "object": "transcription",
+  "model": "falaai-transcribe-1",
+  "language": "por",
+  "duration_seconds": 25.0,
+  "text": "...",
+  "dialog": "Speaker 1: [...] ...",
+  "usage": { "audio_seconds": 25.0, "credits_consumed": 25, "processing_ms": 951 }
+}
 ```
 
-## Getting Started
+> Only need analysis? **Skip step 3** and call `FalaAI::AnalysisApi` with your own transcript (use the `text` field for a plain transcript).
 
-Please follow the [installation](#installation) procedure and then run the following code:
+### 4. Analyze or audit an existing transcript (no transcription needed)
 
 ```ruby
-# Load the gem
 require 'falaai-api'
 
-# Setup authorization
-FalaAI.configure do |config|
-  # Configure Bearer authorization (fai_xxx): ApiKeyAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
-  # Configure a proc to get access tokens in lieu of the static access_token configuration
-  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
-end
+config = FalaAI::Configuration.new
+config.host = ENV['FALAAI_BASE_URL']
+config.access_token = ENV['FALAAI_API_KEY']
+client = FalaAI::ApiClient.new(config)
+analysis = FalaAI::AnalysisApi.new(client)
+
+transcript = 'Good morning, how can I help? I need to cancel my subscription.'
+
+# 5 analyses in one call: summary, reason, action, topic, sentiment
+diagnostic, _status = analysis.create_diagnostic_v1_analyze_diagnostic_post_with_http_info(
+  FalaAI::DiagnosticRequest.new(text: transcript, language: 'pt-BR', duration_seconds: 81.46)
+)
+
+# Compliance risk score + violations + auditable report
+audit, _status = analysis.create_risk_audit_v1_analyze_risk_audit_post_with_http_info(
+  FalaAI::RiskAuditRequest.new(text: transcript, language: 'pt-BR', response_language: 'pt-BR', duration_seconds: 81.46)
+)
+```
+
+## What is FalaAI API?
+
+FalaAI API is an **AI conversation-intelligence API** for analyzing customer-service, contact-center, sales, messaging and other business conversations. It combines speech-to-text (with speaker diarization and audio-event detection), conversation analysis (summary, contact reason, action taken, topic classification, sentiment) and a **compliance/risk audit** against **COPC CX** and **ISO 18295-1**. Conversation content is processed and discarded (zero-storage).
+
+## What can you do with FalaAI?
+
+- **Transcribe** audio to text with speaker separation and audio events.
+- **Diagnose** a conversation: summary, reason, action taken, topic and sentiment.
+- **Audit** conversations: compliance risk score, detections/violations and an auditable HTML report.
+- **Track usage**, **manage webhooks** and **email alerts**, and **health/version** checks.
+
+## Use cases
+
+- **Contact center / Quality** — audit 100% of conversations instead of a sample.
+- **Compliance / Legal** — auditable evidence for audits and disputes.
+- **CX / Operations** — risk score, sentiment and reason per conversation.
+- **BI / Data** — typed JSON ready for your database or analytics stack.
+
+## SDK surface (Ruby)
+
+| Class | Namespace | Purpose |
+|---|---|---|
+| `Configuration` | `FalaAI` | `host`, `access_token` |
+| `ApiClient` | `FalaAI` | `FalaAI::ApiClient.new(config)` |
+| `HealthApi` | `FalaAI` | `health_check` |
+| `SpeechApi` | `FalaAI` | `create_transcription_v1_audio_transcriptions_post_with_http_info(...)` |
+| `AnalysisApi` | `FalaAI` | `create_diagnostic_v1_analyze_diagnostic_post_with_http_info(...)`, `create_risk_audit_v1_analyze_risk_audit_post_with_http_info(...)` |
+| `UsageApi` / `WebhooksApi` / `EmailAlertsApi` / `VersionApi` | `FalaAI` | management |
+| Models | `FalaAI` | `DiagnosticRequest`, `RiskAuditRequest`, `Participant`, `DiagnosticAudioEvent` |
+| `ApiError` | `FalaAI` | HTTP errors |
+
+> Model IDs: `falaai-transcribe-1`, `falaai-diagnostic-1`, `falaai-risk-audit-1`.
+
+## Examples
+
+Runnable examples in [`examples/`](./examples): `health.rb`, `transcribe.rb`, `diagnose.rb`, `audit.rb`.
 
-api_instance = FalaAI::AnalysisApi.new
-auditoria_risco_request = FalaAI::AuditoriaRiscoRequest.new({duration_seconds: 3.56, language: 'pt-BR', response_language: 'en-US'}) # AuditoriaRiscoRequest | 
+## Authentication
+
+Every request requires `Authorization: Bearer fai_<your_key>` — except the public endpoints (`GET/HEAD /v1/health`, `GET /api/version`). Set the key with `Configuration#access_token=` (or `FALAAI_API_KEY`).
+
+## Error handling
+
+Non-2xx responses raise `FalaAI::ApiError`.
+
+```ruby
+require 'falaai-api'
 
 begin
-  #Compliance Risk Audit — conversation compliance analysis
-  result = api_instance.create_auditoria_risco_v1_analyze_auditoria_risco_post(auditoria_risco_request)
-  p result
+  health = FalaAI::HealthApi.new(client).health_check
+  puts health.status
 rescue FalaAI::ApiError => e
-  puts "Exception when calling AnalysisApi->create_auditoria_risco_v1_analyze_auditoria_risco_post: #{e}"
+  warn "FalaAI API error: #{e.message}"
 end
-
 ```
 
-## Documentation for API Endpoints
-
-All URIs are relative to *http://localhost*
-
-Class | Method | HTTP request | Description
------------- | ------------- | ------------- | -------------
-*FalaAI::AnalysisApi* | [**create_auditoria_risco_v1_analyze_auditoria_risco_post**](docs/AnalysisApi.md#create_auditoria_risco_v1_analyze_auditoria_risco_post) | **POST** /v1/analyze/auditoriaRisco | Compliance Risk Audit — conversation compliance analysis
-*FalaAI::AnalysisApi* | [**create_diagnostic_v1_analyze_diagnostic_post**](docs/AnalysisApi.md#create_diagnostic_v1_analyze_diagnostic_post) | **POST** /v1/analyze/diagnostic | Analyze a call transcript — 5 parallel analyses
-*FalaAI::EmailAlertsApi* | [**create_email_alert_v1_email_alerts_post**](docs/EmailAlertsApi.md#create_email_alert_v1_email_alerts_post) | **POST** /v1/email-alerts | Criar email de alerta
-*FalaAI::EmailAlertsApi* | [**delete_email_alert_v1_email_alerts_alert_id_delete**](docs/EmailAlertsApi.md#delete_email_alert_v1_email_alerts_alert_id_delete) | **DELETE** /v1/email-alerts/{alert_id} | Remover email de alerta
-*FalaAI::EmailAlertsApi* | [**list_email_alerts_v1_email_alerts_get**](docs/EmailAlertsApi.md#list_email_alerts_v1_email_alerts_get) | **GET** /v1/email-alerts | Listar emails de alerta
-*FalaAI::EmailAlertsApi* | [**update_email_alert_v1_email_alerts_alert_id_put**](docs/EmailAlertsApi.md#update_email_alert_v1_email_alerts_alert_id_put) | **PUT** /v1/email-alerts/{alert_id} | Atualizar email de alerta
-*FalaAI::HealthApi* | [**health_check**](docs/HealthApi.md#health_check) | **GET** /v1/health | Health Check
-*FalaAI::HealthApi* | [**health_check_head**](docs/HealthApi.md#health_check_head) | **HEAD** /v1/health | Health Check
-*FalaAI::SpeechApi* | [**create_transcription_v1_audio_transcriptions_post**](docs/SpeechApi.md#create_transcription_v1_audio_transcriptions_post) | **POST** /v1/audio/transcriptions | Transcribe audio to text
-*FalaAI::UsageApi* | [**get_usage_by_key_v1_usage_by_key_get**](docs/UsageApi.md#get_usage_by_key_v1_usage_by_key_get) | **GET** /v1/usage/by-key | Get Usage By Key
-*FalaAI::UsageApi* | [**get_usage_log_v1_usage_log_get**](docs/UsageApi.md#get_usage_log_v1_usage_log_get) | **GET** /v1/usage/log | Get Usage Log
-*FalaAI::VersionApi* | [**get_version_api_version_get**](docs/VersionApi.md#get_version_api_version_get) | **GET** /api/version | Get Version
-*FalaAI::WebhooksApi* | [**create_webhook_v1_webhooks_post**](docs/WebhooksApi.md#create_webhook_v1_webhooks_post) | **POST** /v1/webhooks | Criar webhook de alertas
-*FalaAI::WebhooksApi* | [**delete_webhook_v1_webhooks_webhook_id_delete**](docs/WebhooksApi.md#delete_webhook_v1_webhooks_webhook_id_delete) | **DELETE** /v1/webhooks/{webhook_id} | Remover webhook
-*FalaAI::WebhooksApi* | [**list_webhooks_v1_webhooks_get**](docs/WebhooksApi.md#list_webhooks_v1_webhooks_get) | **GET** /v1/webhooks | Listar webhooks de alertas
-*FalaAI::WebhooksApi* | [**update_webhook_v1_webhooks_webhook_id_put**](docs/WebhooksApi.md#update_webhook_v1_webhooks_webhook_id_put) | **PUT** /v1/webhooks/{webhook_id} | Atualizar webhook
-
-
-## Documentation for Models
-
- - [FalaAI::AudioEvent](docs/AudioEvent.md)
- - [FalaAI::AudioInputMeta](docs/AudioInputMeta.md)
- - [FalaAI::AuditoriaRiscoAnalysisV2](docs/AuditoriaRiscoAnalysisV2.md)
- - [FalaAI::AuditoriaRiscoAppliedActionV2](docs/AuditoriaRiscoAppliedActionV2.md)
- - [FalaAI::AuditoriaRiscoAudioEventModelV2](docs/AuditoriaRiscoAudioEventModelV2.md)
- - [FalaAI::AuditoriaRiscoAuditDecisionsV2](docs/AuditoriaRiscoAuditDecisionsV2.md)
- - [FalaAI::AuditoriaRiscoConversationScoresV2](docs/AuditoriaRiscoConversationScoresV2.md)
- - [FalaAI::AuditoriaRiscoDetectionItemV2](docs/AuditoriaRiscoDetectionItemV2.md)
- - [FalaAI::AuditoriaRiscoDetectionsV2](docs/AuditoriaRiscoDetectionsV2.md)
- - [FalaAI::AuditoriaRiscoIndexerV2](docs/AuditoriaRiscoIndexerV2.md)
- - [FalaAI::AuditoriaRiscoMetaV2](docs/AuditoriaRiscoMetaV2.md)
- - [FalaAI::AuditoriaRiscoParticipantV2](docs/AuditoriaRiscoParticipantV2.md)
- - [FalaAI::AuditoriaRiscoParticipantsV2](docs/AuditoriaRiscoParticipantsV2.md)
- - [FalaAI::AuditoriaRiscoRequest](docs/AuditoriaRiscoRequest.md)
- - [FalaAI::AuditoriaRiscoScoresV2](docs/AuditoriaRiscoScoresV2.md)
- - [FalaAI::AuditoriaRiscoScoringExplanationV2](docs/AuditoriaRiscoScoringExplanationV2.md)
- - [FalaAI::AuditoriaRiscoSummaryV2](docs/AuditoriaRiscoSummaryV2.md)
- - [FalaAI::AuditoriaRiscoTimelineV2](docs/AuditoriaRiscoTimelineV2.md)
- - [FalaAI::AuditoriaRiscoUsageV2](docs/AuditoriaRiscoUsageV2.md)
- - [FalaAI::AuditoriaRiscoV2](docs/AuditoriaRiscoV2.md)
- - [FalaAI::AuditoriaRiscoV2Response](docs/AuditoriaRiscoV2Response.md)
- - [FalaAI::AuditoriaRiscoVerdictV2](docs/AuditoriaRiscoVerdictV2.md)
- - [FalaAI::CreateEmailAlertRequest](docs/CreateEmailAlertRequest.md)
- - [FalaAI::CreateWebhookRequest](docs/CreateWebhookRequest.md)
- - [FalaAI::DiagnosticAnalysisMap](docs/DiagnosticAnalysisMap.md)
- - [FalaAI::DiagnosticAudioEvent](docs/DiagnosticAudioEvent.md)
- - [FalaAI::DiagnosticCategoricalAnalysis](docs/DiagnosticCategoricalAnalysis.md)
- - [FalaAI::DiagnosticRequest](docs/DiagnosticRequest.md)
- - [FalaAI::DiagnosticResponse](docs/DiagnosticResponse.md)
- - [FalaAI::DiagnosticTextAnalysis](docs/DiagnosticTextAnalysis.md)
- - [FalaAI::DiagnosticUsage](docs/DiagnosticUsage.md)
- - [FalaAI::EmailAlertItem](docs/EmailAlertItem.md)
- - [FalaAI::EmailAlertListResponse](docs/EmailAlertListResponse.md)
- - [FalaAI::EmailAlertMessageResponse](docs/EmailAlertMessageResponse.md)
- - [FalaAI::EmailEvent](docs/EmailEvent.md)
- - [FalaAI::HTTPValidationError](docs/HTTPValidationError.md)
- - [FalaAI::HealthResponse](docs/HealthResponse.md)
- - [FalaAI::LocationInner](docs/LocationInner.md)
- - [FalaAI::MessageResponse](docs/MessageResponse.md)
- - [FalaAI::Participant](docs/Participant.md)
- - [FalaAI::ParticipantDiagnostic](docs/ParticipantDiagnostic.md)
- - [FalaAI::TranscriptionResponse](docs/TranscriptionResponse.md)
- - [FalaAI::TranscriptionUsage](docs/TranscriptionUsage.md)
- - [FalaAI::UpdateEmailAlertRequest](docs/UpdateEmailAlertRequest.md)
- - [FalaAI::UpdateWebhookRequest](docs/UpdateWebhookRequest.md)
- - [FalaAI::UsageByKeyItem](docs/UsageByKeyItem.md)
- - [FalaAI::UsageLogItem](docs/UsageLogItem.md)
- - [FalaAI::UsageLogResponse](docs/UsageLogResponse.md)
- - [FalaAI::ValidationError](docs/ValidationError.md)
- - [FalaAI::VersionResponse](docs/VersionResponse.md)
- - [FalaAI::WebhookEvent](docs/WebhookEvent.md)
- - [FalaAI::WebhookItem](docs/WebhookItem.md)
- - [FalaAI::WebhookListResponse](docs/WebhookListResponse.md)
-
-
-## Documentation for Authorization
-
-
-Authentication schemes defined for the API:
-### ApiKeyAuth
-
-- **Type**: Bearer authentication (fai_xxx)
+## Where to integrate (this SDK)
+
+FalaAI is language-independent; this package targets **Ruby** backends.
+
+| Platform / environment (this SDK's language: **Ruby**) | Integration |
+|---|---|
+| **Ruby on Rails** apps | `falaai-api` (Ruby) |
+| Ruby workers / Sidekiq jobs | `falaai-api` (Ruby) |
+| Ruby data pipelines | `falaai-api` (Ruby) |
+| Other stacks (3CX, Salesforce, Genesys...) | REST / cURL — [API reference](https://api01-falaai.action.tec.br/docs) (or the SDK for that backend's language) |
+
+> These are **integration examples**, not certified native integrations. Any platform can integrate through **REST / cURL** — see the [API reference](https://api01-falaai.action.tec.br/docs). Authenticated calls use `Authorization: Bearer fai_<key>`.
+
+## Production usage
+
+- Store API keys in environment variables or a secret manager — never hard-code.
+- Reuse the `ApiClient` across requests.
+- Handle `FalaAI::ApiError` explicitly.
+
+## Compatibility
+
+| Requirement | Version |
+|---|---|
+| Ruby | 2.7+ |
+| API | v1.21.49 |
+
+## Documentation
+
+- **SDK docs (this language):** <https://actiontecbr.github.io/falaai-api-ruby/>
+- **API reference (Swagger UI):** <https://api01-falaai.action.tec.br/docs>
+- **OpenAPI contract:** <https://api01-falaai.action.tec.br/openapi.json>
+- **Sandbox:** <https://falaai.action.tec.br/api#playground>
+- **Quickstart:** <https://falaai.action.tec.br/api/quickstart>
+- **Product page:** <https://falaai.action.tec.br/api>
+
+## Versioning
+
+Semantic versioning; the SDK version tracks the API version (`1.21.49`). See [CHANGELOG.md](CHANGELOG.md) and [Releases](https://github.com/ActionTecBr/falaai-api-ruby/releases).
+
+## Security
+
+See [SECURITY.md](SECURITY.md). Never commit real keys — use environment variables.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+[MIT](LICENSE).
+
+## Links
 
+- Website: <https://falaai.action.tec.br>
+- API base URL: <https://api01-falaai.action.tec.br>
+- GitHub organization: <https://github.com/ActionTecBr>
+- Other SDKs: Python, Node.js, PHP, Go, Java, .NET.

data/docs/AnalysisApi.md

@@ -1,20 +1,18 @@
 # FalaAI::AnalysisApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *https://api01-falaai.action.tec.br*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**create_auditoria_risco_v1_analyze_auditoria_risco_post**](AnalysisApi.md#create_auditoria_risco_v1_analyze_auditoria_risco_post) | **POST** /v1/analyze/auditoriaRisco | Compliance Risk Audit — conversation compliance analysis |
-| [**create_diagnostic_v1_analyze_diagnostic_post**](AnalysisApi.md#create_diagnostic_v1_analyze_diagnostic_post) | **POST** /v1/analyze/diagnostic | Analyze a call transcript — 5 parallel analyses |
+| [**create_diagnostic_v1_analyze_diagnostic_post**](AnalysisApi.md#create_diagnostic_v1_analyze_diagnostic_post) | **POST** /v1/analyze/diagnostic | Analyze a call transcript — 5 parallel analyses |
+| [**create_risk_audit_v1_analyze_risk_audit_post**](AnalysisApi.md#create_risk_audit_v1_analyze_risk_audit_post) | **POST** /v1/analyze/riskAudit | Compliance Risk Audit — conversation compliance analysis |
 
 
-## create_auditoria_risco_v1_analyze_auditoria_risco_post
-
-> <AuditoriaRiscoV2Response> create_auditoria_risco_v1_analyze_auditoria_risco_post(auditoria_risco_request)
+## create_diagnostic_v1_analyze_diagnostic_post
 
-Compliance Risk Audit — conversation compliance analysis
+> <DiagnosticResponse> create_diagnostic_v1_analyze_diagnostic_post(diagnostic_request)
 
-Analyzes a call transcript for compliance risks. Returns a score (0-100), classification level, violations, positives, and a detailed HTML report.  **Python:** ```python import httpx  response = httpx.post(     'https://api.fala.ai/v1/analyze/auditoriaRisco',     headers={'Authorization': 'Bearer fai_xxx'},     json={         'dialog': 'Speaker 1: [00:00:00.540 - 00:00:01.139] Hi, Alex.',         'duration_seconds': 151.0,         'language': 'pt-BR',         'response_language': 'en-US'     } ) print(response.json()) ```  **cURL:** ```bash curl https://api.fala.ai/v1/analyze/auditoriaRisco \\   -H 'Authorization: Bearer fai_xxx' \\   -H 'Content-Type: application/json' \\   -d '{     \"dialog\": \"Speaker 1: [00:00:00.540 - 00:00:01.139] Hi, Alex.\",     \"duration_seconds\": 151.0,     \"language\": \"pt-BR\",     \"response_language\": \"en-US\"   }' ```
+Analyze a call transcript — 5 parallel analyses
 
 ### Examples
 
@@ -28,32 +26,32 @@ FalaAI.configure do |config|
 end
 
 api_instance = FalaAI::AnalysisApi.new
-auditoria_risco_request = FalaAI::AuditoriaRiscoRequest.new({duration_seconds: 3.56, language: 'pt-BR', response_language: 'en-US'}) # AuditoriaRiscoRequest | 
+diagnostic_request = FalaAI::DiagnosticRequest.new({language: 'language_example', duration_seconds: 3.56}) # DiagnosticRequest | 
 
 begin
-  # Compliance Risk Audit — conversation compliance analysis
-  result = api_instance.create_auditoria_risco_v1_analyze_auditoria_risco_post(auditoria_risco_request)
+  # Analyze a call transcript — 5 parallel analyses
+  result = api_instance.create_diagnostic_v1_analyze_diagnostic_post(diagnostic_request)
   p result
 rescue FalaAI::ApiError => e
-  puts "Error when calling AnalysisApi->create_auditoria_risco_v1_analyze_auditoria_risco_post: #{e}"
+  puts "Error when calling AnalysisApi->create_diagnostic_v1_analyze_diagnostic_post: #{e}"
 end
 ```
 
-#### Using the create_auditoria_risco_v1_analyze_auditoria_risco_post_with_http_info variant
+#### Using the create_diagnostic_v1_analyze_diagnostic_post_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<AuditoriaRiscoV2Response>, Integer, Hash)> create_auditoria_risco_v1_analyze_auditoria_risco_post_with_http_info(auditoria_risco_request)
+> <Array(<DiagnosticResponse>, Integer, Hash)> create_diagnostic_v1_analyze_diagnostic_post_with_http_info(diagnostic_request)
 
 ```ruby
 begin
-  # Compliance Risk Audit — conversation compliance analysis
-  data, status_code, headers = api_instance.create_auditoria_risco_v1_analyze_auditoria_risco_post_with_http_info(auditoria_risco_request)
+  # Analyze a call transcript — 5 parallel analyses
+  data, status_code, headers = api_instance.create_diagnostic_v1_analyze_diagnostic_post_with_http_info(diagnostic_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <AuditoriaRiscoV2Response>
+  p data # => <DiagnosticResponse>
 rescue FalaAI::ApiError => e
-  puts "Error when calling AnalysisApi->create_auditoria_risco_v1_analyze_auditoria_risco_post_with_http_info: #{e}"
+  puts "Error when calling AnalysisApi->create_diagnostic_v1_analyze_diagnostic_post_with_http_info: #{e}"
 end
 ```
 
@@ -61,11 +59,11 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **auditoria_risco_request** | [**AuditoriaRiscoRequest**](AuditoriaRiscoRequest.md) |  |  |
+| **diagnostic_request** | [**DiagnosticRequest**](DiagnosticRequest.md) |  |  |
 
 ### Return type
 
-[**AuditoriaRiscoV2Response**](AuditoriaRiscoV2Response.md)
+[**DiagnosticResponse**](DiagnosticResponse.md)
 
 ### Authorization
 
@@ -77,13 +75,11 @@ end
 - **Accept**: application/json
 
 
-## create_diagnostic_v1_analyze_diagnostic_post
-
-> <DiagnosticResponse> create_diagnostic_v1_analyze_diagnostic_post(diagnostic_request)
+## create_risk_audit_v1_analyze_risk_audit_post
 
-Analyze a call transcript — 5 parallel analyses
+> <RiskAuditV2Response> create_risk_audit_v1_analyze_risk_audit_post(risk_audit_request)
 
-Runs 5 independent analyses on a call transcript: dialogue summary, contact reason, identified action, label classification, and sentiment.  **Python:** ```python import httpx  response = httpx.post(     'https://api.fala.ai/v1/analyze/diagnostic',     headers={'Authorization': 'Bearer fai_xxx'},     json={         'dialog': 'Speaker 1: [00:00:00.540 - 00:00:01.139] Hi, Alex.',         'language': 'pt-BR',         'duration_seconds': 151.0     } ) print(response.json()) ```  **cURL:** ```bash curl https://api.fala.ai/v1/analyze/diagnostic \\   -H 'Authorization: Bearer fai_xxx' \\   -H 'Content-Type: application/json' \\   -d '{     \"dialog\": \"Speaker 1: [00:00:00.540 - 00:00:01.139] Hi, Alex.\",     \"language\": \"pt-BR\",     \"duration_seconds\": 151.0   }' ```
+Compliance Risk Audit — conversation compliance analysis
 
 ### Examples
 
@@ -97,32 +93,32 @@ FalaAI.configure do |config|
 end
 
 api_instance = FalaAI::AnalysisApi.new
-diagnostic_request = FalaAI::DiagnosticRequest.new({language: 'pt-BR', duration_seconds: 3.56}) # DiagnosticRequest | 
+risk_audit_request = FalaAI::RiskAuditRequest.new({duration_seconds: 3.56, language: 'language_example', response_language: 'response_language_example'}) # RiskAuditRequest | 
 
 begin
-  # Analyze a call transcript — 5 parallel analyses
-  result = api_instance.create_diagnostic_v1_analyze_diagnostic_post(diagnostic_request)
+  # Compliance Risk Audit — conversation compliance analysis
+  result = api_instance.create_risk_audit_v1_analyze_risk_audit_post(risk_audit_request)
   p result
 rescue FalaAI::ApiError => e
-  puts "Error when calling AnalysisApi->create_diagnostic_v1_analyze_diagnostic_post: #{e}"
+  puts "Error when calling AnalysisApi->create_risk_audit_v1_analyze_risk_audit_post: #{e}"
 end
 ```
 
-#### Using the create_diagnostic_v1_analyze_diagnostic_post_with_http_info variant
+#### Using the create_risk_audit_v1_analyze_risk_audit_post_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<DiagnosticResponse>, Integer, Hash)> create_diagnostic_v1_analyze_diagnostic_post_with_http_info(diagnostic_request)
+> <Array(<RiskAuditV2Response>, Integer, Hash)> create_risk_audit_v1_analyze_risk_audit_post_with_http_info(risk_audit_request)
 
 ```ruby
 begin
-  # Analyze a call transcript — 5 parallel analyses
-  data, status_code, headers = api_instance.create_diagnostic_v1_analyze_diagnostic_post_with_http_info(diagnostic_request)
+  # Compliance Risk Audit — conversation compliance analysis
+  data, status_code, headers = api_instance.create_risk_audit_v1_analyze_risk_audit_post_with_http_info(risk_audit_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <DiagnosticResponse>
+  p data # => <RiskAuditV2Response>
 rescue FalaAI::ApiError => e
-  puts "Error when calling AnalysisApi->create_diagnostic_v1_analyze_diagnostic_post_with_http_info: #{e}"
+  puts "Error when calling AnalysisApi->create_risk_audit_v1_analyze_risk_audit_post_with_http_info: #{e}"
 end
 ```
 
@@ -130,11 +126,11 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **diagnostic_request** | [**DiagnosticRequest**](DiagnosticRequest.md) |  |  |
+| **risk_audit_request** | [**RiskAuditRequest**](RiskAuditRequest.md) |  |  |
 
 ### Return type
 
-[**DiagnosticResponse**](DiagnosticResponse.md)
+[**RiskAuditV2Response**](RiskAuditV2Response.md)
 
 ### Authorization
 

data/docs/AudioEvent.md

@@ -16,11 +16,11 @@
 require 'falaai-api'
 
 instance = FalaAI::AudioEvent.new(
-  event: [suspiro],
-  start_s: 75.42,
-  end_s: 75.43,
-  duration_s: 0.01,
-  formatted_timestamp: 00:01:15.420
+  event: null,
+  start_s: null,
+  end_s: null,
+  duration_s: null,
+  formatted_timestamp: null
 )
 ```
 

data/docs/AudioInputMeta.md

@@ -16,11 +16,11 @@
 require 'falaai-api'
 
 instance = FalaAI::AudioInputMeta.new(
-  duration_s: 151.04,
-  original_format: wav,
-  codec: pcm_s16le,
-  sample_rate: 44100,
-  channels: 2
+  duration_s: null,
+  original_format: null,
+  codec: null,
+  sample_rate: null,
+  channels: null
 )
 ```
 

data/docs/CreateEmailAlertRequest.md

@@ -14,9 +14,9 @@
 require 'falaai-api'
 
 instance = FalaAI::CreateEmailAlertRequest.new(
-  name: Financeiro,
-  email: finance@empresa.com,
-  events: [payment.failed, subscription.renewed]
+  name: null,
+  email: null,
+  events: null
 )
 ```