Read properties of search view

Fetch an object containing the definition of the search view identified by view-name.

get/_fabric/{fabric}/_api/search/view/{view-name}/properties

Request

The document declares no server URL.
Auth
- API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_fabric/:fabric/_api/search/view/:view-name/properties/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

fabricstring string required

The name of the fabric.

view-namestring string required

The name of the search view.

Response

Successfully fetched search view properties.

Example response

{
  "code": 200,
  "result": {
    "globallyUniqueId": "h83A7584E8AA9/81730851",
    "id": "81730851",
    "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
            }
          }
        }
      }
    }
  }
}

Changes

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