vector_amp 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 275fe25e338462efa98c327a40e334085c4cbad95e720fc3ca3adecb25afa31c
-  data.tar.gz: ec1e9abc640c9a76a2203550d277c20152828ff341bb91084594170cf572beae
+  metadata.gz: 7147209a61689dee14e2d37581f33cad58fb5291543edb086fcafdf841e71c0a
+  data.tar.gz: c399a9373b4820d6c141362b29e2b81bc34de71a02ecb0d69c7780febdbd3674
 SHA512:
-  metadata.gz: 3fa5d4c3be9cae14083865ee02cfbe99bd72712ecd3ee461db487f10a51ac9c24c6810616b8d918154f1016d6971bb9d5412327221bb983ab39e821940da1595
-  data.tar.gz: 18267f1db75a0b97685a123be17caa021594fa09f6212b6f3f99bc52554a8423e963bac34d6e0f5a266467b017d981fec0f5f6f2c6dd42ef4151ab776dc205aa
+  metadata.gz: 6b2f983acc42db9c33801bcbe726537975af6d6ec9eab12a542a860ac5836fa417e07bb35ddfd6e4f7a55f0b6311c4ee5793d192427e5182c5fff11aae9849c4
+  data.tar.gz: 2d720c1922917177c98cf7ddab94b9f2f20ef0654e31f673d47f4283459cca5c9808851875bf2a28a40ff9f6d63a7634bd852b0a74539453c6e7dff9d4dd58b1

data/README.md

@@ -153,6 +153,20 @@ client.org_secrets.put_openai_api_key(
 )
 ```
 
+Declare typed metadata at creation, then merge fields or replace the complete schema:
+
+```ruby
+schema = [
+  VectorAmp::MetadataSchema.field(:category, VectorAmp::MetadataSchema::STRING),
+  VectorAmp::MetadataSchema.field(:price, VectorAmp::MetadataSchema::F32)
+]
+dataset = client.datasets.create(name: "products", metadata_schema: schema)
+dataset.patch_metadata_schema([VectorAmp::MetadataSchema.field(:inventory, VectorAmp::MetadataSchema::U32)])
+dataset.replace_metadata_schema(schema) # [] removes all declared fields
+```
+
+Canonical types are `STRING`, `U32`, `I32`, `I64`, `F32`, and `F64`.
+
 ### 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.
@@ -360,6 +374,8 @@ equivalent `datasetObj.<m>(...)` on a returned `VectorAmp::Dataset`.
 | Method | Required | Optional (defaults) |
 |---|---|---|
 | `create(name:)` | `name` | `dim` (inferred), `embedding` (vectoramp/VectorAmp-Embedding-4B), `metric` ("cosine"), `hybrid`, `filters`, `metadata_schema`, `tuning`, `metadata` |
+| `patch_metadata_schema(id, schema)` | `id`, `schema` | — |
+| `replace_metadata_schema(id, schema)` | `id`, `schema` | — |
 | `list` | — | `limit` (50), `offset` (0) |
 | `get(id)` | `id` | — |
 | `delete(id)` | `id` | — |

data/lib/vector_amp/dataset.rb

@@ -95,13 +95,22 @@ module VectorAmp
       service.delete(id)
     end
 
+    # Add or update typed metadata fields, retaining omitted fields.
+    def patch_metadata_schema(schema)
+      service.patch_metadata_schema(id, schema)
+    end
+
+    # Replace the complete typed metadata schema.
+    def replace_metadata_schema(schema)
+      service.replace_metadata_schema(id, schema)
+    end
+
     # Fetch stats for this dataset.
     # @return [Hash] dataset statistics.
     def stats
       service.stats(id)
     end
 
-
     # List retained source documents for this dataset using cursor pagination.
     # @param limit [Integer, nil] maximum documents to return.
     # @param cursor [String, nil] cursor from a previous response's `next_cursor`.

data/lib/vector_amp/datasets.rb

@@ -59,7 +59,7 @@ module VectorAmp
     # @param metric [String] distance metric; defaults to `cosine`.
     # @param hybrid [Boolean, nil] enable hybrid (dense + sparse) search; sends `hybrid: true`.
     # @param filters [Hash, nil] optional filter schema/config.
-    # @param metadata_schema [Hash, nil] optional metadata schema.
+    # @param metadata_schema [Array<Hash>, Hash, nil] optional metadata schema.
     # @param tuning [Hash, nil] optional SABLE tuning parameters.
     # @param metadata [Hash, nil] optional dataset metadata.
     # @return [Dataset] created dataset.
@@ -85,7 +85,7 @@ module VectorAmp
         index_type: "sable",
         hybrid: hybrid,
         filters: filters,
-        metadata_schema: metadata_schema,
+        schema: normalize_metadata_schema(metadata_schema),
         tuning: tuning,
         metadata: metadata
       )
@@ -115,6 +115,21 @@ module VectorAmp
       create(name: name, embedding: Embedding.openai(size, secret_ref: secret_ref), **options)
     end
 
+    # Add or update typed metadata fields, retaining omitted fields.
+    # @param dataset_id [String] dataset id.
+    # @param schema [Array<Hash>] fields with `name` and canonical `type`.
+    # @return [Dataset] updated dataset.
+    def patch_metadata_schema(dataset_id, schema)
+      update_metadata_schema(dataset_id, schema, "merge")
+    end
+
+    # Replace the complete typed metadata schema.
+    # @param dataset_id [String] dataset id.
+    # @param schema [Array<Hash>] complete field list; may be empty.
+    # @return [Dataset] updated dataset.
+    def replace_metadata_schema(dataset_id, schema)
+      update_metadata_schema(dataset_id, schema, "replace")
+    end
 
     # List retained source documents for a dataset using cursor pagination.
     # @param dataset_id [String] dataset id.
@@ -268,6 +283,25 @@ module VectorAmp
       end
     end
 
+    def normalize_metadata_schema(schema)
+      return schema unless schema.is_a?(Hash)
+
+      schema.map do |name, config|
+        raise ArgumentError, "metadata schema field #{name.inspect} must be a Hash" unless config.is_a?(Hash)
+
+        { name: name.to_s }.merge(config)
+      end
+    end
+
+    def update_metadata_schema(dataset_id, schema, mode)
+      response = @transport.request(
+        :patch,
+        "/datasets/#{dataset_id}/schema",
+        body: { schema: schema, mode: mode }
+      )
+      wrap_dataset(response)
+    end
+
     def wrap_dataset(data)
       Dataset.new(data, service: self, client: @client)
     end

data/lib/vector_amp/metadata_schema.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module VectorAmp
+  # Helpers and canonical scalar types for dataset metadata schemas.
+  module MetadataSchema
+    STRING = "string"
+    U32 = "u32"
+    I32 = "i32"
+    I64 = "i64"
+    F32 = "f32"
+    F64 = "f64"
+    TYPES = [STRING, U32, I32, I64, F32, F64].freeze
+
+    def self.field(name, type)
+      raise ArgumentError, "unsupported metadata schema type: #{type.inspect}" unless TYPES.include?(type)
+
+      { name: name.to_s, type: type }
+    end
+  end
+end

data/lib/vector_amp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module VectorAmp
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/vector_amp.rb

@@ -5,6 +5,7 @@ require_relative "vector_amp/client"
 require_relative "vector_amp/embedding"
 require_relative "vector_amp/error"
 require_relative "vector_amp/org_secrets"
+require_relative "vector_amp/metadata_schema"
 require_relative "vector_amp/source"
 
 module VectorAmp

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vector_amp
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - VectorAmp
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-07-14 00:00:00.000000000 Z
+date: 2026-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -114,6 +114,7 @@ files:
 - lib/vector_amp/error.rb
 - lib/vector_amp/ingestion.rb
 - lib/vector_amp/intelligence.rb
+- lib/vector_amp/metadata_schema.rb
 - lib/vector_amp/org_secrets.rb
 - lib/vector_amp/schedules.rb
 - lib/vector_amp/source.rb