---
title: "POST /search/suggest"
method: POST
path: "/search/suggest"
---

# POST /search/suggest

`POST /search/suggest`

Get search suggestions by query criteria.

## Query parameters

- `api-version` string, required

## Request body

- SuggestOptions — The payload of suggest request.
  - `keywords` string — The keywords applied to all fields that support suggest operation. It must be at least 1 character, and no more than 100 characters. In the index schema we defined a default suggester which lists all the supported fields and specifies a search mode.
  - `limit` integer — The number of suggestions we hope to return. The default value is 5. The value must be a number between 1 and 100.
  - `filter` unknown

## Response `200`

The request has succeeded.

- SuggestResult — The result item of the search suggest.
  - `value` SuggestResultValue[] — The result value
    - `@search.score` number, float — The search score calculated by the search engine. The results are ordered by search score by default.
    - `@search.text` string — The target text that contains the keyword as prefix. The keyword is wrapped with emphasis mark.
    - `objectType` string — The object type of the record. Object type is the top-level property to distinguish whether a record is an asset or a term.
    - `createTime` integer — The create time of the record. The Unix epoch format.
    - `updateTime` integer — The last update time of the record. The Unix epoch format.
    - `id` string — The GUID of the record.
    - `name` string — The name of the record.
    - `qualifiedName` string — The qualified name of the record.
    - `entityType` string — The type name of the asset.
    - `description` string — The description of the asset.
    - `endorsement` string[] — The endorsement of the asset.
    - `owner` string — The owner of the record.
    - `classification` string[] — The classifications of the record.
    - `label` string[] — The labels of the asset.
    - `term` TermSearchResultValue[] — The terms assigned to the asset.
      - `name` string — The name of the term.
      - `glossaryName` string — The name of the glossary which contains the term.
      - `guid` string — The GUID of the term.
    - `contact` ContactSearchResultValue[] — The contacts of the asset.
      - `id` string — The GUID of the contact.
      - `info` string — The description of the contact.
      - `contactType` string — The type of the contact. It can be Expert or Owner for an entity. It can be Expert or Steward for a glossary term.
    - `assetType` string[] — The asset types of the asset.
    - `glossaryType` string — The type name of the term. Could be AtlasGlossary, AtlasGlossaryTerm or AtlasGlossaryCategory.
    - `glossary` string — The glossary name of the term.
    - `termStatus` string — The status of the term.
    - `termTemplate` string[] — The term template names used by the term.
    - `longDescription` string — The definition of the term.

## Other responses

- `default` — An unexpected error response.

---

[API](https://skmtc.net/azure/apis/purview-datamap.md) · [All operations](https://skmtc.net/azure/apis/purview-datamap/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/purview-datamap/versions/442226cb14a9/schema)