unifiedSearch

Search for entities matching a text description.

Response

Returns UnifiedSearchResponse

Arguments

Name	Type	Description
searchText	String!	The text description to search against.
entityTypes	FilterUnifiedSearchEntityTypeInput	Optional filter against entity types. If provided, only entities whose types match the filter will be returned.
similarityThreshold	Float	Optional threshold in the range [0, 1]. If provided, only objects with a greater similarity score will be returned
siteId	ID	Optional site id. If provided, only return entities from the given site.
first	Int!	Returns the first n entries from the search. Default: 20

Example

Query

query unifiedSearch(
  $searchText: String!,
  $entityTypes: FilterUnifiedSearchEntityTypeInput,
  $similarityThreshold: Float,
  $siteId: ID,
  $first: Int!
) {
  unifiedSearch(
    searchText: $searchText,
    entityTypes: $entityTypes,
    similarityThreshold: $similarityThreshold,
    siteId: $siteId,
    first: $first
  ) {
    entities {
      entity {
        __typename
      }
      similarityScore
      context
    }
  }
}

Variables

{
  "searchText": "searchText-fa30",
  "first": 20
}

Response

{
  "data": {
    "unifiedSearch": {
      "entities": [
        {
          "entity": {
            "__typename": "Site"
          },
          "similarityScore": 973.38,
          "context": "context-a84e"
        }
      ]
    }
  }
}