REST Resource: projects.locations.evaluations

Recurso: Evaluation

Uma avaliação é uma única execução (ou operação) de um processo de avaliação. Ele encapsula o estado da avaliação e os dados resultantes.

Representação JSON 
{
  "name": string,
  "evaluationSpec": {
    object (EvaluationSpec)
  },
  "qualityMetrics": {
    object (QualityMetrics)
  },
  "state": enum (State),
  "error": {
    object (Status)
  },
  "createTime": string,
  "endTime": string,
  "errorSamples": [
    {
      object (Status)
    }
  ]
}
Campos
name

string

Identificador. O nome completo do recurso Evaluation, no formato projects/{project}/locations/{location}/evaluations/{evaluation}.

Esse campo precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres.
evaluationSpec

object (EvaluationSpec)

Obrigatório. A especificação da avaliação.
qualityMetrics

object (QualityMetrics)

Apenas saída. As métricas produzidas pela avaliação, com média em todos os SampleQuerys no SampleQuerySet.

Só é preenchido quando o estado da avaliação é "SUCCEEDED".
state

enum (State)

Apenas saída. O estado da avaliação.
error

object (Status)

Apenas saída. O erro que ocorreu durante a avaliação. Preenchido apenas quando o estado da avaliação é "FAILED".
createTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora em que o Evaluation foi criado.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes 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".
endTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora em que o Evaluation foi concluído.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes 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".
errorSamples[]

object (Status)

Apenas saída. Uma amostra de erros encontrados ao processar a solicitação.

EvaluationSpec

Descreve a especificação da avaliação.

Representação JSON 
{
  "querySetSpec": {
    object (QuerySetSpec)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "searchRequest": {
    object (SearchRequest)
  }
  // End of mutually exclusive fields.
}
Campos
querySetSpec

object (QuerySetSpec)

Opcional. A especificação do conjunto de consultas.
A especificação da pesquisa. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
searchRequest

object (SearchRequest)

Obrigatório. A solicitação de pesquisa usada para realizar a avaliação.

Apenas os seguintes campos em "SearchRequest" são aceitos. Se outros campos forem fornecidos, um erro "UNSUPPORTED" será retornado:
Fim dos campos mutuamente exclusivos.

SearchRequest

Solicite uma mensagem para o método SearchService.Search.

Representação JSON 
{
  "servingConfig": string,
  "branch": string,
  "query": string,
  "pageCategories": [
    string
  ],
  "imageQuery": {
    object (ImageQuery)
  },
  "pageSize": integer,
  "pageToken": string,
  "offset": integer,
  "oneBoxPageSize": integer,
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ],
  "numResultsPerDataStore": integer,
  "filter": string,
  "canonicalFilter": string,
  "orderBy": string,
  "userInfo": {
    object (UserInfo)
  },
  "languageCode": string,
  "regionCode": string,
  "facetSpecs": [
    {
      object (FacetSpec)
    }
  ],
  "boostSpec": {
    object (BoostSpec)
  },
  "params": {
    string: value,
    ...
  },
  "queryExpansionSpec": {
    object (QueryExpansionSpec)
  },
  "spellCorrectionSpec": {
    object (SpellCorrectionSpec)
  },
  "userPseudoId": string,
  "contentSearchSpec": {
    object (ContentSearchSpec)
  },
  "embeddingSpec": {
    object (EmbeddingSpec)
  },
  "rankingExpression": string,
  "rankingExpressionBackend": enum (RankingExpressionBackend),
  "safeSearch": boolean,
  "userLabels": {
    string: string,
    ...
  },
  "naturalLanguageQueryUnderstandingSpec": {
    object (NaturalLanguageQueryUnderstandingSpec)
  },
  "searchAsYouTypeSpec": {
    object (SearchAsYouTypeSpec)
  },
  "displaySpec": {
    object (DisplaySpec)
  },
  "crowdingSpecs": [
    {
      object (CrowdingSpec)
    }
  ],
  "session": string,
  "sessionSpec": {
    object (SessionSpec)
  },
  "relevanceThreshold": enum (RelevanceThreshold),
  "relevanceFilterSpec": {
    object (RelevanceFilterSpec)
  },
  "personalizationSpec": {
    object (PersonalizationSpec)
  },
  "relevanceScoreSpec": {
    object (RelevanceScoreSpec)
  },
  "searchAddonSpec": {
    object (SearchAddonSpec)
  },
  "customRankingParams": {
    object (CustomRankingParams)
  },
  "entity": string
}
Campos
servingConfig

string

Obrigatório. O nome do recurso da configuração de veiculação da pesquisa, como projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config ou projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config. Esse campo é usado para identificar o nome da configuração de veiculação, o conjunto de modelos usados para fazer a pesquisa.
branch

string

O nome do recurso da ramificação, como projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0.

Use default_branch como o ID da ramificação ou deixe este campo em branco para pesquisar documentos na ramificação padrão.
query

string

Consulta de pesquisa bruta.
pageCategories[]

string

Opcional. As categorias associadas a uma página de categoria. Precisa ser definido para consultas de navegação por categoria para alcançar uma boa qualidade de pesquisa. O formato precisa ser o mesmo de PageInfo.page_category. Esse campo é o equivalente da consulta para consultas de navegação. Ele é usado pelo modelo de navegação quando a consulta está vazia.

Se o campo estiver vazio, ele não será usado pelo modelo de navegação. Se o campo contiver mais de um elemento, apenas o primeiro será usado.

Para representar o caminho completo de uma categoria, use o caractere ">" para separar as diferentes hierarquias. Se ">" fizer parte do nome da categoria, substitua por outros caracteres. Por exemplo, Graphics Cards > RTX>4090 > Founders Edition, em que "RTX > 4090" representa um nível, pode ser reescrito como Graphics Cards > RTX_4090 > Founders Edition
imageQuery

object (ImageQuery)

Consulta de imagem bruta.
pageSize

integer

Número máximo de Documents a serem retornados. O valor máximo permitido depende do tipo de dados. Valores acima do máximo são convertidos para o máximo.

  • Sites com indexação básica: padrão 10, máximo 25.
  • Sites com indexação avançada: padrão 25, máximo 50.
  • Outro: padrão 50, máximo 100.

Se esse campo for negativo, um INVALID_ARGUMENT será retornado.
pageToken

string

Um token de página recebido de uma chamada SearchService.Search anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para SearchService.Search precisam corresponder à chamada que forneceu o token da página. Caso contrário, um erro INVALID_ARGUMENT será retornado.
offset

integer

Um número inteiro com índice zero que especifica o deslocamento atual (ou seja, o local do resultado inicial, entre os Documents considerados relevantes pela API) nos resultados da pesquisa. Esse campo só é considerado se pageToken não estiver definido.

Se esse campo for negativo, um INVALID_ARGUMENT será retornado.

Um grande valor de ajuste pode ser limitado a um limite razoável.
oneBoxPageSize

integer

O número máximo de resultados a serem retornados para o OneBox. Isso se aplica a cada tipo de OneBox individualmente. O número padrão é 10.
dataStoreSpecs[]

object (DataStoreSpec)

Especificações que definem os DataStores específicos a serem pesquisados, além das configurações desses repositórios de dados. Isso só é considerado para Engines com vários repositórios de dados. Para mecanismos com um único repositório de dados, use as especificações diretamente em SearchRequest.

Em um mecanismo com vários repositórios de dados, esse campo é opcional. Se estiver vazio, todos os repositórios de dados do mecanismo serão pesquisados (pesquisa combinada). A menos que especifique exatamente um repositório de dados, alguns campos de solicitação, como orderBy e queryExpansionSpec, não são compatíveis e retornam um erro INVALID_ARGUMENT.
numResultsPerDataStore

integer

Opcional. O número máximo de resultados a serem recuperados de cada repositório de dados. Se não for especificado, ele usará o SearchRequest.DataStoreSpec.num_results, se fornecido. Caso contrário, não haverá limite.
filter

string

A sintaxe do filtro consiste em uma linguagem de expressão para construir um predicado de um ou mais campos dos documentos que estão sendo filtrados. A expressão de filtro diferencia maiúsculas de minúsculas.

Se esse campo não for reconhecido, um INVALID_ARGUMENT será retornado.

A filtragem na Vertex AI para Pesquisa é feita mapeando a chave de filtro do lado esquerdo (LHS, na sigla em inglês) para uma propriedade de chave definida no back-end da Vertex AI para Pesquisa. Esse mapeamento é definido pelo cliente no esquema dele. Por exemplo, um cliente de mídia pode ter um campo "name" no esquema. Nesse caso, o filtro ficaria assim: filter --> name:'ANY("king kong")'

Para mais informações sobre filtragem, incluindo sintaxe e operadores de filtro, consulte Filtro.
canonicalFilter

string

O filtro padrão aplicado quando um usuário faz uma pesquisa sem marcar nenhum filtro na página de pesquisa.

O filtro aplicado a cada solicitação de pesquisa quando é necessário melhorar a qualidade, como a expansão de consultas. Se uma consulta não tiver resultados suficientes, esse filtro será usado para determinar se o fluxo de expansão de consulta será ativado ou não. O filtro original ainda será usado na expansão de consulta. Recomendamos o uso desse campo para alcançar uma alta qualidade de pesquisa.

Para mais informações sobre a sintaxe de filtro, consulte SearchRequest.filter.
orderBy

string

A ordem em que os documentos são retornados. Os documentos podem ser ordenados por um campo em um objeto Document. Deixe em branco se a ordenação for por relevância. A expressão orderBy diferencia maiúsculas de minúsculas.

Para mais informações sobre como ordenar os resultados da pesquisa no site, consulte Ordenar resultados da pesquisa na Web. Para mais informações sobre como ordenar os resultados da pesquisa de saúde, consulte Ordenar resultados da pesquisa de saúde. Se esse campo não for reconhecido, um INVALID_ARGUMENT será retornado.
userInfo

object (UserInfo)

Informações sobre o usuário final. Altamente recomendado para análise e personalização. UserInfo.user_agent é usado para deduzir deviceType para análise.
languageCode

string

O código de idioma BCP-47, como pt-BR ou en-US. Para mais informações, consulte Campos padrão. Esse campo ajuda a interpretar melhor a consulta. Se um valor não for especificado, o código do idioma da consulta será detectado automaticamente, o que pode não ser preciso.
regionCode

string

O código de país/região Unicode (CLDR) de um local, como "US" e "419". Para mais informações, consulte Campos padrão. Se definido, os resultados serão promovidos com base no regionCode fornecido.
facetSpecs[]

object (FacetSpec)

Especificações de atributos para pesquisa facetada. Se estiver vazio, nenhuma faceta será retornada.

São permitidos no máximo 100 valores. Caso contrário, um erro INVALID_ARGUMENT será retornado.
boostSpec

object (BoostSpec)

Otimizar a especificação para impulsionar determinados documentos. Para mais informações sobre o aumento, consulte Aumento.
params

map (key: string, value: value (Value format))

Outros parâmetros de pesquisa.

Para pesquisa em sites públicos, os valores compatíveis são:

  • user_country_code: string. O padrão é vazio. Se definido como não vazio, os resultados serão restritos ou promovidos com base no local fornecido. Por exemplo, user_country_code: "au"

Para ver os códigos disponíveis, consulte Códigos de país.

  • searchType: double. O padrão é vazio. Ativa a pesquisa de conteúdo que não seja de páginas da Web, dependendo do valor. O único valor válido que não é o padrão é 1, que permite a pesquisa de imagens. Por exemplo, searchType: 1
queryExpansionSpec

object (QueryExpansionSpec)

A especificação de expansão de consulta que especifica as condições em que ela ocorre.
spellCorrectionSpec

object (SpellCorrectionSpec)

A especificação de correção ortográfica que especifica o modo em que ela entra em vigor.
userPseudoId

string

Opcional. Um identificador exclusivo para rastrear visitantes. Por exemplo, isso pode ser implementado com um cookie HTTP, que deve ser capaz de identificar um visitante de forma exclusiva em um único dispositivo. Esse identificador exclusivo não muda se o visitante faz login ou logout no site.

Esse campo NÃO pode ter um valor fixo, como unknown_visitor.

Precisa ser o mesmo identificador de UserEvent.user_pseudo_id e CompleteQueryRequest.user_pseudo_id.

O campo precisa ser uma string codificada em UTF-8 com um limite de 128 caracteres. Caso contrário, um erro INVALID_ARGUMENT será retornado.
contentSearchSpec

object (ContentSearchSpec)

Uma especificação para configurar o comportamento da pesquisa de conteúdo.
embeddingSpec

object (EmbeddingSpec)

Usa o embedding fornecido para fazer outra recuperação semântica de documentos. A recuperação é baseada no produto escalar de SearchRequest.EmbeddingSpec.EmbeddingVector.vector e a incorporação de documento fornecida em SearchRequest.EmbeddingSpec.EmbeddingVector.field_path.

Se SearchRequest.EmbeddingSpec.EmbeddingVector.field_path não for fornecido, ServingConfig.EmbeddingConfig.field_path será usado.
rankingExpression

string

Opcional. A expressão de classificação controla a classificação personalizada nos documentos de recuperação. Isso substitui ServingConfig.ranking_expression. A sintaxe e os recursos compatíveis dependem do valor de rankingExpressionBackend. Se rankingExpressionBackend não for fornecido, o padrão será RANK_BY_EMBEDDING.

Se rankingExpressionBackend não for fornecido ou for definido como RANK_BY_EMBEDDING, ele deverá ser uma única função ou várias funções unidas por "+".

  • rankingExpression = function, { " + ", function };

Funções compatíveis:

  • double * relevanceScore
  • double * dotProduct(embedding_field_path)

Variáveis de função:

  • relevanceScore: palavras-chave predefinidas usadas para medir a relevância entre a consulta e o documento.
  • embedding_field_path: o campo de embedding de documento usado com o vetor de embedding de consulta.
  • dotProduct: função de embedding entre embedding_field_path e o vetor de embedding de consulta.

Exemplo de expressão de classificação:

Se o documento tiver um campo de incorporação doc_embedding, a expressão de classificação poderá ser 0.5 * relevanceScore + 0.3 * dotProduct(doc_embedding).

Se rankingExpressionBackend estiver definido como RANK_BY_FORMULA, os seguintes tipos de expressão (e combinações deles encadeados usando operadores + ou *) serão aceitos:

  • double
  • signal
  • log(signal)
  • exp(signal)
  • rr(signal, double > 0): transformação de classificação recíproca com o segundo argumento sendo uma constante de denominador.
  • isNan(signal): retorna 0 se o indicador for NaN e 1 caso contrário.
  • fillNan(signal1, signal2 | double): se signal1 for NaN, vai retornar signal2 | double. Caso contrário, vai retornar signal1.

Confira alguns exemplos de fórmulas de classificação que usam os tipos de expressão de classificação compatíveis:

  • 0.2 * semanticSimilarityScore + 0.8 * log(keywordSimilarityScore): principalmente classificação pelo logaritmo de keywordSimilarityScore com um pequeno ajuste de semantic_smilarity_score.
  • 0.2 * exp(fillNan(semanticSimilarityScore, 0)) + 0.3 * isNan(keywordSimilarityScore): classifica pelo expoente de semanticSimilarityScore, preenchendo o valor com 0 se for NaN.Também adiciona um ajuste constante de 0,3 à pontuação final se semanticSimilarityScore for NaN.
  • 0.2 * rr(semanticSimilarityScore, 16) + 0.8 * rr(keywordSimilarityScore, 16): principalmente classificação pela classificação recíproca de keywordSimilarityScore com um pequeno ajuste da classificação recíproca de semantic_smilarity_score.

Há suporte para os seguintes indicadores:

  • semanticSimilarityScore: ajuste de similaridade semântica calculado usando os embeddings gerados por um modelo proprietário do Google. Essa pontuação determina o grau de semelhança semântica entre uma consulta de pesquisa e um documento.
  • keywordSimilarityScore: o ajuste de correspondência de palavra-chave usa a função de classificação Best Match 25 (BM25). Essa pontuação é calculada usando um modelo probabilístico para estimar a probabilidade de um documento ser relevante para uma determinada consulta.
  • relevanceScore: ajuste de relevância semântica que usa um modelo proprietário do Google para determinar o significado e a intenção por trás da consulta de um usuário no contexto do conteúdo dos documentos.
  • pctrRank: ajuste de preços da taxa de conversão estimada como um uso de classificação. A taxa de cliques prevista (pCTR) é usada para avaliar a relevância e o atrativo de um resultado da pesquisa do ponto de vista do usuário. Uma pCTR mais alta sugere que o resultado tem mais chances de satisfazer a consulta e a intenção do usuário, o que o torna um indicador valioso para a classificação.
  • freshnessRank: ajuste de atualização como uma classificação
  • documentAge: o tempo em horas decorrido desde a última atualização do documento, um número de ponto flutuante (por exemplo, 0,25 significa 15 minutos).
  • topicalityRank: ajuste de relevância como uma classificação. Usa um modelo proprietário do Google para determinar a sobreposição baseada em palavras-chave entre a consulta e o documento.
  • baseRank: a classificação padrão do resultado.
  • mediaActorMatch: se o ator de mídia corresponde à consulta
  • mediaDirectorMatch: se o diretor de mídia corresponde à consulta
  • mediaGenreMatch: se o gênero da mídia corresponde à consulta
  • mediaLanguageMatch: se o idioma da mídia corresponde à consulta
  • mediaTitleMatch: se o título da mídia corresponde à consulta
  • mediaPrefixSimilarityRank: classificação de similaridade de prefixo para resultados de mídia.
  • mediaSemanticSimilarityRank: classificação de similaridade semântica para resultados de mídia.
rankingExpressionBackend

enum (RankingExpressionBackend)

Opcional. O back-end a ser usado para a avaliação da expressão de classificação.
userLabels

map (key: string, value: string)

Os rótulos de usuário aplicados a um recurso precisam atender aos seguintes requisitos:

  • Cada recurso pode ter vários rótulos, até um máximo de 64.
  • Cada rótulo precisa ser um par de chave-valor.
  • As chaves têm um tamanho mínimo de 1 caractere e máximo de 63 caracteres e não podem estar vazias. Os valores podem estar vazios e ter um tamanho máximo de 63 caracteres.
  • As chaves e os valores contêm apenas letras minúsculas, caracteres numéricos, sublinhados e traços. Todos os caracteres precisam usar a codificação UTF-8, e os caracteres internacionais são permitidos.
  • A parte da chave de um rótulo precisa ser única. No entanto, é possível usar a mesma chave com vários recursos.
  • As chaves precisam começar com uma letra minúscula ou um caractere internacional.

Consulte o documento do Google Cloud para mais detalhes.
naturalLanguageQueryUnderstandingSpec

object (NaturalLanguageQueryUnderstandingSpec)

Opcional. Configuração para recursos de compreensão de consultas em linguagem natural, como extrair filtros de campos estruturados da consulta. Consulte esta documentação para mais informações. Se naturalLanguageQueryUnderstandingSpec não for especificado, não será feita nenhuma outra compreensão de consulta em linguagem natural.
searchAsYouTypeSpec

object (SearchAsYouTypeSpec)

Configuração de pesquisa enquanto você digita. Compatível apenas com a vertical IndustryVertical.MEDIA.
displaySpec

object (DisplaySpec)

Opcional. Configuração para o recurso de exibição, como o destaque de correspondências nos resultados da pesquisa.
crowdingSpecs[]

object (CrowdingSpec)

Opcional. Especificações de recolhimento para melhorar a diversidade de resultados. Se várias CrowdingSpecs forem especificadas, o agrupamento será avaliado em cada combinação exclusiva dos valores field, e maxCount será o valor máximo de maxCount em todas as CrowdingSpecs. Por exemplo, se o primeiro CrowdingSpec tiver field = "color" e maxCount = 3, e o segundo tiver field = "size" e maxCount = 2, depois que três documentos compartilharem a mesma cor E o mesmo tamanho, os seguintes serão removidos ou rebaixados.
session

string

O nome do recurso da sessão. Opcional.

A sessão permite que os usuários façam chamadas de API /search de várias rodadas ou coordenação entre chamadas de API /search e /answer.

Exemplo 1 (chamadas de API /search de várias rodadas): chame a API /search com o ID da sessão gerado na primeira chamada. Aqui, a consulta de pesquisa anterior é considerada na posição da consulta. Por exemplo, se a primeira consulta for "Como foi o desempenho da Alphabet em 2022?" e a consulta atual for "E 2023?", ela será interpretada como "Como foi o desempenho da Alphabet em 2023?".

Exemplo 2 (coordenação entre chamadas de API /search e /answer): chame a API /answer com o ID da sessão gerado na primeira chamada. Aqui, a geração de respostas acontece no contexto dos resultados da pesquisa da primeira chamada de pesquisa.
sessionSpec

object (SessionSpec)

Especificação da sessão.

Só pode ser usado quando session está definido.
relevanceThreshold

enum (RelevanceThreshold)

O limite de relevância global dos resultados da pesquisa.

O padrão é o limite definido pelo Google, que usa um equilíbrio de precisão e recall para fornecer resultados altamente precisos e cobertura abrangente de informações relevantes.

Se for necessário um filtro de relevância mais granular, use relevanceFilterSpec.

Esse recurso não está disponível para a pesquisa na área da saúde.
relevanceFilterSpec

object (RelevanceFilterSpec)

Opcional. A especificação granular da filtragem de relevância.

Se não for especificado, o relevanceThreshold global será usado para todas as subpesquisas. Se especificado, isso vai substituir o relevanceThreshold global para usar limites em cada subpesquisa.

No momento, esse recurso só está disponível para pesquisa personalizada e Pesquisa no site.
personalizationSpec

object (PersonalizationSpec)

A especificação para personalização.

Se ServingConfig.personalization_spec e SearchRequest.personalization_spec estiverem definidos, SearchRequest.personalization_spec vai substituir ServingConfig.personalization_spec.
relevanceScoreSpec

object (RelevanceScoreSpec)

Opcional. A especificação para retornar a pontuação de relevância.
searchAddonSpec

object (SearchAddonSpec)

Opcional. O SearchAddonSpec é usado para desativar complementos de pesquisa de acordo com o novo modelo de reprecificação. Esse campo só é compatível com solicitações de pesquisa.
customRankingParams

object (CustomRankingParams)

Opcional. Configuração opcional para o recurso de classificação personalizada.
entity

string

Opcional. A entidade para clientes que podem executar várias entidades, domínios, sites ou regiões diferentes, por exemplo, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com" etc. Se essa opção estiver definida, ela precisará corresponder exatamente a UserEvent.entity para que os resultados da pesquisa sejam impulsionados pela entidade.

ImageQuery

Especifica a entrada de consulta de imagem.

Representação JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "imageBytes": string
  // End of mutually exclusive fields.
}
Campos
Especifica os bytes da imagem. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
imageBytes

string

Bytes de imagem codificados em Base64. Formatos de imagem compatíveis: JPEG, PNG e BMP.
Fim dos campos mutuamente exclusivos.

DataStoreSpec

Uma struct para definir repositórios de dados em que filtrar em uma chamada de pesquisa e configurações para esses repositórios. Caso contrário, um erro INVALID_ARGUMENT será retornado.

Representação JSON 
{
  "dataStore": string,
  "filter": string,
  "boostSpec": {
    object (BoostSpec)
  },
  "customSearchOperators": string,
  "numResults": integer
}
Campos
dataStore

string

Obrigatório. Nome completo do recurso de DataStore, como projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. O caminho precisa incluir o número do projeto. O ID do projeto não é compatível com esse campo.
filter

string

Opcional. Especificação de filtro para filtrar documentos no repositório de dados especificado pelo campo "dataStore". Para mais informações sobre filtragem, consulte Filtragem.
boostSpec

object (BoostSpec)

Opcional. Otimizar a especificação para impulsionar determinados documentos. Para mais informações sobre o aumento, consulte Aumento.
customSearchOperators

string

Opcional. Operadores de pesquisa personalizados que, se especificados, serão usados para filtrar resultados de repositórios de dados do espaço de trabalho. Para mais informações sobre operadores de pesquisa personalizados, consulte SearchOperators.
numResults

integer

Opcional. O número máximo de resultados a serem recuperados desse repositório de dados. Se não for especificado, ele usará o SearchRequest.num_results_per_data_store, se fornecido. Caso contrário, não haverá limite. Se este campo e SearchRequest.num_results_per_data_store forem especificados, este campo será usado.

BoostSpec

Otimizar a especificação para impulsionar determinados documentos.

Representação JSON 
{
  "conditionBoostSpecs": [
    {
      object (ConditionBoostSpec)
    }
  ]
}
Campos
conditionBoostSpecs[]

object (ConditionBoostSpec)

Especificações de otimização de condição. Se um documento corresponder a várias condições nas especificações, as pontuações de reforço dessas especificações serão aplicadas e combinadas de maneira não linear. O número máximo de especificações é 20.

ConditionBoostSpec

O reforço é aplicado a documentos que correspondem a uma condição.

Representação JSON 
{
  "condition": string,
  "boost": number,
  "boostControlSpec": {
    object (BoostControlSpec)
  }
}
Campos
condition

string

Uma expressão que especifica uma condição de reforço. A sintaxe e os campos compatíveis são os mesmos de uma expressão de filtro. Consulte SearchRequest.filter para ver a sintaxe detalhada e as limitações.

Exemplos:

  • Para aumentar a relevância de documentos com o ID "doc_1" ou "doc_2" e a cor "Red" ou "Blue": (documentId: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))
boost

number

Intensidade da otimização da condição, que precisa estar em [-1, 1]. Reforço negativo significa rebaixamento. O padrão é 0,0.

Definir como 1.0 oferece uma boa promoção ao documento. No entanto, isso não significa necessariamente que o documento otimizado será o resultado principal em todos os momentos, nem que os outros documentos serão excluídos. É possível que sejam mostrados resultados mesmo que nenhum deles corresponda à condição. Além disso, os resultados mais relevantes para a consulta de pesquisa ainda podem ter uma classificação maior do que a dos documentos mais favorecidos, mas irrelevantes.

Definir como -1.0 reduz bastante a classificação do documento. No entanto, resultados muito relevantes ainda podem ser mostrados. O documento vai ter uma disputa upstream para conseguir uma classificação razoavelmente alta, mas não será completamente bloqueado.

Definir como 0,0 significa que nenhum aumento será aplicado. A condição de reforço é ignorada. Apenas uma das combinações (condição, reforço) ou o boostControlSpec abaixo está definido. Se os dois forem definidos, o aumento global será ignorado e o boostControlSpec mais refinado será aplicado.
boostControlSpec

object (BoostControlSpec)

Especificação complexa para classificação personalizada com base no valor do atributo definido pelo cliente.

BoostControlSpec

Especificação para classificação personalizada com base no valor do atributo especificado pelo cliente. Ela oferece mais controles para classificação personalizada do que a combinação simples (condição, reforço) acima.

Representação JSON 
{
  "fieldName": string,
  "attributeType": enum (AttributeType),
  "interpolationType": enum (InterpolationType),
  "controlPoints": [
    {
      object (ControlPoint)
    }
  ]
}
Campos
fieldName

string

O nome do campo cujo valor será usado para determinar o valor do reforço.
attributeType

enum (AttributeType)

O tipo de atributo a ser usado para determinar o valor do aumento. O valor do atributo pode ser derivado do valor do campo do fieldName especificado. No caso de valores numéricos, é simples: attributeValue = numerical_field_value. No caso da atualização, attributeValue = (time.now() - datetime_field_value).
interpolationType

enum (InterpolationType)

O tipo de interpolação a ser aplicado para conectar os pontos de controle listados abaixo.
controlPoints[]

object (ControlPoint)

Os pontos de controle usados para definir a curva. A função monotônica (definida pelo "interpolationType" acima) passa pelos pontos de controle listados aqui.

AttributeType

O atributo(ou função) a que a classificação personalizada será aplicada.

Tipos enumerados
ATTRIBUTE_TYPE_UNSPECIFIED AttributeType não especificado.
NUMERICAL O valor do campo numérico será usado para atualizar dinamicamente o valor do reforço. Nesse caso, o attributeValue (o valor x) do ponto de controle será o valor real do campo numérico para o qual o boostAmount é especificado.
FRESHNESS Para o caso de uso de atualização, o valor do atributo será a duração entre a hora atual e a data no campo de data e hora especificado. O valor precisa ser formatado como um valor dayTimeDuration XSD (um subconjunto restrito de um valor de duração ISO 8601). O padrão é: [nD][T[nH][nM][nS]]. Por exemplo, 5D, 3DT12H30M, T24H.

InterpolationType

O tipo de interpolação a ser aplicado. O padrão é linear (linear por partes).

Tipos enumerados
INTERPOLATION_TYPE_UNSPECIFIED O tipo de interpolação não foi especificado. Nesse caso, o padrão é "Linear".
LINEAR A interpolação linear por partes será aplicada.

ControlPoint

Os pontos de controle usados para definir a curva. A curva definida por esses pontos de controle só pode ser monotonicamente crescente ou decrescente(valores constantes são aceitáveis).

Representação JSON 
{
  "attributeValue": string,
  "boostAmount": number
}
Campos
attributeValue

string

Pode ser um dos seguintes: 1. O valor do campo numérico. 2. A especificação de duração para atualização. O valor precisa ser formatado como um valor XSD dayTimeDuration (um subconjunto restrito de um valor de duração ISO 8601). O padrão é: [nD][T[nH][nM][nS]].
boostAmount

number

O valor entre -1 e 1 pelo qual aumentar a pontuação se o atributo "attributeValue" for avaliado como o valor especificado acima.

FacetSpec

Uma especificação de atributo para realizar uma pesquisa refinada.

Representação JSON 
{
  "facetKey": {
    object (FacetKey)
  },
  "limit": integer,
  "excludedFilterKeys": [
    string
  ],
  "enableDynamicPosition": boolean
}
Campos
facetKey

object (FacetKey)

Obrigatório. A especificação da chave de faceta.
limit

integer

Número máximo de valores de atributo retornados para este atributo. Se não for especificado, o padrão será 20. O valor máximo permitido é 300. Valores acima de 300 são convertidos para 300. Para agregação na pesquisa de saúde, quando [FacetKey.key] é "healthcare_aggregation_key", o limite é substituído por 10.000 internamente, independente do valor definido aqui.

Se esse campo for negativo, um INVALID_ARGUMENT será retornado.
excludedFilterKeys[]

string

Lista de chaves a serem excluídas ao criar facetas.

Por padrão, FacetKey.key não é excluído do filtro, a menos que esteja listado nesse campo.

Listar uma chave de atributo nesse campo permite que os valores dela apareçam como resultados de atributos, mesmo quando são filtrados dos resultados da pesquisa. O uso desse campo não afeta os resultados da pesquisa retornados.

Por exemplo, suponha que haja 100 documentos com o atributo "Vermelho" e 200 documentos com o atributo "Azul". Uma consulta que contenha o filtro "color:ANY("Red")" e tenha "color" como FacetKey.key retornaria por padrão apenas documentos "Red" nos resultados da pesquisa, além de retornar "Red" com a contagem 100 como o único atributo de cor. Embora também haja documentos azuis disponíveis, "Azul" não seria mostrado como um valor de refinamento disponível.

Se "color" estiver listado em "excludedFilterKeys", a consulta vai retornar os valores de faceta "Red" com a contagem 100 e "Blue" com a contagem 200, porque a chave "color" agora está excluída do filtro. Como esse campo não afeta os resultados da pesquisa, eles ainda são filtrados corretamente para retornar apenas documentos "Vermelho".

São permitidos no máximo 100 valores. Caso contrário, um erro INVALID_ARGUMENT será retornado.
enableDynamicPosition

boolean

Ativa a posição dinâmica para esse atributo. Se definido como "true", a posição dessa faceta entre todas as facetas na resposta será determinada automaticamente. Se os atributos dinâmicos estiverem ativados, eles serão ordenados juntos. Se definido como "false", a posição desse atributo na resposta será a mesma da solicitação, e ele será classificado antes dos atributos com posição dinâmica ativada e de todos os atributos dinâmicos.

Por exemplo, talvez você sempre queira que a faceta de classificação seja retornada na resposta, mas não necessariamente que ela seja mostrada na parte de cima. Nesse caso, defina "enableDynamicPosition" como "true" para que a posição do atributo de classificação na resposta seja determinada automaticamente.

Outro exemplo, supondo que você tenha as seguintes facetas na solicitação:

  • "rating", enableDynamicPosition = true

  • "price", enableDynamicPosition = false

  • "brands", enableDynamicPosition = false

Além disso, você tem atributos dinâmicos ativados, o que gera um atributo gender. Então, a ordem final das facetas na resposta pode ser ("price", "brands", "rating", "gender") ou ("price", "brands", "gender", "rating") dependendo de como a API ordena as facetas "gender" e "rating". No entanto, observe que "price" e "brands" sempre são classificados na primeira e na segunda posição porque o enableDynamicPosition é falso.

FacetKey

Especifica como uma faceta é calculada.

Representação JSON 
{
  "key": string,
  "intervals": [
    {
      object (Interval)
    }
  ],
  "restrictedValues": [
    string
  ],
  "prefixes": [
    string
  ],
  "contains": [
    string
  ],
  "caseInsensitive": boolean,
  "orderBy": string
}
Campos
key

string

Obrigatório. Chaves de atributos textuais e numéricos compatíveis no objeto Document, em que os valores de atributo são calculados. A chave de refinamento diferencia maiúsculas de minúsculas.
intervals[]

object (Interval)

Definido apenas se os valores forem agrupados em intervalos. Precisa ser definido para atributos com valores numéricos. Não pode ser definido para atributos com valores de texto. O número máximo de intervalos é 30.
restrictedValues[]

string

Recebe apenas o aspecto para os valores restritos especificados. Disponível apenas em campos de texto. Por exemplo, suponha que "categoria" tenha três valores: "Ação > 2022", "Ação > 2021" e "Ficção científica > 2022". Se "restrictedValues" for definido como "Action > 2022", a faceta "category" vai conter apenas "Action > 2022". Disponível apenas em campos de texto. O máximo é 10.
prefixes[]

string

Recebe apenas valores de faceta que começam com o prefixo de string especificado. Por exemplo, suponha que "categoria" tenha três valores: "Ação > 2022", "Ação > 2021" e "Ficção científica > 2022". Se você definir "prefixes" como "Action", a faceta "category" vai conter apenas "Action > 2022" e "Action > 2021". Disponível apenas em campos de texto. O máximo é 10.
contains[]

string

Recebe apenas valores de faceta que contêm as strings especificadas. Por exemplo, suponha que "categoria" tenha três valores: "Ação > 2022", "Ação > 2021" e "Ficção científica > 2022". Se você definir "contém" como "2022", a faceta "categoria" vai conter apenas "Ação > 2022" e "Ficção científica > 2022". Disponível apenas em campos de texto. O máximo é 10.
caseInsensitive

boolean

Verdadeiro para tornar as chaves de refinamento insensíveis a maiúsculas e minúsculas ao receber valores de refinamento com prefixos ou contém. Caso contrário, falso.
orderBy

string

A ordem em que os documentos são retornados.

Os valores permitidos são:

Se não for definido, os valores textuais serão classificados em ordem natural, e os intervalos numéricos serão classificados na ordem fornecida por FacetSpec.FacetKey.intervals.

Intervalo

Um intervalo de ponto flutuante.

Representação JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "minimum": number,
  "exclusiveMinimum": number
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "maximum": number,
  "exclusiveMaximum": number
  // End of mutually exclusive fields.
}
Campos

O limite inferior do intervalo. Se nenhum dos campos de mínimo estiver definido, o limite inferior será infinito negativo.

Caso contrário, um erro INVALID_ARGUMENT será retornado. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
minimum

number

Limite inferior inclusivo.
exclusiveMinimum

number

Limite inferior exclusivo.
Fim dos campos mutuamente exclusivos.

O limite superior do intervalo. Se nenhum dos campos de valor máximo for definido, o limite superior será infinito positivo.

Esse campo não pode ser menor que o mínimo. Caso contrário, um erro INVALID_ARGUMENT será retornado. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
maximum

number

Limite superior inclusivo.
exclusiveMaximum

number

Limite superior exclusivo.
Fim dos campos mutuamente exclusivos.

QueryExpansionSpec

Especificação para determinar em quais condições a expansão de consulta deve ocorrer.

Representação JSON 
{
  "condition": enum (Condition),
  "pinUnexpandedResults": boolean
}
Campos
condition

enum (Condition)

A condição em que a expansão de consulta deve ocorrer. O padrão é Condition.DISABLED.
pinUnexpandedResults

boolean

Se os resultados não expandidos devem ser fixados. Se este campo for definido como verdadeiro, os produtos não expandidos sempre vão aparecer na parte de cima dos resultados da pesquisa, seguidos pelos resultados expandidos.

Condição

Tipo enumerado que descreve em qual condição a expansão de consulta deve ocorrer.

Tipos enumerados
CONDITION_UNSPECIFIED Condição de expansão de consulta não especificada. Nesse caso, o comportamento do servidor é Condition.DISABLED por padrão.
DISABLED A expansão de consulta foi desativada. Somente a consulta de pesquisa exata é usada, mesmo que SearchResponse.total_size seja zero.
AUTO Expansão automática de consulta criada pela API Search.

SpellCorrectionSpec

A especificação para correção ortográfica de consultas.

Representação JSON 
{
  "mode": enum (Mode)
}
Campos
mode

enum (Mode)

O modo em que a correção ortográfica substitui a consulta de pesquisa original. O valor padrão é Mode.AUTO.

Modo

Tipo enumerado que descreve em qual modo a correção ortográfica deve ocorrer.

Tipos enumerados
MODE_UNSPECIFIED Modo de correção ortográfica não especificado. Nesse caso, o comportamento do servidor é Mode.AUTO por padrão.
SUGGESTION_ONLY A API Search tenta encontrar uma sugestão de ortografia. Se uma sugestão for encontrada, ela será colocada no SearchResponse.corrected_query. A sugestão de ortografia não será usada como consulta de pesquisa.
AUTO Correção ortográfica automática criada pela API Search. A pesquisa será baseada na consulta corrigida, se encontrada.

EmbeddingSpec

A especificação que usa o vetor de embedding de consulta personalizado para fazer a recuperação semântica de documentos.

Representação JSON 
{
  "embeddingVectors": [
    {
      object (EmbeddingVector)
    }
  ]
}
Campos
embeddingVectors[]

object (EmbeddingVector)

O vetor de embedding usado para recuperação. Limite de 1.

EmbeddingVector

Vetor de embedding.

Representação JSON 
{
  "fieldPath": string,
  "vector": [
    number
  ]
}
Campos
fieldPath

string

Caminho do campo de embedding no esquema.
vector[]

number

Vetor de embedding de consulta.

RankingExpressionBackend

O back-end a ser usado para a avaliação da expressão de classificação.

Tipos enumerados
RANKING_EXPRESSION_BACKEND_UNSPECIFIED Opção padrão para valores não especificados/desconhecidos.
BYOE

Descontinuado: use RANK_BY_EMBEDDING. Classificação por modelo de incorporação personalizada, a maneira padrão de avaliar a expressão de classificação. Opção de enumeração legada. Use RANK_BY_EMBEDDING.
CLEARBOX

Descontinuado: use RANK_BY_FORMULA. Classificação por fórmula personalizada. Opção de enumeração legada. Use RANK_BY_FORMULA.
RANK_BY_EMBEDDING Classificação por modelo de incorporação personalizada, a maneira padrão de avaliar a expressão de classificação.
RANK_BY_FORMULA Classificação por fórmula personalizada.

NaturalLanguageQueryUnderstandingSpec

Especificação para ativar recursos de processamento de linguagem natural em solicitações de pesquisa.

Representação JSON 
{
  "filterExtractionCondition": enum (FilterExtractionCondition),
  "geoSearchQueryDetectionFieldNames": [
    string
  ],
  "extractedFilterBehavior": enum (ExtractedFilterBehavior),
  "allowedFieldNames": [
    string
  ]
}
Campos
filterExtractionCondition

enum (FilterExtractionCondition)

A condição em que a extração de filtro deve ocorrer. O comportamento padrão do servidor é DISABLED.
geoSearchQueryDetectionFieldNames[]

string

Nomes de campos usados para filtragem com base em localização, em que os filtros de geolocalização são detectados em consultas de pesquisa com linguagem natural. Só é válido quando "FilterExtractionCondition" está definido como ENABLED.
extractedFilterBehavior

enum (ExtractedFilterBehavior)

Opcional. Controla o comportamento de como os filtros extraídos são aplicados à pesquisa. O comportamento padrão depende da solicitação. Para uma única pesquisa estruturada no armazenamento de dados, o padrão é HARD_FILTER. Para a pesquisa em vários repositórios de dados, o comportamento padrão é SOFT_BOOST. Os filtros com base em localização são sempre aplicados como filtros rígidos, e a configuração SOFT_BOOST não os afeta. Esse campo só é usado se SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition estiver definido como FilterExtractionCondition.ENABLED.
allowedFieldNames[]

string

Opcional. Lista de permissões de campos que podem ser usados para extração de filtros de linguagem natural. Por padrão, se não for especificado, todos os campos indexáveis estarão qualificados para extração de filtro de linguagem natural, mas não há garantia de que serão usados. Se algum campo for especificado em "allowedFieldNames", somente os campos marcados como indexáveis no esquema e especificados na lista de permissão poderão ser extraídos pelo filtro de linguagem natural. Observação: para pesquisa em vários repositórios de dados, isso ainda não é compatível e será ignorado.

FilterExtractionCondition

Enumeração que descreve em qual condição a extração de filtro deve ocorrer.

Tipos enumerados
CONDITION_UNSPECIFIED O comportamento padrão do servidor é DISABLED.
DISABLED Desativa a extração de filtros de linguagem natural.
ENABLED Ativa a extração de filtros de linguagem natural.

ExtractedFilterBehavior

Tipo enumerado que descreve como os filtros extraídos são aplicados à pesquisa.

Tipos enumerados
EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED O EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED vai usar o comportamento padrão para filtros extraídos. Para uma única pesquisa do datastore, o padrão é aplicar como filtros rígidos. Para a pesquisa em vários repositórios de dados, o padrão é aplicar como reforços leves.
HARD_FILTER Aplica todos os filtros extraídos como filtros fixos aos resultados. Os resultados que não passarem pelos filtros extraídos não serão retornados no conjunto de resultados.
SOFT_BOOST Aplica todos os filtros extraídos como aumentos leves. Os resultados que passarem pelos filtros serão promovidos para classificações mais altas no conjunto de resultados.

SearchAsYouTypeSpec

Especificação para pesquisar enquanto você digita em solicitações de pesquisa.

Representação JSON 
{
  "condition": enum (Condition),
  "fields": [
    {
      object (Field)
    }
  ],
  "scoreThreshold": number
}
Campos
condition

enum (Condition)

A condição em que a pesquisa enquanto você digita deve ocorrer. O padrão é Condition.DISABLED.
fields[]

object (Field)

Opcional. A lista de campos a serem usados para a pontuação da pesquisa conforme você digita.
scoreThreshold

number

Opcional. Limite de pontuação da pesquisa conforme você digita para fins de filtragem. Vamos manter o resultado se score >= scoreThreshold.

Condição

Tipo enumerado que descreve em qual condição a pesquisa conforme você digita deve ocorrer.

Tipos enumerados
CONDITION_UNSPECIFIED O comportamento padrão do servidor é Condition.DISABLED.
DISABLED Desativa o recurso "Pesquisar enquanto você digita".
ENABLED Ativa o recurso "Pesquisar enquanto você digita".
AUTO Alternância automática entre os modos de pesquisa instantânea e padrão, ideal para implementações de API única (por exemplo, remoção de repetições).

Campo

Um campo de esquema a ser usado para a pontuação da pesquisa conforme você digita nesta solicitação. Substitui qualquer configuração de campo "Pesquisar enquanto você digita" no nível do repositório de dados durante a solicitação.

Representação JSON 
{
  "key": string,
  "weight": number
}
Campos
key

string

Obrigatório. Uma chave de campo indexada para a pesquisa instantânea.
weight

number

Opcional. Ponderação para pontuações deste campo. O padrão é 1.0 se nada for especificado.

DisplaySpec

Especifica recursos para exibição, como o destaque de correspondências.

Representação JSON 
{
  "matchHighlightingCondition": enum (MatchHighlightingCondition)
}
Campos
matchHighlightingCondition

enum (MatchHighlightingCondition)

A condição em que o destaque de correspondência deve ocorrer.

MatchHighlightingCondition

Tipo enumerado que descreve em qual condição o destaque de correspondência deve ocorrer.

Tipos enumerados
MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED O comportamento do servidor é o mesmo de MATCH_HIGHLIGHTING_DISABLED.
MATCH_HIGHLIGHTING_DISABLED Desativa o destaque de correspondências em todos os documentos.
MATCH_HIGHLIGHTING_ENABLED Ativa o destaque de correspondências em todos os documentos.

CrowdingSpec

Especificação para aglomeração. O recolhimento melhora a diversidade dos resultados da pesquisa ao limitar o número de resultados que compartilham o mesmo valor de campo. Por exemplo, o recolhimento no campo "cor" com um maxCount de 3 e o modo DROP_CROWDED_RESULTS retornam no máximo três resultados com a mesma cor em todas as páginas.

Representação JSON 
{
  "field": string,
  "maxCount": integer,
  "mode": enum (Mode)
}
Campos
field

string

O campo a ser usado para aglomeração. Os documentos podem ser lotados por um campo no objeto Document. O campo de aglomeração diferencia maiúsculas de minúsculas.
maxCount

integer

O número máximo de documentos a serem mantidos por valor do campo. Quando há pelo menos maxCount resultados anteriores que contêm o mesmo valor para o campo especificado (de acordo com a ordem especificada em orderBy), os resultados posteriores com o mesmo valor são "descartados". Se não for especificado, o valor padrão será 1.
mode

enum (Mode)

Modo a ser usado para documentos que estão amontoados.

Modo

Enumeração que descreve o modo a ser usado para documentos que estão muito próximos. Eles podem ser descartados ou rebaixados para as páginas posteriores.

Tipos enumerados
MODE_UNSPECIFIED Modo de aglomeração não especificado. Nesse caso, o comportamento do servidor é Mode.DROP_CROWDED_RESULTS por padrão.
DROP_CROWDED_RESULTS Remova resultados com muita gente.
DEMOTE_CROWDED_RESULTS_TO_END Rebaixar resultados lotados para as páginas posteriores.

SessionSpec

Especificação da sessão.

Representação JSON 
{
  "queryId": string,
  "searchResultPersistenceCount": integer
}
Campos
queryId

string

Se definido, o resultado da pesquisa será armazenado na "rodada" especificada por esse ID de consulta.

Exemplo: digamos que a sessão seja assim: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" queryId: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" queryId: ".../questions/zzz" } } }

O usuário pode chamar a API /search com uma solicitação como esta:

session: ".../sessions/xxx" sessionSpec { queryId: ".../questions/zzz" }

Em seguida, a API armazena o resultado da pesquisa, associado à última interação. O resultado da pesquisa armazenado pode ser usado por uma chamada de API /answer subsequente (com o ID da sessão e o ID da consulta especificados). Também é possível chamar /search e /answer em paralelo com o mesmo ID de sessão e ID de consulta.
searchResultPersistenceCount

integer

O número de principais resultados da pesquisa a serem mantidos. Os resultados da pesquisa persistentes podem ser usados na próxima chamada de API /answer.

Esse campo é semelhante ao campo summaryResultCount em SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count.

No máximo, 10 resultados para o modo de documentos ou 50 para o modo de partes.

RelevanceThreshold

O limite de relevância dos resultados da pesquisa. Quanto maior for o limite de relevância, mais resultados relevantes serão mostrados e menos resultados serão retornados.

Tipos enumerados
RELEVANCE_THRESHOLD_UNSPECIFIED Valor padrão. Nesse caso, o comportamento do servidor volta ao limite definido pelo Google.
LOWEST Limite de relevância mais baixo.
LOW Limite de relevância baixa.
MEDIUM Limite de relevância média.
HIGH Limite de alta relevância.

RelevanceFilterSpec

Especificação de filtragem de relevância.

Representação JSON 
{
  "keywordSearchThreshold": {
    object (RelevanceThresholdSpec)
  },
  "semanticSearchThreshold": {
    object (RelevanceThresholdSpec)
  }
}
Campos
keywordSearchThreshold

object (RelevanceThresholdSpec)

Opcional. Especificação do limite de filtragem de relevância para pesquisa de palavras-chave.
semanticSearchThreshold

object (RelevanceThresholdSpec)

Opcional. Especificação do limite de filtragem de relevância para pesquisa semântica.

RelevanceThresholdSpec

Especificação para filtragem de relevância em uma subpesquisa específica.

Representação JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "relevanceThreshold": enum (RelevanceThreshold),
  "semanticRelevanceThreshold": number
  // End of mutually exclusive fields.
}
Campos
Configura como o limite de relevância é determinado. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
relevanceThreshold

enum (RelevanceThreshold)

Limite de relevância predefinido para a subpesquisa.
semanticRelevanceThreshold

number

Limite de relevância personalizado para a subpesquisa. O valor precisa estar entre [0,0, 1,0].
Fim dos campos mutuamente exclusivos.

RelevanceScoreSpec

A especificação para retornar a pontuação de relevância do documento.

Representação JSON 
{
  "returnRelevanceScore": boolean
}
Campos
returnRelevanceScore

boolean

Opcional. Define se o score de relevância será retornado para os resultados da pesquisa. Quanto maior a pontuação, mais relevante é o documento para a consulta.

SearchAddonSpec

O SearchAddonSpec é usado para desativar complementos de pesquisa de acordo com o novo modelo de reprecificação. Por padrão, se o SearchAddonSpec não for especificado, vamos considerar que o cliente quer ativar os complementos sempre que possível.

Representação JSON 
{
  "disableSemanticAddOn": boolean,
  "disableKpiPersonalizationAddOn": boolean,
  "disableGenerativeAnswerAddOn": boolean
}
Campos
disableSemanticAddOn

boolean

Opcional. Se for verdadeiro, o complemento semântico será desativado. O complemento semântico inclui incorporações e jetstream.
disableKpiPersonalizationAddOn

boolean

Opcional. Se for "true", desativa a nova classificação e a personalização de eventos para otimizar os KPIs e personalizar os resultados.
disableGenerativeAnswerAddOn

boolean

Opcional. Se for verdadeiro, o complemento de respostas generativas será desativado. O complemento de respostas generativas inclui linguagem natural para filtros e respostas simples.

CustomRankingParams

Parâmetros de configuração para o recurso de classificação personalizada.

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

string

Opcional. Uma lista de expressões de classificação (consulte rankingExpression para a documentação de sintaxe) a serem avaliadas. Os resultados da avaliação serão retornados no campo SearchResponse.SearchResult.rank_signals.precomputed_expression_values.

QuerySetSpec

Descreve a especificação do conjunto de consultas.

Representação JSON 
{
  "sampleQuerySet": string
}
Campos
sampleQuerySet

string

Opcional. O nome completo do recurso SampleQuerySet usado para a avaliação, no formato projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}.

QualityMetrics

Descreve as métricas produzidas pela avaliação.

Representação JSON 
{
  "docRecall": {
    object (TopkMetrics)
  },
  "docPrecision": {
    object (TopkMetrics)
  },
  "docNdcg": {
    object (TopkMetrics)
  },
  "pageRecall": {
    object (TopkMetrics)
  },
  "pageNdcg": {
    object (TopkMetrics)
  }
}
Campos
docRecall

object (TopkMetrics)

Recall por documento, em vários níveis de corte top-k.

O recall é a fração de documentos relevantes recuperados em relação a todos os documentos relevantes.

Exemplo (top-5): * Para um único SampleQuery, se 3 de 5 documentos relevantes forem recuperados no top-5, recall@5 = 3/5 = 0,6
docPrecision

object (TopkMetrics)

Precisão por documento, em vários níveis de corte de top-k.

A precisão é a fração de documentos recuperados que são relevantes.

Exemplo (top-5): * Para um único SampleQuery, se 4 dos 5 documentos recuperados no top-5 forem relevantes, precision@5 = 4/5 = 0,8
docNdcg

object (TopkMetrics)

Ganho cumulativo descontado normalizado (NDCG, na sigla em inglês) por documento, em vários níveis de corte k superior.

O NDCG mede a qualidade da classificação, mais relevância aos resultados principais.

Exemplo (top-3): suponha SampleQuery com três documentos recuperados (D1, D2, D3) e julgamentos de relevância binária (1 para relevante, 0 para não relevante):

Recuperado: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)]

Calcule o NDCG@3 para cada SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1,13 * DCG@3 ideal: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1,63 * NDCG@3: 1,13/1,63 = 0,693
pageRecall

object (TopkMetrics)

Recall por página, em vários níveis de corte top-k.

O recall é a fração de páginas relevantes recuperadas em relação a todas as páginas relevantes.

Exemplo (top-5): * Para um único SampleQuery, se 3 de 5 páginas relevantes forem recuperadas no top-5, recall@5 = 3/5 = 0,6
pageNdcg

object (TopkMetrics)

Ganho cumulativo descontado normalizado (NDCG) por página, em vários níveis de corte top-k.

O NDCG mede a qualidade da classificação, mais relevância aos resultados principais.

Exemplo (top-3): suponha SampleQuery com três páginas recuperadas (P1, P2, P3) e julgamentos de relevância binária (1 para relevante, 0 para não relevante):

Recuperado: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)]

Calcule o NDCG@3 para SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1,13 * DCG@3 ideal: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1,63 * NDCG@3: 1,13/1,63 = 0,693

TopkMetrics

Armazena os valores de métrica em níveis top-k específicos.

Representação JSON 
{
  "top1": number,
  "top3": number,
  "top5": number,
  "top10": number
}
Campos
top1

number

O valor do top 1.
top3

number

O valor do top-3.
top5

number

O valor do top 5.
top10

number

O valor dos 10 principais.

Estado

Descreve o estado de uma avaliação.

Tipos enumerados
STATE_UNSPECIFIED A avaliação não foi especificada.
PENDING O serviço está se preparando para executar a avaliação.
RUNNING A avaliação está em andamento.
SUCCEEDED A avaliação foi concluída.
FAILED A avaliação falhou.

Métodos

create

 Cria uma Evaluation.

get

 Recebe um Evaluation.

list

 Recebe uma lista de Evaluations.

listResults

 Recebe uma lista de resultados para um determinado Evaluation.