MAmacrometa
Search

Create search view

Create a search view. Search view is updated with collection data changes every 10 seconds.

Note: Search view can't be created with the links. Use PUT/PATCH for links management.

post/_fabric/{fabric}/_api/search/view

Request

Path parameters

fabricstring string required

The name of the fabric.

Request body

OR

Example request

{
  "name": "new_collection_view",
  "links": {
    "[collection-name]": {
      "fields": {
        "[field-name]": {
          "size": 4,
          "distanceType": "L2",
          "indexConfig": {
            "type": "hnsw",
            "maxSize": 100000,
            "nLinks": 8,
            "efConstruction": 8,
            "efSearch": 8,
            "nProbe": 8,
            "sample": 0.1
          },
          "quantizationConfig": {
            "type": "none",
            "bits": 8
          }
        }
      }
    }
  }
}

Response

Successfully created search view.

globallyUniqueIdstring

Gloable Unique identifier of the search view.

idstring

Unique identifier of the search view.

namestring

The name of the search view. This field is immutable.

typestring

The type of the search view. must be equal to search.

Example response

{
  "globallyUniqueId": "h83A7584E8AA9/81730851",
  "id": "81730851",
  "name": "new_collection_view",
  "primarySort": [
    {
      "field": "attribute1",
      "direction": "asc"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.