perplexity_api 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1fb38e349b1dec664c558b497eb1cfebb13db32a2dfe8b73235c67d1d60a8da
-  data.tar.gz: 65c6e01e0fc38d3709b74928931804a1cd2894c5c1e2f1229f2efa12347c2a24
+  metadata.gz: 4f134dd6fd6ac47f11b94ed74f4a6c361de0859a73b7845c9c642769e4e340b0
+  data.tar.gz: b0e6576ed1173b6702d6382d2711f34b8ddae1570b2a793a19a216744b330ec1
 SHA512:
-  metadata.gz: cbf92894516bd532e9027e64d100d98559610d14f879d4e6e346998d3adf85ba5f4dbc3c108db9c62773dd8a935ddd95df6c2e1c75fabc3ccd1efe8c85e3fd2d
-  data.tar.gz: 5cb07fc82fad69e9f4c0b483db88e6f010250360f9aff30ab3e02152dd28eb6d9a08a901f98ae066b3eeddf1aa9c860060fe0cdbfaba00d0263073ec41ce6043
+  metadata.gz: f891118c6640903373100e66654c59c15900eb36d4ed3d7c6b428e4c624b81d9930bd6b7569f39d1255753edf58acf664e57adbf80e92efe10bf189449b2586d
+  data.tar.gz: '0097f6120b11a3ddde782cd0673bb4442a9c45f7e308f16363821ed9ae11b0a455191712e7c2cf8813498271d6bad826cef22e930cee822d7338c7bb44f11186'

data/{.env.sample → .env.example}

@@ -7,4 +7,6 @@ PERPLEXITY_API_KEY=your_api_key_here
 # PERPLEXITY_TEMPERATURE=0.7
 # PERPLEXITY_MAX_TOKENS=1024
 # PERPLEXITY_TOP_P=0.9
-# PERPLEXITY_TOP_K=0
+# PERPLEXITY_TOP_K=0
+# PERPLEXITY_FREQUENCY_PENALTY=0.0
+# PERPLEXITY_PRESENCE_PENALTY=0.0

data/.gitignore

@@ -55,3 +55,7 @@ build-iPhoneSimulator/
 
 # Used by RuboCop. Remote config files pulled in from inherit_from directive.
 # .rubocop-https?--*
+/docs/
+.rspec_status
+
+test_*

data/CHANGELOG.md

@@ -0,0 +1,42 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.3.0] - 2025-01-07
+
+### Added
+- Streaming support via `StreamClient` class for real-time responses
+- Web search capabilities with `search_mode` parameter (web/academic)
+- Domain filtering with `search_domain_filter` (include/exclude domains)
+- Date filtering with `search_after_date_filter` and `search_before_date_filter`
+- Recency filtering with `search_recency_filter` (month/week/day/hour)
+- Location-based search with `web_search_options`
+- Support for new models: sonar-pro, sonar-deep-research
+- Full conversation history support with messages array
+- New parameters: `frequency_penalty` and `presence_penalty`
+- Beta features: `return_images` and `return_related_questions`
+- Model constants in `PerplexityApi::Models`
+- Helper methods: `stream`, `stream_chat`
+- Comprehensive examples directory
+
+### Changed
+- `chat` method now accepts both string and array of messages
+- `chat` method accepts options parameter for per-request configuration
+- Updated default configuration to include new penalty parameters
+
+### Fixed
+- Improved error handling for streaming responses
+
+## [0.2.1] - Previous version
+
+### Fixed
+- Environment variable loading issues
+- Configuration management improvements
+
+## [0.1.0] - Initial release
+
+### Added
+- Basic chat functionality
+- Configuration management
+- Environment variable support
+- Basic parameter support (temperature, max_tokens, top_p, top_k)

data/Gemfile.lock

@@ -1,14 +1,13 @@
 PATH
   remote: .
   specs:
-    perplexity_api (0.1.1)
+    perplexity_api (0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.6.1)
-    dotenv (2.8.1)
-    rake (10.5.0)
+    rake (13.3.0)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -27,11 +26,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
-  dotenv (~> 2.7)
+  bundler (~> 2.0)
   perplexity_api!
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.17.2
+   2.6.9

data/README.md

@@ -1,12 +1,19 @@
 # PerplexityApi
+[![Gem Version](https://badge.fury.io/rb/perplexity_api.svg?v=0.2.1)](https://badge.fury.io/rb/perplexity_api)
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.txt)
 
 A Ruby wrapper gem for Perplexity AI's API. This gem allows you to easily integrate Perplexity AI's powerful language models into your Ruby applications.
 
 ## Features
 
 - API key can be configured externally
-- Ability to select the latest models
+- Support for all latest Perplexity models including sonar-pro and sonar-deep-research
 - Simple interface to send messages and get results
+- Streaming support for real-time responses
+- Web search capabilities with domain filtering and date filters
+- Conversation history support with full messages array
+- Advanced search features including location-based search
+- Beta features: image results and related questions
 - Options can be customized or use defaults
 
 ## Installation
@@ -54,13 +61,10 @@ PERPLEXITY_TOP_P=0.9
 PERPLEXITY_TOP_K=0
 ```
 
-If you're using the dotenv gem in your application, you can load these variables from a `.env` file:
+You can set these environment variables in your application's environment or use a method of your choice to load them from a `.env` file.
 
 ```ruby
-require 'dotenv'
-Dotenv.load  # Load environment variables from .env file
-
-# Then use the PerplexityApi gem
+# After setting environment variables, use the PerplexityApi gem
 require 'perplexity_api'
 ```
 
@@ -86,6 +90,21 @@ response = PerplexityApi.chat("Hello, Perplexity AI!")
 puts response["choices"][0]["message"]["content"]
 ```
 
+### Conversation History
+
+You can maintain conversation context by passing an array of messages:
+
+```ruby
+messages = [
+  { role: "system", content: "You are a helpful assistant." },
+  { role: "user", content: "What is the capital of France?" },
+  { role: "assistant", content: "The capital of France is Paris." },
+  { role: "user", content: "What is its population?" }
+]
+
+response = PerplexityApi.chat(messages)
+```
+
 ### Using a Client Instance
 
 For more detailed control, you can create a client instance:
@@ -98,7 +117,10 @@ client = PerplexityApi.new(
     temperature: 0.5,
     max_tokens: 2048,
     top_p: 0.9,
-    top_k: 0
+    top_k: 0,
+    frequency_penalty: 0.1,
+    presence_penalty: 0.1,
+    search_mode: "web"
   }
 )
 
@@ -106,8 +128,106 @@ response = client.chat("Enter your complex question here...")
 puts response["choices"][0]["message"]["content"]
 ```
 
+### Streaming Responses
+
+For real-time streaming responses:
+
+```ruby
+PerplexityApi.stream_chat("Tell me about Ruby programming") do |chunk|
+  print chunk["choices"][0]["delta"]["content"] if chunk["choices"][0]["delta"]["content"]
+end
+```
+
+Or with a client instance:
+
+```ruby
+client = PerplexityApi.stream
+client.chat("Explain quantum computing") do |chunk|
+  # Process each chunk as it arrives
+end
+```
+
+### Web Search Features
+
+Enable web search with specific filters:
+
+```ruby
+response = PerplexityApi.chat(
+  "What are the latest developments in AI?",
+  options: {
+    search_mode: "web",
+    search_domain_filter: ["arxiv.org", "nature.com", "-reddit.com"],
+    search_recency_filter: "week"
+  }
+)
+```
+
+### Advanced Search Options
+
+Use date filters and location-based search:
+
+```ruby
+response = PerplexityApi.chat(
+  "Find research papers on climate change",
+  options: {
+    search_mode: "academic",
+    search_after_date_filter: "01/01/2024",
+    search_before_date_filter: "12/31/2024",
+    web_search_options: {
+      search_context_size: "high",
+      user_location: {
+        country: "US",
+        latitude: 37.7749,
+        longitude: -122.4194
+      }
+    }
+  }
+)
+```
+
+### Beta Features
+
+Enable image results and related questions (closed beta):
+
+```ruby
+response = PerplexityApi.chat(
+  "Show me images of the Eiffel Tower",
+  options: {
+    return_images: true,
+    return_related_questions: true
+  }
+)
+
+# Access images if available
+if response["images"]
+  response["images"].each do |image|
+    puts "Image URL: #{image["url"]}"
+  end
+end
+
+# Access related questions
+if response["related_questions"]
+  puts "Related questions:"
+  response["related_questions"].each { |q| puts "- #{q}" }
+end
+```
+
 ## Models
 
+The gem includes constants for all available models:
+
+```ruby
+# Current Sonar Models
+PerplexityApi::Models::SONAR              # "sonar"
+PerplexityApi::Models::SONAR_PRO          # "sonar-pro"
+PerplexityApi::Models::SONAR_DEEP_RESEARCH # "sonar-deep-research"
+
+# Other Models
+PerplexityApi::Models::LLAMA_3_1_70B_INSTRUCT  # "llama-3.1-70b-instruct"
+PerplexityApi::Models::MISTRAL_7B              # "mistral-7b"
+PerplexityApi::Models::CODELLAMA_34B           # "codellama-34b"
+```
+
 For the most up-to-date list of models, refer to the [Perplexity AI official documentation](https://docs.perplexity.ai/guides/model-cards).
 
 ## Development

data/examples/basic_usage.rb

@@ -0,0 +1,25 @@
+require 'perplexity_api'
+
+# Basic chat
+puts "=== Basic Chat ==="
+response = PerplexityApi.chat("What is Ruby programming language?")
+puts response["choices"][0]["message"]["content"]
+puts
+
+# Chat with options
+puts "=== Chat with Custom Options ==="
+response = PerplexityApi.chat(
+  "Tell me about the benefits of Ruby",
+  options: {
+    temperature: 0.3,
+    max_tokens: 500
+  }
+)
+puts response["choices"][0]["message"]["content"]
+puts
+
+# Using specific model
+puts "=== Using Sonar Pro Model ==="
+client = PerplexityApi.new(model: PerplexityApi::Models::SONAR_PRO)
+response = client.chat("What are the latest features in Ruby 3.3?")
+puts response["choices"][0]["message"]["content"]

data/examples/conversation.rb

@@ -0,0 +1,34 @@
+require 'perplexity_api'
+
+# Multi-turn conversation
+puts "=== Multi-turn Conversation ==="
+
+messages = [
+  { role: "system", content: "You are a helpful Ruby programming expert." },
+  { role: "user", content: "What is a Ruby gem?" }
+]
+
+# First response
+response = PerplexityApi.chat(messages)
+assistant_message = response["choices"][0]["message"]["content"]
+puts "User: What is a Ruby gem?"
+puts "Assistant: #{assistant_message}"
+puts
+
+# Add assistant response to conversation
+messages << { role: "assistant", content: assistant_message }
+messages << { role: "user", content: "How do I create my own gem?" }
+
+# Second response
+response = PerplexityApi.chat(messages)
+puts "User: How do I create my own gem?"
+puts "Assistant: #{response["choices"][0]["message"]["content"]}"
+puts
+
+# Continue the conversation
+messages << { role: "assistant", content: response["choices"][0]["message"]["content"] }
+messages << { role: "user", content: "What about publishing it to RubyGems?" }
+
+response = PerplexityApi.chat(messages)
+puts "User: What about publishing it to RubyGems?"
+puts "Assistant: #{response["choices"][0]["message"]["content"]}"

data/examples/streaming.rb

@@ -0,0 +1,26 @@
+require 'perplexity_api'
+
+# Basic streaming
+puts "=== Basic Streaming ==="
+PerplexityApi.stream_chat("Write a haiku about programming") do |chunk|
+  if chunk["choices"] && chunk["choices"][0]["delta"]["content"]
+    print chunk["choices"][0]["delta"]["content"]
+  end
+end
+puts "\n"
+
+# Streaming with web search
+puts "\n=== Streaming with Web Search ==="
+client = PerplexityApi.stream(
+  options: {
+    search_mode: "web",
+    search_recency_filter: "day"
+  }
+)
+
+client.chat("What happened in tech news today?") do |chunk|
+  if chunk["choices"] && chunk["choices"][0]["delta"]["content"]
+    print chunk["choices"][0]["delta"]["content"]
+  end
+end
+puts "\n"

data/examples/web_search.rb

@@ -0,0 +1,45 @@
+require 'perplexity_api'
+
+# Web search with domain filtering
+puts "=== Web Search with Domain Filtering ==="
+response = PerplexityApi.chat(
+  "What are the latest AI research papers?",
+  options: {
+    search_mode: "web",
+    search_domain_filter: ["arxiv.org", "openai.com", "-reddit.com"],
+    search_recency_filter: "week"
+  }
+)
+puts response["choices"][0]["message"]["content"]
+puts
+
+# Academic search
+puts "=== Academic Search ==="
+response = PerplexityApi.chat(
+  "Find recent studies on climate change mitigation",
+  options: {
+    search_mode: "academic",
+    search_after_date_filter: "01/01/2024",
+    search_before_date_filter: "12/31/2024"
+  }
+)
+puts response["choices"][0]["message"]["content"]
+puts
+
+# Location-based search
+puts "=== Location-based Search ==="
+response = PerplexityApi.chat(
+  "What are the best restaurants near me?",
+  options: {
+    search_mode: "web",
+    web_search_options: {
+      search_context_size: "high",
+      user_location: {
+        country: "US",
+        latitude: 37.7749,
+        longitude: -122.4194
+      }
+    }
+  }
+)
+puts response["choices"][0]["message"]["content"]

data/lib/perplexity_api/client.rb

@@ -14,9 +14,12 @@ module PerplexityApi
     end
 
     # Method to send a message and get a response
-    def chat(message)
+    def chat(messages, options = {})
       @config.validate!
       
+      messages = prepare_messages(messages)
+      merged_options = @options.merge(options)
+      
       uri = URI.parse("#{@config.api_base}/chat/completions")
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
@@ -25,14 +28,8 @@ module PerplexityApi
       request["Content-Type"] = "application/json"
       request["Authorization"] = "Bearer #{@config.api_key}"
 
-      request.body = {
-        model: @model,
-        messages: [{ role: "user", content: message }],
-        temperature: @options[:temperature],
-        max_tokens: @options[:max_tokens],
-        top_p: @options[:top_p],
-        top_k: @options[:top_k]
-      }.to_json
+      request_body = build_request_body(messages, merged_options)
+      request.body = request_body.to_json
 
       response = http.request(request)
       
@@ -42,5 +39,56 @@ module PerplexityApi
         raise Error, "API call failed: #{response.code} #{response.body}"
       end
     end
+
+    private
+
+    def prepare_messages(messages)
+      case messages
+      when String
+        [{ role: "user", content: messages }]
+      when Array
+        messages
+      else
+        raise ArgumentError, "Messages must be a string or array"
+      end
+    end
+
+    def build_request_body(messages, options)
+      body = {
+        model: @model,
+        messages: messages
+      }
+
+      # Basic parameters
+      body[:temperature] = options[:temperature] if options[:temperature]
+      body[:max_tokens] = options[:max_tokens] if options[:max_tokens]
+      body[:top_p] = options[:top_p] if options[:top_p]
+      body[:top_k] = options[:top_k] if options[:top_k]
+      body[:frequency_penalty] = options[:frequency_penalty] if options[:frequency_penalty]
+      body[:presence_penalty] = options[:presence_penalty] if options[:presence_penalty]
+      body[:stream] = options[:stream] if options.key?(:stream)
+
+      # Search parameters
+      body[:search_mode] = options[:search_mode] if options[:search_mode]
+      body[:search_domain_filter] = options[:search_domain_filter] if options[:search_domain_filter]
+      body[:search_recency_filter] = options[:search_recency_filter] if options[:search_recency_filter]
+      body[:search_after_date_filter] = options[:search_after_date_filter] if options[:search_after_date_filter]
+      body[:search_before_date_filter] = options[:search_before_date_filter] if options[:search_before_date_filter]
+      body[:last_updated_after_filter] = options[:last_updated_after_filter] if options[:last_updated_after_filter]
+      body[:last_updated_before_filter] = options[:last_updated_before_filter] if options[:last_updated_before_filter]
+
+      # Beta features
+      body[:return_images] = options[:return_images] if options[:return_images]
+      body[:return_related_questions] = options[:return_related_questions] if options[:return_related_questions]
+
+      # Advanced features
+      body[:reasoning_effort] = options[:reasoning_effort] if options[:reasoning_effort]
+      
+      if options[:web_search_options]
+        body[:web_search_options] = options[:web_search_options]
+      end
+
+      body
+    end
   end
 end

data/lib/perplexity_api/configuration.rb

@@ -17,7 +17,9 @@ module PerplexityApi
         temperature: ENV["PERPLEXITY_TEMPERATURE"] ? ENV["PERPLEXITY_TEMPERATURE"].to_f : 0.7,
         max_tokens: ENV["PERPLEXITY_MAX_TOKENS"] ? ENV["PERPLEXITY_MAX_TOKENS"].to_i : 1024,
         top_p: ENV["PERPLEXITY_TOP_P"] ? ENV["PERPLEXITY_TOP_P"].to_f : 0.9,
-        top_k: ENV["PERPLEXITY_TOP_K"] ? ENV["PERPLEXITY_TOP_K"].to_i : 0
+        top_k: ENV["PERPLEXITY_TOP_K"] ? ENV["PERPLEXITY_TOP_K"].to_i : 0,
+        frequency_penalty: ENV["PERPLEXITY_FREQUENCY_PENALTY"] ? ENV["PERPLEXITY_FREQUENCY_PENALTY"].to_f : 0.0,
+        presence_penalty: ENV["PERPLEXITY_PRESENCE_PENALTY"] ? ENV["PERPLEXITY_PRESENCE_PENALTY"].to_f : 0.0
       }
       
       debug_log "Configuration loaded from environment variables"

data/lib/perplexity_api/models.rb

@@ -0,0 +1,44 @@
+module PerplexityApi
+  module Models
+    # Current Sonar Models
+    SONAR = "sonar"
+    SONAR_PRO = "sonar-pro"
+    SONAR_DEEP_RESEARCH = "sonar-deep-research"
+    
+    # Legacy Models
+    LLAMA_3_1_SONAR_SMALL_128K_CHAT = "llama-3.1-sonar-small-128k-chat"
+    LLAMA_3_1_SONAR_LARGE_128K_CHAT = "llama-3.1-sonar-large-128k-chat"
+    LLAMA_3_1_70B_INSTRUCT = "llama-3.1-70b-instruct"
+    LLAMA_3_1_8B_INSTRUCT = "llama-3.1-8b-instruct"
+    MISTRAL_7B = "mistral-7b"
+    CODELLAMA_34B = "codellama-34b"
+    LLAMA_2_70B = "llama-2-70b"
+    
+    # Model Groups
+    SONAR_MODELS = [SONAR, SONAR_PRO, SONAR_DEEP_RESEARCH].freeze
+    LLAMA_MODELS = [
+      LLAMA_3_1_SONAR_SMALL_128K_CHAT,
+      LLAMA_3_1_SONAR_LARGE_128K_CHAT,
+      LLAMA_3_1_70B_INSTRUCT,
+      LLAMA_3_1_8B_INSTRUCT,
+      LLAMA_2_70B
+    ].freeze
+    
+    ALL_MODELS = (SONAR_MODELS + LLAMA_MODELS + [MISTRAL_7B, CODELLAMA_34B]).freeze
+    
+    # Search modes
+    SEARCH_MODE_WEB = "web"
+    SEARCH_MODE_ACADEMIC = "academic"
+    
+    # Search recency filters
+    RECENCY_MONTH = "month"
+    RECENCY_WEEK = "week"
+    RECENCY_DAY = "day"
+    RECENCY_HOUR = "hour"
+    
+    # Search context sizes
+    CONTEXT_SIZE_LOW = "low"
+    CONTEXT_SIZE_MEDIUM = "medium"
+    CONTEXT_SIZE_HIGH = "high"
+  end
+end

data/lib/perplexity_api/stream_client.rb

@@ -0,0 +1,115 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+module PerplexityApi
+  class StreamClient
+    attr_reader :config
+
+    def initialize(api_key: nil, model: nil, options: {})
+      @config = PerplexityApi.configuration.dup
+      @config.api_key = api_key if api_key != nil
+      @model = model || @config.default_model
+      @options = @config.default_options.merge(options)
+    end
+
+    def chat(messages, &block)
+      @config.validate!
+      
+      messages = prepare_messages(messages)
+      
+      uri = URI.parse("#{@config.api_base}/chat/completions")
+      
+      Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+        request = Net::HTTP::Post.new(uri.path)
+        request["Content-Type"] = "application/json"
+        request["Authorization"] = "Bearer #{@config.api_key}"
+        request["Accept"] = "text/event-stream"
+        request["Cache-Control"] = "no-cache"
+        
+        request_body = build_request_body(messages)
+        request_body[:stream] = true
+        request.body = request_body.to_json
+
+        http.request(request) do |response|
+          if response.code.to_i != 200
+            raise Error, "API call failed: #{response.code} #{response.read_body}"
+          end
+
+          buffer = ""
+          response.read_body do |chunk|
+            buffer += chunk
+            
+            while (line_end = buffer.index("\n"))
+              line = buffer[0...line_end]
+              buffer = buffer[(line_end + 1)..-1]
+              
+              next if line.strip.empty?
+              next unless line.start_with?("data: ")
+              
+              data = line[6..-1].strip
+              next if data == "[DONE]"
+              
+              begin
+                parsed = JSON.parse(data)
+                block.call(parsed) if block_given?
+              rescue JSON::ParserError => e
+                # Skip invalid JSON
+              end
+            end
+          end
+        end
+      end
+    end
+
+    private
+
+    def prepare_messages(messages)
+      case messages
+      when String
+        [{ role: "user", content: messages }]
+      when Array
+        messages
+      else
+        raise ArgumentError, "Messages must be a string or array"
+      end
+    end
+
+    def build_request_body(messages)
+      body = {
+        model: @model,
+        messages: messages
+      }
+
+      # Basic parameters
+      body[:temperature] = @options[:temperature] if @options[:temperature]
+      body[:max_tokens] = @options[:max_tokens] if @options[:max_tokens]
+      body[:top_p] = @options[:top_p] if @options[:top_p]
+      body[:top_k] = @options[:top_k] if @options[:top_k]
+      body[:frequency_penalty] = @options[:frequency_penalty] if @options[:frequency_penalty]
+      body[:presence_penalty] = @options[:presence_penalty] if @options[:presence_penalty]
+
+      # Search parameters
+      body[:search_mode] = @options[:search_mode] if @options[:search_mode]
+      body[:search_domain_filter] = @options[:search_domain_filter] if @options[:search_domain_filter]
+      body[:search_recency_filter] = @options[:search_recency_filter] if @options[:search_recency_filter]
+      body[:search_after_date_filter] = @options[:search_after_date_filter] if @options[:search_after_date_filter]
+      body[:search_before_date_filter] = @options[:search_before_date_filter] if @options[:search_before_date_filter]
+      body[:last_updated_after_filter] = @options[:last_updated_after_filter] if @options[:last_updated_after_filter]
+      body[:last_updated_before_filter] = @options[:last_updated_before_filter] if @options[:last_updated_before_filter]
+
+      # Beta features
+      body[:return_images] = @options[:return_images] if @options[:return_images]
+      body[:return_related_questions] = @options[:return_related_questions] if @options[:return_related_questions]
+
+      # Advanced features
+      body[:reasoning_effort] = @options[:reasoning_effort] if @options[:reasoning_effort]
+      
+      if @options[:web_search_options]
+        body[:web_search_options] = @options[:web_search_options]
+      end
+
+      body
+    end
+  end
+end

data/lib/perplexity_api/version.rb

@@ -1,3 +1,3 @@
 module PerplexityApi
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

data/lib/perplexity_api.rb

@@ -1,6 +1,8 @@
 require "perplexity_api/version"
 require "perplexity_api/configuration"
+require "perplexity_api/models"
 require "perplexity_api/client"
+require "perplexity_api/stream_client"
 
 module PerplexityApi
   class Error < StandardError; end
@@ -11,9 +13,20 @@ module PerplexityApi
   end
   
   # Helper method to directly send a message
-  def self.chat(message, api_key: nil, model: nil, options: {})
+  def self.chat(messages, api_key: nil, model: nil, options: {})
     client = Client.new(api_key: api_key, model: model, options: options)
-    client.chat(message)
+    client.chat(messages, options)
+  end
+  
+  # Helper method to create a stream client instance
+  def self.stream(api_key: nil, model: nil, options: {})
+    StreamClient.new(api_key: api_key, model: model, options: options)
+  end
+  
+  # Helper method to directly stream a message
+  def self.stream_chat(messages, api_key: nil, model: nil, options: {}, &block)
+    client = StreamClient.new(api_key: api_key, model: model, options: options)
+    client.chat(messages, &block)
   end
   
   # Helper method to get available models

data/perplexity_api.gemspec

@@ -35,10 +35,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "dotenv", "~> 2.7"
   
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.required_ruby_version = ">= 3.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: perplexity_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Hisafumi Kikkawa
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-27 00:00:00.000000000 Z
+date: 2025-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
 description: A Ruby library for easily using Perplexity AI's API. Allows setting API
   keys, selecting models, and customizing options.
 email:
@@ -74,11 +60,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".env.sample"
+- ".env.example"
 - ".gitignore"
 - ".rspec"
-- ".rspec_status"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -88,9 +74,15 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/basic_usage.rb
+- examples/conversation.rb
+- examples/streaming.rb
+- examples/web_search.rb
 - lib/perplexity_api.rb
 - lib/perplexity_api/client.rb
 - lib/perplexity_api/configuration.rb
+- lib/perplexity_api/models.rb
+- lib/perplexity_api/stream_client.rb
 - lib/perplexity_api/version.rb
 - perplexity_api.gemspec
 homepage: https://github.com/hisafumi-kikkawa/perplexity_api
@@ -101,7 +93,7 @@ metadata:
   homepage_uri: https://github.com/hisafumi-kikkawa/perplexity_api
   source_code_uri: https://github.com/hisafumi-kikkawa/perplexity_api
   changelog_uri: https://github.com/hisafumi-kikkawa/perplexity_api/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -109,15 +101,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Ruby wrapper for Perplexity API
 test_files: []

data/.rspec_status

@@ -1,24 +0,0 @@
-example_id                                           | status | run_time        |
----------------------------------------------------- | ------ | --------------- |
-./spec/perplexity_api/client_spec.rb[1:1:1:1]        | passed | 0.0228 seconds  |
-./spec/perplexity_api/client_spec.rb[1:1:2:1]        | passed | 0.0001 seconds  |
-./spec/perplexity_api/client_spec.rb[1:2:1]          | passed | 0.00063 seconds |
-./spec/perplexity_api/client_spec.rb[1:2:2]          | passed | 0.00161 seconds |
-./spec/perplexity_api/client_spec.rb[1:2:3:1]        | passed | 0.0053 seconds  |
-./spec/perplexity_api/client_spec.rb[1:2:4:1]        | passed | 0.00045 seconds |
-./spec/perplexity_api/configuration_spec.rb[1:1:1:1] | passed | 0.0081 seconds  |
-./spec/perplexity_api/configuration_spec.rb[1:1:2:1] | passed | 0.00034 seconds |
-./spec/perplexity_api/configuration_spec.rb[1:1:3:1] | passed | 0.00192 seconds |
-./spec/perplexity_api/configuration_spec.rb[1:2:1]   | passed | 0.00362 seconds |
-./spec/perplexity_api/configuration_spec.rb[1:3:1:1] | passed | 0.00084 seconds |
-./spec/perplexity_api/configuration_spec.rb[1:3:2:1] | passed | 0.00007 seconds |
-./spec/perplexity_api/configuration_spec.rb[2:1:1]   | passed | 0.00073 seconds |
-./spec/perplexity_api/configuration_spec.rb[2:1:2]   | passed | 0.00006 seconds |
-./spec/perplexity_api/configuration_spec.rb[2:2:1]   | passed | 0.00739 seconds |
-./spec/perplexity_api/configuration_spec.rb[2:2:2]   | passed | 0.0001 seconds  |
-./spec/perplexity_api/configuration_spec.rb[2:3:1]   | passed | 0.00102 seconds |
-./spec/perplexity_api_spec.rb[1:1]                   | passed | 0.00011 seconds |
-./spec/perplexity_api_spec.rb[1:2:1]                 | passed | 0.00011 seconds |
-./spec/perplexity_api_spec.rb[1:3:1]                 | passed | 0.00017 seconds |
-./spec/perplexity_api_spec.rb[1:3:2]                 | passed | 0.00013 seconds |
-./spec/perplexity_api_spec.rb[1:4:1:1]               | passed | 0.00151 seconds |