@spec create(collection_name(), object_data(), Keyword.t()) ::
  WeaviateEx.api_response()

Creates a new object in a collection.

Parameters

• collection_name - The collection to create the object in
• data - Object data including properties and optional vector
• opts - Additional options (consistency_level, etc.)

Data Fields

• :id - Optional UUID (auto-generated if not provided)
• :properties - Object properties matching the collection schema
• :vector - Optional vector embedding (if not using auto-vectorization)

Examples

# Simple object
{:ok, obj} = Objects.create("Article", %{
  properties: %{title: "Hello"}
})

# With custom ID and vector
{:ok, obj} = Objects.create("Article", %{
  id: "550e8400-e29b-41d4-a716-446655440000",
  properties: %{title: "Hello"},
  vector: [0.1, 0.2, 0.3]
})

@spec delete(collection_name(), object_id(), Keyword.t()) :: WeaviateEx.api_response()

Deletes an object.

Examples

{:ok, _} = Objects.delete("Article", uuid)

@spec exists?(collection_name(), object_id(), Keyword.t()) ::
  {:ok, boolean()} | {:error, term()}

Checks if an object exists (using HEAD request).

Returns {:ok, true} if the object exists (204 status). Returns {:error, ...} if the object doesn't exist (404 status).

Examples

case Objects.exists?("Article", uuid) do
  {:ok, true} -> IO.puts("Object exists")
  {:error, %{status: 404}} -> IO.puts("Object not found")
end

@spec fetch_objects_by_ids(collection_name(), [object_id()], Keyword.t()) ::
  WeaviateEx.api_response()

Fetch multiple objects by their UUIDs.

Uses a GraphQL query with a ContainsAny filter and preserves input ordering.

Options

• :return_properties - List of property names to return (default: all)
• :tenant - Tenant name for multi-tenant collections

@spec get(collection_name(), object_id(), Keyword.t()) :: WeaviateEx.api_response()

Retrieves an object by collection name and ID.

Parameters

• collection_name - The collection containing the object
• id - The object UUID
• opts - Additional options (consistency_level, tenant, include)

Examples

{:ok, object} = Objects.get("Article", "550e8400-e29b-41d4-a716-446655440000")

@spec list(collection_name(), Keyword.t()) :: WeaviateEx.api_response()

Lists objects from a collection.

Parameters

• collection_name - The collection to list objects from
• opts - Pagination and filtering options

Options

• :limit - Maximum number of objects to return
• :offset - Number of objects to skip
• :after - Cursor for pagination
• :include - Additional fields to include (e.g., "vector", "classification")
• :sort - Sort order
• :order - Sort direction ("asc" or "desc")

Examples

# Get first 10 objects
{:ok, result} = Objects.list("Article", limit: 10)

# With pagination
{:ok, result} = Objects.list("Article", limit: 10, offset: 20)

# Include vectors
{:ok, result} = Objects.list("Article", limit: 10, include: "vector")

@spec patch(collection_name(), object_id(), object_data(), Keyword.t()) ::
  WeaviateEx.api_response()

Patches an object (partial update).

This performs a PATCH request which merges changes with existing data. After patching, the updated object is fetched and returned.

NOTE: PATCH operations should not include vectors. If you need to update the vector, use update/4 (PUT) instead which replaces the entire object.

Examples

{:ok, patched} = Objects.patch("Article", uuid, %{
  properties: %{title: "Updated Title"}
})

@spec replace(collection_name(), object_id(), object_data(), Keyword.t()) ::
  WeaviateEx.api_response()

Replaces an object entirely (full replacement using PUT).

This is a semantic alias for update/4 that makes the intent clearer. Use this when you want to replace the entire object with new data.

All existing properties will be replaced with the new data. Properties not included in the new data will be removed.

Parameters

• collection_name - The collection containing the object
• id - The object UUID
• data - Complete object data to replace with
• opts - Additional options (consistency_level, tenant, keep_vector)

Options

• :consistency_level - Write consistency level ("ONE", "QUORUM", "ALL")
• :tenant - Tenant name for multi-tenant collections
• :keep_vector - If true, keeps the existing vector (default: false)

Examples

# Replace entire object
{:ok, replaced} = Objects.replace("Article", uuid, %{
  properties: %{title: "New Title", content: "New Content"}
})

# Replace with new vector
{:ok, replaced} = Objects.replace("Article", uuid, %{
  properties: %{title: "New Title"},
  vector: [0.1, 0.2, 0.3]
})

# Replace but keep existing vector
{:ok, replaced} = Objects.replace("Article", uuid, %{
  properties: %{title: "New Title"}
}, keep_vector: true)

@spec update(collection_name(), object_id(), object_data(), Keyword.t()) ::
  WeaviateEx.api_response()

Updates an object (full replacement).

This performs a PUT request which replaces the entire object.

Examples

{:ok, updated} = Objects.update("Article", uuid, %{
  properties: %{title: "New Title", content: "New Content"}
})

@spec validate(collection_name(), object_data(), Keyword.t()) ::
  WeaviateEx.api_response()

Validates an object without creating it.

Useful for checking if object data is valid before insertion.

Examples

{:ok, result} = Objects.validate("Article", %{
  properties: %{title: "Test"}
})