REST Resource: projects.locations.evaluations

Recurso: avaliação

Uma avaliação é uma única execução (ou execução) de um processo de avaliação. 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}.

Este campo tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres.
evaluationSpec

object (EvaluationSpec)

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

object (QualityMetrics)

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

Apenas 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. Apenas preenchido quando o estado da avaliação é FAILED.
createTime

string (Timestamp format)

Apenas saída. Data/hora de criação do Evaluation.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". 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. Indicação de tempo em que a tarefa Evaluation foi concluída.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". 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 dos erros encontrados durante o processamento do pedido.

EvaluationSpec

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

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

  // Union field search_spec can be only one of the following:
  "searchRequest": {
    object (SearchRequest)
  }
  // End of list of possible types for union field search_spec.
}
Campos
querySetSpec

object (QuerySetSpec)

Opcional. A especificação do conjunto de consultas.
Campo de união search_spec. A especificação de pesquisa. search_spec só pode ser uma das seguintes opções:
searchRequest

object (SearchRequest)

Obrigatório. O pedido de pesquisa usado para realizar a avaliação.

Apenas são suportados os seguintes campos em SearchRequest. Se forem fornecidos outros campos, é devolvido um erro UNSUPPORTED:

SearchRequest

Mensagem de pedido para o método SearchService.Search.

Representação JSON 
{
  "servingConfig": string,
  "branch": string,
  "query": string,
  "imageQuery": {
    object (ImageQuery)
  },
  "pageSize": integer,
  "pageToken": string,
  "offset": integer,
  "oneBoxPageSize": integer,
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ],
  "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)
  },
  "session": string,
  "sessionSpec": {
    object (SessionSpec)
  },
  "relevanceThreshold": enum (RelevanceThreshold),
  "personalizationSpec": {
    object (PersonalizationSpec)
  },
  "relevanceScoreSpec": {
    object (RelevanceScoreSpec)
  },
  "searchAddonSpec": {
    object (SearchAddonSpec)
  }
}
Campos
servingConfig

string

Obrigatório. O nome do recurso da configuração de publicação de anúncios de 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. Este campo é usado para identificar o nome da configuração de publicaçã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 do ramo ou deixe este campo vazio para pesquisar documentos no ramo predefinido.
query

string

Consulta de pesquisa não processada.
imageQuery

object (ImageQuery)

Consulta de imagem RAW.
pageSize

integer

Número máximo de Documents a devolver. O valor máximo permitido depende do tipo de dados. Os valores acima do valor máximo são convertidos para o valor máximo.

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

Se este campo for negativo, é devolvido um INVALID_ARGUMENT.
pageToken

string

Um token de página recebido de uma chamada SearchService.Search anterior. Faculte este valor para obter a página seguinte.

Quando paginar, todos os outros parâmetros fornecidos a SearchService.Search têm de corresponder à chamada que forneceu o token da página. Caso contrário, é devolvido um erro INVALID_ARGUMENT.
offset

integer

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

Se este campo for negativo, é devolvido um INVALID_ARGUMENT.

Um desvio grande pode ser limitado a um limite razoável.
oneBoxPageSize

integer

O número máximo de resultados a devolver para o OneBox. Isto aplica-se a cada tipo de OneBox individualmente. O número predefinido é 10.
dataStoreSpecs[]

object (DataStoreSpec)

Especificações que definem os DataStores específicos a serem pesquisados, juntamente com as configurações desses repositórios de dados. Isto só é considerado para Engines com várias lojas de dados. Para motores com um único armazenamento de dados, devem ser usadas as especificações diretamente abaixo de SearchRequest.
filter

string

A sintaxe do filtro consiste numa linguagem de expressão para criar um predicado a partir de um ou mais campos dos documentos que estão a ser filtrados. A expressão de filtro é sensível a maiúsculas e minúsculas.

Se este campo não for reconhecível, é devolvido um INVALID_ARGUMENT.

A filtragem na Vertex AI Search é feita através do mapeamento da chave do filtro do lado esquerdo para uma propriedade de chave definida no back-end da Vertex AI Search. Este mapeamento é definido pelo cliente no respetivo esquema. Por exemplo, um cliente de multimédia pode ter um campo "name" no respetivo esquema. Neste caso, o filtro teria o seguinte aspeto: filter --> name:'ANY("king kong")'

Para mais informações sobre a filtragem, incluindo a sintaxe e os operadores de filtro, consulte o artigo Filtrar
canonicalFilter

string

O filtro predefinido que é aplicado quando um utilizador faz uma pesquisa sem selecionar filtros na página de pesquisa.

O filtro aplicado a cada pedido de pesquisa quando é necessário um melhoramento da qualidade, como a expansão de consultas. No caso de uma consulta não ter uma quantidade suficiente de resultados, este filtro é usado para determinar se o fluxo de expansão de consultas deve ou não ser ativado. O filtro original continua a ser usado para a pesquisa expandida da consulta. Este campo é vivamente recomendado para alcançar uma elevada qualidade de pesquisa.

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

string

A ordem pela qual os documentos são devolvidos. Os documentos podem ser ordenados por um campo num objeto Document. Deixe-o não definido se a ordenação for por relevância. A expressão orderBy é sensível a maiúsculas e minúsculas.

Para mais informações sobre a ordenação dos resultados da pesquisa de Websites, consulte o artigo Ordene os resultados da pesquisa na Web. Para mais informações sobre a ordenação dos resultados da pesquisa de cuidados de saúde, consulte o artigo Ordene os resultados da pesquisa de cuidados de saúde. Se este campo não for reconhecível, é devolvido um INVALID_ARGUMENT.
userInfo

object (UserInfo)

Informações sobre o utilizador final. Altamente recomendado para estatísticas e personalização. UserInfo.user_agent é usado para deduzir deviceType para estatísticas.
languageCode

string

O código de idioma BCP-47, como "en-US" ou "sr-Latn". Para mais informações, consulte o artigo Campos padrão. Este campo ajuda a interpretar melhor a consulta. Se não for especificado um valor, o código do idioma da consulta é detetado automaticamente, o que pode não ser preciso.
regionCode

string

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

object (FacetSpec)

Especificações de facetas para a pesquisa com filtros. Se estiver vazio, não são devolvidas facetas.

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

object (BoostSpec)

Especificação de aumento para aumentar determinados documentos. Para mais informações sobre o aumento, consulte o artigo Aumentar
params

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

Parâmetros de pesquisa adicionais.

Para a pesquisa de Websites públicos apenas, os valores suportados são:

  • user_country_code: string. Predefinição vazia. Se for definido como não vazio, os resultados são restritos ou melhorados com base na localização fornecida. Por exemplo, user_country_code: "au"

Para ver os códigos disponíveis, consulte Códigos dos países

  • searchType: duplo. Predefinição vazia. Ativa a pesquisa de conteúdo que não seja de páginas Web, consoante o valor. O único valor não predefinido válido é 1, que ativa a pesquisa de imagens. Por exemplo, searchType: 1
queryExpansionSpec

object (QueryExpansionSpec)

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

object (SpellCorrectionSpec)

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

string

Um identificador exclusivo para acompanhar os visitantes. Por exemplo, isto pode ser implementado com um cookie HTTP, que deve ser capaz de identificar de forma exclusiva um visitante num único dispositivo. Este identificador exclusivo não deve ser alterado se o visitante iniciar ou terminar sessão no Website.

Este campo NÃO deve ter um valor fixo, como unknown_visitor.

Este deve ser o mesmo identificador que UserEvent.user_pseudo_id e CompleteQueryRequest.user_pseudo_id

O campo tem de ser uma string codificada em UTF-8 com um limite de 128 carateres. Caso contrário, é devolvido um erro INVALID_ARGUMENT.
contentSearchSpec

object (ContentSearchSpec)

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

object (EmbeddingSpec)

Usa a incorporação fornecida para fazer uma obtenção semântica adicional de documentos. A obtenção baseia-se no produto escalar de SearchRequest.EmbeddingSpec.EmbeddingVector.vector e na incorporação de documentos fornecida em SearchRequest.EmbeddingSpec.EmbeddingVector.field_path.

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

string

Opcional. A expressão de classificação controla a classificação personalizada nos documentos de obtenção. Esta opção substitui ServingConfig.ranking_expression. A sintaxe e as funcionalidades suportadas dependem do valor de rankingExpressionBackend. Se rankingExpressionBackend não for fornecido, a predefinição é RANK_BY_EMBEDDING.

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

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

Funções suportadas:

  • 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 incorporação de documentos usado com o vetor de incorporação de consultas.
  • dotProduct: função de incorporação entre embedding_field_path e o vetor de incorporação de consultas.

Exemplo de expressão de classificação:

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

Se rankingExpressionBackend estiver definido como RANK_BY_FORMULA, são suportados os seguintes tipos de expressões (e combinações destes encadeados com operadores + ou *):

  • double
  • signal
  • log(signal)
  • exp(signal)
  • rr(signal, double > 0) -- transformação de classificação recíproca com o segundo argumento a ser uma constante do denominador.
  • isNan(signal) -- devolve 0 se o sinal for NaN e 1 caso contrário.
  • fillNan(signal1, signal2 | double) -- se signal1 for NaN, devolve signal2 | double; caso contrário, devolve signal1.

Seguem-se alguns exemplos de fórmulas de classificação que usam os tipos de expressões de classificação suportados:

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

Os seguintes sinais são suportados:

  • semanticSimilarityScore: ajuste de semelhança semântica calculado através das incorporações geradas por um modelo proprietário da Google. Esta pontuação determina a semelhança semântica entre uma consulta de pesquisa e um documento.
  • keywordSimilarityScore: o ajuste de correspondência de palavras-chave usa a função de classificação Best Match 25 (BM25). Esta pontuação é calculada através de um modelo probabilístico para estimar a probabilidade de um documento ser relevante para uma determinada consulta.
  • relevanceScore: ajuste da relevância semântica que usa um modelo proprietário da Google para determinar o significado e a intenção por detrás da consulta de um utilizador no contexto do conteúdo dos documentos.
  • pctrRank: ajuste da taxa de conversão prevista como utilização de classificação. A taxa de cliques prevista (pCTR) é usada para avaliar a relevância e a atratividade de um resultado da pesquisa na perspetiva do utilizador. Uma pCTR mais elevada sugere que o resultado tem maior probabilidade de satisfazer a consulta e a intenção do utilizador, o que o torna um sinal valioso para a classificação.
  • freshnessRank: ajuste de atualização como classificação
  • documentAge: o tempo em horas decorrido desde a última atualização do documento, um número de vírgula flutuante (por exemplo, 0,25 significa 15 minutos).
  • topicalityRank: ajuste da relevância como classificação. Usa um modelo proprietário da Google para determinar a sobreposição baseada em palavras-chave entre a consulta e o documento.
  • baseRank: a classificação predefinida do resultado
rankingExpressionBackend

enum (RankingExpressionBackend)

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

map (key: string, value: string)

As etiquetas de utilizador aplicadas a um recurso têm de cumprir os seguintes requisitos:

  • Cada recurso pode ter várias etiquetas, até um máximo de 64.
  • Cada etiqueta tem de ser um par chave-valor.
  • As chaves têm um comprimento mínimo de 1 carater e um comprimento máximo de 63 carateres, e não podem estar vazias. Os valores podem estar vazios e ter um comprimento máximo de 63 carateres.
  • As chaves e os valores só podem conter letras minúsculas, carateres numéricos, sublinhados e travessões. Todos os carateres têm de usar a codificação UTF-8, e são permitidos carateres internacionais.
  • A parte da chave de uma etiqueta tem de ser exclusiva. No entanto, pode usar a mesma chave com vários recursos.
  • As chaves têm de começar com uma letra minúscula ou um caráter internacional.

Consulte o documento do Google Cloud para ver mais detalhes.
naturalLanguageQueryUnderstandingSpec

object (NaturalLanguageQueryUnderstandingSpec)

Opcional. Configuração para capacidades de compreensão de consultas de linguagem natural, como a extração de filtros de campos estruturados da consulta. Consulte esta documentação para mais informações. Se naturalLanguageQueryUnderstandingSpec não for especificado, não é feita nenhuma compreensão adicional de consultas de linguagem natural.
searchAsYouTypeSpec

object (SearchAsYouTypeSpec)

Configuração de pesquisa à medida que escreve. Apenas suportado para a vertical IndustryVertical.MEDIA.
displaySpec

object (DisplaySpec)

Opcional. Configuração para a funcionalidade de apresentação, como o realce de correspondências nos resultados da pesquisa.
session

string

O nome do recurso da sessão. Opcional.

A sessão permite que os utilizadores façam chamadas API de várias interações/pesquisa ou coordenação entre chamadas API de pesquisa e chamadas API de resposta.

Exemplo n.º 1 (várias interações/chamadas da API /search): 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. Ou seja, se a primeira consulta for "Como se saiu a Alphabet em 2022?" e a consulta atual for "E em 2023?", a consulta atual vai ser interpretada como "Qual foi o desempenho da Alphabet em 2023?".

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

A funcionalidade de pesquisa com várias interações está atualmente na fase de GA privada. Use a versão v1alpha ou v1beta antes de lançarmos esta funcionalidade para a disponibilidade geral pública. Em alternativa, peça a inclusão na lista de autorizações através da equipa de apoio técnico da Google.
sessionSpec

object (SessionSpec)

Especificação da sessão.

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

enum (RelevanceThreshold)

O limite de relevância dos resultados da pesquisa.

Usar o limite definido pela Google, tirando partido de um equilíbrio entre a precisão e a capacidade de memorização para apresentar resultados altamente precisos e uma cobertura abrangente de informações relevantes.

Esta funcionalidade não é compatível com a pesquisa de cuidados de saúde.
personalizationSpec

object (PersonalizationSpec)

A especificação para personalização.

Tenha em atenção que, se ServingConfig.personalization_spec e SearchRequest.personalization_spec estiverem definidos, SearchRequest.personalization_spec substitui ServingConfig.personalization_spec.
relevanceScoreSpec

object (RelevanceScoreSpec)

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

object (SearchAddonSpec)

Opcional. SearchAddonSpec é usado para desativar suplementos para a pesquisa de acordo com o novo modelo de reprecificação. Este campo só é suportado para pedidos de pesquisa.

ImageQuery

Especifica a entrada de consulta de imagem.

Representação JSON 
{

  // Union field image can be only one of the following:
  "imageBytes": string
  // End of list of possible types for union field image.
}
Campos

Campo de união image.

image só pode ser uma das seguintes opções:
imageBytes

string

Bytes de imagem codificados em Base64. Formatos de imagem suportados: JPEG, PNG e BMP.

DataStoreSpec

Uma struct para definir arquivos de dados a filtrar numa chamada de pesquisa e configurações para esses arquivos de dados. Caso contrário, é devolvido um erro INVALID_ARGUMENT.

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

string

Obrigatório. Nome completo do recurso de DataStore, como projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. O caminho tem de incluir o número do projeto. O ID do projeto não é suportado para este campo.
filter

string

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

object (BoostSpec)

Opcional. Especificação de aumento para aumentar determinados documentos. Para mais informações sobre o aumento, consulte o artigo Aumentar
customSearchOperators

string

Opcional. Operadores de pesquisa personalizados que, se especificados, são usados para filtrar os resultados das bases de dados de dados do espaço de trabalho. Para mais informações sobre os operadores de pesquisa personalizados, consulte SearchOperators.

BoostSpec

Especificação de aumento para aumentar determinados documentos.

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

object (ConditionBoostSpec)

Especificações do aumento de condição. Se um documento corresponder a várias condições nas especificações, as pontuações de aumento destas especificações são todas aplicadas e combinadas de forma não linear. O número máximo de especificações é 20.

ConditionBoostSpec

O aumento aplica-se 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 aumento. A sintaxe e os campos suportados são os mesmos que os de uma expressão de filtro. Consulte SearchRequest.filter para ver a sintaxe detalhada e as limitações.

Exemplos:

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

number

Intensidade do aumento da condição, que deve estar no intervalo [-1, 1]. Um aumento negativo significa uma despromoção. A predefinição é 0,0.

Se definir o valor como 1,0, o documento recebe uma grande promoção. No entanto, não significa necessariamente que o documento otimizado seja sempre o resultado principal, nem que outros documentos sejam excluídos. Os resultados podem continuar a ser apresentados mesmo quando nenhum deles corresponde à condição. Além disso, os resultados significativamente mais relevantes para a consulta de pesquisa podem continuar a superar os seus documentos muito favorecidos, mas irrelevantes.

Se definir o valor como -1,0, o documento é significativamente despromovido. No entanto, os resultados profundamente relevantes podem continuar a ser apresentados. O documento vai ter uma batalha a montante para conseguir uma classificação razoavelmente elevada, mas não está completamente bloqueado.

A definição de 0,0 significa que não é aplicado nenhum aumento. A condição de aumento é ignorada. Apenas uma das combinações (condição, aumento) ou o boostControlSpec abaixo está definida. Se ambos estiverem definidos, o aumento global é ignorado e é aplicado o boostControlSpec mais detalhado.
boostControlSpec

object (BoostControlSpec)

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

BoostControlSpec

Especificação para a classificação personalizada com base no valor do atributo especificado pelo cliente. Oferece mais controlos para a classificação personalizada do que a combinação simples (condição, aumento) acima.

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

string

O nome do campo cujo valor vai ser usado para determinar o valor do aumento.
attributeType

enum (AttributeType)

O tipo de atributo a usar 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, ou seja, attributeValue = numerical_field_value. No entanto, no caso da atualidade, attributeValue = (time.now() - datetime_field_value).
interpolationType

enum (InterpolationType)

O tipo de interpolação a aplicar para ligar os pontos de controlo indicados abaixo.
controlPoints[]

object (ControlPoint)

Os pontos de controlo usados para definir a curva. A função monótona (definida através de interpolationType acima) passa pelos pontos de controlo indicados aqui.

AttributeType

O atributo(ou a função) ao qual a classificação personalizada deve ser aplicada.

Enumerações
ATTRIBUTE_TYPE_UNSPECIFIED AttributeType não especificado.
NUMERICAL O valor do campo numérico é usado para atualizar dinamicamente o valor do aumento. Neste caso, o attributeValue (o valor x) do ponto de controlo é o valor real do campo numérico para o qual o boostAmount é especificado.
FRESHNESS Para o exemplo de utilização da atualidade, o valor do atributo é a duração entre a hora atual e a data no campo de data/hora especificado. O valor tem de ser formatado como um valor XSD dayTimeDuration (um subconjunto restrito de um valor de duração ISO 8601). O padrão para isto é: [nD][T[nH][nM][nS]]. Por exemplo, 5D, 3DT12H30M, T24H.

InterpolationType

O tipo de interpolação a aplicar. A predefinição é linear (linear por partes).

Enumerações
INTERPOLATION_TYPE_UNSPECIFIED O tipo de interpolação não foi especificado. Neste caso, a predefinição é Linear.
LINEAR É aplicada a interpolação linear por partes.

ControlPoint

Os pontos de controlo usados para definir a curva. A curva definida através destes pontos de controlo só pode ser monotonicamente crescente ou decrescente(os 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 a atualização: o valor tem de ser formatado como um valor XSD dayTimeDuration (um subconjunto restrito de um valor de duração ISO 8601). O padrão para isto é: [nD][T[nH][nM][nS]].
boostAmount

number

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

FacetSpec

Uma especificação de faceta para realizar uma pesquisa com filtros.

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

Valores máximos de facetas devolvidos para esta faceta. Se não for especificado, a predefinição é 20. O valor máximo permitido é 300. Os valores acima de 300 são forçados a 300. Para a agregação na pesquisa de cuidados de saúde, quando [FacetKey.key] é "healthcare_aggregation_key", o limite é substituído internamente por 10 000, independentemente do valor definido aqui.

Se este campo for negativo, é devolvido um INVALID_ARGUMENT.
excludedFilterKeys[]

string

Lista de chaves a excluir ao usar a segmentação detalhada.

Por predefinição, FacetKey.key não é excluído do filtro, a menos que esteja listado neste campo.

A inclusão de uma chave de atributo neste campo permite que os respetivos valores apareçam como resultados de atributos, mesmo quando são filtrados dos resultados da pesquisa. A utilização deste campo não afeta os resultados da pesquisa devolvidos.

Por exemplo, suponhamos que existem 100 documentos com a faceta de cor "Vermelho" e 200 documentos com a faceta de cor "Azul". Uma consulta que contenha o filtro "color:ANY("Red")" e que tenha "color" como FacetKey.key devolve, por predefinição, apenas documentos "Red" nos resultados da pesquisa e também devolve "Red" com a contagem 100 como a única faceta de cor. Embora também estejam disponíveis documentos azuis, "Azul" não seria apresentado como um valor de faceta disponível.

Se "color" estiver listado em "excludedFilterKeys", a consulta devolve os valores da faceta "Red" com a contagem 100 e "Blue" com a contagem 200, porque a chave "color" está agora excluída do filtro. Uma vez que este campo não afeta os resultados da pesquisa, os resultados da pesquisa continuam a ser filtrados corretamente para devolver apenas documentos "Vermelho".

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

boolean

Ativa a posição dinâmica para esta faceta. Se estiver definido como verdadeiro, a posição deste aspeto entre todos os aspetos na resposta é determinada automaticamente. Se as facetas dinâmicas estiverem ativadas, são ordenadas em conjunto. Se for definido como falso, a posição deste aspeto na resposta é a mesma que no pedido, e é classificado antes dos aspetos com a posição dinâmica ativada e de todos os aspetos dinâmicos.

Por exemplo, pode querer sempre que a faceta de classificação seja devolvida na resposta, mas não é necessariamente para apresentar sempre a faceta de classificação na parte superior. Nesse caso, pode definir enableDynamicPosition como verdadeiro para que a posição do aspeto de classificação na resposta seja determinada automaticamente.

Outro exemplo, partindo do princípio de que tem as seguintes facetas no pedido:

  • "rating", enableDynamicPosition = true

  • "price", enableDynamicPosition = false

  • "brands", enableDynamicPosition = false

Além disso, tem facetas dinâmicas ativadas, o que gera uma faceta gender. Em seguida, a ordem final das facetas na resposta pode ser ("price", "brands", "rating", "gender") ou ("price", "brands", "gender", "rating"), dependendo da forma como a API ordena as facetas "gender" e "rating". No entanto, repare que "price" e "brands" estão sempre classificados na primeira e segunda posição, respetivamente, porque o enableDynamicPosition é falso.

FacetKey

Especifica como é calculado um aspeto.

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 facetas textuais e numéricas suportadas no objeto Document, sobre as quais os valores das facetas são calculados. A chave de faceta é sensível a maiúsculas e minúsculas.
intervals[]

object (Interval)

Defina apenas se os valores devem ser agrupados em intervalos. Tem de ser definido para facetas com valores numéricos. Não pode ser definido para uma faceta com valores de texto. O número máximo de intervalos é 30.
restrictedValues[]

string

Apenas recebe a faceta para os valores restritos especificados. Só é suportado em campos de texto. Por exemplo, suponhamos que "categoria" tem três valores: "Ação > 2022", "Ação > 2021" e "Ciência ficção > 2022". Se definir "restrictedValues" como "Action > 2022", a faceta "category" só contém "Action > 2022". Só é suportado em campos de texto. O máximo é 10.
prefixes[]

string

Apenas recebe valores de facetas que começam com o prefixo de string fornecido. Por exemplo, suponhamos que "categoria" tem três valores: "Ação > 2022", "Ação > 2021" e "Ciência ficção > 2022". Se definir "prefixes" como "Action", o detalhe "category" contém apenas "Action > 2022" e "Action > 2021". Só é suportado em campos de texto. O máximo é 10.
contains[]

string

Obtenha apenas valores de facetas que contenham as strings indicadas. Por exemplo, suponhamos que "categoria" tem três valores: "Ação > 2022", "Ação > 2021" e "Ciência ficção > 2022". Se definir "contém" como "2022", a faceta "categoria" só contém "Ação > 2022" e "Ciência ficção > 2022". Só é suportado em campos de texto. O máximo é 10.
caseInsensitive

boolean

Verdadeiro para tornar as chaves de faceta insensíveis a maiúsculas e minúsculas quando obtém valores de facetas com prefixos ou contém; caso contrário, falso.
orderBy

string

A ordem pela qual os documentos são devolvidos.

Os valores permitidos são:

Se não estiver definido, os valores textuais são ordenados por ordem natural; os intervalos numéricos são ordenados pela ordem indicada por FacetSpec.FacetKey.intervals.

Intervalo

Um intervalo de vírgula flutuante.

Representação JSON 
{

  // Union field min can be only one of the following:
  "minimum": number,
  "exclusiveMinimum": number
  // End of list of possible types for union field min.

  // Union field max can be only one of the following:
  "maximum": number,
  "exclusiveMaximum": number
  // End of list of possible types for union field max.
}
Campos

Campo de união min. O limite inferior do intervalo. Se nenhum dos campos min estiver definido, o limite inferior é o infinito negativo.

Este campo não pode ser superior ao valor máximo. Caso contrário, é devolvido um erro INVALID_ARGUMENT. min só pode ser uma das seguintes opções:
minimum

number

Limite inferior inclusivo.
exclusiveMinimum

number

Limite inferior exclusivo.

Campo de união max. O limite superior do intervalo. Se nenhum dos campos max estiver definido, o limite superior é o infinito positivo.

Este campo não pode ser inferior ao valor mínimo. Caso contrário, é devolvido um erro INVALID_ARGUMENT. max só pode ser uma das seguintes opções:
maximum

number

Limite superior inclusivo.
exclusiveMaximum

number

Limite superior exclusivo.

QueryExpansionSpec

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

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

enum (Condition)

A condição em que a expansão de consultas deve ocorrer. Predefinição para 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 estão sempre na parte superior dos resultados da pesquisa, seguidos pelos resultados expandidos.

Condição

Enum que descreve em que condição deve ocorrer a expansão de consultas.

Enumerações
CONDITION_UNSPECIFIED Condição de expansão da consulta não especificada. Neste caso, o comportamento do servidor é predefinido para Condition.DISABLED.
DISABLED Expansão de consultas desativada. Apenas é usada a consulta de pesquisa exata, mesmo que SearchResponse.total_size seja zero.
AUTO Expansão automática de consultas criada pela API Search.

SpellCorrectionSpec

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

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

enum (Mode)

O modo no qual a correção ortográfica substitui a consulta de pesquisa original. A predefinição é Mode.AUTO.

Modo

Enum que descreve em que modo deve ocorrer a correção ortográfica.

Enumerações
MODE_UNSPECIFIED Modo de correção ortográfica não especificado. Neste caso, o comportamento do servidor é predefinido para Mode.AUTO.
SUGGESTION_ONLY A API Search tenta encontrar uma sugestão ortográfica. Se for encontrada uma sugestão, esta é colocada no SearchResponse.corrected_query. A sugestão ortográfica não é usada como consulta de pesquisa.
AUTO Correção ortográfica automática criada pela API Search. A pesquisa baseia-se na consulta corrigida, se for encontrada.

EmbeddingSpec

A especificação que usa o vetor de incorporação de consultas personalizado para fazer a obtenção semântica de documentos.

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

object (EmbeddingVector)

O vetor de incorporação usado para a obtenção. Limite de 1.

EmbeddingVector

Vetor de incorporação.

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

string

Incorporação do caminho do campo no esquema.
vector[]

number

Vetor de incorporação de consultas.

RankingExpressionBackend

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

Enumerações
RANKING_EXPRESSION_BACKEND_UNSPECIFIED Opção predefinida para valores não especificados/desconhecidos.
BYOE

Descontinuado: em alternativa, use RANK_BY_EMBEDDING. Classificação pelo modelo de incorporação personalizado, a forma predefinida de avaliar a expressão de classificação. Opção de enumeração antiga. Em alternativa, deve usar-se RANK_BY_EMBEDDING.
CLEARBOX

Descontinuado: em alternativa, use RANK_BY_FORMULA. Classificação por fórmula personalizada. Opção de enumeração antiga. Em alternativa, deve usar-se RANK_BY_FORMULA.
RANK_BY_EMBEDDING Classificação pelo modelo de incorporação personalizado, a forma predefinida de avaliar a expressão de classificação.
RANK_BY_FORMULA Classificação por fórmula personalizada.

NaturalLanguageQueryUnderstandingSpec

Especificação para ativar as capacidades de compreensão de linguagem natural para pedidos 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 filtros deve ocorrer. O comportamento do servidor é predefinido para DISABLED.
geoSearchQueryDetectionFieldNames[]

string

Nomes de campos usados para a filtragem baseada na localização, onde os filtros de geolocalização são detetados em consultas de pesquisa em linguagem natural. Só é válido quando FilterExtractionCondition está definido como ENABLED.

Se este campo estiver definido, substitui os nomes dos campos definidos em ServingConfig.geo_search_query_detection_field_names.
extractedFilterBehavior

enum (ExtractedFilterBehavior)

Opcional. Controla o comportamento da forma como os filtros extraídos são aplicados à pesquisa. O comportamento predefinido depende do pedido. Para a pesquisa estruturada de um único arquivo de dados, a predefinição é HARD_FILTER. Para a pesquisa em vários arquivos de dados, o comportamento predefinido é SOFT_BOOST. Os filtros baseados na localização são sempre aplicados como filtros rígidos, e a definição SOFT_BOOST não os afeta. Este campo só é usado se [SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition][] estiver definido como FilterExtractionCondition.ENABLED.
allowedFieldNames[]

string

Opcional. Lista de autorizações de campos que podem ser usados para a extração de filtros de linguagem natural. Por predefinição, se não for especificado, todos os campos indexáveis são elegíveis para a extração de filtros de linguagem natural (mas não é garantido que sejam usados). Se forem especificados campos em allowedFieldNames, apenas os campos que estejam marcados como indexáveis no esquema e especificados na lista de autorizações são elegíveis para a extração de filtros de linguagem natural. Nota: para a pesquisa em vários arquivos de dados, esta opção ainda não é suportada e será ignorada.

FilterExtractionCondition

Enum que descreve em que condição deve ocorrer a extração de filtros.

Enumerações
CONDITION_UNSPECIFIED O comportamento do servidor é predefinido para DISABLED.
DISABLED Desativa a extração de filtros de NL.
ENABLED Ativa a extração de filtros de NL.

ExtractedFilterBehavior

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

Enumerações
EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED vai usar o comportamento predefinido para os filtros extraídos. Para a pesquisa de um único arquivo de dados, a predefinição é aplicar como filtros rígidos. Para a pesquisa em vários arquivos de dados, a predefinição é aplicar como aumentos suaves.
HARD_FILTER Aplica todos os filtros extraídos como filtros rígidos nos resultados. Os resultados que não passarem nos filtros extraídos não são devolvidos no conjunto de resultados.
SOFT_BOOST Aplica todos os filtros extraídos como aumentos ligeiros. Os resultados que passam nos filtros são otimizados para classificações mais elevadas no conjunto de resultados.

SearchAsYouTypeSpec

Especificação para a pesquisa à medida que escreve em pedidos de pesquisa.

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

enum (Condition)

A condição em que a pesquisa à medida que escreve deve ocorrer. Predefinição para Condition.DISABLED.

Condição

Enum que descreve em que condição deve ocorrer a pesquisa à medida que escreve.

Enumerações
CONDITION_UNSPECIFIED O comportamento do servidor é predefinido para Condition.DISABLED.
DISABLED Desativa a pesquisa à medida que escreve.
ENABLED Ativa a pesquisa à medida que escreve.
AUTO Alternância automática entre os modos de pesquisa à medida que escreve e de pesquisa padrão, ideal para implementações de API única (por exemplo, eliminação de repetições).

DisplaySpec

Especifica funcionalidades para apresentação, como o realce de correspondências.

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

enum (MatchHighlightingCondition)

A condição em que o realce de correspondências deve ocorrer.

MatchHighlightingCondition

Enum que descreve em que condição deve ocorrer o realce de correspondências.

Enumerações
MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED O comportamento do servidor é o mesmo que MATCH_HIGHLIGHTING_DISABLED.
MATCH_HIGHLIGHTING_DISABLED Desativa o realce de correspondências em todos os documentos.
MATCH_HIGHLIGHTING_ENABLED Ativa o realce de correspondências em todos os documentos.

SessionSpec

Especificação da sessão.

A funcionalidade de pesquisa com várias interações está atualmente na fase de GA privada. Use a versão v1alpha ou v1beta antes de lançarmos esta funcionalidade para a disponibilidade geral pública. Em alternativa, peça a inclusão na lista de autorizações através da equipa de apoio técnico da Google.

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

string

Se estiver definido, o resultado da pesquisa é armazenado no "turno" especificado por este ID de consulta.

Exemplo: suponhamos que a sessão tem o seguinte aspeto: session { name: ".../sessions/xxx" turns { query { text: "O que é foo?" queryId: ".../questions/yyy" } answer: "Foo é ..." } turns { query { text: "E bar?" queryId: ".../questions/zzz" } } }

O utilizador pode chamar a API /search com um pedido como este:

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). Além disso, é possível chamar /search e /answer em paralelo com o mesmo ID da sessão e ID da consulta.
searchResultPersistenceCount

integer

O número de principais resultados da pesquisa a manter. Os resultados da pesquisa persistentes podem ser usados para a chamada da API /answer subsequente.

Este 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 fragmentos.

RelevanceThreshold

O limite de relevância dos resultados da pesquisa. Quanto mais elevado for o limite de relevância, mais resultados relevantes são apresentados e menor é o número de resultados devolvidos.

Enumerações
RELEVANCE_THRESHOLD_UNSPECIFIED Valor predefinido. Neste caso, o comportamento do servidor assume a predefinição do limite definido pela Google.
LOWEST Limite de relevância mais baixo.
LOW Limite de relevância baixo.
MEDIUM Requisito de relevância médio.
HIGH Limiar de relevância elevado.

RelevanceScoreSpec

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

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

boolean

Opcional. Se deve devolver a pontuação de relevância para os resultados da pesquisa. Quanto mais elevada for a pontuação, mais relevante é o documento para a consulta.

SearchAddonSpec

SearchAddonSpec é usado para desativar suplementos para a pesquisa de acordo com o novo modelo de reprecificação. Por predefinição, se o SearchAddonSpec não for especificado, consideramos que o cliente quer ativá-los sempre que aplicável.

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

boolean

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

boolean

Opcional. Se for verdadeiro, desativa a reclassificação e a personalização de eventos para otimizar os KPIs e personalizar os resultados.
disableGenerativeAnswerAddOn

boolean

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

QuerySetSpec

Descreve a especificação do conjunto de consultas.

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

string

Opcional. O nome completo do recurso do SampleQuerySet usado para a avaliação, no formato de 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)

Relembrar por documento, a vários níveis de limite superior k.

A capacidade de memorização é a fração de documentos relevantes obtidos em relação a todos os documentos relevantes.

Exemplo (5 principais): * Para um único SampleQuery, se 3 em 5 documentos relevantes forem obtidos nos 5 principais, recall@5 = 3/5 = 0,6
docPrecision

object (TopkMetrics)

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

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

Exemplo (5 principais): * Para um único SampleQuery, se 4 em 5 documentos obtidos nos 5 principais forem relevantes, precision@5 = 4/5 = 0,8
docNdcg

object (TopkMetrics)

Ganhos cumulativos com desconto normalizados (NDCG) por documento, a vários níveis de limite superior k.

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

Exemplo (3 principais): suponha que SampleQuery com três documentos obtidos (D1, D2, D3) e julgamentos de relevância binários (1 para relevante, 0 para não relevante):

Retrieved: [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)

Relembrar por página, a vários níveis de limite superior k.

A capacidade de memorização é a fração de páginas relevantes obtidas em todas as páginas relevantes.

Exemplo (5 principais): * Para uma única SampleQuery, se 3 de 5 páginas relevantes forem obtidas nos 5 principais, recall@5 = 3/5 = 0,6
pageNdcg

object (TopkMetrics)

Ganhos cumulativos com desconto normalizados (NDCG) por página, a vários níveis de limite superior k.

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

Exemplo (3 principais): suponhamos que SampleQuery tem três páginas obtidas (P1, P2 e P3) e julgamentos de relevância binários (1 para relevante, 0 para não relevante):

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

Calcular 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 das métricas em níveis top-k específicos.

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

number

O valor principal.
top3

number

O valor dos 3 principais.
top5

number

O valor dos 5 principais.
top10

number

O valor dos 10 principais.

Estado

Descreve o estado de uma avaliação.

Enumerações
STATE_UNSPECIFIED A avaliação não está especificada.
PENDING O serviço está a preparar-se para executar a avaliação.
RUNNING A avaliação está em curso.
SUCCEEDED A avaliação foi concluída com êxito.
FAILED A avaliação falhou.

Métodos

create

 Cria um Evaluation.

get

 Obtém um Evaluation.

list

 Obtém uma lista de Evaluations.

listResults

 Obtém uma lista de resultados para um determinado Evaluation.