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 app de pesquisa.

Formato: searchapplications/{applicationId}.
displayName

string

Nome de exibição do app 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 origem especificada em dataSourceRestrictions.
scoringConfig

object (ScoringConfig)

Configuração para classificar resultados.
defaultSortOptions

object (SortOptions)

As opções padrão para classificar os resultados da pesquisa
defaultFacetOptions[]

object (FacetOptions)

Os campos padrão para retornar resultados de atributos. As origens especificadas aqui também foram incluídas no dataSourceRestrictions acima.
returnResultThumbnailUrls

boolean

Para 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) atualmente 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 nas APIs de consulta.
queryInterpretationConfig

object (QueryInterpretationConfig)

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

DataSourceRestriction

Restrição à fonte de dados.

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

object (Source)

A fonte 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. Filtros com o mesmo tipo de objeto são unidos de forma conjuntiva e, em seguida, as expressões resultantes são unidas de modo disjuntivo.

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

OBSERVAÇÃO: no momento, a API Suggest é compatível apenas com alguns filtros: "objecttype", "type" e "mimetype". Por enquanto, não é possível usar filtros específicos do esquema para filtrar sugestões.

Origem

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

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 do conteúdo predefinida para o Google Apps.

Source.PredefinedSource

Origens predefinidas:

Enums
NONE
QUERY_HISTORY Sugere consultas feitas pelo usuário no passado. Válido apenas quando usado com a API de sugestão. Ignorado quando usado na API de consulta.
PERSON Sugere pessoas da organização. Válido apenas quando usado com a API de sugestão. Resulta em 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 na consulta.

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

string

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

object (Filter)

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

Filtro

Uma maneira genérica de expressar filtros em uma consulta, que é compatível com duas abordagens:

1. Configurar um ValueFilter. O nome precisa corresponder a um "operatorName" definido no esquema da 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. E pode aparecer somente no nível superior. OR pode aparecer somente sob 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 funciona com os dois tipos de filtro definidos no esquema da sua fonte 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 pelos valores de propriedade maiores ou menores do que o valor fornecido na consulta.
value

object (Value)

O valor a ser comparado.

Valor

Definição de um valor único 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)

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
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 NOT só pode ser aplicado em um único subfiltro.

SourceConfig

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

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

object (Source)

A origem em que esta configuração deve ser usada.
scoringConfig

object (SourceScoringConfig)

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

object (SourceCrowdingConfig)

A configuração de agrupamento 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 origem.

SourceScoringConfig.SourceImportance

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

Enums
DEFAULT
LOW
HIGH

SourceCrowdingConfig

Definir os limites de agrupamento dos resultados da pesquisa. Agrupamento é uma situação na qual vários resultados da mesma fonte ou host "se acumulam" outros resultados, diminuindo a qualidade da pesquisa para os usuários. Para promover melhor qualidade e diversidade de fontes nos resultados da pesquisa, você pode definir uma condição para reduzir resultados repetitivos por origem.

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

integer

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

integer

Número máximo de sugestões permitidas de uma fonte. 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 query.search ou query.suggest.

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

boolean

Define se a atualização será usada como indicador de classificação. Por padrão, a atualização é usada como indicador de classificação. Observe que essa configuração não está disponível na interface do administrador.
disablePersonalization

boolean

Se os resultados devem ser personalizados. Por padrão, 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 de classificação padrão é crescente

SortOptions.SortOrder

Enums
ASCENDING
DESCENDING

FacetOptions

Especifica os operadores para os quais os resultados de atributos devem ser retornados. Haverá um FacetResult para cada combinação sourceName/objectType/operatorName.

Representação JSON 
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "numFacetBuckets": integer,
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
Campos
sourceName

string

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

string

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

string

O nome do operador escolhido para as facetas. @consulte cloudsearch.SchemaPropertyOptions
numFacetBuckets

integer

Número máximo de buckets de atributos que precisam ser retornados para esse atributo. O valor padrão é 10. O valor máximo é 100.
integerFacetingOptions

object (IntegerFacetingOptions)

Se definido, descreve as opções de atributos 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 seria o mínimo de numFacetBuckets.

IntegerFacetingOptions

Usado para especificar opções de atributos de inteiros.

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

string (Int64Value format)

Os buckets para valores inteiros informados precisam estar em ordem estritamente crescente. Por exemplo, se os valores fornecidos forem (1,5,10,100), os seguintes buckets de atributos 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 interpretação de consultas em linguagem natural (NL), recuperação de resultados complementares e uso de sinônimos, incluindo os personalizados. Se esta flag for definida como verdadeira, 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

Defina este flag para desativar a recuperação de resultados complementares. Definir um flag aqui não vai recuperar resultados complementares para consultas associadas a um determinado app de pesquisa. Se esta flag for definida como verdadeira, terá precedência sobre a opção definida no nível da consulta. Para o valor padrão "False", a sinalização no nível da consulta vai definir a interpretação correta dos resultados complementares.

Métodos

create

 Cria um app de pesquisa.

delete

 Exclui um app de pesquisa.

get

 Recebe o app de pesquisa especificado.

list

 Lista todos os apps de pesquisa.

patch

 Atualiza um app de pesquisa.

reset

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

update

 Atualiza um app de pesquisa.