Weaviate
Store rows with their vectors in Weaviate and search them by similarity with where filters. Typical uses: give an LLM the closest documents (RAG), find similar records.
weaviate pingweaviate collection_createweaviate collection_createweaviate collectionsweaviate collection_dropweaviate insertweaviate insertweaviate collection_infoweaviate searchweaviate searchweaviate findweaviate findweaviate getweaviate getweaviate countweaviate countweaviate deleteweaviate delete_whereweaviate requestweaviate request

weaviate ping <config>


Description

    Test the connection: {engine, version}

Parameters

    config:   The Weaviate configuration as JSON: url (http://127.0.0.1:8080), api_key (the name of a secret: secret set), allow_plain (false: an API key over http is refused unless the host is localhost, 127.0.0.1 or ::1; true: accept to send it in clear), timeout_ms (30000), max_bytes (64 MB, the limit of a response, 256 MB at most). The key goes in Authorization: Bearer - String - required
admin
weaviate ping "{\"url\": \"http://localhost:8080\"}"
mentdb
{"engine": "weaviate", "version": "1.40.5"}

weaviate collection_create <config> <collection>


Description

    Create a class without vectorizer, with the cosine distance; the properties are created by Weaviate from the data. Returns {created}

Parameters

    config:   The Weaviate configuration as JSON: url (http://127.0.0.1:8080), api_key (the name of a secret: secret set), allow_plain (false: an API key over http is refused unless the host is localhost, 127.0.0.1 or ::1; true: accept to send it in clear), timeout_ms (30000), max_bytes (64 MB, the limit of a response, 256 MB at most). The key goes in Authorization: Bearer - String - required
    collection:   The collection (a Weaviate class): a letter then letters, digits or _; the first letter is put in capital, as Weaviate does - String - required
admin
weaviate collection_create "{\"url\": \"http://localhost:8080\"}" "Notes"
mentdb
{"created": "Notes"}

weaviate collection_create <config> <collection> <json_options>


Description

    Create with options: distance (cosine, dot, l2-squared, hamming, manhattan), properties (an object {name: type}, types like text, int, number, boolean, date, uuid, text[]), description

Parameters

    config:   The Weaviate configuration as JSON: url (http://127.0.0.1:8080), api_key (the name of a secret: secret set), allow_plain (false: an API key over http is refused unless the host is localhost, 127.0.0.1 or ::1; true: accept to send it in clear), timeout_ms (30000), max_bytes (64 MB, the limit of a response, 256 MB at most). The key goes in Authorization: Bearer - String - required
    collection:   The collection (a Weaviate class): a letter then letters, digits or _; the first letter is put in capital, as Weaviate does - String - required
    json_options:   The options: see the description - String - required
admin
weaviate collection_create "{\"url\": \"http://localhost:8080\"}" "Faq" "{\"properties\": {\"title\": \"text\", \"lang\": \"text\", \"views\": \"int\"}}"
mentdb
{"created": "Faq"}

weaviate collections <config>


Description

    The names of the classes, as a JSON array

Parameters

    config:   The Weaviate configuration as JSON: url (http://127.0.0.1:8080), api_key (the name of a secret: secret set), allow_plain (false: an API key over http is refused unless the host is localhost, 127.0.0.1 or ::1; true: accept to send it in clear), timeout_ms (30000), max_bytes (64 MB, the limit of a response, 256 MB at most). The key goes in Authorization: Bearer - String - required
admin
weaviate collections "{\"url\": \"http://localhost:8080\"}"
mentdb
["Notes", "Faq"]

weaviate collection_drop <config> <collection>


Description

    Delete a class and its objects. Returns {dropped: name}, or {dropped: null} if it did not exist

Parameters

    config:   The Weaviate configuration as JSON: url (http://127.0.0.1:8080), api_key (the name of a secret: secret set), allow_plain (false: an API key over http is refused unless the host is localhost, 127.0.0.1 or ::1; true: accept to send it in clear), timeout_ms (30000), max_bytes (64 MB, the limit of a response, 256 MB at most). The key goes in Authorization: Bearer - String - required
    collection:   The collection (a Weaviate class): a letter then letters, digits or _; the first letter is put in capital, as Weaviate does - String - required
admin
weaviate collection_drop "{\"url\": \"http://localhost:8080\"}" "Notes"
mentdb
{"dropped": "Notes"}
no such class (fixed result: real Weaviate 1.40.5)
admin
weaviate collection_drop "{\"url\": \"http://localhost:8080\"}" "Nothing"
mentdb
{"dropped": null}

weaviate insert <config> <collection> <rows_json>


Description

    Insert or replace objects from rows with the batch API (see the description). Returns {inserted, errors}

Parameters

    config:   The Weaviate configuration as JSON: url (http://127.0.0.1:8080), api_key (the name of a secret: secret set), allow_plain (false: an API key over http is refused unless the host is localhost, 127.0.0.1 or ::1; true: accept to send it in clear), timeout_ms (30000), max_bytes (64 MB, the limit of a response, 256 MB at most). The key goes in Authorization: Bearer - String - required
    collection:   The collection (a Weaviate class): a letter then letters, digits or _; the first letter is put in capital, as Weaviate does - String - required
    rows_json:   The rows: a JSON array of objects with an id, a vector field and other fields; or a JSON array of texts (the output of llm chunk) with the parameter vectors - String - required
admin
weaviate insert "{\"url\": \"http://localhost:8080\"}" "Faq" "[{\"id\": 1, \"title\": \"Refund policy\", \"lang\": \"en\", \"embedding\": [0.9, 0.1, 0], \"views\": 10}, {\"id\": 2, \"title\": \"Delivery times\", \"lang\": \"en\", \"embedding\": [0.1, 0.9, 0], \"views\": 3}, {\"id\": \"doc-3\", \"title\": \"Retours\", \"lang\": \"fr\", \"embedding\": [0.8, 0.2, 0.1], \"views\": 7}]"
mentdb
{"inserted": 3, "errors": []}
a vector of another dimension: an error for this row only (fixed result: real Weaviate 1.40.5)
admin
weaviate insert "{\"url\": \"http://localhost:8080\"}" "Faq" "[{\"id\": 9, \"title\": \"Bad\", \"embedding\": [1, 0]}]"
mentdb
{"inserted": 0, "errors": [{"row": 1, "error": "Validate vector index for 45c48cce-2e2d-3fbd-aa1a-fc51c7c6ad26: new node has a vector with length 2. Existing nodes have vectors with length 3: vector dimensions do not match the index dimensions"}]}

weaviate insert <config> <collection> <rows_json> <json_options>


Description

    Insert with options: id_field (id), vector_field (embedding), text_field (text), vectors, fields, batch_size (100)

Parameters

    config:   The Weaviate configuration as JSON: url (http://127.0.0.1:8080), api_key (the name of a secret: secret set), allow_plain (false: an API key over http is refused unless the host is localhost, 127.0.0.1 or ::1; true: accept to send it in clear), timeout_ms (30000), max_bytes (64 MB, the limit of a response, 256 MB at most). The key goes in Authorization: Bearer - String - required
    collection:   The collection (a Weaviate class): a letter then letters, digits or _; the first letter is put in capital, as Weaviate does - String - required
    rows_json:   The rows: a JSON array of objects with an id, a vector field and other fields; or a JSON array of texts (the output of llm chunk) with the parameter vectors - String - required
    json_options:   The options: see the description - String - required
admin
weaviate insert "{\"url\": \"http://localhost:8080\"}" "Faq" "[\"Refunds are paid within 14 days.\", \"Our shops open at 8 am.\"]" "{\"vectors\": [[0.85, 0.15, 0.05], [0, 0.2, 0.95]]}"
mentdb
{"inserted": 2, "errors": []}

weaviate collection_info <config> <collection>


Description

    A class: {name, distance, vectorizer, properties {name: type}, count}

Parameters

    config:   The Weaviate configuration as JSON: url (http://127.0.0.1:8080), api_key (the name of a secret: secret set), allow_plain (false: an API key over http is refused unless the host is localhost, 127.0.0.1 or ::1; true: accept to send it in clear), timeout_ms (30000), max_bytes (64 MB, the limit of a response, 256 MB at most). The key goes in Authorization: Bearer - String - required
    collection:   The collection (a Weaviate class): a letter then letters, digits or _; the first letter is put in capital, as Weaviate does - String - required
admin
weaviate collection_info "{\"url\": \"http://localhost:8080\"}" "Faq"
mentdb
{"name": "Faq", "distance": "cosine", "vectorizer": "none", "properties": {"title": "text", "lang": "text", "views": "int", "source_id": "text", "text": "text"}, "count": 5}

weaviate find <config> <collection> <filter_json>


Description

    The objects matching a where filter ({}: all), without vectors, 100 at most

Parameters

    config:   The Weaviate configuration as JSON: url (http://127.0.0.1:8080), api_key (the name of a secret: secret set), allow_plain (false: an API key over http is refused unless the host is localhost, 127.0.0.1 or ::1; true: accept to send it in clear), timeout_ms (30000), max_bytes (64 MB, the limit of a response, 256 MB at most). The key goes in Authorization: Bearer - String - required
    collection:   The collection (a Weaviate class): a letter then letters, digits or _; the first letter is put in capital, as Weaviate does - String - required
    filter_json:   The filter as a JSON object ({} or an empty text: no filter) - String - required
admin
weaviate find "{\"url\": \"http://localhost:8080\"}" "Faq" "{\"path\": [\"lang\"], \"operator\": \"Equal\", \"valueText\": \"en\"}"
mentdb
[{"id": "c4ca4238-a0b9-3382-8dcc-509a6f75849b", "title": "Refund policy", "lang": "en", "views": 10, "source_id": "1"}, {"id": "c81e728d-9d4c-3f63-af06-7f89cc14862c", "title": "Delivery times", "lang": "en", "views": 3, "source_id": "2"}]

weaviate find <config> <collection> <filter_json> <json_options>


Description

    Find with options: limit (100), skip (limit + skip: 10000 at most), fields, with_vector, vector_field

Parameters

    config:   The Weaviate configuration as JSON: url (http://127.0.0.1:8080), api_key (the name of a secret: secret set), allow_plain (false: an API key over http is refused unless the host is localhost, 127.0.0.1 or ::1; true: accept to send it in clear), timeout_ms (30000), max_bytes (64 MB, the limit of a response, 256 MB at most). The key goes in Authorization: Bearer - String - required
    collection:   The collection (a Weaviate class): a letter then letters, digits or _; the first letter is put in capital, as Weaviate does - String - required
    filter_json:   The filter as a JSON object ({} or an empty text: no filter) - String - required
    json_options:   The options: see the description - String - required
admin
weaviate find "{\"url\": \"http://localhost:8080\"}" "Faq" "{}" "{\"limit\": 2, \"skip\": 1, \"fields\": [\"title\"]}"
mentdb
[{"id": "ba60c502-ea42-34a6-88aa-96329f33b3d5"}, {"id": "c4ca4238-a0b9-3382-8dcc-509a6f75849b", "title": "Refund policy"}]

weaviate get <config> <collection> <id>


Description

    An object by its id (a UUID, or a text turned into its UUID as in weaviate insert), as an object; null if absent

Parameters

    config:   The Weaviate configuration as JSON: url (http://127.0.0.1:8080), api_key (the name of a secret: secret set), allow_plain (false: an API key over http is refused unless the host is localhost, 127.0.0.1 or ::1; true: accept to send it in clear), timeout_ms (30000), max_bytes (64 MB, the limit of a response, 256 MB at most). The key goes in Authorization: Bearer - String - required
    collection:   The collection (a Weaviate class): a letter then letters, digits or _; the first letter is put in capital, as Weaviate does - String - required
    id:   The id - String - required
admin
weaviate get "{\"url\": \"http://localhost:8080\"}" "Faq" "doc-3"
mentdb
{"id": "7ae5a3b8-ab44-30ba-b3c6-3c7c721f959f", "lang": "fr", "source_id": "doc-3", "title": "Retours", "views": 7}
absent (fixed result: real Weaviate 1.40.5)
admin
weaviate get "{\"url\": \"http://localhost:8080\"}" "Faq" "nothing"
mentdb
null

weaviate get <config> <collection> <id> <json_options>


Description

    Get with options: with_vector, vector_field

Parameters

    config:   The Weaviate configuration as JSON: url (http://127.0.0.1:8080), api_key (the name of a secret: secret set), allow_plain (false: an API key over http is refused unless the host is localhost, 127.0.0.1 or ::1; true: accept to send it in clear), timeout_ms (30000), max_bytes (64 MB, the limit of a response, 256 MB at most). The key goes in Authorization: Bearer - String - required
    collection:   The collection (a Weaviate class): a letter then letters, digits or _; the first letter is put in capital, as Weaviate does - String - required
    id:   The id - String - required
    json_options:   The options: see the description - String - required
admin
weaviate get "{\"url\": \"http://localhost:8080\"}" "Faq" "1" "{\"with_vector\": true}"
mentdb
{"id": "c4ca4238-a0b9-3382-8dcc-509a6f75849b", "embedding": [0.9, 0.1, 0], "lang": "en", "source_id": "1", "title": "Refund policy", "views": 10}

weaviate count <config> <collection>


Description

    The number of objects (Aggregate)

Parameters

    config:   The Weaviate configuration as JSON: url (http://127.0.0.1:8080), api_key (the name of a secret: secret set), allow_plain (false: an API key over http is refused unless the host is localhost, 127.0.0.1 or ::1; true: accept to send it in clear), timeout_ms (30000), max_bytes (64 MB, the limit of a response, 256 MB at most). The key goes in Authorization: Bearer - String - required
    collection:   The collection (a Weaviate class): a letter then letters, digits or _; the first letter is put in capital, as Weaviate does - String - required
admin
weaviate count "{\"url\": \"http://localhost:8080\"}" "Faq"
mentdb
5

weaviate count <config> <collection> <filter_json>


Description

    The number of objects matching a where filter

Parameters

    config:   The Weaviate configuration as JSON: url (http://127.0.0.1:8080), api_key (the name of a secret: secret set), allow_plain (false: an API key over http is refused unless the host is localhost, 127.0.0.1 or ::1; true: accept to send it in clear), timeout_ms (30000), max_bytes (64 MB, the limit of a response, 256 MB at most). The key goes in Authorization: Bearer - String - required
    collection:   The collection (a Weaviate class): a letter then letters, digits or _; the first letter is put in capital, as Weaviate does - String - required
    filter_json:   The filter as a JSON object ({} or an empty text: no filter) - String - required
admin
weaviate count "{\"url\": \"http://localhost:8080\"}" "Faq" "{\"path\": [\"lang\"], \"operator\": \"Equal\", \"valueText\": \"en\"}"
mentdb
2

weaviate delete <config> <collection> <id>


Description

    Delete an object by its id. Returns {deleted: 1}, or 0 if absent

Parameters

    config:   The Weaviate configuration as JSON: url (http://127.0.0.1:8080), api_key (the name of a secret: secret set), allow_plain (false: an API key over http is refused unless the host is localhost, 127.0.0.1 or ::1; true: accept to send it in clear), timeout_ms (30000), max_bytes (64 MB, the limit of a response, 256 MB at most). The key goes in Authorization: Bearer - String - required
    collection:   The collection (a Weaviate class): a letter then letters, digits or _; the first letter is put in capital, as Weaviate does - String - required
    id:   The id - String - required
admin
weaviate delete "{\"url\": \"http://localhost:8080\"}" "Faq" "doc-3"
mentdb
{"deleted": 1}
absent (fixed result: real Weaviate 1.40.5)
admin
weaviate delete "{\"url\": \"http://localhost:8080\"}" "Faq" "nothing"
mentdb
{"deleted": 0}

weaviate delete_where <config> <collection> <filter_json>


Description

    Delete the objects matching a where filter with the batch delete (an empty filter is refused). Returns {deleted, failed, errors}

Parameters

    config:   The Weaviate configuration as JSON: url (http://127.0.0.1:8080), api_key (the name of a secret: secret set), allow_plain (false: an API key over http is refused unless the host is localhost, 127.0.0.1 or ::1; true: accept to send it in clear), timeout_ms (30000), max_bytes (64 MB, the limit of a response, 256 MB at most). The key goes in Authorization: Bearer - String - required
    collection:   The collection (a Weaviate class): a letter then letters, digits or _; the first letter is put in capital, as Weaviate does - String - required
    filter_json:   The filter as a JSON object ({} or an empty text: no filter) - String - required
admin
weaviate delete_where "{\"url\": \"http://localhost:8080\"}" "Faq" "{\"path\": [\"views\"], \"operator\": \"GreaterThan\", \"valueInt\": 5}"
mentdb
{"deleted": 1, "failed": 0, "errors": []}

weaviate request <config> <method> <path>


Description

    Any GET or DELETE of the REST API: the raw JSON answer

Parameters

    config:   The Weaviate configuration as JSON: url (http://127.0.0.1:8080), api_key (the name of a secret: secret set), allow_plain (false: an API key over http is refused unless the host is localhost, 127.0.0.1 or ::1; true: accept to send it in clear), timeout_ms (30000), max_bytes (64 MB, the limit of a response, 256 MB at most). The key goes in Authorization: Bearer - String - required
    method:   GET, POST, PUT, PATCH, DELETE or HEAD - String - required
    path:   The path relative to the url, like /collections - String - required
admin
weaviate request "{\"url\": \"http://localhost:8080\"}" "GET" "/v1/.well-known/ready"
mentdb
null

weaviate request <config> <method> <path> <body_json>


Description

    Any call of the REST API or of GraphQL with a JSON body: the raw JSON answer

Parameters

    config:   The Weaviate configuration as JSON: url (http://127.0.0.1:8080), api_key (the name of a secret: secret set), allow_plain (false: an API key over http is refused unless the host is localhost, 127.0.0.1 or ::1; true: accept to send it in clear), timeout_ms (30000), max_bytes (64 MB, the limit of a response, 256 MB at most). The key goes in Authorization: Bearer - String - required
    method:   GET, POST, PUT, PATCH, DELETE or HEAD - String - required
    path:   The path relative to the url, like /collections - String - required
    body_json:   The JSON body - String - required
admin
weaviate request "{\"url\": \"http://localhost:8080\"}" "POST" "/v1/graphql" "{\"query\": \"{ Aggregate { Faq { views { mean } } } }\"}"
mentdb
{"data":{"Aggregate":{"Faq":[{"views":{"mean":3}}]}}}