Skip to content

Commit 8e3acfe

Browse files
committed
Deployed fb06383 with MkDocs version: 1.6.1
1 parent 82787c3 commit 8e3acfe

41 files changed

Lines changed: 32746 additions & 2999 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

api/yard-reference/index.html

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4291,10 +4291,34 @@ <h2 id="classes-modules">Classes &amp; Modules<a class="headerlink" href="#class
42914291
<td>Metrics and logging instrumentation</td>
42924292
</tr>
42934293
<tr>
4294+
<td><a href="../yard/HTM/PropositionService/">HTM::PropositionService</a></td>
4295+
<td>HTM::PropositionService class</td>
4296+
</tr>
4297+
<tr>
4298+
<td><a href="../yard/HTM/QueryCache/">HTM::QueryCache</a></td>
4299+
<td>HTM::QueryCache class</td>
4300+
</tr>
4301+
<tr>
4302+
<td><a href="../yard/HTM/SqlBuilder/">HTM::SqlBuilder</a></td>
4303+
<td>HTM::SqlBuilder class</td>
4304+
</tr>
4305+
<tr>
42944306
<td><a href="../yard/HTM/TagService/">HTM::TagService</a></td>
42954307
<td>Hierarchical tag extraction service</td>
42964308
</tr>
42974309
<tr>
4310+
<td><a href="../yard/HTM/Telemetry/">HTM::Telemetry</a></td>
4311+
<td>HTM::Telemetry class</td>
4312+
</tr>
4313+
<tr>
4314+
<td><a href="../yard/HTM/Telemetry/NullInstrument/">HTM::Telemetry::NullInstrument</a></td>
4315+
<td>HTM::Telemetry::NullInstrument class</td>
4316+
</tr>
4317+
<tr>
4318+
<td><a href="../yard/HTM/Telemetry/NullMeter/">HTM::Telemetry::NullMeter</a></td>
4319+
<td>HTM::Telemetry::NullMeter class</td>
4320+
</tr>
4321+
<tr>
42984322
<td><a href="../yard/HTM/Timeframe/">HTM::Timeframe</a></td>
42994323
<td>Time-based query filtering</td>
43004324
</tr>

api/yard/HTM/Configuration/index.html

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4229,6 +4229,16 @@ <h2 id="attribute-i-bedrock_region">bedrock_region[RW]<a class="headerlink" href
42294229
<p>Returns the value of attribute bedrock_region.</p>
42304230
<h2 id="attribute-i-bedrock_secret_key">bedrock_secret_key[RW]<a class="headerlink" href="#attribute-i-bedrock_secret_key" title="Permanent link">&para;</a></h2>
42314231
<p>Returns the value of attribute bedrock_secret_key.</p>
4232+
<h2 id="attribute-i-chunk_overlap">chunk_overlap[RW]<a class="headerlink" href="#attribute-i-chunk_overlap" title="Permanent link">&para;</a></h2>
4233+
<p>Character overlap between chunks (default: 64)</p>
4234+
<h2 id="attribute-i-chunk_size">chunk_size[RW]<a class="headerlink" href="#attribute-i-chunk_size" title="Permanent link">&para;</a></h2>
4235+
<p>Chunking configuration (for file loading)</p>
4236+
<h2 id="attribute-i-circuit_breaker_failure_threshold">circuit_breaker_failure_threshold[RW]<a class="headerlink" href="#attribute-i-circuit_breaker_failure_threshold" title="Permanent link">&para;</a></h2>
4237+
<p>Circuit breaker configuration</p>
4238+
<h2 id="attribute-i-circuit_breaker_half_open_max_calls">circuit_breaker_half_open_max_calls[RW]<a class="headerlink" href="#attribute-i-circuit_breaker_half_open_max_calls" title="Permanent link">&para;</a></h2>
4239+
<p>Successes to close (default: 3)</p>
4240+
<h2 id="attribute-i-circuit_breaker_reset_timeout">circuit_breaker_reset_timeout[RW]<a class="headerlink" href="#attribute-i-circuit_breaker_reset_timeout" title="Permanent link">&para;</a></h2>
4241+
<p>Seconds before half-open (default: 60)</p>
42324242
<h2 id="attribute-i-connection_timeout">connection_timeout[RW]<a class="headerlink" href="#attribute-i-connection_timeout" title="Permanent link">&para;</a></h2>
42334243
<p>Returns the value of attribute connection_timeout.</p>
42344244
<h2 id="attribute-i-deepseek_api_key">deepseek_api_key[RW]<a class="headerlink" href="#attribute-i-deepseek_api_key" title="Permanent link">&para;</a></h2>
@@ -4243,6 +4253,8 @@ <h2 id="attribute-i-embedding_provider">embedding_provider[RW]<a class="headerli
42434253
<p>Returns the value of attribute embedding_provider.</p>
42444254
<h2 id="attribute-i-embedding_timeout">embedding_timeout[RW]<a class="headerlink" href="#attribute-i-embedding_timeout" title="Permanent link">&para;</a></h2>
42454255
<p>Returns the value of attribute embedding_timeout.</p>
4256+
<h2 id="attribute-i-extract_propositions">extract_propositions[RW]<a class="headerlink" href="#attribute-i-extract_propositions" title="Permanent link">&para;</a></h2>
4257+
<p>Returns the value of attribute extract_propositions.</p>
42464258
<h2 id="attribute-i-gemini_api_key">gemini_api_key[RW]<a class="headerlink" href="#attribute-i-gemini_api_key" title="Permanent link">&para;</a></h2>
42474259
<p>Returns the value of attribute gemini_api_key.</p>
42484260
<h2 id="attribute-i-huggingface_api_key">huggingface_api_key[RW]<a class="headerlink" href="#attribute-i-huggingface_api_key" title="Permanent link">&para;</a></h2>
@@ -4251,6 +4263,10 @@ <h2 id="attribute-i-job_backend">job_backend[RW]<a class="headerlink" href="#att
42514263
<p>Returns the value of attribute job_backend.</p>
42524264
<h2 id="attribute-i-logger">logger[RW]<a class="headerlink" href="#attribute-i-logger" title="Permanent link">&para;</a></h2>
42534265
<p>Returns the value of attribute logger.</p>
4266+
<h2 id="attribute-i-max_embedding_dimension">max_embedding_dimension[RW]<a class="headerlink" href="#attribute-i-max_embedding_dimension" title="Permanent link">&para;</a></h2>
4267+
<p>Limit configuration</p>
4268+
<h2 id="attribute-i-max_tag_depth">max_tag_depth[RW]<a class="headerlink" href="#attribute-i-max_tag_depth" title="Permanent link">&para;</a></h2>
4269+
<p>Max tag hierarchy depth (default: 4)</p>
42544270
<h2 id="attribute-i-ollama_url">ollama_url[RW]<a class="headerlink" href="#attribute-i-ollama_url" title="Permanent link">&para;</a></h2>
42554271
<p>Returns the value of attribute ollama_url.</p>
42564272
<h2 id="attribute-i-openai_api_key">openai_api_key[RW]<a class="headerlink" href="#attribute-i-openai_api_key" title="Permanent link">&para;</a></h2>
@@ -4261,6 +4277,24 @@ <h2 id="attribute-i-openai_project">openai_project[RW]<a class="headerlink" href
42614277
<p>Provider-specific API keys and endpoints</p>
42624278
<h2 id="attribute-i-openrouter_api_key">openrouter_api_key[RW]<a class="headerlink" href="#attribute-i-openrouter_api_key" title="Permanent link">&para;</a></h2>
42634279
<p>Returns the value of attribute openrouter_api_key.</p>
4280+
<h2 id="attribute-i-proposition_extractor">proposition_extractor[RW]<a class="headerlink" href="#attribute-i-proposition_extractor" title="Permanent link">&para;</a></h2>
4281+
<p>Returns the value of attribute proposition_extractor.</p>
4282+
<h2 id="attribute-i-proposition_model">proposition_model[RW]<a class="headerlink" href="#attribute-i-proposition_model" title="Permanent link">&para;</a></h2>
4283+
<p>Returns the value of attribute proposition_model.</p>
4284+
<h2 id="attribute-i-proposition_provider">proposition_provider[RW]<a class="headerlink" href="#attribute-i-proposition_provider" title="Permanent link">&para;</a></h2>
4285+
<p>Returns the value of attribute proposition_provider.</p>
4286+
<h2 id="attribute-i-proposition_timeout">proposition_timeout[RW]<a class="headerlink" href="#attribute-i-proposition_timeout" title="Permanent link">&para;</a></h2>
4287+
<p>Returns the value of attribute proposition_timeout.</p>
4288+
<h2 id="attribute-i-relevance_access_weight">relevance_access_weight[RW]<a class="headerlink" href="#attribute-i-relevance_access_weight" title="Permanent link">&para;</a></h2>
4289+
<p>Access frequency weight (default: 0.1)</p>
4290+
<h2 id="attribute-i-relevance_recency_half_life_hours">relevance_recency_half_life_hours[RW]<a class="headerlink" href="#attribute-i-relevance_recency_half_life_hours" title="Permanent link">&para;</a></h2>
4291+
<p>Decay half-life in hours (default: 168 = 1 week)</p>
4292+
<h2 id="attribute-i-relevance_recency_weight">relevance_recency_weight[RW]<a class="headerlink" href="#attribute-i-relevance_recency_weight" title="Permanent link">&para;</a></h2>
4293+
<p>Temporal freshness weight (default: 0.1)</p>
4294+
<h2 id="attribute-i-relevance_semantic_weight">relevance_semantic_weight[RW]<a class="headerlink" href="#attribute-i-relevance_semantic_weight" title="Permanent link">&para;</a></h2>
4295+
<p>Relevance scoring weights (must sum to 1.0)</p>
4296+
<h2 id="attribute-i-relevance_tag_weight">relevance_tag_weight[RW]<a class="headerlink" href="#attribute-i-relevance_tag_weight" title="Permanent link">&para;</a></h2>
4297+
<p>Tag overlap weight (default: 0.3)</p>
42644298
<h2 id="attribute-i-tag_extractor">tag_extractor[RW]<a class="headerlink" href="#attribute-i-tag_extractor" title="Permanent link">&para;</a></h2>
42654299
<p>Returns the value of attribute tag_extractor.</p>
42664300
<h2 id="attribute-i-tag_model">tag_model[RW]<a class="headerlink" href="#attribute-i-tag_model" title="Permanent link">&para;</a></h2>
@@ -4269,6 +4303,8 @@ <h2 id="attribute-i-tag_provider">tag_provider[RW]<a class="headerlink" href="#a
42694303
<p>Returns the value of attribute tag_provider.</p>
42704304
<h2 id="attribute-i-tag_timeout">tag_timeout[RW]<a class="headerlink" href="#attribute-i-tag_timeout" title="Permanent link">&para;</a></h2>
42714305
<p>Returns the value of attribute tag_timeout.</p>
4306+
<h2 id="attribute-i-telemetry_enabled">telemetry_enabled[RW]<a class="headerlink" href="#attribute-i-telemetry_enabled" title="Permanent link">&para;</a></h2>
4307+
<p>Enable OpenTelemetry metrics (default: false)</p>
42724308
<h2 id="attribute-i-token_counter">token_counter[RW]<a class="headerlink" href="#attribute-i-token_counter" title="Permanent link">&para;</a></h2>
42734309
<p>Returns the value of attribute token_counter.</p>
42744310
<h2 id="attribute-i-week_start">week_start[RW]<a class="headerlink" href="#attribute-i-week_start" title="Permanent link">&para;</a></h2>

api/yard/HTM/Database/index.html

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4168,16 +4168,18 @@ <h1 id="class-htmdatabase">Class: HTM::Database<a class="headerlink" href="#clas
41684168
initialization</p>
41694169
<h1 id="class-methods">Class Methods<a class="headerlink" href="#class-methods" title="Permanent link">&para;</a></h1>
41704170
<h2 id="method-c-default_config">default_config()<a class="headerlink" href="#method-c-default_config" title="Permanent link">&para;</a></h2>
4171-
<p>Get default database configuration
4172-
<strong><code>@return</code></strong> [Hash, nil] Connection configuration hash</p>
4171+
<p>Get default database configuration (respects RAILS_ENV)</p>
4172+
<p>Uses ActiveRecordConfig which reads from config/database.yml and respects
4173+
RAILS_ENV for environment-specific database selection.
4174+
<strong><code>@return</code></strong> [Hash, nil] Connection configuration hash with PG-style keys</p>
41734175
<h2 id="method-c-drop">drop(db_url nil)<a class="headerlink" href="#method-c-drop" title="Permanent link">&para;</a></h2>
4174-
<p>Drop all HTM tables
4175-
<strong><code>@param</code></strong> [String] Database connection URL (uses ENV['HTM_DBURL'] if not provided)</p>
4176+
<p>Drop all HTM tables (respects RAILS_ENV)
4177+
<strong><code>@param</code></strong> [String] Database connection URL (uses default_config if not provided)</p>
41764178
<p><strong><code>@return</code></strong> [void] </p>
41774179
<h2 id="method-c-dump_schema">dump_schema(db_url nil)<a class="headerlink" href="#method-c-dump_schema" title="Permanent link">&para;</a></h2>
4178-
<p>Dump current database schema to db/schema.sql</p>
4180+
<p>Dump current database schema to db/schema.sql (respects RAILS_ENV)</p>
41794181
<p>Uses pg_dump to create a clean SQL schema file without data
4180-
<strong><code>@param</code></strong> [String] Database connection URL (uses ENV['HTM_DBURL'] if not provided)</p>
4182+
<strong><code>@param</code></strong> [String] Database connection URL (uses default_config if not provided)</p>
41814183
<p><strong><code>@return</code></strong> [void] </p>
41824184
<h2 id="method-c-generate_docs">generate_docs(db_url nil)<a class="headerlink" href="#method-c-generate_docs" title="Permanent link">&para;</a></h2>
41834185
<p>Generate database documentation using tbls</p>
@@ -4190,13 +4192,13 @@ <h2 id="method-c-generate_docs">generate_docs(db_url nil)<a class="headerlink" h
41904192
<strong><code>@param</code></strong> [String] Database connection URL (uses ENV['HTM_DBURL'] if not provided)</p>
41914193
<p><strong><code>@return</code></strong> [void] </p>
41924194
<h2 id="method-c-info">info(db_url nil)<a class="headerlink" href="#method-c-info" title="Permanent link">&para;</a></h2>
4193-
<p>Show database info
4194-
<strong><code>@param</code></strong> [String] Database connection URL (uses ENV['HTM_DBURL'] if not provided)</p>
4195+
<p>Show database info (respects RAILS_ENV)
4196+
<strong><code>@param</code></strong> [String] Database connection URL (uses default_config if not provided)</p>
41954197
<p><strong><code>@return</code></strong> [void] </p>
41964198
<h2 id="method-c-load_schema">load_schema(db_url nil)<a class="headerlink" href="#method-c-load_schema" title="Permanent link">&para;</a></h2>
4197-
<p>Load schema from db/schema.sql</p>
4199+
<p>Load schema from db/schema.sql (respects RAILS_ENV)</p>
41984200
<p>Uses psql to load the schema file
4199-
<strong><code>@param</code></strong> [String] Database connection URL (uses ENV['HTM_DBURL'] if not provided)</p>
4201+
<strong><code>@param</code></strong> [String] Database connection URL (uses default_config if not provided)</p>
42004202
<p><strong><code>@return</code></strong> [void] </p>
42014203
<h2 id="method-c-migrate">migrate(db_url nil)<a class="headerlink" href="#method-c-migrate" title="Permanent link">&para;</a></h2>
42024204
<p>Run pending database migrations

api/yard/HTM/EmbeddingService/index.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4191,8 +4191,11 @@ <h2 id="method-c-generate">generate(text )<a class="headerlink" href="#method-c-
41914191
storage_embedding: String, # Formatted for database storage
41924192
storage_dimension: Integer # Padded dimension (2000)
41934193
}</p>
4194+
<h2 id="method-c-max_dimension">max_dimension()<a class="headerlink" href="#method-c-max_dimension" title="Permanent link">&para;</a></h2>
4195+
<p>Maximum embedding dimension (configurable, default 2000)
4196+
<strong><code>@return</code></strong> [Integer] Max dimensions for pgvector HNSW index</p>
41944197
<h2 id="method-c-pad_embedding">pad_embedding(embedding )<a class="headerlink" href="#method-c-pad_embedding" title="Permanent link">&para;</a></h2>
4195-
<p>Pad embedding to MAX_DIMENSION with zeros
4198+
<p>Pad embedding to max_dimension with zeros
41964199
<strong><code>@param</code></strong> [Array<Float>] Original embedding</p>
41974200
<p><strong><code>@return</code></strong> [Array<Float>] Padded embedding</p>
41984201
<h2 id="method-c-reset_circuit_breaker!">reset_circuit_breaker!()<a class="headerlink" href="#method-c-reset_circuit_breaker!" title="Permanent link">&para;</a></h2>

0 commit comments

Comments
 (0)