falaai-api 1.21.48 → 1.21.51

data/docs/WhatsappApi.md

@@ -0,0 +1,93 @@
+# FalaAI::WhatsappApi
+
+All URIs are relative to *https://api01-falaai.action.tec.br*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**extract_conversations_v1_whatsapp_extract_conversations_post**](WhatsappApi.md#extract_conversations_v1_whatsapp_extract_conversations_post) | **POST** /v1/whatsapp/extractConversations | Extract and segment WhatsApp conversations from an export |
+
+
+## extract_conversations_v1_whatsapp_extract_conversations_post
+
+> <WhatsappConversationsResponse> extract_conversations_v1_whatsapp_extract_conversations_post(file, start, _end, timezone, date_format, opts)
+
+Extract and segment WhatsApp conversations from an export
+
+### Examples
+
+```ruby
+require 'time'
+require 'falaai-api'
+# setup authorization
+FalaAI.configure do |config|
+  # Configure Bearer authorization (fai_xxx): ApiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = FalaAI::WhatsappApi.new
+file = File.new('/path/to/some/file') # File | 
+start = 'start_example' # String | 
+_end = '_end_example' # String | 
+timezone = 'timezone_example' # String | 
+date_format = 'date_format_example' # String | 
+opts = {
+  gap_minutes: 8.14, # Float | 
+  min_messages: 56, # Integer | 
+  chars_per_minute: 8.14, # Float | 
+  client_reference_id: 'client_reference_id_example' # String | 
+}
+
+begin
+  # Extract and segment WhatsApp conversations from an export
+  result = api_instance.extract_conversations_v1_whatsapp_extract_conversations_post(file, start, _end, timezone, date_format, opts)
+  p result
+rescue FalaAI::ApiError => e
+  puts "Error when calling WhatsappApi->extract_conversations_v1_whatsapp_extract_conversations_post: #{e}"
+end
+```
+
+#### Using the extract_conversations_v1_whatsapp_extract_conversations_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WhatsappConversationsResponse>, Integer, Hash)> extract_conversations_v1_whatsapp_extract_conversations_post_with_http_info(file, start, _end, timezone, date_format, opts)
+
+```ruby
+begin
+  # Extract and segment WhatsApp conversations from an export
+  data, status_code, headers = api_instance.extract_conversations_v1_whatsapp_extract_conversations_post_with_http_info(file, start, _end, timezone, date_format, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WhatsappConversationsResponse>
+rescue FalaAI::ApiError => e
+  puts "Error when calling WhatsappApi->extract_conversations_v1_whatsapp_extract_conversations_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file** | **File** |  |  |
+| **start** | **String** |  |  |
+| **_end** | **String** |  |  |
+| **timezone** | **String** |  |  |
+| **date_format** | **String** |  |  |
+| **gap_minutes** | **Float** |  | [optional][default to 720] |
+| **min_messages** | **Integer** |  | [optional][default to 2] |
+| **chars_per_minute** | **Float** |  | [optional][default to 800] |
+| **client_reference_id** | **String** |  | [optional] |
+
+### Return type
+
+[**WhatsappConversationsResponse**](WhatsappConversationsResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: application/json
+

data/docs/WhatsappConversation.md

@@ -0,0 +1,32 @@
+# FalaAI::WhatsappConversation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_id** | **String** | Conversation identifier in the batch |  |
+| **first_at** | **String** | Real start (wall-clock, ISO) |  |
+| **last_at** | **String** | Real end (wall-clock, ISO) |  |
+| **duration_seconds** | **Float** | (last - first) + last turn duration |  |
+| **speakers** | [**Array<WhatsappSpeaker>**](WhatsappSpeaker.md) | Speakers of THIS conversation (dynamic) |  |
+| **dialog** | **String** | Lines 'Speaker N: [HH:MM:SS.mmm - HH:MM:SS.mmm] text' (real offset) |  |
+| **message_count** | **Integer** | Number of messages |  |
+| **characters** | **Integer** | Total characters of the conversation |  |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::WhatsappConversation.new(
+  conversation_id: null,
+  first_at: null,
+  last_at: null,
+  duration_seconds: null,
+  speakers: null,
+  dialog: null,
+  message_count: null,
+  characters: null
+)
+```
+

data/docs/WhatsappConversationsResponse.md

@@ -0,0 +1,28 @@
+# FalaAI::WhatsappConversationsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier. Prefix 'wc-' + UUID |  |
+| **object** | **String** | Object type. Always 'conversations' |  |
+| **usage** | [**WhatsappUsage**](WhatsappUsage.md) | Usage and processing information |  |
+| **conversations** | [**Array<WhatsappConversation>**](WhatsappConversation.md) | Segmented conversations |  |
+| **client_reference_id** | **String** | Client-supplied ID echoed verbatim (if provided) | [optional] |
+| **meta** | [**WhatsappMeta**](WhatsappMeta.md) | Segmentation parameters and counts |  |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::WhatsappConversationsResponse.new(
+  id: null,
+  object: null,
+  usage: null,
+  conversations: null,
+  client_reference_id: null,
+  meta: null
+)
+```
+

data/docs/WhatsappMeta.md

@@ -0,0 +1,48 @@
+# FalaAI::WhatsappMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file** | **String** | Uploaded file name |  |
+| **chat_txt** | **String** | chat.txt entry name inside the export |  |
+| **format** | **String** | Detected format: Android | iOS |  |
+| **date_format** | **String** | Date order used |  |
+| **timezone** | **String** | Timezone informed |  |
+| **start** | **String** | Window start (ISO) |  |
+| **_end** | **String** | Window end (ISO) |  |
+| **gap_minutes** | **Float** | Gap used to split conversations |  |
+| **min_messages** | **Integer** | Minimum messages per conversation |  |
+| **chars_per_minute** | **Float** | Chars per minute used to estimate duration |  |
+| **turns** | **Integer** | Total parsed turns |  |
+| **system_lines** | **Integer** | System lines ignored |  |
+| **conversations_total** | **Integer** | Conversations before window filter |  |
+| **conversations_in_window** | **Integer** | Conversations overlapping the window |  |
+| **monologues_dropped** | **Integer** | Single-speaker conversations dropped |  |
+| **conversations_selected** | **Integer** | Final conversations returned |  |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::WhatsappMeta.new(
+  file: null,
+  chat_txt: null,
+  format: null,
+  date_format: null,
+  timezone: null,
+  start: null,
+  _end: null,
+  gap_minutes: null,
+  min_messages: null,
+  chars_per_minute: null,
+  turns: null,
+  system_lines: null,
+  conversations_total: null,
+  conversations_in_window: null,
+  monologues_dropped: null,
+  conversations_selected: null
+)
+```
+

data/docs/WhatsappSpeaker.md

@@ -0,0 +1,20 @@
+# FalaAI::WhatsappSpeaker
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **label** | **String** | Speaker label (e.g. 'Speaker 1') |  |
+| **name** | **String** | Participant name from the export |  |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::WhatsappSpeaker.new(
+  label: null,
+  name: null
+)
+```
+

data/docs/WhatsappUsage.md

@@ -0,0 +1,24 @@
+# FalaAI::WhatsappUsage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversations** | **Integer** | Number of conversations returned |  |
+| **characters** | **Integer** | Total characters across conversations |  |
+| **credits_consumed** | **Integer** | Credits consumed (1 per conversation) |  |
+| **processing_ms** | **Integer** | Total processing time in milliseconds |  |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::WhatsappUsage.new(
+  conversations: null,
+  characters: null,
+  credits_consumed: null,
+  processing_ms: null
+)
+```
+