vector_amp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b5cca5e94ec6fe5fa062e6e6034a5576db8264eefb4ebc306ed489ad8946ccd6
+  data.tar.gz: ba79880edd034128d92b4a57b3a7fe46be310e0b190d3cb93f8c7a6b00d80db4
+SHA512:
+  metadata.gz: 8a1cf8517e4862b4a240b6dc6b4da146bb2fe1499d9b2b6a98fbdefe870be57ad24c78b5defffc4986ca3babea7d8533128450d1bfc54468305c23e54bcabcc5
+  data.tar.gz: aca7d1ef6aa30ff9477fdcd30d1deab9831111a8fd759f521e0cbd2334f724d2b870e57eee393a9d0d987f19ced7c6b9a776054c54a44bd6f5b4a6f6f20c3aa1

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and do
+          not modify the License. You may add Your own attribution notices
+          within Derivative Works that You distribute, alongside or as an
+          addendum to the NOTICE text from the Work, provided that such
+          additional attribution notices cannot be construed as modifying
+          the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 VectorAmp, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE

@@ -0,0 +1,8 @@
+VectorAmp SDK
+Copyright 2026 VectorAmp, Inc.
+
+This product includes software developed at VectorAmp, Inc.
+(https://vectoramp.com/).
+
+Licensed under the Apache License, Version 2.0. See the LICENSE file for
+the full license text.

data/README.md

@@ -0,0 +1,377 @@
+<div align="center">
+  <a href="https://vectoramp.com/">
+    <picture>
+      <source media="(prefers-color-scheme: light)" srcset=".github/images/logo-full-light.svg">
+      <source media="(prefers-color-scheme: dark)" srcset=".github/images/logo-full-dark.svg">
+      <img alt="VectorAmp Logo" src=".github/images/logo-full-dark.svg" width="50%">
+    </picture>
+  </a>
+</div>
+
+# VectorAmp Ruby SDK
+
+Official Ruby client for the VectorAmp API.
+
+- Default API: `https://api.vectoramp.com`
+- Auth: `X-Api-Key`
+- Transport abstraction: REST today, designed so gRPC can be added later
+- Licensed under Apache-2.0.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "vector_amp"
+```
+
+Or install from a local checkout while developing:
+
+```bash
+bundle install
+```
+
+## Quick start
+
+```ruby
+require "vector_amp"
+
+# api_key defaults to ENV["VECTORAMP_API_KEY"]; base_url defaults to production.
+client = VectorAmp::Client.new
+
+# One-call create: only a name is required. The SDK defaults to the managed
+# vectoramp/VectorAmp-Embedding-4B model, infers dim (2560), metric "cosine",
+# and always uses the SABLE index (index type is never exposed).
+dataset = client.datasets.create(name: "product-docs")
+
+# Create/get/list return VectorAmp::Dataset resources. Prefer the object->method
+# style: call helpers directly on the returned dataset.
+dataset.add_texts(
+  ["VectorAmp is powered by SABLE."],
+  metadata: { source: "readme" }
+)
+
+# Add raw vectors. Ids may be strings or integers; integer ids stay numbers.
+dataset.insert(vectors: [
+  { id: 1, values: [0.1, 0.2, 0.3], metadata: { title: "Intro" } },
+  { id: "doc-002", values: [0.4, 0.5, 0.6], metadata: { title: "Details" } }
+])
+
+results = dataset.search("What powers VectorAmp?", top_k: 5, include_documents: true)
+answer = dataset.ask("What powers VectorAmp?")
+```
+
+### Creating datasets
+
+```ruby
+# Minimal: name only.
+client.datasets.create(name: "docs")
+
+# Enable hybrid (dense + sparse) search.
+client.datasets.create(name: "docs", hybrid: true)
+
+# Use an OpenAI embedding model (dim inferred from the model).
+client.datasets.create(name: "docs", embedding: VectorAmp::Embedding.openai("large"))
+
+# Custom/unknown model: pass dim explicitly.
+client.datasets.create(name: "docs", embedding: { provider: "acme", model: "acme-embed" }, dim: 1024)
+```
+
+## Configuration
+
+```ruby
+client = VectorAmp::Client.new(
+  api_key: "va_...",
+  base_url: "https://api.vectoramp.com",
+  timeout: 30
+)
+```
+
+`api_key` defaults to `ENV["VECTORAMP_API_KEY"]`.
+
+## Datasets
+
+```ruby
+# Paginated envelope: { "datasets" => [VectorAmp::Dataset, ...], "total" => n, "limit" => 50, "offset" => 0 }
+page = client.datasets.list(limit: 50, offset: 0)
+dataset = page["datasets"].first
+
+# Object->method style (preferred).
+dataset = client.datasets.get("dataset-uuid")
+dataset.stats
+dataset.search(
+  "wireless headphones",
+  top_k: 10,
+  filters: { category: "electronics" },
+  advanced_filters: [
+    { field: "price", op: "lt", value: 100.0 }
+  ],
+  include_metadata: true,
+  include_documents: false,
+  rerank: true # expands to vectoramp / VectorAmp-Rerank-v1
+)
+dataset.insert(vectors: [{ id: "sku-1", values: [0.1, 0.2], metadata: { category: "electronics" } }])
+dataset.add_texts(["Wireless headphones"], metadata: { category: "electronics" })
+dataset.ask("Which headphones should I buy?")
+dataset.ingest_source("source-uuid")
+dataset.delete
+
+# Hybrid search: pass a sparse query and/or alpha weighting on a hybrid dataset.
+dataset.search("wireless headphones", hybrid: true, sparse_query: "headphones", alpha: 0.5)
+
+# Client-namespaced methods are equivalent and also supported.
+client.datasets.stats("dataset-uuid")
+client.datasets.search("dataset-uuid", "wireless headphones", top_k: 10)
+client.datasets.insert("dataset-uuid", vectors: [])
+```
+
+`client.datasets.create` intentionally does not accept `index_type`; all datasets are created with SABLE.
+
+### Source documents
+
+Dataset document listing is cursor-based: pass `next_cursor` into the next request and do not assume offsets or totals. Downloads return retained original bytes and follow API/storage redirects.
+
+```ruby
+page = client.datasets.list_documents("dataset-uuid", limit: 50, cursor: nil, status: "ready")
+page.fetch("documents").each do |doc|
+  next unless doc["download_available"]
+
+  bytes = client.datasets.download_document("dataset-uuid", doc.fetch("id"))
+end
+
+if page["next_cursor"]
+  next_page = client.datasets.list_documents("dataset-uuid", cursor: page["next_cursor"])
+end
+
+# Resource-style helpers are available too.
+dataset = client.datasets.get("dataset-uuid")
+docs = dataset.list_documents(limit: 25)
+raw = dataset.download_document(docs.fetch("documents").first.fetch("id"))
+```
+
+## Ingestion
+
+```ruby
+# Sources: paginated envelope { "sources" => [...], "total" => n, ... }
+client.ingestion.list_sources(limit: 50, offset: 0)
+client.ingestion.get_source("source-uuid")
+
+# Typed builders cover the supported source_type values:
+# "web", "s3", "gcs", "gdrive", "file_upload", "jira", and "confluence".
+source = client.sources.create_web(
+  start_urls: ["https://docs.example.com"],
+  max_depth: 1,
+  include_assets: true,
+  max_assets_per_page: 5
+)
+
+s3_source = client.sources.create_s3(
+  bucket: "vectoramp-docs",
+  prefix: "public/"
+)
+
+gcs_source = client.sources.create_gcs(bucket: "vectoramp-docs-gcs", prefix: "public/")
+
+jira_source = client.sources.create_jira(
+  cloud_id: "atlassian-cloud-id",
+  project_keys: ["ENG"],
+  include_comments: true # default
+)
+
+confluence_source = client.sources.create_confluence(
+  cloud_id: "atlassian-cloud-id",
+  spaces: ["ENG"],
+  username: "service-account@example.com",
+  api_token: ENV["CONFLUENCE_API_TOKEN"]
+)
+
+gdrive_source = client.sources.create_google_drive(
+  folder_ids: ["google-drive-folder-id"]
+)
+
+file_source = client.sources.create_file_upload
+
+# You can still pass name: when you want control. If omitted, the SDK chooses
+# a readable default from the URL, bucket, Google Drive id, or upload timestamp.
+
+# GenericSource is an escape hatch for API-compatible source configs that are
+# not modeled by a typed SDK helper yet.
+generic_source = VectorAmp::GenericSource.new(
+  source_type: "custom",
+  name: "custom-source",
+  config: { endpoint: "https://example.com/feed" }
+)
+client.sources.create(generic_source)
+
+# The lower-level existing API is still supported.
+source = client.ingestion.create_source(
+  source_type: "web",
+  name: "docs-site",
+  config: { start_urls: ["https://docs.example.com"], max_depth: 1 }
+)
+
+job = client.ingestion.start_job(
+  source_id: source["id"],
+  dataset_id: "dataset-uuid"
+)
+
+# Dataset resources can ingest by source id or by a typed source object that has an id.
+dataset.ingest_source(source["id"])
+typed_source = VectorAmp::WebSource.new(id: source["id"], name: "docs-site", start_urls: ["https://docs.example.com"])
+dataset.ingest_source(typed_source)
+
+# Jobs: paginated envelope { "jobs" => [...], "total" => n, ... }
+client.ingestion.list_jobs(dataset_id: "dataset-uuid", limit: 50, offset: 0)
+client.ingestion.get_job(job["job_id"])
+client.ingestion.job_files(job["job_id"])
+client.ingestion.job_statistics(job["job_id"])
+client.ingestion.cancel_job(job["job_id"])
+```
+
+### Upload files from the filesystem
+
+`ingest_files` uses the REST upload flow: create a `file_upload` source, initialize upload, PUT bytes to presigned URLs, then complete the upload.
+
+```ruby
+client.ingestion.ingest_files(
+  dataset_id: "dataset-uuid",
+  paths: ["docs/whitepaper.pdf", "docs/notes.md"],
+  metadata: { team: "product" }
+)
+
+# Or from a Dataset resource. No source name is required; the SDK creates a
+# file_upload source with a generated name before uploading.
+dataset.ingest_files(paths: ["docs/whitepaper.pdf"])
+```
+
+## Intelligence / RAG
+
+Non-streaming:
+
+```ruby
+answer = client.ask(
+  "What are the key features?",
+  dataset_id: "all",
+  top_k: 5
+)
+puts answer["answer"]
+```
+
+Multi-turn conversations: the Intelligence API is stateless, so send prior turns
+in `conversation_history`. You decide how many previous messages to include.
+
+```ruby
+history = [
+  { role: "user", content: "What are the key features?" },
+  { role: "assistant", content: "Hybrid search, reranking, and managed ingestion." }
+]
+
+follow_up = client.intelligence.query(
+  "Which of those help with relevance?",
+  dataset_id: "all",
+  conversation_history: history.last(10) # include as many prior turns as you want
+)
+puts follow_up["answer"]
+```
+
+Streaming SSE:
+
+```ruby
+client.ask_stream("Summarize the docs", dataset_id: "dataset-uuid") do |event|
+  print event["content"] if event["chunk_type"] == "text"
+end
+
+# Or as an Enumerator:
+client.ask_stream("Summarize").each do |event|
+  puts event.inspect
+end
+```
+
+### Sessions
+
+Persist multi-turn conversations server-side instead of resending history.
+
+```ruby
+session = client.intelligence.create_session(title: "Onboarding", dataset_id: "dataset-uuid")
+
+client.intelligence.append_message(session.fetch("id"), role: "user", content: "What is SABLE?")
+client.intelligence.append_message(session.fetch("id"), role: "assistant", content: "A managed index type.")
+
+messages = client.intelligence.list_messages(session.fetch("id"))
+sessions = client.intelligence.list_sessions(limit: 20)
+client.intelligence.get_session(session.fetch("id"))
+client.intelligence.delete_session(session.fetch("id"))
+```
+
+## Error handling
+
+Non-2xx responses raise `VectorAmp::APIError` with `status`, `body`, and `headers`.
+
+```ruby
+begin
+  client.datasets.get("missing")
+rescue VectorAmp::APIError => e
+  warn "VectorAmp API error #{e.status}: #{e.message}"
+end
+```
+
+## Development
+
+```bash
+bundle install
+bundle exec rake test
+```
+
+Tests mock HTTP with WebMock and enforce SimpleCov coverage.
+
+## Method reference
+
+Both access styles work everywhere: `client.datasets.<m>(id, ...)` and the
+equivalent `datasetObj.<m>(...)` on a returned `VectorAmp::Dataset`.
+
+### Datasets — `client.datasets`
+
+| Method | Required | Optional (defaults) |
+|---|---|---|
+| `create(name:)` | `name` | `dim` (inferred), `embedding` (vectoramp/VectorAmp-Embedding-4B), `metric` ("cosine"), `hybrid`, `filters`, `metadata_schema`, `tuning`, `metadata` |
+| `list` | — | `limit` (50), `offset` (0) |
+| `get(id)` | `id` | — |
+| `delete(id)` | `id` | — |
+| `stats(id)` | `id` | — |
+| `search(id, query = nil)` | `id` | `query`/`query_text`/`search_text`, `top_k` (10), `filters`, `advanced_filters`, `hybrid`, `sparse_query`, `alpha`, `rerank`, `include_documents`, `include_metadata`, `include_embeddings`, `embedding_model`, `embedding_provider`, `nprobe_override`, `rerank_depth_override` |
+| `insert(id, vectors:)` | `id`, `vectors` | — (integer ids preserved as numbers) |
+| `embed(id)` | `id` | `text`, `texts` (one required) |
+| `add_texts(id, texts = nil)` | `id`, `texts` | `ids` (auto-generated), `metadata` |
+| `list_documents(id)` | `id` | `limit` (50), `cursor`, `status` |
+| `download_document(id, document_id)` | `id`, `document_id` | — |
+
+Dataset-object helpers: `search`, `insert`, `add_texts`, `embed`, `delete`, `stats`,
+`list_documents`, `download_document`, `ask`, `ingest_source`, `ingest_files`.
+
+### Intelligence — `client.intelligence` (and `client.ask` / `client.ask_stream`)
+
+| Method | Required | Optional (defaults) |
+|---|---|---|
+| `query(query)` / `ask` / `ask_stream` | `query` | `dataset_id` ("all" when unscoped), `top_k` (5 server-side), `conversation_history`, `include_sources`, `stream` |
+| `create_session` | — | `title`, `dataset_id`, `workspace_id`, `metadata` |
+| `list_sessions` | — | `limit` (50) |
+| `get_session(session_id)` | `session_id` | — |
+| `delete_session(session_id)` | `session_id` | — |
+| `append_message(session_id, role:, content:)` | `session_id`, `role`, `content` | `metadata` |
+| `list_messages(session_id)` | `session_id` | `limit` (100) |
+
+### Sources — `client.sources` (alias of `client.ingestion`)
+
+`create(source)`, `create_web(start_urls:)`, `create_s3(bucket:)`, `create_gcs(bucket:)`,
+`create_google_drive(folder_ids:|file_ids:)`, `create_jira(cloud_id:)`,
+`create_confluence(cloud_id:|base_url:)`, `create_file_upload`, `list_sources`, `get_source(id)`.
+Jobs: `start_job(source_id:, dataset_id:)`, `list_jobs`, `get_job(id)`, `retry_job(id)`,
+`ingest_files(dataset_id:, paths:)`.
+
+### Schedules — `client.schedules`
+
+`list`, `get(id)`, `create(source_id:, dataset_id:, cron:)`, `update(id)`, `delete(id)`, `trigger(id)`.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).

data/lib/vector_amp/client.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative "connections"
+require_relative "datasets"
+require_relative "error"
+require_relative "ingestion"
+require_relative "intelligence"
+require_relative "schedules"
+require_relative "source"
+require_relative "transport/http"
+
+module VectorAmp
+  # Top-level API client for VectorAmp datasets, ingestion sources/jobs, and intelligence.
+  class Client
+    DEFAULT_BASE_URL = "https://api.vectoramp.com"
+
+    # @return [String] API base URL used by this client.
+    # @return [DatasetsResource] dataset API resource.
+    # @return [IngestionResource] ingestion/source API resource.
+    # @return [IntelligenceResource] intelligence API resource.
+    # @return [ConnectionsResource] managed provider connections API resource.
+    attr_reader :base_url, :datasets, :ingestion, :intelligence, :schedules, :sources, :connections
+
+    # Create a VectorAmp API client.
+    # @param api_key [String] API key; defaults to ENV["VECTORAMP_API_KEY"].
+    # @param base_url [String] API base URL; defaults to the production API.
+    # @param transport [#request, nil] optional custom transport for tests or advanced use.
+    # @param timeout [Numeric] HTTP timeout in seconds for the default transport.
+    # @return [Client]
+    # @raise [ConfigurationError] when api_key is missing.
+    def initialize(api_key: ENV["VECTORAMP_API_KEY"], base_url: DEFAULT_BASE_URL, transport: nil, timeout: Transport::HTTP::DEFAULT_TIMEOUT)
+      raise ConfigurationError, "api_key is required" if api_key.nil? || api_key.empty?
+
+      @base_url = base_url
+      @transport = transport || Transport::HTTP.new(base_url: base_url, api_key: api_key, timeout: timeout)
+      @ingestion = IngestionResource.new(@transport)
+      @sources = @ingestion
+      @schedules = SchedulesResource.new(@transport)
+      @intelligence = IntelligenceResource.new(@transport)
+      @connections = ConnectionsResource.new(@transport)
+      @datasets = DatasetsResource.new(@transport, client: self)
+    end
+
+    # Ask an intelligence question and return a complete response.
+    # @param query [String] natural-language question.
+    # @param options [Hash] forwarded to {IntelligenceResource#query}; `stream` is forced to false.
+    # @return [Hash] intelligence response.
+    def ask(query, **options)
+      @intelligence.query(query, **options.merge(stream: false))
+    end
+
+    # Ask an intelligence question as a stream.
+    # @param query [String] natural-language question.
+    # @param options [Hash] forwarded to {IntelligenceResource#query}; `stream` is forced to true.
+    # @yieldparam chunk [Object] streamed response chunk from the transport.
+    # @return [Enumerator, Object] enumerator without a block, otherwise the transport result.
+    def ask_stream(query, **options, &block)
+      @intelligence.query(query, **options.merge(stream: true), &block)
+    end
+  end
+end