Search.Definition object
This object creates a definition of information about the data for search.
Syntax
Search.Definition(params: Search.Params)
Parameters
| Value | Description | Data type | Optional | Default value |
|---|---|---|---|---|
| params | An object literal of type Search.Params | object | No | - |
Search.Params properties
| Value | Description | Data type | Optional | Default value |
|---|---|---|---|---|
| query | One of two parameters (the other being filter) which restricts the set of documents matched |
string | No | - |
| view | Identifies a subset of the overall search data universe (see Search.View below) | View | Yes | View.SearchAll |
| filter | Where query is for unstructured end-user-oriented restriction, filter is for structured programmatic restriction |
string | Yes | - |
| orderBy | Defines the order in which matching documents should be returned | string | Yes | - |
| boost | This argument supports exactly the same predicate expression syntax as filter , but where filter restricts which documents are matched at all, boost just applies a large scoring boost to documents it matches, which will almost always guarantee that they appear at the top of the results |
string | Yes | - |
| select | List of the properties of a document to be returned in the response | string or string[] | Yes | - |
| top | The maximum number of documents to retrieve. Must be non-negative | number | Yes | 10 |
| skip | The number of documents to skip in the sorted result set before returning the next top |
number | Yes | 0 |
| groupBy | If specified, this must name a single Groupable property. Returned documents are grouped into buckets based on their value for this property |
string | Yes | - |
| groupCount | When supplied in combination with groupBy, sets the maximum number of documents to be returned per bucket |
number | Yes | 3 (when groupBy is specified) |
| navigators | This can name one or more properties, separated by commas, each of which must be Navigable |
string | Yes | - |
| features | A comma-separated list of feature names (see Search.Feature below) which should be enabled for this request | Feature | Yes | - |
| extendedParams | Additional parameters to apply to the request. | object | Yes | - |
Search.Feature values
| Name | Description |
|---|---|
| Feature.quoteperm | Forces permissioning to be applied to QUOTE/STIR content; any quote docs for which the user is not permissioned will not be matched. This isn't really a legal or contractual requirement; those generally apply to timeseries data which doesn't go through search. Rather, it's a courtesy feature intended to avoid showing quotes in search results when the user won't be able to do anything with them |
| Feature.spell | If Query looks misspelled it still will be run through the search as entered, but an alternative spelling will be suggested if it looks more productive |
| Feature.tcm | Attempts to interpret Query as a "Ticker Coupon Maturity" microformat, e.g. vod 5% 2028 will be parsed as searching for instruments with a ticker of vod, a coupon of 5% and maturing in 2028 |
Returned value
ContentDefinition object.
Usage
import { Search } from '@refinitiv-data/data';
const definition = Search.Definition({
query: 'CTO Microsoft',
view: Search.View.People,
});
`