Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ERROR] metric_type should be metricType in Create Collection API docs #942

Open
ivhacks opened this issue Sep 16, 2024 · 0 comments
Open

Comments

@ivhacks
Copy link

ivhacks commented Sep 16, 2024

Where is the error
https://milvus.io/api-reference/restful/v2.4.x/v2/Collection%20(v2)/Create.md

How would you like to improve it
Change all instances of metric_type to metricType

I'm learning about Milvus and am trying to create a database to compare colors by Euclidean distance. When I run the following commands, as per the current docs, to create and describe a collection, its metric type shows as the default, COSINE (note the snake_case on metric_type):

curl -s --request POST "http://localhost:19530/v2/vectordb/collections/create" \
--data-raw '{
    "collectionName": "colors",
    "dimension": 3,
    "metric_type": "L2",
    "autoId": true
}'

curl -s --request POST "http://localhost:19530/v2/vectordb/collections/describe" --data-raw '{
    "collectionName": "colors"
}' | jq

However, when I change it to metricType, it properly comes back as using L2:

curl -s --request POST "http://localhost:19530/v2/vectordb/collections/create" \
--data-raw '{
    "collectionName": "colors",
    "dimension": 3,
    "metricType": "L2",
    "autoId": true
}'

curl -s --request POST "http://localhost:19530/v2/vectordb/collections/describe" --data-raw '{
    "collectionName": "colors"
}' | jq
@ivhacks ivhacks changed the title [ERROR] metric_type should be metricType [ERROR] metric_type should be metricType in Create Collection API docs Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant