Collections

All operations related to collections

Get all collections

Get all collections and their configurations

Get all Collections

GET/collections

Response

200400

Returns a list of Collections along with their configurations.

Body

application/json

name*string

descriptionnullable string

config*object

idnullable string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/collections', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "name": "text",
    "description": "text",
    "config": {
      "dim": 1,
      "m": 1,
      "efConstruction": 1,
      "ef": 1,
      "model": "text",
      "algo": "text",
      "allowReplace": true
    },
    "id": "text"
  }
]

Get a collection

Get a specific collection and it's configuration using it's id or name.

Get a Collection

GET/collections/{collectionIdOrName}

Path parameters

collectionIdOrName*string

Response

200400

Returns the Collection information.

Body

application/json

name*string

descriptionnullable string

config*object

idnullable string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/collections/{collectionIdOrName}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "name": "text",
  "description": "text",
  "config": {
    "dim": 1,
    "m": 1,
    "efConstruction": 1,
    "ef": 1,
    "model": "text",
    "algo": "text",
    "allowReplace": true
  },
  "id": "text"
}

Create a collection

Create Collection

POST/collections

Body

application/json

name*string

Pattern: ^[a-zA-Z0-9_-]+$

descriptionnullable string

config*object

Response

200400

Returns the created Collection information.

Body

application/json

name*string

descriptionnullable string

config*object

idnullable string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/collections', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "config": {
        "dim": 1
      }
    }),
});
const data = await response.json();

Response

200400

{
  "name": "text",
  "description": "text",
  "config": {
    "dim": 1,
    "m": 1,
    "efConstruction": 1,
    "ef": 1,
    "model": "text",
    "algo": "text",
    "allowReplace": true
  },
  "id": "text"
}

Delete a collection

Delete an existing collection using it's name or id.

Delete a Collection

DELETE/collections/{collectionIdOrName}

Path parameters

collectionIdOrName*string

Response

200400

Returns the deleted Collection.

Body

application/json

deleted*object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/collections/{collectionIdOrName}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "deleted": {
    "name": "text",
    "description": "text",
    "config": {
      "dim": 1,
      "m": 1,
      "efConstruction": 1,
      "ef": 1,
      "model": "text",
      "algo": "text",
      "allowReplace": true
    },
    "id": "text"
  }
}

Update a collection

Update details of an existing collection.

Updates a Collection

POST/collections/{collectionId}

Path parameters

collectionId*string

Body

application/json

namestring

Pattern: ^[a-zA-Z0-9_-]+$

descriptionstring

Response

200400

Returns the updated collection information.

Body

application/json

name*string

descriptionnullable string

config*object

idnullable string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/collections/{collectionId}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "name": "text",
  "description": "text",
  "config": {
    "dim": 1,
    "m": 1,
    "efConstruction": 1,
    "ef": 1,
    "model": "text",
    "algo": "text",
    "allowReplace": true
  },
  "id": "text"
}

Query a collection for a vector value

Search a collection using a query vector. It retrieves the vectors that are most similar to the queried vector, along with their similarity scores.

Semantic search over Vectors

POST/collections/{collectionId}/query

Path parameters

collectionId*string

Body

application/json

vectors*array of array of number

limitnumber

Response

200400

Returns a list of the matching Vectors in a Collection.

Body

application/json

id*nullable string

content*string

metadatanullable any

distance*number

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/collections/{collectionId}/query', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "vectors": [
        [
          null
        ]
      ]
    }),
});
const data = await response.json();

Response

200400

[
  [
    {
      "id": "text",
      "content": "text",
      "metadata": null,
      "distance": 1
    }
  ]
]

Query a collection for a text

Search a collection using a text. It retrieves the vectors that are most similar to the queried text, along with their similarity scores.

Semantic search by text over Vectors

POST/collections/{collectionId}/query/text

Path parameters

collectionId*string

Body

application/json

content*array of string

topKnumber

Response

200400

Returns a list of the matching Vectors in a Collection.

Body

application/json

id*nullable string

content*string

metadatanullable any

distance*number

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/collections/{collectionId}/query/text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "content": [
        null
      ]
    }),
});
const data = await response.json();

Response

200400

[
  [
    {
      "id": "text",
      "content": "text",
      "metadata": null,
      "distance": 1
    }
  ]
]