CLcloudglue
Search

Get a search response by ID

Changed on

Get a search response by search_id.

get/search/{search_id}

Request

  • Base URL
    https://api.cloudglue.dev/v1
  • Auth
    HTTP bearer

Path parameters

search_idstring uuid required

The ID of the search response to get

Response

A search response

idstring uuid required

ID of the search response

object'search' required

Object type, always 'search'

querystring

The search query that was executed (for text search) or the source image URL/base64 indicator (for face search)

scope'file' | 'segment' | 'face' | 'moment' required

The search scope that was used

group_by_key'file'

The key used for grouping results. Only present when group_by_key was specified in the request and results are grouped.

group_countinteger

Number of groups in the results. Only present when group_by_key is specified.

search_modalitiesstring[]

Specifies the type(s) of search to execute. When multiple modalities are specified, a hybrid search is executed that combines results from each modality.

Available modalities:

  • general_content: baseline for matching the content of the search item (file/segment) based on visual or spoken content similarity to provided short natural language query string
  • speech_lexical: performs keyword based search (e.g. query of president matching president or presidential strings) and exact match (e.g. specifically find mentions of "Barack Obama" or "Donald Trump") against speech content present in search item
  • ocr_lexical: performs keyword based search and exact match against screen text content present in search item
  • tag_semantic: performs basic word semantic similarity search against tag values associated with search items (e.g. query=animal expected to match tags with value containing dog or cat)
  • tag_lexical: performs keyword based search and exact match against tag values associated with search items
  • doc_lexical: performs keyword based search and exact match against file-level documents (generated summaries, metadata-collection docs, and entity-collection docs). Only applicable when search scope=file.

Only applicable when search scope=file or scope=segment.

totalinteger required

Total number of results returned. When group_by_key is specified, this represents the total number of items across all groups (not the number of groups).

limitinteger required

The limit that was applied to the search

Changes

  • 23d3f240819fRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • d2a5205fc779Revision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new moment enum value to the response property for the response status