REST Resource: projects.locations.corpora.searchConfigs

Recurso: SearchConfig

O SearchConfig armazena propriedades diferentes que afetam os comportamentos e os resultados da pesquisa.

Representação JSON 
{
  "name": string,
  "facetProperty": {
    object (FacetProperty)
  },
  "searchCriteriaProperty": {
    object (SearchCriteriaProperty)
  }
}
Campos
name

string

Nome do recurso da configuração de pesquisa. Para CustomSearchCriteria, o searchConfig seria o nome do operador de pesquisa. Para facetas, o searchConfig seria o nome da dimensão da faceta. Formulário: projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{searchConfig}
facetProperty

object (FacetProperty)

Estabelece uma FacetDimension e as especificações associadas.
searchCriteriaProperty

object (SearchCriteriaProperty)

Cria um mapeamento entre um SearchCriteria personalizado e uma ou mais chaves de UGA.

FacetProperty

Configuração central de uma faceta.

Representação JSON 
{
  "mappedFields": [
    string
  ],
  "displayName": string,
  "resultSize": string,
  "bucketType": enum (FacetBucketType),

  // Union field range_facet_config can be only one of the following:
  "fixedRangeBucketSpec": {
    object (FixedRangeBucketSpec)
  },
  "customRangeBucketSpec": {
    object (CustomRangeBucketSpec)
  },
  "datetimeBucketSpec": {
    object (DateTimeBucketSpec)
  }
  // End of list of possible types for union field range_facet_config.
}
Campos
mappedFields[]

string

Nome dos atributos, que são as dimensões que os usuários querem usar para refinar os resultados da pesquisa. mappedFields vai corresponder às chaves do UserSpecifiedDataSchema.

Por exemplo, o usuário pode adicionar vários UGAs com a mesma chave, como player:adam, player:bob, player:charles. Quando vários mappedFields são especificados, o valor deles é mesclado como valor de faceta final. Por exemplo, home_team: a, home_team:b, away_team:a, away_team:c, quando facet_field = [home_team, away_team], facet_value será [a, b, c].

A menos que seja uma dimensão de faceta 1:1 (mappedFields.size() == 1) E o mapped_field for igual ao SearchConfig.name principal, o pai também precisa ter uma SearchCriteriaProperty que mapeie para os mesmos campos. O mappedFields não pode estar vazio.
displayName

string

Nome de exibição do atributo. Para ser usado pela interface para renderização de facetas.
resultSize

string (int64 format)

Número máximo de buckets únicos a serem retornados para um atributo. O número de buckets pode ser grande para uma faceta de alta cardinalidade, como "jogador". Só retornamos os n mais relacionados ao usuário. Se for <= 0, o servidor vai decidir o tamanho do resultado adequado.
bucketType

enum (FacetBucketType)

Tipo de bucket de faceta, por exemplo, valor, intervalo.

Campo de união range_facet_config.

range_facet_config pode ser apenas de um dos tipos a seguir:
fixedRangeBucketSpec

object (FixedRangeBucketSpec)

Configuração de bucket de faceta de período fixo.
customRangeBucketSpec

object (CustomRangeBucketSpec)

Configuração do bucket de atributos de intervalo personalizado.
datetimeBucketSpec

object (DateTimeBucketSpec)

Configuração do bucket de facetas de período

FixedRangeBucketSpec

Se o tipo de bucket for FIXED_RANGE, especifique como os valores são agrupados em buckets. Use FixedRangeBucketSpec quando quiser criar vários buckets com granularidades iguais. Usando o valor do bucket inteiro como exemplo, quando bucketStart = 0, bucketGranularity = 10 e bucketCount = 5, esse atributo vai ser agregado usando os seguintes buckets: [-inf, 0), [0, 10), [10, 20), [20, 30), [30, inf). bucketCount <= 1 é uma especificação inválida.

Representação JSON 
{
  "bucketStart": {
    object (FacetValue)
  },
  "bucketGranularity": {
    object (FacetValue)
  },
  "bucketCount": integer
}
Campos
bucketStart

object (FacetValue)

Limite inferior do bucket. OBSERVAÇÃO: no momento, somente o tipo de número inteiro é aceito para esse campo.
bucketGranularity

object (FacetValue)

Granularidade do bucket. OBSERVAÇÃO: no momento, somente o tipo de número inteiro é aceito para esse campo.
bucketCount

integer

Número total de buckets.

FacetValue

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,
  "datetimeValue": {
    object (DateTime)
  }
  // End of list of possible types for union field value.
}
Campos

Campo de união value.

value pode ser apenas de um dos tipos a seguir:
stringValue

string

Valor do tipo string.
integerValue

string (int64 format)

Valor do tipo inteiro.
datetimeValue

object (DateTime)

Valor do tipo "data e hora".

CustomRangeBucketSpec

Se o tipo de bucket for CUSTOM_RANGE, especifique como os valores são agrupados. Use o valor do bucket de número inteiro como exemplo. Quando os endpoints são 0, 10, 100 e 1.000, as seguintes facetas são geradas: [-inf, 0), [0, 10), [10, 100), [100, 1.000), [1.000, inf). Observações: os endpoints precisam ser listados em ordem crescente. Caso contrário, a API SearchConfig vai rejeitar a configuração da faceta. - < 1 endpoint é uma especificação inválida.

Representação JSON 
{
  "endpoints": [
    {
      object (FacetValue)
    }
  ]
}
Campos
endpoints[]

object (FacetValue)

No momento, apenas o tipo de número inteiro é aceito para esse campo.

DateTimeBucketSpec

Se o tipo de bucket for "DATA", especifique como os valores de data são agrupados em buckets.

Representação JSON 
{
  "granularity": enum (Granularity)
}
Campos
granularity

enum (Granularity)

Granularidade da faceta de tipo de data.

Granularidade

Enum de granularidade para o bucket de data e hora.

Enums
GRANULARITY_UNSPECIFIED Granularidade não especificada.
YEAR A granularidade é "ano".
MONTH A granularidade é mensal.
DAY A granularidade é diária.

FacetBucketType

Tipos diferentes para um bucket de facetas.

Enums
FACET_BUCKET_TYPE_UNSPECIFIED Tipo não especificado.
FACET_BUCKET_TYPE_VALUE Tipo de valor.
FACET_BUCKET_TYPE_DATETIME Tipo de data e hora.
FACET_BUCKET_TYPE_FIXED_RANGE Tipo de intervalo fixo.
FACET_BUCKET_TYPE_CUSTOM_RANGE Tipo de intervalo personalizado.

SearchCriteriaProperty

Configuração central para critérios de pesquisa personalizados.

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

string

Cada mapped_field corresponde a uma chave de UGA. Para entender como essa propriedade funciona, confira o exemplo a seguir. Na tabela SearchConfig, o usuário adiciona esta entrada: searchConfig { name: "person" searchCriteriaProperty { mappedFields: "player" mappedFields: "coach" } }

Agora, quando um usuário emite uma consulta como: criteria { field: "person" textArray { txtValues: "Tom Brady" txtValues: "Bill Belichick" } }

A pesquisa MWH vai retornar documentos de pesquisa em que (player=Tom Brady || coach=Tom Brady || player=Bill Belichick || coach=Bill Belichick).

Métodos

create

 Cria uma configuração de pesquisa dentro de um corpus.

delete

 Exclui uma configuração de pesquisa em um corpus.

get

 Recebe uma configuração de pesquisa dentro de um corpus.

list

 Lista todas as configurações de pesquisa em um corpus.

patch

 Atualiza uma configuração de pesquisa em um corpus.