tavus 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8abebe116a50edbe96292bcedc7a3594eab176057beba78b51b87040df69c56
-  data.tar.gz: 7009d1905a0e5ed9bd768913acfd04f6ac0902ea412497e4534a293e5b8ab10c
+  metadata.gz: c039f30c7780c7779cf62ebab8ba14a93804219d34b6142107597f72c7b3648e
+  data.tar.gz: 06ad9b3b7220bc5d4310ffa39fdab1fb09c867d93736aca4915d3f29736b80ed
 SHA512:
-  metadata.gz: b98ef18d21ee6fbbf469c3ca2218326a7f81463ffba244f347ad6143d36e45ae1ab26aaaf2caf3331d3d47712da3f4312af3fa0588d06227f1aa422064b4e2ca
-  data.tar.gz: b516b9b900af933c7b28b5c04878f6898473086eb72d4ba03695dbc88c92333c16c849aacc2a960b4c468c3c34469ddab55b622c99cb0fd8669b864f94eb3277
+  metadata.gz: 71ac4bdf23f3f45455038616600b6d82c6bb9c8e3773ab767c7a0d4452050f85161479c98a00e129f2a5722cba0642a3708b29b707c25f41ad804a713905907d
+  data.tar.gz: 81f62d1e52cbb1969342046a8c108ae57a91ceb54ed1c4d55c0e3fdaa7f5a8158b9535d1fff1840730f5fb7b1fa24b0a1857d2a61a5ee0993ada72e78df4cbdf

data/CHANGELOG.md

@@ -10,49 +10,90 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Initial release of Tavus Ruby client
-- Support for Conversations API endpoints:
-  - Create conversation
-  - Get conversation
-  - List conversations
-  - End conversation
-  - Delete conversation
-- Support for Personas API endpoints:
-  - Create persona
-  - Get persona
-  - List personas
-  - Patch persona (JSON Patch operations)
-  - Delete persona
-- Support for Replicas API endpoints:
-  - Create replica
-  - Get replica
-  - List replicas
-  - Rename replica
-  - Delete replica
-- Support for Objectives API endpoints:
-  - Create objectives
-  - Get objective
-  - List objectives
-  - Patch objective (JSON Patch operations)
-  - Delete objective
-- Support for Guardrails API endpoints:
-  - Create guardrails
-  - Get guardrails
-  - List guardrails
-  - Patch guardrails (JSON Patch operations)
+- Full coverage of Tavus API v2 endpoints
+
+- **Conversations Management**:
+  - Create conversation with replica and persona
+  - Get conversation details by ID
+  - List conversations with pagination and filtering
+  - End active conversations
+  - Delete conversations
+  - Support for audio-only mode, custom greetings, conversational context
+  - Document integration with IDs, tags, and retrieval strategies
+  - Memory stores and callback webhooks
+
+- **Personas Management**:
+  - Create personas with system prompts and pipeline modes
+  - Get persona details by ID
+  - List personas with pagination and filtering
+  - Update personas using JSON Patch operations (RFC 6902)
+  - Delete personas
+  - Helper methods for building patch operations and updating single fields
+  - Full support for perception, STT, LLM, and TTS layer configuration
+  - Custom tool/function integration support
+
+- **Replicas Management**:
+  - Create replicas from training videos
+  - Get replica details with optional verbose mode
+  - List replicas with pagination and filtering
+  - Rename replicas
+  - Delete replicas (soft and hard delete)
+  - Support for consent videos and custom model selection
+
+- **Objectives Management**:
+  - Create conversation objectives
+  - Get objective details by ID
+  - List objectives with pagination
+  - Update objectives using JSON Patch operations
+  - Delete objectives
+  - Helper methods for patch operations
+
+- **Guardrails Management**:
+  - Create guardrails for behavioral control
+  - Get guardrails details by ID
+  - List guardrails with pagination
+  - Update guardrails using JSON Patch operations
   - Delete guardrails
-- Support for Documents (Knowledge Base) API endpoints:
-  - Create document
-  - Get document
-  - List documents
-  - Update document
-  - Delete document
-- Support for Video Generation API endpoints:
-  - Generate video from text
-  - Generate video from audio
-  - Get video
-  - List videos
-  - Rename video
-  - Delete video
-- Configuration management for API key and base URL
-- Comprehensive error handling
-- Full API documentation in README
+  - Callback webhook support
+
+- **Knowledge Base (Documents)**:
+  - Upload documents from URLs
+  - Get document details by ID
+  - List documents with pagination, sorting, and filtering
+  - Update document metadata (name and tags)
+  - Delete documents
+  - Support for multiple file formats (.pdf, .txt, .docx, .doc, .png, .jpg, .pptx, .csv, .xlsx)
+  - Website snapshot support
+  - Tag-based organization and search
+
+- **Video Generation**:
+  - Generate videos from text scripts
+  - Generate videos from audio files
+  - Get video details with optional verbose mode
+  - List videos with pagination
+  - Rename videos
+  - Delete videos (soft and hard delete)
+  - Advanced options: fast rendering, transparent backgrounds, custom backgrounds, watermarks
+
+- **Configuration**:
+  - Global configuration via `Tavus.configure`
+  - Per-instance configuration
+  - Configurable API key, base URL, and timeout
+
+- **Error Handling**:
+  - Comprehensive error classes for different HTTP status codes
+  - `AuthenticationError` (401)
+  - `BadRequestError` (400)
+  - `NotFoundError` (404)
+  - `ValidationError` (422)
+  - `RateLimitError` (429)
+  - `ServerError` (5xx)
+  - `ApiError` (generic API errors)
+  - `ConfigurationError` (configuration issues)
+
+- **Documentation**:
+  - Complete README with usage examples
+  - API reference tables
+  - Error handling guide
+  - Configuration examples
+  - Code examples for all endpoints

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tavus (0.1.0)
+    tavus (0.1.1)
       json (~> 2.0)
 
 GEM

data/README.md

@@ -67,6 +67,11 @@ client = Tavus::Client.new(
 
 ## Usage
 
+For more comprehensive examples, check the [examples/](examples/) directory:
+- [basic_usage.rb](examples/basic_usage.rb) - Basic operations with personas and conversations
+- [advanced_persona.rb](examples/advanced_persona.rb) - Advanced persona configuration with custom layers
+- [complete_workflow.rb](examples/complete_workflow.rb) - End-to-end workflow including replicas, documents, objectives, guardrails, and videos
+
 ### Conversations
 
 #### Create a Conversation
@@ -102,8 +107,8 @@ conversation = client.conversations.create(
 #   "conversation_name" => "Interview User",
 #   "status" => "active",
 #   "conversation_url" => "https://tavus.daily.co/c123456",
-#   "replica_id" => "r79e1c033f",
-#   "persona_id" => "p5317866",
+#   "replica_id" => "rfe12d8b9597",
+#   "persona_id" => "pdced222244b",
 #   "created_at" => "2025-10-04T12:00:00Z"
 # }
 ```
@@ -706,6 +711,40 @@ end
 | `rename(video_id, video_name)` | Rename a video |
 | `delete(video_id, hard: false)` | Delete a video |
 
+## JSON Patch Operations
+
+Several resources (Personas, Objectives, and Guardrails) support updates via JSON Patch operations following [RFC 6902](https://tools.ietf.org/html/rfc6902). This allows for precise, atomic updates to specific fields.
+
+### Supported Operations
+
+- `add`: Add a new field or array element
+- `remove`: Remove a field or array element
+- `replace`: Replace an existing field value
+- `copy`: Copy a value from one location to another
+- `move`: Move a value from one location to another
+- `test`: Test that a value at a location equals a specified value
+
+### Examples
+
+```ruby
+# Replace a single field
+operations = [
+  { op: 'replace', path: '/persona_name', value: 'New Name' }
+]
+
+# Multiple operations in one request
+operations = [
+  { op: 'replace', path: '/persona_name', value: 'Updated Name' },
+  { op: 'add', path: '/layers/tts/tts_emotion_control', value: 'true' },
+  { op: 'remove', path: '/layers/stt/hotwords' }
+]
+
+# Update nested fields
+operations = [
+  { op: 'replace', path: '/layers/llm/model', value: 'tavus-gpt-4o' }
+]
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -720,11 +759,9 @@ This project uses GitHub Actions for continuous integration:
 - **Linting**: RuboCop style checking
 - **Security**: Bundle audit for dependency vulnerabilities
 
-[![CI](https://github.com/upriser/tavus/actions/workflows/ci.yml/badge.svg)](https://github.com/upriser/tavus/actions/workflows/ci.yml)
-
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/upriser/tavus.
+Bug reports and pull requests are welcome on GitHub at https://github.com/vbrazo/tavus.
 
 ## License
 
@@ -734,3 +771,8 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 - [Tavus API Documentation](https://docs.tavus.io)
 - [Tavus Developer Portal](https://platform.tavus.io)
+- [GitHub Repository](https://github.com/vbrazo/tavus)
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for a detailed list of changes and version history.

data/lib/tavus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tavus
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tavus
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Vitor Oliveira
@@ -108,8 +108,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.21'
-description: A Ruby gem for interacting with the Tavus Conversational Video Interface
-  API, supporting conversations and personas management.
+description: A Ruby gem for interacting with the Tavus API. Provides full support
+  for Conversational Video Interfaces (CVI), including conversations, personas, replicas,
+  objectives, guardrails, knowledge base documents, and video generation.
 email:
 - vbrazo@gmail.com
 executables: []