soilsidekick 3.0.0

data/docs/LeafEnginesApi.md

@@ -0,0 +1,87 @@
+# SoilSidekick::LeafEnginesApi
+
+All URIs are relative to *https://wzgnxkoeqzvueypwzvyn.supabase.co/functions/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**leafengines_query**](LeafEnginesApi.md#leafengines_query) | **POST** /leafengines-query | Query plant-environment compatibility |
+
+
+## leafengines_query
+
+> <LeafEnginesCompatibility> leafengines_query(leafengines_query_request, opts)
+
+Query plant-environment compatibility
+
+LeafEngines API for plant compatibility scoring with environmental factors
+
+### Examples
+
+```ruby
+require 'time'
+require 'soilsidekick'
+# setup authorization
+SoilSidekick.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = SoilSidekick::LeafEnginesApi.new
+leafengines_query_request = SoilSidekick::LeafenginesQueryRequest.new({location: SoilSidekick::LeafenginesQueryRequestLocation.new, plant: SoilSidekick::LeafenginesQueryRequestPlant.new}) # LeafenginesQueryRequest | 
+opts = {
+  x_tq_context_mode: 4096, # Integer | TurboQuant extended context window size (tokens). With 3-bit KV cache, context windows up to 24K tokens are feasible within the same memory budget as standard 4K. 
+  x_tq_kv_cache_hint: 'none', # String | KV cache management hint. - `none`: No caching (default) - `reuse`: Reuse KV cache from previous request in same session (40-60% compute savings) - `persist`: Persist cache to disk for cross-session reuse 
+  x_tq_model_tier: 'auto' # String | Preferred model tier for inference. - `auto`: Server selects optimal model based on device capabilities - `gemma-2b`: Lightweight model (~0.5GB KV with TQ) - `gemma-7b`: Full model, standard KV cache - `gemma-7b-tq`: Full model with TurboQuant 3-bit KV cache (~1.3GB) 
+}
+
+begin
+  # Query plant-environment compatibility
+  result = api_instance.leafengines_query(leafengines_query_request, opts)
+  p result
+rescue SoilSidekick::ApiError => e
+  puts "Error when calling LeafEnginesApi->leafengines_query: #{e}"
+end
+```
+
+#### Using the leafengines_query_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LeafEnginesCompatibility>, Integer, Hash)> leafengines_query_with_http_info(leafengines_query_request, opts)
+
+```ruby
+begin
+  # Query plant-environment compatibility
+  data, status_code, headers = api_instance.leafengines_query_with_http_info(leafengines_query_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LeafEnginesCompatibility>
+rescue SoilSidekick::ApiError => e
+  puts "Error when calling LeafEnginesApi->leafengines_query_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **leafengines_query_request** | [**LeafenginesQueryRequest**](LeafenginesQueryRequest.md) |  |  |
+| **x_tq_context_mode** | **Integer** | TurboQuant extended context window size (tokens). With 3-bit KV cache, context windows up to 24K tokens are feasible within the same memory budget as standard 4K.  | [optional][default to 4096] |
+| **x_tq_kv_cache_hint** | **String** | KV cache management hint. - &#x60;none&#x60;: No caching (default) - &#x60;reuse&#x60;: Reuse KV cache from previous request in same session (40-60% compute savings) - &#x60;persist&#x60;: Persist cache to disk for cross-session reuse  | [optional][default to &#39;none&#39;] |
+| **x_tq_model_tier** | **String** | Preferred model tier for inference. - &#x60;auto&#x60;: Server selects optimal model based on device capabilities - &#x60;gemma-2b&#x60;: Lightweight model (~0.5GB KV with TQ) - &#x60;gemma-7b&#x60;: Full model, standard KV cache - &#x60;gemma-7b-tq&#x60;: Full model with TurboQuant 3-bit KV cache (~1.3GB)  | [optional][default to &#39;auto&#39;] |
+
+### Return type
+
+[**LeafEnginesCompatibility**](LeafEnginesCompatibility.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/LeafEnginesCompatibility.md

@@ -0,0 +1,22 @@
+# SoilSidekick::LeafEnginesCompatibility
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  | [optional] |
+| **data** | [**LeafEnginesCompatibilityData**](LeafEnginesCompatibilityData.md) |  | [optional] |
+| **usage** | [**LeafEnginesCompatibilityUsage**](LeafEnginesCompatibilityUsage.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::LeafEnginesCompatibility.new(
+  success: null,
+  data: null,
+  usage: null
+)
+```
+

data/docs/LeafEnginesCompatibilityData.md

@@ -0,0 +1,32 @@
+# SoilSidekick::LeafEnginesCompatibilityData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **overall_score** | **Float** | Overall compatibility score (0-100) | [optional] |
+| **soil_compatibility** | **Float** |  | [optional] |
+| **water_compatibility** | **Float** |  | [optional] |
+| **climate_compatibility** | **Float** |  | [optional] |
+| **breakdown** | [**LeafEnginesCompatibilityDataBreakdown**](LeafEnginesCompatibilityDataBreakdown.md) |  | [optional] |
+| **recommendations** | **Array<String>** |  | [optional] |
+| **risk_level** | **String** |  | [optional] |
+| **metadata** | [**LeafEnginesCompatibilityDataMetadata**](LeafEnginesCompatibilityDataMetadata.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::LeafEnginesCompatibilityData.new(
+  overall_score: null,
+  soil_compatibility: null,
+  water_compatibility: null,
+  climate_compatibility: null,
+  breakdown: null,
+  recommendations: null,
+  risk_level: null,
+  metadata: null
+)
+```
+

data/docs/LeafEnginesCompatibilityDataBreakdown.md

@@ -0,0 +1,22 @@
+# SoilSidekick::LeafEnginesCompatibilityDataBreakdown
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **soil** | [**LeafEnginesCompatibilityDataBreakdownSoil**](LeafEnginesCompatibilityDataBreakdownSoil.md) |  | [optional] |
+| **water** | **Object** |  | [optional] |
+| **climate** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::LeafEnginesCompatibilityDataBreakdown.new(
+  soil: null,
+  water: null,
+  climate: null
+)
+```
+

data/docs/LeafEnginesCompatibilityDataBreakdownSoil.md

@@ -0,0 +1,22 @@
+# SoilSidekick::LeafEnginesCompatibilityDataBreakdownSoil
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **score** | **Float** |  | [optional] |
+| **factors** | **Array<String>** |  | [optional] |
+| **concerns** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::LeafEnginesCompatibilityDataBreakdownSoil.new(
+  score: null,
+  factors: null,
+  concerns: null
+)
+```
+

data/docs/LeafEnginesCompatibilityDataMetadata.md

@@ -0,0 +1,22 @@
+# SoilSidekick::LeafEnginesCompatibilityDataMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **location** | **String** |  | [optional] |
+| **timestamp** | **Time** |  | [optional] |
+| **data_sources** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::LeafEnginesCompatibilityDataMetadata.new(
+  location: null,
+  timestamp: null,
+  data_sources: null
+)
+```
+

data/docs/LeafEnginesCompatibilityUsage.md

@@ -0,0 +1,20 @@
+# SoilSidekick::LeafEnginesCompatibilityUsage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **credits_used** | **Integer** |  | [optional] |
+| **response_time_ms** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::LeafEnginesCompatibilityUsage.new(
+  credits_used: null,
+  response_time_ms: null
+)
+```
+

data/docs/LeafenginesQueryRequest.md

@@ -0,0 +1,22 @@
+# SoilSidekick::LeafenginesQueryRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **location** | [**LeafenginesQueryRequestLocation**](LeafenginesQueryRequestLocation.md) |  |  |
+| **plant** | [**LeafenginesQueryRequestPlant**](LeafenginesQueryRequestPlant.md) |  |  |
+| **options** | [**LeafenginesQueryRequestOptions**](LeafenginesQueryRequestOptions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::LeafenginesQueryRequest.new(
+  location: null,
+  plant: null,
+  options: null
+)
+```
+

data/docs/LeafenginesQueryRequestLocation.md

@@ -0,0 +1,24 @@
+# SoilSidekick::LeafenginesQueryRequestLocation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **latitude** | **Float** |  | [optional] |
+| **longitude** | **Float** |  | [optional] |
+| **address** | **String** |  | [optional] |
+| **county_fips** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::LeafenginesQueryRequestLocation.new(
+  latitude: null,
+  longitude: null,
+  address: null,
+  county_fips: null
+)
+```
+

data/docs/LeafenginesQueryRequestOptions.md

@@ -0,0 +1,22 @@
+# SoilSidekick::LeafenginesQueryRequestOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **include_satellite_data** | **Boolean** |  | [optional] |
+| **include_water_quality** | **Boolean** |  | [optional] |
+| **include_recommendations** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::LeafenginesQueryRequestOptions.new(
+  include_satellite_data: null,
+  include_water_quality: null,
+  include_recommendations: null
+)
+```
+

data/docs/LeafenginesQueryRequestPlant.md

@@ -0,0 +1,24 @@
+# SoilSidekick::LeafenginesQueryRequestPlant
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **common_name** | **String** |  | [optional] |
+| **scientific_name** | **String** |  | [optional] |
+| **plant_id** | **String** |  | [optional] |
+| **care_requirements** | [**LeafenginesQueryRequestPlantCareRequirements**](LeafenginesQueryRequestPlantCareRequirements.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::LeafenginesQueryRequestPlant.new(
+  common_name: null,
+  scientific_name: null,
+  plant_id: null,
+  care_requirements: null
+)
+```
+

data/docs/LeafenginesQueryRequestPlantCareRequirements.md

@@ -0,0 +1,22 @@
+# SoilSidekick::LeafenginesQueryRequestPlantCareRequirements
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sun_exposure** | **String** |  | [optional] |
+| **water_needs** | **String** |  | [optional] |
+| **soil_ph_range** | [**LeafenginesQueryRequestPlantCareRequirementsSoilPhRange**](LeafenginesQueryRequestPlantCareRequirementsSoilPhRange.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::LeafenginesQueryRequestPlantCareRequirements.new(
+  sun_exposure: null,
+  water_needs: null,
+  soil_ph_range: null
+)
+```
+

data/docs/LeafenginesQueryRequestPlantCareRequirementsSoilPhRange.md

@@ -0,0 +1,20 @@
+# SoilSidekick::LeafenginesQueryRequestPlantCareRequirementsSoilPhRange
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **min** | **Float** |  | [optional] |
+| **max** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::LeafenginesQueryRequestPlantCareRequirementsSoilPhRange.new(
+  min: null,
+  max: null
+)
+```
+

data/docs/LiveAgriculturalData.md

@@ -0,0 +1,30 @@
+# SoilSidekick::LiveAgriculturalData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **county_fips** | **String** |  | [optional] |
+| **county_name** | **String** |  | [optional] |
+| **state_code** | **String** |  | [optional] |
+| **data** | [**LiveAgriculturalDataData**](LiveAgriculturalDataData.md) |  | [optional] |
+| **sources** | **Array<String>** |  | [optional] |
+| **timestamp** | **Time** |  | [optional] |
+| **cache_status** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::LiveAgriculturalData.new(
+  county_fips: null,
+  county_name: null,
+  state_code: null,
+  data: null,
+  sources: null,
+  timestamp: null,
+  cache_status: null
+)
+```
+

data/docs/LiveAgriculturalDataData.md

@@ -0,0 +1,24 @@
+# SoilSidekick::LiveAgriculturalDataData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **weather** | **Object** |  | [optional] |
+| **soil** | **Object** |  | [optional] |
+| **crop** | **Object** |  | [optional] |
+| **environmental** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::LiveAgriculturalDataData.new(
+  weather: null,
+  soil: null,
+  crop: null,
+  environmental: null
+)
+```
+

data/docs/PlantingCalendar.md

@@ -0,0 +1,26 @@
+# SoilSidekick::PlantingCalendar
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **crop_type** | **String** |  | [optional] |
+| **optimal_planting_window** | [**GetTerritorialWaterAnalyticsRequestDateRange**](GetTerritorialWaterAnalyticsRequestDateRange.md) |  | [optional] |
+| **climate_factors** | **Object** |  | [optional] |
+| **soil_factors** | **Object** |  | [optional] |
+| **recommendations** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::PlantingCalendar.new(
+  crop_type: null,
+  optimal_planting_window: null,
+  climate_factors: null,
+  soil_factors: null,
+  recommendations: null
+)
+```
+

data/docs/SafeIdentification.md

@@ -0,0 +1,26 @@
+# SoilSidekick::SafeIdentification
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  | [optional] |
+| **identification** | [**SafeIdentificationIdentification**](SafeIdentificationIdentification.md) |  | [optional] |
+| **safety_analysis** | [**SafeIdentificationSafetyAnalysis**](SafeIdentificationSafetyAnalysis.md) |  | [optional] |
+| **confidence_breakdown** | [**SafeIdentificationConfidenceBreakdown**](SafeIdentificationConfidenceBreakdown.md) |  | [optional] |
+| **metadata** | [**SafeIdentificationMetadata**](SafeIdentificationMetadata.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::SafeIdentification.new(
+  success: null,
+  identification: null,
+  safety_analysis: null,
+  confidence_breakdown: null,
+  metadata: null
+)
+```
+

data/docs/SafeIdentificationConfidenceBreakdown.md

@@ -0,0 +1,24 @@
+# SoilSidekick::SafeIdentificationConfidenceBreakdown
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **visual_match** | **Float** |  | [optional] |
+| **environmental_context** | **Float** |  | [optional] |
+| **regional_prevalence** | **Float** |  | [optional] |
+| **growth_stage_alignment** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::SafeIdentificationConfidenceBreakdown.new(
+  visual_match: null,
+  environmental_context: null,
+  regional_prevalence: null,
+  growth_stage_alignment: null
+)
+```
+

data/docs/SafeIdentificationIdentification.md

@@ -0,0 +1,22 @@
+# SoilSidekick::SafeIdentificationIdentification
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **primary_match** | [**SafeIdentificationIdentificationPrimaryMatch**](SafeIdentificationIdentificationPrimaryMatch.md) |  | [optional] |
+| **environmental_probability** | **Float** | Likelihood this plant exists in the given environment | [optional] |
+| **growth_stage_detected** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::SafeIdentificationIdentification.new(
+  primary_match: null,
+  environmental_probability: null,
+  growth_stage_detected: null
+)
+```
+

data/docs/SafeIdentificationIdentificationPrimaryMatch.md

@@ -0,0 +1,24 @@
+# SoilSidekick::SafeIdentificationIdentificationPrimaryMatch
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **common_name** | **String** |  | [optional] |
+| **scientific_name** | **String** |  | [optional] |
+| **confidence** | **Float** | Confidence percentage (0-100) | [optional] |
+| **family** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::SafeIdentificationIdentificationPrimaryMatch.new(
+  common_name: null,
+  scientific_name: null,
+  confidence: null,
+  family: null
+)
+```
+

data/docs/SafeIdentificationMetadata.md

@@ -0,0 +1,22 @@
+# SoilSidekick::SafeIdentificationMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **analysis_id** | **String** |  | [optional] |
+| **timestamp** | **Time** |  | [optional] |
+| **environmental_data_used** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::SafeIdentificationMetadata.new(
+  analysis_id: null,
+  timestamp: null,
+  environmental_data_used: null
+)
+```
+

data/docs/SafeIdentificationRequest.md

@@ -0,0 +1,22 @@
+# SoilSidekick::SafeIdentificationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **image** | **String** | Base64 encoded image or image URL |  |
+| **location** | [**SafeIdentificationRequestLocation**](SafeIdentificationRequestLocation.md) |  | [optional] |
+| **context** | [**SafeIdentificationRequestContext**](SafeIdentificationRequestContext.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::SafeIdentificationRequest.new(
+  image: null,
+  location: null,
+  context: null
+)
+```
+

data/docs/SafeIdentificationRequestContext.md

@@ -0,0 +1,22 @@
+# SoilSidekick::SafeIdentificationRequestContext
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **environment** | **String** |  | [optional] |
+| **purpose** | **String** |  | [optional] |
+| **growth_stage** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::SafeIdentificationRequestContext.new(
+  environment: null,
+  purpose: null,
+  growth_stage: null
+)
+```
+

data/docs/SafeIdentificationRequestLocation.md

@@ -0,0 +1,22 @@
+# SoilSidekick::SafeIdentificationRequestLocation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **county_fips** | **String** |  | [optional] |
+| **state_code** | **String** |  | [optional] |
+| **coordinates** | [**SafeIdentificationRequestLocationCoordinates**](SafeIdentificationRequestLocationCoordinates.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::SafeIdentificationRequestLocation.new(
+  county_fips: null,
+  state_code: null,
+  coordinates: null
+)
+```
+

data/docs/SafeIdentificationRequestLocationCoordinates.md

@@ -0,0 +1,20 @@
+# SoilSidekick::SafeIdentificationRequestLocationCoordinates
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **latitude** | **Float** |  | [optional] |
+| **longitude** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::SafeIdentificationRequestLocationCoordinates.new(
+  latitude: null,
+  longitude: null
+)
+```
+