Noizu.Weaviate.Api.Nodes (Noizu Weaviate v0.2.0)

Functions for getting information about the Weaviate nodes.

Summary

Functions

Get information about the Weaviate nodes.

Get nodes for a specific collection/class.

Functions

Link to this function

get_information_about_nodes(options \\ nil)

@spec get_information_about_nodes(options :: any()) :: {:ok, any()} | {:error, any()}

Get information about the Weaviate nodes.

Returns

A tuple {:ok, response} on successful API call, where response is the API response. Returns {:error, term} on failure, where term contains error details.

Examples

{:ok, response} = Noizu.Weaviate.Api.Nodes.get_information_about_nodes()
Link to this function

get_nodes_for_collection(class_name, options \\ nil)

@spec get_nodes_for_collection(String.t(), options :: any()) ::
  {:ok, any()} | {:error, any()}

Get nodes for a specific collection/class.

Parameters

  • class_name (required) - The name of the class/collection.
  • options (optional) - Additional options for the API call. Supports :output ("minimal" or "verbose").

Returns

A tuple {:ok, response} on successful API call, where response is the API response. Returns {:error, term} on failure, where term contains error details.

Examples

{:ok, response} = Noizu.Weaviate.Api.Nodes.get_nodes_for_collection("Product")
{:ok, response} = Noizu.Weaviate.Api.Nodes.get_nodes_for_collection("Product", output: "verbose")