Sign in

v1

latestOpenAPI 3.0.3GPL-3.02026-07-177978150.2 KB
collections

Update a collection

Update a collection's schema to modify the fields and their types.

patch/collections/{collectionName}

Path parameters

collectionNamestring required

The name of the collection to update

Request body

synonym_setsstring[]

List of synonym set names to associate with this collection

metadataobject

Optional details about the collection, e.g., when it was created, who created it etc.

Example request

{
  "fields": [
    {
      "name": "company_name",
      "type": "string",
      "facet": false
    },
    {
      "name": "num_employees",
      "type": "int32",
      "facet": false
    },
    {
      "name": "country",
      "type": "string",
      "facet": true
    }
  ],
  "synonym_sets": [
    "synonym_set_1"
  ]
}

Response

The updated partial collection schema

synonym_setsstring[]

List of synonym set names to associate with this collection

metadataobject

Optional details about the collection, e.g., when it was created, who created it etc.

Example response

{
  "fields": [
    {
      "name": "company_name",
      "type": "string",
      "facet": false
    },
    {
      "name": "num_employees",
      "type": "int32",
      "facet": false
    },
    {
      "name": "country",
      "type": "string",
      "facet": true
    }
  ],
  "synonym_sets": [
    "synonym_set_1"
  ]
}