cURL
curl --request PATCH \
--url https://{projectHost}/collections/{collectionName} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"indexConfigs": {
"example-field1": {
"type": "text",
"analyzers": [
"english"
]
},
"example-field2": {
"type": "vector",
"dimensions": 128,
"similarity": "cosine"
},
"example-field3": {
"type": "keyword"
}
}
}
'import requests
url = "https://{projectHost}/collections/{collectionName}"
payload = { "indexConfigs": {
"example-field1": {
"type": "text",
"analyzers": ["english"]
},
"example-field2": {
"type": "vector",
"dimensions": 128,
"similarity": "cosine"
},
"example-field3": { "type": "keyword" }
} }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
indexConfigs: {
'example-field1': {type: 'text', analyzers: ['english']},
'example-field2': {type: 'vector', dimensions: 128, similarity: 'cosine'},
'example-field3': {type: 'keyword'}
}
})
};
fetch('https://{projectHost}/collections/{collectionName}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{projectHost}/collections/{collectionName}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'indexConfigs' => [
'example-field1' => [
'type' => 'text',
'analyzers' => [
'english'
]
],
'example-field2' => [
'type' => 'vector',
'dimensions' => 128,
'similarity' => 'cosine'
],
'example-field3' => [
'type' => 'keyword'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{projectHost}/collections/{collectionName}"
payload := strings.NewReader("{\n \"indexConfigs\": {\n \"example-field1\": {\n \"type\": \"text\",\n \"analyzers\": [\n \"english\"\n ]\n },\n \"example-field2\": {\n \"type\": \"vector\",\n \"dimensions\": 128,\n \"similarity\": \"cosine\"\n },\n \"example-field3\": {\n \"type\": \"keyword\"\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://{projectHost}/collections/{collectionName}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"indexConfigs\": {\n \"example-field1\": {\n \"type\": \"text\",\n \"analyzers\": [\n \"english\"\n ]\n },\n \"example-field2\": {\n \"type\": \"vector\",\n \"dimensions\": 128,\n \"similarity\": \"cosine\"\n },\n \"example-field3\": {\n \"type\": \"keyword\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{projectHost}/collections/{collectionName}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"indexConfigs\": {\n \"example-field1\": {\n \"type\": \"text\",\n \"analyzers\": [\n \"english\"\n ]\n },\n \"example-field2\": {\n \"type\": \"vector\",\n \"dimensions\": 128,\n \"similarity\": \"cosine\"\n },\n \"example-field3\": {\n \"type\": \"keyword\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"collection": {
"projectName": "example-project-name",
"collectionName": "example-collection-name",
"indexConfigs": {
"example-field1": {
"type": "text",
"analyzers": [
"english"
]
},
"example-field2": {
"type": "vector",
"dimensions": 128,
"similarity": "cosine"
},
"example-field3": {
"type": "keyword"
}
},
"numDocs": 1000,
"collectionStatus": "ACTIVE"
}
}{
"message": "Invalid request"
}{
"message": "Authentication failed"
}{
"message": "Resource not found"
}{
"message": "Too many requests"
}{
"message": "Internal server error"
}Collections
Configure a collection
Configure a collection.
PATCH
/
collections
/
{collectionName}
cURL
curl --request PATCH \
--url https://{projectHost}/collections/{collectionName} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"indexConfigs": {
"example-field1": {
"type": "text",
"analyzers": [
"english"
]
},
"example-field2": {
"type": "vector",
"dimensions": 128,
"similarity": "cosine"
},
"example-field3": {
"type": "keyword"
}
}
}
'import requests
url = "https://{projectHost}/collections/{collectionName}"
payload = { "indexConfigs": {
"example-field1": {
"type": "text",
"analyzers": ["english"]
},
"example-field2": {
"type": "vector",
"dimensions": 128,
"similarity": "cosine"
},
"example-field3": { "type": "keyword" }
} }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
indexConfigs: {
'example-field1': {type: 'text', analyzers: ['english']},
'example-field2': {type: 'vector', dimensions: 128, similarity: 'cosine'},
'example-field3': {type: 'keyword'}
}
})
};
fetch('https://{projectHost}/collections/{collectionName}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{projectHost}/collections/{collectionName}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'indexConfigs' => [
'example-field1' => [
'type' => 'text',
'analyzers' => [
'english'
]
],
'example-field2' => [
'type' => 'vector',
'dimensions' => 128,
'similarity' => 'cosine'
],
'example-field3' => [
'type' => 'keyword'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{projectHost}/collections/{collectionName}"
payload := strings.NewReader("{\n \"indexConfigs\": {\n \"example-field1\": {\n \"type\": \"text\",\n \"analyzers\": [\n \"english\"\n ]\n },\n \"example-field2\": {\n \"type\": \"vector\",\n \"dimensions\": 128,\n \"similarity\": \"cosine\"\n },\n \"example-field3\": {\n \"type\": \"keyword\"\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://{projectHost}/collections/{collectionName}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"indexConfigs\": {\n \"example-field1\": {\n \"type\": \"text\",\n \"analyzers\": [\n \"english\"\n ]\n },\n \"example-field2\": {\n \"type\": \"vector\",\n \"dimensions\": 128,\n \"similarity\": \"cosine\"\n },\n \"example-field3\": {\n \"type\": \"keyword\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{projectHost}/collections/{collectionName}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"indexConfigs\": {\n \"example-field1\": {\n \"type\": \"text\",\n \"analyzers\": [\n \"english\"\n ]\n },\n \"example-field2\": {\n \"type\": \"vector\",\n \"dimensions\": 128,\n \"similarity\": \"cosine\"\n },\n \"example-field3\": {\n \"type\": \"keyword\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"collection": {
"projectName": "example-project-name",
"collectionName": "example-collection-name",
"indexConfigs": {
"example-field1": {
"type": "text",
"analyzers": [
"english"
]
},
"example-field2": {
"type": "vector",
"dimensions": 128,
"similarity": "cosine"
},
"example-field3": {
"type": "keyword"
}
},
"numDocs": 1000,
"collectionStatus": "ACTIVE"
}
}{
"message": "Invalid request"
}{
"message": "Authentication failed"
}{
"message": "Resource not found"
}{
"message": "Too many requests"
}{
"message": "Internal server error"
}Was this page helpful?
⌘I