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}.

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

Preenchido apenas 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)
  },

  // 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 da pesquisa. search_spec pode ser apenas de um dos tipos a seguir:
searchRequest

object (SearchRequest)

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

Somente os seguintes campos em "SearchRequest" são aceitos. Se outros campos forem fornecidos, um erro "UNSUPPORTED" será retornado:

ImageQuery

Especifica a entrada da 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 pode ser apenas de um dos tipos a seguir:
imageBytes

string

Bytes de imagem codificados em Base64. Formatos de imagem compatíveis: JPEG, PNG e BMP.

FacetSpec

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

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 o [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 neste 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 vai retornar por padrão apenas documentos "Red" nos resultados da pesquisa, além de "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ê queira que o aspecto de classificação sempre seja retornado na resposta, mas não necessariamente que ele seja exibido na parte superior. Nesse caso, defina "enableDynamicPosition" como "true" para que a posição do aspecto 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 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 aceitas 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 facetas com valores numéricos. Não pode ser definido para facetas 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 "category" tenha três valores: "Action > 2022", "Action > 2021" e "Sci-Fi > 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 "category" tenha três valores: "Action > 2022", "Action > 2021" e "Sci-Fi > 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 "category" tenha três valores: "Action > 2022", "Action > 2021" e "Sci-Fi > 2022". Se o valor "contém" for definido 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, será 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 
{

  // 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 será infinito negativo.

Caso contrário, um erro INVALID_ARGUMENT será retornado. min pode ser apenas de um dos tipos a seguir:
minimum

number

Limite inferior inclusivo.
exclusiveMinimum

number

Limite inferior exclusivo.

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

Esse campo não pode ser menor que o valor mínimo. Caso contrário, um erro INVALID_ARGUMENT será retornado. max pode ser apenas de um dos tipos a seguir:
maximum

number

Limite superior inclusivo.
exclusiveMaximum

number

Limite superior exclusivo.

QueryExpansionSpec

Especificação para determinar em quais condições a expansão da 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 esse 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

Enumeração que descreve em qual condição a expansão da consulta deve ocorrer.

Tipos enumerados
CONDITION_UNSPECIFIED Condição de expansão de consulta não especificada. Nesse caso, o comportamento padrão do servidor é Condition.DISABLED.
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

Enumeração 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 padrão do servidor é Mode.AUTO.
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 compreensão de linguagem natural para 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 na localização, em que filtros de geolocalização são detectados em consultas de pesquisa em linguagem natural. Só é válido quando "FilterExtractionCondition" está definido como ENABLED.

Se esse campo for definido, ele vai substituir os nomes de campo definidos em ServingConfig.geo_search_query_detection_field_names.
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 armazenamentos de dados, o comportamento padrão é SOFT_BOOST. Os filtros com base em local são sempre aplicados como filtros rígidos, e a configuração SOFT_BOOST não os afeta. Esse campo só é usado se [SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition][] 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ões serão qualificados para extração de filtro de linguagem natural. Observação: para pesquisa em vários armazenamentos 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

Enumeração 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 nos resultados. Os resultados que não passarem nos 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 posições mais altas no conjunto de resultados.

SearchAsYouTypeSpec

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

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

enum (Condition)

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

Condição

Enumeração 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).

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

Enumeração 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 que 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.

SessionSpec

Especificação da sessão.

No momento, o recurso de pesquisa com várias interações está na fase de GA particular. Use a versão v1alpha ou v1beta antes de lançarmos esse recurso para disponibilidade geral pública ou peça a inclusão na lista de permissões para a equipe de suporte do Google.

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: suponha 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 dos 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 o limite de relevância, mais resultados relevantes são mostrados e menos resultados são retornados.

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

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 a pontuação de relevância será retornada 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 "true", o complemento semântico será desativado. O complemento semântico inclui embeddings e jetstream.
disableKpiPersonalizationAddOn

boolean

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

boolean

Opcional. Se for "true", o complemento de respostas generativas será desativado. O complemento 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 na 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 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.

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 de primeiro nível.
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.