REST Resource: settings.searchapplications

{
  "name": string,
  "displayName": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "sourceConfig": [
    {
      object (SourceConfig)
    }
  ],
  "scoringConfig": {
    object (ScoringConfig)
  },
  "defaultSortOptions": {
    object (SortOptions)
  },
  "defaultFacetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "returnResultThumbnailUrls": boolean,
  "operationIds": [
    string
  ],
  "enableAuditLog": boolean,
  "queryInterpretationConfig": {
    object (QueryInterpretationConfig)
  }
}

string

The name of the Search Application.

Format: searchapplications/{applicationId}.

string

Display name of the Search Application. The maximum length is 300 characters.

object (DataSourceRestriction)

Retrictions applied to the configurations. The maximum number of elements is 10.

object (SourceConfig)

Configuration for a sources specified in dataSourceRestrictions.

object (ScoringConfig)

Configuration for ranking results.

object (SortOptions)

The default options for sorting the search results

object (FacetOptions)

The default fields for returning facet results. The sources specified here also have been included in dataSourceRestrictions above.

boolean

With each result we should return the URI for its thumbnail (when applicable)

string

Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.

boolean

Indicates whether audit logging is on/off for requests made for the search application in query APIs.

object (QueryInterpretationConfig)

The default options for query interpretation

{
  "source": {
    object (Source)
  },
  "filterOptions": [
    {
      object (FilterOptions)
    }
  ]
}

object (Source)

The source of restriction.

object (FilterOptions)

Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively.

The maximum number of elements is 20.

NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions.

{

  // Union field source can be only one of the following:
  "name": string,
  "predefinedSource": enum (Source.PredefinedSource)
  // End of list of possible types for union field source.
}

string

Source name for content indexed by the Indexing API.

enum (Source.PredefinedSource)

Predefined content source for Google Apps.

{
  "objectType": string,
  "filter": {
    object (Filter)
  }
}

string

If objectType is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.

object (Filter)

Generic filter to restrict the search, such as lang:en, site:xyz.

{

  // Union field filter can be only one of the following:
  "valueFilter": {
    object (Filter.ValueFilter)
  },
  "compositeFilter": {
    object (Filter.CompositeFilter)
  }
  // End of list of possible types for union field filter.
}

object (Filter.ValueFilter)

object (Filter.CompositeFilter)

{
  "operatorName": string,
  "value": {
    object (Value)
  }
}

string

The operatorName applied to the query, such as price_greater_than. The filter can work against both types of filters defined in the schema for your data source:

1. operatorName, where the query filters results by the property that matches the value.

2. greaterThanOperatorName or lessThanOperatorName in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.

object (Value)

The value to be compared with.

{

  // Union field value can be only one of the following:
  "stringValue": string,
  "integerValue": string,
  "doubleValue": number,
  "timestampValue": string,
  "booleanValue": boolean,
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}

string

string (int64 format)

number

string (Timestamp format)

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

boolean

object (Date)

{
  "logicOperator": enum (Filter.CompositeFilter.LogicOperator),
  "subFilters": [
    {
      object (Filter)
    }
  ]
}

enum (Filter.CompositeFilter.LogicOperator)

The logic operator of the sub filter.

object (Filter)

Sub filters.

{
  "source": {
    object (Source)
  },
  "scoringConfig": {
    object (SourceScoringConfig)
  },
  "crowdingConfig": {
    object (SourceCrowdingConfig)
  }
}

object (Source)

The source for which this configuration is to be used.

object (SourceScoringConfig)

The scoring configuration for the source.

object (SourceCrowdingConfig)

The crowding configuration for the source.

{
  "sourceImportance": enum (SourceScoringConfig.SourceImportance)
}

enum (SourceScoringConfig.SourceImportance)

Importance of the source.

{
  "numResults": integer,
  "numSuggestions": integer
}

integer

Maximum number of results allowed from a datasource in a result page as long as results from other sources are not exhausted. value specified must not be negative. A default value is used if this value is equal to 0. To disable crowding, set the value greater than 100.

integer

Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.

{
  "disableFreshness": boolean,
  "disablePersonalization": boolean
}

boolean

Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.

boolean

Whether to personalize the results. By default, personal signals will be used to boost results.

{
  "operatorName": string,
  "sortOrder": enum (SortOptions.SortOrder)
}

string

The name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.

enum (SortOptions.SortOrder)

Ascending is the default sort order

{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "numFacetBuckets": integer,
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}

string

Source name to facet on. Format: datasources/{sourceId} If empty, all data sources will be used.

string

If objectType is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.

string

The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions

integer

Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.

object (IntegerFacetingOptions)

If set, describes integer faceting options for the given integer property. The corresponding integer property in the schema should be marked isFacetable. The number of buckets returned would be minimum of this and numFacetBuckets.

{
  "integerBuckets": [
    string
  ]
}

string (Int64Value format)

Buckets for given integer values should be in strictly ascending order. For example, if values supplied are (1,5,10,100), the following facet buckets will be formed {<1, [1,5), [5-10), [10-100), >=100}.

{
  "forceVerbatimMode": boolean,
  "forceDisableSupplementalResults": boolean
}

boolean

Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode.

boolean

Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results.