REST Resource: settings.searchapplications

Recurso: SearchApplication

SearchApplication

Representação JSON 
{
  "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)
  }
}
Campos
name

string

O nome do aplicativo de pesquisa.

Formato: searchapplications/{applicationId}.
displayName

string

Nome de exibição do aplicativo de pesquisa. O tamanho máximo é de 300 caracteres.
dataSourceRestrictions[]

object (DataSourceRestriction)

Restrições aplicadas às configurações. O número máximo de elementos é 10.
sourceConfig[]

object (SourceConfig)

Configuração para uma fonte especificada em dataSourceRestrictions.
scoringConfig

object (ScoringConfig)

Configuração para resultados de classificação.
defaultSortOptions

object (SortOptions)

As opções padrão de classificação dos resultados da pesquisa
defaultFacetOptions[]

object (FacetOptions)

Os campos padrão para retornar os resultados de faceta. As fontes especificadas aqui também foram incluídas em dataSourceRestrictions acima.
returnResultThumbnailUrls

boolean

Com cada resultado, precisamos retornar o URI da miniatura (quando aplicável).
operationIds[]

string

Apenas saída. IDs das operações de longa duração (LROs, na sigla em inglês) em execução para este esquema. Campo somente de saída.
enableAuditLog

boolean

Indica se o registro de auditoria está ativado/desativado para solicitações feitas para o aplicativo de pesquisa em APIs de consulta.
queryInterpretationConfig

object (QueryInterpretationConfig)

As opções padrão para interpretação de consulta

DataSourceRestriction

Restrição na fonte de dados.

Representação JSON 
{
  "source": {
    object (Source)
  },
  "filterOptions": [
    {
      object (FilterOptions)
    }
  ]
}
Campos
source

object (Source)

A origem da restrição.
filterOptions[]

object (FilterOptions)

Opções de filtro que restringem os resultados. Se houver vários filtros, eles serão agrupados por tipo de objeto antes da mesclagem. Os filtros com o mesmo tipo de objeto são unidos de forma conjuntiva, e as expressões resultantes são unidas de forma disjuntiva.

O número máximo de elementos é 20.

OBSERVAÇÃO: no momento, a API Suggest oferece suporte apenas a alguns filtros: "objecttype", "type" e "mimetype". Por enquanto, os filtros específicos do esquema não podem ser usados para filtrar sugestões.

Origem

Define as origens das APIs de pesquisa/sugestão.

Representação JSON 
{

  // 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.
}
Campos

Campo de união source.

source pode ser apenas de um dos tipos a seguir:
name

string

Nome da origem do conteúdo indexado pelo Indexing API.
predefinedSource

enum (Source.PredefinedSource)

Origem de conteúdo predefinida para o Google Apps.

Source.PredefinedSource

Fontes predefinidas:

Enums
NONE
QUERY_HISTORY Sugere consultas emitidas pelo usuário anteriormente. Válido apenas quando usado com a API de sugestões. Ignorado quando usado na API de consulta.
PERSON Sugere pessoas na organização. Válido apenas quando usado com a API de sugestões. Resulta em um erro quando usado na API de consulta.
GOOGLE_DRIVE
GOOGLE_GMAIL
GOOGLE_SITES
GOOGLE_GROUPS
GOOGLE_CALENDAR
GOOGLE_KEEP

FilterOptions

Opções de filtro a serem aplicadas à consulta.

Representação JSON 
{
  "objectType": string,
  "filter": {
    object (Filter)
  }
}
Campos
objectType

string

Se o objectType for definido, apenas objetos desse tipo serão retornados. Ele precisa corresponder ao nome do objeto registrado na definição do esquema. O tamanho máximo é de 256 caracteres.
filter

object (Filter)

Filtro genérico para restringir a pesquisa, como lang:en, site:xyz.

Filtro

Uma maneira genérica de expressar filtros em uma consulta, que oferece suporte a duas abordagens:

1. Definir um ValueFilter. O nome precisa corresponder a um operatorName definido no esquema da sua fonte de dados.

2. Como definir um CompositeFilter. Os filtros são avaliados usando o operador lógico. Os operadores de nível superior só podem ser AND ou NOT. A cláusula AND só pode aparecer no nível mais alto. A opção OR só pode aparecer em um AND de nível superior.

Representação JSON 
{

  // 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.
}
Campos

Campo de união filter.

filter pode ser apenas de um dos tipos a seguir:
valueFilter

object (Filter.ValueFilter)
compositeFilter

object (Filter.CompositeFilter)

Filter.ValueFilter

Representação JSON 
{
  "operatorName": string,
  "value": {
    object (Value)
  }
}
Campos
operatorName

string

O operatorName aplicado à consulta, como price_greater_than. O filtro pode funcionar com os dois tipos de filtros definidos no esquema da sua origem de dados:

  1. operatorName, em que a consulta filtra os resultados pela propriedade que corresponde ao valor.

  2. greaterThanOperatorName ou lessThanOperatorName no esquema. A consulta filtra os resultados para os valores de propriedade maiores ou menores que o valor fornecido na consulta.
value

object (Value)

O valor a ser comparado.

Valor

Definição de um único valor com tipo genérico.

Representação JSON 
{

  // 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.
}
Campos
Campo de união value. O valor da propriedade nomeada. value pode ser apenas de um dos tipos a seguir:
stringValue

string
integerValue

string (int64 format)
doubleValue

number
timestampValue

string (Timestamp format)

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa dígitos fracionários 0, 3, 6 ou 9. Deslocamentos diferentes de "Z" também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
booleanValue

boolean
dateValue

object (Date)

Filter.CompositeFilter

Representação JSON 
{
  "logicOperator": enum (Filter.CompositeFilter.LogicOperator),
  "subFilters": [
    {
      object (Filter)
    }
  ]
}
Campos
logicOperator

enum (Filter.CompositeFilter.LogicOperator)

O operador lógico do subfiltro.
subFilters[]

object (Filter)

Subfiltros.

Filter.CompositeFilter.LogicOperator

Enums
AND Operadores lógicos, que só podem ser aplicados a subfiltros.
OR
NOT A opção "NÃO" só pode ser aplicada a um único subfiltro.

SourceConfig

Configurações de uma origem durante o processamento de uma solicitação Search ou query.suggest.

Representação JSON 
{
  "source": {
    object (Source)
  },
  "scoringConfig": {
    object (SourceScoringConfig)
  },
  "crowdingConfig": {
    object (SourceCrowdingConfig)
  }
}
Campos
source

object (Source)

A origem para a qual essa configuração será usada.
scoringConfig

object (SourceScoringConfig)

A configuração de pontuação da origem.
crowdingConfig

object (SourceCrowdingConfig)

A configuração de crowding da origem.

SourceScoringConfig

Defina a configuração de pontuação. Isso permite modificar a classificação dos resultados de uma origem.

Representação JSON 
{
  "sourceImportance": enum (SourceScoringConfig.SourceImportance)
}
Campos
sourceImportance

enum (SourceScoringConfig.SourceImportance)

Importância da fonte.

SourceScoringConfig.SourceImportance

A importância de uma fonte, que pode ser usada para indicar se ela precisa ter mais prioridade na classificação em comparação com outra.

Enums
DEFAULT
LOW
HIGH

SourceCrowdingConfig

Defina limites de resultados de pesquisa. O crowding é uma situação em que vários resultados da mesma fonte ou host "superam" outros resultados, diminuindo a qualidade da pesquisa para os usuários. Para melhorar a qualidade da pesquisa e a diversidade de fontes nos resultados da pesquisa, defina uma condição para reduzir os resultados repetitivos por origem.

Representação JSON 
{
  "numResults": integer,
  "numSuggestions": integer
}
Campos
numResults

integer

Número máximo de resultados permitidos de uma fonte de dados em uma página de resultados, desde que os resultados de outras fontes não sejam esgotados. O valor especificado não pode ser negativo. Um valor padrão será usado se esse valor for igual a 0. Para desativar o recolhimento, defina o valor como maior que 100.
numSuggestions

integer

Número máximo de sugestões permitidas de uma origem. Nenhum limite será definido nos resultados se esse valor for menor ou igual a 0.

ScoringConfig

Configurações de pontuação para uma origem ao processar uma solicitação Search ou query.suggest.

Representação JSON 
{
  "disableFreshness": boolean,
  "disablePersonalization": boolean
}
Campos
disableFreshness

boolean

Indica se a atualização será usada como um indicador de classificação. Por padrão, a recência é usada como um indicador de classificação. Essa configuração não está disponível na interface do administrador.
disablePersonalization

boolean

Se os resultados serão personalizados. Por padrão, os indicadores pessoais são usados para melhorar os resultados.

SortOptions

Representação JSON 
{
  "operatorName": string,
  "sortOrder": enum (SortOptions.SortOrder)
}
Campos
operatorName

string

O nome do operador correspondente ao campo a ser classificado. A propriedade correspondente precisa ser marcada como sortable.
sortOrder

enum (SortOptions.SortOrder)

A ordem crescente é a ordem de classificação padrão

SortOptions.SortOrder

Enums
ASCENDING
DESCENDING

FacetOptions

Especifica operadores para retornar resultados de atributos. Haverá um FacetResult para cada combinação de sourceName/objectType/operatorName.

Representação JSON 
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "numFacetBuckets": integer,

  // Union field faceting_options can be only one of the following:
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
  // End of list of possible types for union field faceting_options.
}
Campos
sourceName

string

Nome da origem para a qual o atributo será associado. Formato: datasources/{sourceId} Se estiver vazio, todas as fontes de dados serão usadas.
objectType

string

Se o objectType for definido, apenas os objetos desse tipo serão usados para calcular as facetas. Se estiver vazio, todos os objetos serão usados para calcular as facetas.
operatorName

string

O nome do operador escolhido para a divisão em facetas. @see cloudsearch.SchemaPropertyOptions
numFacetBuckets

integer

Número máximo de buckets de faceta que precisam ser retornados para essa faceta. O valor padrão é 10. O valor máximo é 100.

Campo de união faceting_options.

faceting_options pode ser apenas de um dos tipos a seguir:
integerFacetingOptions

object (IntegerFacetingOptions)

Se definido, descreve as opções de facetação de números inteiros para a propriedade de número inteiro especificada. A propriedade de número inteiro correspondente no esquema precisa ser marcada como isFacetable. O número de buckets retornados será o mínimo entre este e numFacetBuckets.

IntegerFacetingOptions

Usado para especificar opções de facetação de números inteiros.

Representação JSON 
{
  "integerBuckets": [
    string
  ]
}
Campos
integerBuckets[]

string (Int64Value format)

Os intervalos para valores inteiros específicos precisam estar em ordem estritamente crescente. Por exemplo, se os valores fornecidos forem (1,5,10,100), os seguintes buckets de facetas serão formados: {<1, [1,5), [5-10), [10-100), >=100}.

QueryInterpretationConfig

Opções padrão para interpretar a consulta do usuário.

Representação JSON 
{
  "forceVerbatimMode": boolean,
  "forceDisableSupplementalResults": boolean
}
Campos
forceVerbatimMode

boolean

Ative essa flag para desativar todas as otimizações internas, como a interpretação de consultas em linguagem natural (LN), a recuperação de resultados complementares e o uso de sinônimos, incluindo os personalizados. Se essa flag for definida como "True", ela terá precedência sobre a opção definida no nível da consulta. Para o valor padrão "False", a flag no nível da consulta vai definir a interpretação correta para o modo literal.
forceDisableSupplementalResults

boolean

Definir essa flag para desativar a recuperação de resultados complementares. Definir uma flag aqui não recupera resultados complementares para consultas associadas a um determinado aplicativo de pesquisa. Se essa flag for definida como "True", ela terá precedência sobre a opção definida no nível da consulta. Para o valor padrão "Falso", a flag no nível da consulta vai definir a interpretação correta para os resultados suplementares.

Métodos

create

 Cria um app de pesquisa.

delete

 Exclui um aplicativo de pesquisa.

get

 Recebe o aplicativo de pesquisa especificado.

list

 Lista todos os aplicativos de pesquisa.

patch

 Atualiza um app de pesquisa.

reset

 Redefine um aplicativo de pesquisa para as configurações padrão.

update

 Atualiza um app de pesquisa.