Skip to content
MilvusNode SDK
Sections

Query entities

Markdown

Copy for agent

Connection and CORS help

Use HTTPS for remote clusters or HTTP on loopback. Requests go directly from your browser to the endpoint. Run List collections to populate the collection selector. When copying an authenticated cURL command, set MILVUS_TOKEN in your shell.

For cross-origin requests, configure the endpoint to answer OPTIONS and allow the docs origin, POST, Content-Type, and Authorization if you use a token. Try the copied cURL command to troubleshoot outside the browser.

POST/v2/vectordb/entities/query

{
  "dbName": "default",
  "collectionName": "books",
  "outputFields": [
    "title"
  ],
  "limit": 5
}

Example response

{
  "code": 0,
  "data": [
    {
      "id": 101,
      "title": "Invisible Cities"
    }
  ],
  "cost": 0
}
cURL command
curl --request POST --url 'https://your-cluster.example.com/v2/vectordb/entities/query' \
  --header 'Content-Type: application/json' \
  --header "Authorization: Bearer ${MILVUS_TOKEN}" \
  --data-raw '{
  "dbName": "default",
  "collectionName": "books",
  "outputFields": [
    "title"
  ],
  "limit": 5
}'

Read rows matching a scalar filter. Supply a limit when reading without a filter.

Request fields

dbName string
Database name. Operations on collections use default when omitted.
collectionName string (required)
Name of the collection.
partitionNames array of string
Names of the partitions to target.
outputFields array of string
Field names to include in the returned entities.
filter string
Milvus scalar filter expression.
limit integer
Maximum number of rows or hits per query input.
offset integer
Number of matching results to skip.
orderByFields array of string
Field ordering expressions for sorted results.
groupByFields array of string
Fields used to group query results.
exprParams object
Values for placeholders in a filter expression.
consistencyLevel string
Read consistency level, such as Strong, Session, or Bounded.

See HttpClient.query for the Node.js SDK method.