feather-ai 0.2.0

data/sig/Feather.rbs

@@ -0,0 +1,91 @@
+module Feather
+  VERSION: String
+
+  class Error < StandardError
+  end
+
+  class ConfigurationError < Error
+  end
+
+  class IdentificationError < Error
+  end
+
+  def self.configuration: () -> Configuration
+  def self.configure: () { (Configuration) -> void } -> void
+  def self.reset!: () -> nil
+  def self.identify: (?String? image, ?String? audio, ?location: String?, ?consensus: bool) -> Result
+
+  class Configuration
+    attr_accessor provider: Symbol
+    attr_accessor model: String
+    attr_accessor location: String?
+    attr_accessor consensus_models: Array[String]
+    attr_accessor tips_model: String
+
+    def initialize: () -> void
+    def initialize_copy: (Configuration source) -> void
+  end
+
+  class Result
+    attr_reader common_name: String?
+    attr_reader species: String?
+    attr_reader family: String?
+    attr_reader confidence: Symbol?
+    attr_reader region_native: bool?
+    attr_reader candidates: Array[Result]
+    attr_reader input_tokens: Integer?
+    attr_reader output_tokens: Integer?
+    attr_reader cost: Float?
+    attr_reader model_id: String?
+    attr_reader duration_ms: Integer?
+    attr_reader source: Symbol?
+    attr_reader consensus_models: Array[String]?
+
+    def initialize: (Hash[Symbol, untyped] attrs) -> void
+    def confident?: () -> bool
+    def region_native?: () -> bool
+    def photography_tips: () -> Hash[Symbol, String]?
+    def to_h: () -> Hash[Symbol, untyped]
+  end
+
+  class Identifier
+    SCHEMA: untyped
+    PROVIDER_RATES: Hash[Symbol, Hash[Symbol, Float]]
+
+    def initialize: (?config: Configuration) -> void
+    def identify: (?String? image, ?String? audio, ?location: String?) -> Result
+  end
+
+  class Consensus
+    def initialize: (?config: Configuration) -> void
+    def identify: (?String? image, ?String? audio, ?location: String?) -> Result
+  end
+
+  class PhotographyTips
+    SCHEMA: untyped
+
+    def initialize: (species: String, common_name: String, ?config: Configuration) -> void
+    def fetch: () -> Hash[Symbol, String]
+  end
+
+  module Instrumentation
+    def self.instrument: (String event_name, ?Hash[Symbol, untyped] payload) { () -> untyped } -> untyped
+  end
+
+  module Rails
+    module ActsAsSighting
+      CORRECTABLE_FIELDS: Array[Symbol]
+
+      module ClassMethods
+        def acts_as_sighting: () -> void
+      end
+
+      module InstanceMethods
+        def identify!: () -> Result
+        def correct!: (Hash[Symbol | String, untyped] attrs) -> void
+        def corrected?: () -> bool
+        def correction_delta: () -> Hash[Symbol, Hash[Symbol, untyped]]
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: feather-ai
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Brandyn Britton
+bindir: exe
+cert_chain: []
+date: 2026-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby_llm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A Ruby gem for identifying birds from photos and audio using RubyLLM.
+  Adds multi-modal identification, location-aware results, multi-model consensus,
+  and a Rails integration.
+email:
+- brandynbb96@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".idea/.gitignore"
+- ".idea/Feather.iml"
+- ".idea/copilot.data.migration.ask2agent.xml"
+- ".idea/modules.xml"
+- ".idea/vcs.xml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CLAUDE.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/feather_ai.rb
+- lib/feather_ai/configuration.rb
+- lib/feather_ai/consensus.rb
+- lib/feather_ai/identifier.rb
+- lib/feather_ai/instrumentation.rb
+- lib/feather_ai/photography_tips.rb
+- lib/feather_ai/rails.rb
+- lib/feather_ai/rails/acts_as_sighting.rb
+- lib/feather_ai/rails/railtie.rb
+- lib/feather_ai/result.rb
+- lib/feather_ai/version.rb
+- lib/generators/feather_ai/add_corrections_generator.rb
+- lib/generators/feather_ai/install_generator.rb
+- lib/generators/feather_ai/templates/correction_migration.rb.tt
+- lib/generators/feather_ai/templates/migration.rb.tt
+- sig/Feather.rbs
+homepage: https://github.com/Birdup-Australia/Feather
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Birdup-Australia/Feather
+  source_code_uri: https://github.com/Birdup-Australia/Feather
+  changelog_uri: https://github.com/Birdup-Australia/Feather/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Identify birds from photos and audio using LLMs
+test_files: []