WeaviateEx.Query.Metadata (WeaviateEx v0.7.4)

Metadata selection helpers for queries.

Controls which metadata fields are returned with query results.

Examples

# Return all metadata
Query.get("Article")
|> Query.return_metadata(Metadata.full())

# Return only distance and certainty
Query.get("Article")
|> Query.return_metadata(Metadata.select(["distance", "certainty"]))

# Return common metadata
Query.get("Article")
|> Query.return_metadata(Metadata.common())

Summary

Types

fields()

Functions

common()

Return commonly used metadata fields.

full()

Return all available metadata fields.

select(fields)

Select specific metadata fields.

timestamps()

Return timestamp metadata fields.

to_graphql(fields)

Convert metadata fields to GraphQL format.

Types

fields()

@type fields() :: [String.t()]

Functions

common()

@spec common() :: fields()

Return commonly used metadata fields.

Includes: id, distance, certainty, score

Examples

Metadata.common()

full()

@spec full() :: fields()

Return all available metadata fields.

Includes: id, creationTimeUnix, lastUpdateTimeUnix, distance, certainty, score, explainScore, isConsistent

Examples

Metadata.full()

select(fields)

@spec select(fields()) :: fields()

Select specific metadata fields.

Examples

Metadata.select(["id", "distance"])

timestamps()

@spec timestamps() :: fields()

Return timestamp metadata fields.

Includes: creationTimeUnix, lastUpdateTimeUnix

Examples

Metadata.timestamps()

to_graphql(fields)

@spec to_graphql(fields()) :: String.t()

Convert metadata fields to GraphQL format.

Examples

Metadata.to_graphql(["id", "distance"])
# => "id distance"