The Resources.Search class provides methods to perform searches.

Methods

Make a search request

Description: This method performs a search across a specific index based on the provided parameters and returns the first page of results.

Function signature and example:

1
async query(
2
  {
3
    indexId,
4
    query,
5
    queryText,
6
    queryMediaType,
7
    queryMediaFile,
8
    queryMediaUrl,
9
    options: searchOptions,
10
    groupBy,
11
    threshold,
12
    operator,
13
    conversationOption,
14
    filter,
15
    pageLimit,
16
    sortOption,
17
    adjustConfidenceLevel,
18
  }: SearchOptions,
19
  options: RequestOptions = {},
20
): Promise<Models.SearchResult>

Parameters:

The SearchOptions interface defines the parameters for performing a search request:

Return value: Returns a Promise that resolves to a Models.SearchResult object containing the search results.

API Reference: For a description of each field in the request and response, see the Any-to-video search page.

Related guides:

• Search.
• Pagination > Search results.
• Sorting > Search results
• Filtering > Search results
• Grouping and ungrouping.

Retrieve a specific page of search results

Description: This method retrieves a specific page of search results.

Function signature and example:

1
async byPageToken(pageToken: string, options: RequestOptions = {}): Promise<Models.SearchResult>

Parameters:

Return value: Returns a Promise that resolves to a Models.SearchResult object containing the search results.

API Reference: For a description of each field in the request and response, see the Retrieve a specific page of search results page.

Related guides:

• Search.
• Pagination > Search results.
• Sorting > Search results
• Filtering > Search results
• Grouping and ungrouping.

Iterative pagination

If your application must retrieve a large number of items, use iterative pagination. To retrieve the first page of results, invoke the query method of the search object. To retrieve subsequent pages of results, use the async iterator protocol.

1
function printSearchData(data) {
2
  console.log(`  Score: ${data.score}`);
3
  console.log(`  Start: ${data.start}`);
4
  console.log(`  End: ${data.end}`);
5
  console.log(`  Video ID: ${data.videoId}`);
6
  console.log(`  Confidence: ${data.confidence}`);
7
  console.log(`  Thumbnail URL: ${data.thumbnailUrl}`);
8
}
9
10
function printPage(result, pageNumber) {
11
  console.log(`Page ${pageNumber}`);
12
  
13
  // Print the search results
14
  console.log("Search Results:");
15
  const data = result.data || result;
16
  data.forEach(item => {
17
    if ('clips' in item) {
18
      console.log(`Video ID: ${item.id}`);
19
      if (item.clips) {
20
        item.clips.forEach(clip => {
21
          printSearchData(clip);
22
        });
23
      }
24
    } else {
25
      printSearchData(item);
26
    }
27
  });
28
}
29
30
let searchResults = await client.search.query({
31
  indexId: "<YOUR_INDEX_ID>",
32
  queryText: "<YOUR_QUERY>",
33
  options: ["visual", "audio"],
34
  groupBy: "clip",
35
  threshold: "medium",
36
  operator: "or",
37
  filter: {
38
     "metadata.language": "en",
39
  },
40
  sortOption: "score",
41
  adjustConfidenceLevel: 0.5,
42
  pageLimit: 5
43
});
44
45
// Print the search pool information
46
console.log("Search pool:");
47
console.log(`  Total count: ${searchResults.pool.totalCount}`);
48
console.log(`  Total duration: ${searchResults.pool.totalDuration}`);
49
console.log(`  Index ID: ${searchResults.pool.indexId}`);
50
51
let pageNumber = 1;
52
printPage(searchResults, pageNumber);
53
54
while (true) {
55
  const nextPage = await searchResults.next();
56
  if (nextPage === null) break;
57
  pageNumber++;
58
  printPage(nextPage, pageNumber);
59
}
60
61
console.log("No more results.");

Error codes

This section lists the most common error messages you may encounter while using the Resources.Search class.

• search_option_not_supported
  • Search option {search_option} is not supported for index {index_id}. Please use one of the following search options: {supported_search_option}.
• search_option_combination_not_supported
  • Search option {search_option} is not supported with {other_combination}.
• search_filter_invalid
  • Filter used in search is invalid. Please use the valid filter syntax by following filtering documentation.
• search_page_token_expired
  • The token that identifies the page to be retrieved is expired or invalid. You must make a new search request. Token: {next_page_token}.
• index_not_supported_for_search:
  • You can only perform search requests on indexes with an engine from the Marengo family enabled.