- Recurso: SearchApplication
- DataSourceRestriction
- Origem
- Source.PredefinedSource
- FilterOptions
- Filtrar
- Filter.ValueFilter
- Valor
- Filter.CompositeFilter
- Filter.CompositeFilter.LogicOperator
- SourceConfig
- SourceScoringConfig
- SourceScoringConfig.SourceImportance
- SourceCrowdingConfig
- ScoringConfig
- SortOptions
- SortOptions.SortOrder
- FacetOptions
- IntegerFacetingOptions
- QueryInterpretationConfig
- Métodos
Recurso: SearchApplication
SearchApplication
Representação JSON |
---|
{ "name": string, "displayName": string, "dataSourceRestrictions": [ { object ( |
Campos | |
---|---|
name |
O nome do app de pesquisa. Formato: searchapplications/{applicationId}. |
displayName |
Nome de exibição do app de pesquisa. O tamanho máximo é de 300 caracteres. |
dataSourceRestrictions[] |
Restrições aplicadas às configurações. O número máximo de elementos é 10. |
sourceConfig[] |
Configuração para fontes especificadas em dataSourceRestrictions. |
scoringConfig |
Configuração para classificar resultados. |
defaultSortOptions |
As opções padrão para classificar os resultados da pesquisa |
defaultFacetOptions[] |
Os campos padrão para retornar resultados de atributos. As fontes especificadas aqui também foram incluídas no |
returnResultThumbnailUrls |
Com cada resultado, devemos retornar o URI da miniatura (quando aplicável) |
operationIds[] |
Apenas saída. IDs das operações de longa duração (LROs) em execução no momento para este esquema. Campo somente de saída. |
enableAuditLog |
Indica se o registro de auditoria está ativado/desativado para solicitações feitas para o aplicativo de pesquisa em APIs de consulta. |
queryInterpretationConfig |
As opções padrão para interpretação de consulta |
DataSourceRestriction
Restrição na fonte de dados.
Representação JSON |
---|
{ "source": { object ( |
Campos | |
---|---|
source |
A fonte da restrição. |
filterOptions[] |
Opções de filtro que restringem os resultados. Se houver vários filtros, eles serão agrupados por tipo de objeto antes de serem mesclados. Filtros com o mesmo tipo de objeto são combinados de forma conjunta, e as expressões resultantes são agrupadas disjuntivamente. O número máximo de elementos é 20. OBSERVAÇÃO: a API Suggest suporta apenas alguns filtros no momento: "objecttype", "type" e "mimetype". Por enquanto, filtros específicos de esquema não podem ser usados para filtrar sugestões. |
Origem
Define origens para as APIs de sugestão/pesquisa.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união
|
|
name |
Nome da origem do conteúdo indexado por |
predefinedSource |
Fonte de conteúdo predefinida para o Google Apps. |
Source.PredefinedSource
Origens predefinidas:
Enums | |
---|---|
NONE |
|
QUERY_HISTORY |
Sugere consultas emitidas 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 na 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 à consulta.
Representação JSON |
---|
{
"objectType": string,
"filter": {
object ( |
Campos | |
---|---|
objectType |
Se o "objectType" estiver definido, apenas os objetos desse tipo serão retornados. Precisa corresponder ao nome do objeto que foi registrado na definição do esquema. O tamanho máximo é de 256 caracteres. |
filter |
Filtro genérico para restringir a pesquisa, por exemplo, |
Filtrar
Uma maneira genérica de expressar filtros em uma consulta, compatível com duas abordagens:
1. Como configurar um ValueFilter. O nome precisa corresponder a um providerName 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 podem aparecer apenas no nível superior. OR pode aparecer somente abaixo de um AND de nível superior.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união
|
|
valueFilter |
|
compositeFilter |
|
Filter.ValueFilter
Representação JSON |
---|
{
"operatorName": string,
"value": {
object ( |
Campos | |
---|---|
operatorName |
O
|
value |
O valor a ser comparado. |
Valor
Definição de um valor único com tipo genérico.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união value . O valor da propriedade nomeada. value pode ser apenas de um dos tipos a seguir: |
|
stringValue |
|
integerValue |
|
doubleValue |
|
timestampValue |
Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: |
booleanValue |
|
dateValue |
|
Filter.CompositeFilter
Representação JSON |
---|
{ "logicOperator": enum ( |
Campos | |
---|---|
logicOperator |
O operador lógico do subfiltro. |
subFilters[] |
Subfiltros. |
Filter.CompositeFilter.LogicOperator
Enums | |
---|---|
AND |
Operadores lógicos, que só podem ser aplicados a subfiltros. |
OR |
|
NOT |
NOT pode ser aplicado apenas em um único subfiltro. |
SourceConfig
Configurações para uma origem ao processar uma solicitação query.search
ou query.suggest
.
Representação JSON |
---|
{ "source": { object ( |
Campos | |
---|---|
source |
A fonte para que esta configuração será usada. |
scoringConfig |
A configuração de pontuação da origem. |
crowdingConfig |
A configuração de agrupamento da origem. |
SourceScoringConfig
Define a configuração de pontuação. Isso permite modificar a classificação dos resultados de uma fonte.
Representação JSON |
---|
{
"sourceImportance": enum ( |
Campos | |
---|---|
sourceImportance |
Importância da fonte. |
SourceScoringConfig.SourceImportance
A importância de uma fonte que pode ser usada para indicar se ela deve ter mais prioridade na classificação em comparação a outra.
Enums | |
---|---|
DEFAULT |
|
LOW |
|
HIGH |
SourceCrowdingConfig
Definir limites de agrupamento dos resultados da pesquisa. Agregação é uma situação em que vários resultados da mesma origem ou host "selocam" outros resultados, diminuindo a qualidade da pesquisa para os usuários. Para promover melhor qualidade de pesquisa e diversidade de fontes nos resultados, você pode definir uma condição para reduzir os resultados repetitivos por origem.
Representação JSON |
---|
{ "numResults": integer, "numSuggestions": integer } |
Campos | |
---|---|
numResults |
O 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 vai ser usado se esse valor for igual a 0. Para desativar o agrupamento, defina um valor maior que 100. |
numSuggestions |
Número máximo de sugestões permitidas de uma origem. Nenhum limite será definido para os resultados se esse valor for menor ou igual a 0. |
ScoringConfig
Configurações de pontuação de uma origem ao processar uma solicitação query.search
ou query.suggest
.
Representação JSON |
---|
{ "disableFreshness": boolean, "disablePersonalization": boolean } |
Campos | |
---|---|
disableFreshness |
Define se a atualização deve ser usada como um indicador de classificação. Por padrão, a atualização é usada como um indicador de classificação. Observe que essa configuração não está disponível na interface do administrador. |
disablePersonalization |
Define se os resultados devem ser personalizados. Por padrão, indicadores pessoais serão usados para impulsionar os resultados. |
SortOptions
Representação JSON |
---|
{
"operatorName": string,
"sortOrder": enum ( |
Campos | |
---|---|
operatorName |
O nome do operador correspondente ao campo a ser classificado. A propriedade correspondente precisa ser marcada como |
sortOrder |
A ordem de classificação padrão é crescente |
SortOptions.SortOrder
Enums | |
---|---|
ASCENDING |
|
DESCENDING |
FacetOptions
Especifica os operadores para os quais retornar os resultados de atributos. Haverá um FacetResult para cada combinação sourceName/objectType/operatorName.
Representação JSON |
---|
{
"sourceName": string,
"objectType": string,
"operatorName": string,
"numFacetBuckets": integer,
"integerFacetingOptions": {
object ( |
Campos | |
---|---|
sourceName |
Nome da origem para o atributo. Formato: datasources/{sourceId} Se estiver vazio, todas as fontes de dados vão ser usadas. |
objectType |
Se oobjectType 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 |
O nome do operador escolhido para a filtragem de atributos. @see cloudsearch.SchemaPropertyOptions |
numFacetBuckets |
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 |
Se definido, descreve as opções de atributos para a propriedade de números inteiros especificada. A propriedade inteira correspondente no esquema deve ser marcada como isFacetable. O número de buckets retornados seria o mínimo deste e de numFacetBuckets. |
IntegerFacetingOptions
Usado para especificar opções de atributos para números inteiros.
Representação JSON |
---|
{ "integerBuckets": [ string ] } |
Campos | |
---|---|
integerBuckets[] |
Buckets para determinados valores inteiros 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 |
Ative essa sinalização para desativar todas as otimizações internas, como a interpretação de consultas em linguagem natural (NL), a recuperação complementar de resultados e o uso de sinônimos, incluindo os personalizados. Se essa flag for definida como verdadeira, ela 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 para o modo literal. |
forceDisableSupplementalResults |
Defina esta sinalização para desativar a recuperação de resultados complementares. Definir uma sinalização aqui não recuperará resultados complementares para consultas associadas a um determinado aplicativo de pesquisa. Se essa flag for definida como verdadeira, ela terá precedência sobre a opção definida no nível da consulta. Para o valor padrão "Falso", a sinalização no nível da consulta definirá a interpretação correta para resultados complementares. |
Métodos |
|
---|---|
|
Cria um app de pesquisa. |
|
Exclui um app de pesquisa. |
|
Recebe o app de pesquisa especificado. |
|
Lista todos os apps de pesquisa. |
|
Atualiza um app de pesquisa. |
|
Redefine um app de pesquisa para as configurações padrão. |
|
Atualiza um app de pesquisa. |