REST Resource: projects.locations.evaluations

Recurso: Evaluation

Una evaluación es una única ejecución (o prueba) de un proceso de evaluación. Encapsula el estado de la evaluación y los datos resultantes.

Representación 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. Nombre completo del recurso Evaluation, con el formato projects/{project}/locations/{location}/evaluations/{evaluation}.

Este campo debe ser una cadena codificada en UTF-8 con un límite de 1024 caracteres.
evaluationSpec

object (EvaluationSpec)

Obligatorio. Especificación de la evaluación.
qualityMetrics

object (QualityMetrics)

Solo de salida. Las métricas producidas por la evaluación, promediadas en todos los SampleQuerys del SampleQuerySet.

Solo se rellena cuando el estado de la evaluación es SUCCEEDED.
state

enum (State)

Solo de salida. El estado de la evaluación.
error

object (Status)

Solo de salida. El error que se ha producido durante la evaluación. Solo se rellena cuando el estado de la evaluación es FAILED.
createTime

string (Timestamp format)

Solo de salida. Marca de tiempo de la creación de Evaluation.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Solo de salida. Marca de tiempo en la que se completó la Evaluation.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
errorSamples[]

object (Status)

Solo de salida. Una muestra de los errores detectados al procesar la solicitud.

EvaluationSpec

Describe la especificación de la evaluación.

Representación 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. Especificación del conjunto de consultas.
Campo de unión search_spec. Especificación de la búsqueda. search_spec solo puede ser una de estas dos opciones:
searchRequest

object (SearchRequest)

Obligatorio. La solicitud de búsqueda que se utiliza para realizar la evaluación.

Solo se admiten los siguientes campos de SearchRequest. Si se proporciona algún otro campo, se devolverá un error UNSUPPORTED:

ImageQuery

Especifica la entrada de consulta de imagen.

Representación 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ón image.

image solo puede ser una de estas dos opciones:
imageBytes

string

Bytes de imagen codificados en Base64. Formatos de imagen admitidos: JPEG, PNG y BMP.

FacetSpec

Especificación de una faceta para realizar una búsqueda por facetas.

Representación JSON 
{
  "facetKey": {
    object (FacetKey)
  },
  "limit": integer,
  "excludedFilterKeys": [
    string
  ],
  "enableDynamicPosition": boolean
}
Campos
facetKey

object (FacetKey)

Obligatorio. Especificación de la clave de la faceta.
limit

integer

Número máximo de valores de faceta que se devuelven para esta faceta. Si no se especifica, el valor predeterminado es 20. El valor máximo permitido es 300. Los valores superiores a 300 se convierten en 300. En el caso de la agregación en la búsqueda de asistencia sanitaria, cuando [FacetKey.key] sea "healthcare_aggregation_key", el límite se sustituirá por 10.000 internamente, independientemente del valor definido aquí.

Si este campo es negativo, se devuelve un error INVALID_ARGUMENT.
excludedFilterKeys[]

string

Lista de claves que se excluirán al crear facetas.

De forma predeterminada, FacetKey.key no se excluye del filtro a menos que se incluya en este campo.

Si se incluye una clave de faceta en este campo, sus valores podrán aparecer como resultados de faceta aunque se hayan excluido de los resultados de búsqueda. El uso de este campo no afecta a los resultados de búsqueda que se devuelven.

Por ejemplo, supongamos que hay 100 documentos con la faceta de color "Rojo" y 200 documentos con la faceta de color "Azul". Una consulta que contenga el filtro "color:ANY("Rojo")" y que tenga "color" como FacetKey.key devolvería de forma predeterminada solo los documentos "Rojo" en los resultados de búsqueda, así como "Rojo" con el recuento 100 como la única faceta de color. Aunque también hay documentos azules, "Azul" no se mostraría como un valor de faceta disponible.

Si "color" aparece en "excludedFilterKeys", la consulta devuelve los valores de la faceta "Rojo" con el recuento 100 y "Azul" con el recuento 200, ya que la clave "color" ahora está excluida del filtro. Como este campo no afecta a los resultados de búsqueda, estos se siguen filtrando correctamente para devolver solo los documentos "Rojo".

Se permiten un máximo de 100 valores. De lo contrario, se devuelve un error INVALID_ARGUMENT.
enableDynamicPosition

boolean

Habilita la posición dinámica de esta faceta. Si se define como true, la posición de esta faceta entre todas las facetas de la respuesta se determina automáticamente. Si las facetas dinámicas están habilitadas, se ordenan juntas. Si se asigna el valor "false", la posición de esta faceta en la respuesta es la misma que en la solicitud y se clasifica antes de las facetas con la posición dinámica habilitada y de todas las facetas dinámicas.

Por ejemplo, puede que siempre quiera que se devuelva la faceta de valoración en la respuesta, pero no es necesario que siempre se muestre en la parte superior. En ese caso, puedes asignar el valor true a enableDynamicPosition para que la posición de la faceta de valoración en la respuesta se determine automáticamente.

Otro ejemplo, suponiendo que tiene las siguientes facetas en la solicitud:

  • "rating", enableDynamicPosition = true

  • "price", enableDynamicPosition = false

  • "brands", enableDynamicPosition = false

También tiene habilitadas las facetas dinámicas, que generan una faceta gender. El orden final de las facetas en la respuesta puede ser ("price", "brands", "rating", "gender") o ("price", "brands", "gender", "rating"), en función de cómo ordene la API las facetas "gender" y "rating". Sin embargo, observa que "price" y "brands" siempre se clasifican en primer y segundo lugar porque su valor de enableDynamicPosition es false.

FacetKey

Especifica cómo se calcula una faceta.

Representación JSON 
{
  "key": string,
  "intervals": [
    {
      object (Interval)
    }
  ],
  "restrictedValues": [
    string
  ],
  "prefixes": [
    string
  ],
  "contains": [
    string
  ],
  "caseInsensitive": boolean,
  "orderBy": string
}
Campos
key

string

Obligatorio. Claves de faceta textuales y numéricas admitidas en el objeto Document, sobre las que se calculan los valores de faceta. La clave de la faceta distingue entre mayúsculas y minúsculas.
intervals[]

object (Interval)

Solo se debe definir si los valores se deben agrupar en intervalos. Se debe definir para las facetas con valores numéricos. No se debe definir para las facetas con valores de texto. El número máximo de intervalos es 30.
restrictedValues[]

string

Solo se obtiene la faceta de los valores restringidos proporcionados. Solo se admite en campos de texto. Por ejemplo, supongamos que "category" tiene tres valores: "Action > 2022", "Action > 2021" y "Sci-Fi > 2022". Si asigna el valor "Action> 2022 " a "restrictedValues", la faceta "category" solo contendrá "Action > 2022". Solo se admite en campos de texto. El máximo es 10.
prefixes[]

string

Solo se obtienen los valores de faceta que empiezan por el prefijo de cadena proporcionado. Por ejemplo, supongamos que "category" tiene tres valores: "Action > 2022", "Action > 2021" y "Sci-Fi > 2022". Si se asigna el valor "Action" a "prefixes", la faceta "category" solo contendrá "Action > 2022" y "Action > 2021". Solo se admite en campos de texto. El máximo es 10.
contains[]

string

Solo se obtienen los valores de faceta que contienen las cadenas proporcionadas. Por ejemplo, supongamos que "category" tiene tres valores: "Action > 2022", "Action > 2021" y "Sci-Fi > 2022". Si se asigna el valor "2022" a "contains", la faceta "category" solo contendrá "Action > 2022" y "Sci-Fi > 2022". Solo se admite en campos de texto. El máximo es 10.
caseInsensitive

boolean

True para que las claves de las facetas no distingan entre mayúsculas y minúsculas al obtener valores de facetas con prefijos o que contengan un texto; false en caso contrario.
orderBy

string

El orden en el que se devuelven los documentos.

Los valores permitidos son:

Si no se define, los valores de texto se ordenan de forma natural y los intervalos numéricos se ordenan según el orden que se indica en FacetSpec.FacetKey.intervals.

Intervalo

Un intervalo de punto flotante.

Representación 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ón min. Límite inferior del intervalo. Si no se define ninguno de los campos mínimos, el límite inferior es infinito negativo.

Este campo no debe ser mayor que el valor máximo. De lo contrario, se devolverá un error INVALID_ARGUMENT. min solo puede ser una de estas dos opciones:
minimum

number

Límite inferior inclusivo.
exclusiveMinimum

number

Límite inferior exclusivo.

Campo de unión max. Límite superior del intervalo. Si no se define ninguno de los campos máximos, el límite superior es infinito positivo.

Este campo no debe ser inferior al valor mínimo. De lo contrario, se devuelve un error INVALID_ARGUMENT. max solo puede ser una de estas dos opciones:
maximum

number

Límite superior inclusivo.
exclusiveMaximum

number

Límite superior exclusivo.

QueryExpansionSpec

Especificación para determinar en qué condiciones se debe producir la ampliación de la consulta.

Representación JSON 
{
  "condition": enum (Condition),
  "pinUnexpandedResults": boolean
}
Campos
condition

enum (Condition)

La condición en la que se debe producir la ampliación de la consulta. El valor predeterminado es Condition.DISABLED.
pinUnexpandedResults

boolean

Si se deben fijar los resultados sin expandir. Si este campo tiene el valor true, los productos sin desplegar siempre se mostrarán en la parte superior de los resultados de búsqueda, seguidos de los resultados desplegados.

Condición

Enumeración que describe en qué condiciones se debe producir la ampliación de la consulta.

Enumeraciones
CONDITION_UNSPECIFIED Condición de expansión de consulta no especificada. En este caso, el comportamiento del servidor es Condition.DISABLED de forma predeterminada.
DISABLED Se ha inhabilitado la ampliación de consultas. Solo se utiliza la consulta de búsqueda exacta, aunque SearchResponse.total_size sea cero.
AUTO Expansión automática de consultas creada por la API Search.

SpellCorrectionSpec

Especificación de la corrección ortográfica de la consulta.

Representación JSON 
{
  "mode": enum (Mode)
}
Campos
mode

enum (Mode)

El modo en el que la corrección ortográfica sustituye a la consulta de búsqueda original. El valor predeterminado es Mode.AUTO.

Modo

Enumeración que describe en qué modo se debe realizar la corrección ortográfica.

Enumeraciones
MODE_UNSPECIFIED Modo de corrección ortográfica no especificado. En este caso, el comportamiento del servidor es Mode.AUTO de forma predeterminada.
SUGGESTION_ONLY La API Search intenta encontrar una sugerencia ortográfica. Si se encuentra una sugerencia, se coloca en la SearchResponse.corrected_query. La sugerencia ortográfica no se usará como consulta de búsqueda.
AUTO Corrección ortográfica automática creada por la API Search. La búsqueda se basará en la consulta corregida, si se encuentra.

EmbeddingSpec

La especificación que usa un vector de incrustación de consulta personalizado para hacer una recuperación semántica de documentos.

Representación JSON 
{
  "embeddingVectors": [
    {
      object (EmbeddingVector)
    }
  ]
}
Campos
embeddingVectors[]

object (EmbeddingVector)

El vector de inserción que se ha usado para la recuperación. Límite: 1.

EmbeddingVector

Vector de inserción.

Representación JSON 
{
  "fieldPath": string,
  "vector": [
    number
  ]
}
Campos
fieldPath

string

Ruta de campo de inserción en el esquema.
vector[]

number

Vector de incrustación de la consulta.

RankingExpressionBackend

Backend que se va a usar para la evaluación de la expresión de clasificación.

Enumeraciones
RANKING_EXPRESSION_BACKEND_UNSPECIFIED Opción predeterminada para valores no especificados o desconocidos.
BYOE

Obsoleto: usa RANK_BY_EMBEDDING en su lugar. Clasificación por modelo de inserción personalizado, que es la forma predeterminada de evaluar la expresión de clasificación. Opción de enumación antigua. En su lugar, se debe usar RANK_BY_EMBEDDING.
CLEARBOX

Obsoleto: usa RANK_BY_FORMULA en su lugar. Clasificación por fórmula personalizada. Opción de enumación antigua. En su lugar, se debe usar RANK_BY_FORMULA.
RANK_BY_EMBEDDING Clasificación por modelo de inserción personalizado, que es la forma predeterminada de evaluar la expresión de clasificación.
RANK_BY_FORMULA Clasificación por fórmula personalizada.

NaturalLanguageQueryUnderstandingSpec

Especificación para habilitar las funciones de comprensión del lenguaje natural en las solicitudes de búsqueda.

Representación JSON 
{
  "filterExtractionCondition": enum (FilterExtractionCondition),
  "geoSearchQueryDetectionFieldNames": [
    string
  ],
  "extractedFilterBehavior": enum (ExtractedFilterBehavior),
  "allowedFieldNames": [
    string
  ]
}
Campos
filterExtractionCondition

enum (FilterExtractionCondition)

La condición en la que se debe producir la extracción del filtro. El comportamiento predeterminado del servidor es DISABLED.
geoSearchQueryDetectionFieldNames[]

string

Nombres de los campos que se usan para filtrar por ubicación, donde se detectan filtros de geolocalización en las consultas de búsqueda en lenguaje natural. Solo es válido cuando FilterExtractionCondition se define como ENABLED.

Si se define este campo, se anulan los nombres de campo definidos en ServingConfig.geo_search_query_detection_field_names.
extractedFilterBehavior

enum (ExtractedFilterBehavior)

Opcional. Controla el comportamiento de cómo se aplican los filtros extraídos a la búsqueda. El comportamiento predeterminado depende de la solicitud. En el caso de la búsqueda estructurada de un solo almacén de datos, el valor predeterminado es HARD_FILTER. En las búsquedas en varios almacenes de datos, el comportamiento predeterminado es SOFT_BOOST. Los filtros basados en la ubicación siempre se aplican como filtros estrictos, por lo que el ajuste SOFT_BOOST no les afectará. Este campo solo se usa si [SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition][] tiene el valor FilterExtractionCondition.ENABLED.
allowedFieldNames[]

string

Opcional. Lista de permitidos de campos que se pueden usar para la extracción de filtros de lenguaje natural. De forma predeterminada, si no se especifica, todos los campos indexables se pueden usar para extraer filtros de lenguaje natural (pero no se garantiza que se utilicen). Si se especifica algún campo en allowedFieldNames, solo los campos que estén marcados como indexables en el esquema y que se especifiquen en la lista de permitidos podrán extraerse mediante filtros de lenguaje natural. Nota: La búsqueda en varios almacenes de datos aún no se admite y se ignorará.

FilterExtractionCondition

Enumeración que describe en qué condición se debe producir la extracción del filtro.

Enumeraciones
CONDITION_UNSPECIFIED El comportamiento predeterminado del servidor es DISABLED.
DISABLED Inhabilita la extracción de filtros de lenguaje natural.
ENABLED Habilita la extracción de filtros de lenguaje natural.

ExtractedFilterBehavior

Enumeración que describe cómo se aplican los filtros extraídos a la búsqueda.

Enumeraciones
EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED usará el comportamiento predeterminado para los filtros extraídos. En el caso de las búsquedas en un solo almacén de datos, los filtros se aplican de forma predeterminada como filtros estrictos. En el caso de la búsqueda en varios almacenes de datos, se aplican como refuerzos parciales de forma predeterminada.
HARD_FILTER Aplica todos los filtros extraídos como filtros fijos en los resultados. Los resultados que no cumplan los filtros extraídos no se devolverán en el conjunto de resultados.
SOFT_BOOST Aplica todos los filtros extraídos como aumentos suaves. Los resultados que cumplan los filtros se impulsarán a puestos más altos en el conjunto de resultados.

SearchAsYouTypeSpec

Especificación de la búsqueda mientras escribes en las solicitudes de búsqueda.

Representación JSON 
{
  "condition": enum (Condition)
}
Campos
condition

enum (Condition)

La condición en la que se debe producir la búsqueda a medida que se escribe. El valor predeterminado es Condition.DISABLED.

Condición

Enumeración que describe en qué condiciones se debe producir la búsqueda mientras escribes.

Enumeraciones
CONDITION_UNSPECIFIED El comportamiento predeterminado del servidor es Condition.DISABLED.
DISABLED Inhabilita la búsqueda a medida que se escribe.
ENABLED Habilita la función de búsqueda a medida que se escribe.
AUTO Cambio automático entre los modos de búsqueda mientras escribes y de búsqueda estándar, ideal para implementaciones de una sola API (por ejemplo, para evitar rebotes).

DisplaySpec

Especifica las funciones que se van a mostrar, como el resaltado de coincidencias.

Representación JSON 
{
  "matchHighlightingCondition": enum (MatchHighlightingCondition)
}
Campos
matchHighlightingCondition

enum (MatchHighlightingCondition)

La condición en la que se debe destacar la coincidencia.

MatchHighlightingCondition

Enumeración que describe en qué condición se debe destacar la coincidencia.

Enumeraciones
MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED El comportamiento del servidor es el mismo que el de MATCH_HIGHLIGHTING_DISABLED.
MATCH_HIGHLIGHTING_DISABLED Inhabilita el resaltado de coincidencias en todos los documentos.
MATCH_HIGHLIGHTING_ENABLED Habilita el resaltado de coincidencias en todos los documentos.

SessionSpec

Especificación de la sesión.

La función de búsqueda multirrespuesta se encuentra en la fase de disponibilidad general privada. Usa la versión v1alpha o v1beta antes de que lancemos esta función para el público general. También puedes solicitar que se te incluya en la lista de permitidos a través del equipo de Asistencia de Google.

Representación JSON 
{
  "queryId": string,
  "searchResultPersistenceCount": integer
}
Campos
queryId

string

Si se define, el resultado de búsqueda se almacena en el turno especificado por este ID de consulta.

Ejemplo: Supongamos que la sesión es la siguiente: session { name: ".../sessions/xxx" turns { query { text: "¿Qué es foo?" queryId: ".../questions/yyy" } answer: "Foo es ..." } turns { query { text: "¿Y bar?" queryId: ".../questions/zzz" } } }

El usuario puede llamar a la API /search con una solicitud como esta:

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

Después, la API almacena el resultado de búsqueda asociado al último turno. El resultado de la búsqueda almacenada se puede usar en una llamada posterior a la API /answer (con el ID de sesión y el ID de consulta especificados). También es posible llamar a /search y /answer en paralelo con el mismo ID de sesión y el mismo ID de consulta.
searchResultPersistenceCount

integer

Número de resultados de búsqueda principales que se conservarán. Los resultados de búsqueda persistentes se pueden usar en la llamada posterior a la API /answer.

Este campo es similar al campo summaryResultCount de SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count.

Un máximo de 10 resultados en el modo Documentos o 50 en el modo Fragmentos.

RelevanceThreshold

El umbral de relevancia de los resultados de búsqueda. Cuanto más alto sea el umbral de relevancia, más resultados relevantes se mostrarán y menos resultados se devolverán.

Enumeraciones
RELEVANCE_THRESHOLD_UNSPECIFIED Valor predeterminado. En este caso, el comportamiento del servidor se ajusta al umbral definido por Google.
LOWEST Umbral de relevancia más bajo.
LOW Umbral de relevancia bajo.
MEDIUM Umbral de relevancia medio.
HIGH Umbral de relevancia alto.

RelevanceScoreSpec

Especificación para devolver la puntuación de relevancia del documento.

Representación JSON 
{
  "returnRelevanceScore": boolean
}
Campos
returnRelevanceScore

boolean

Opcional. Indica si se devuelve la puntuación de relevancia de los resultados de búsqueda. Cuanto mayor sea la puntuación, más relevante será el documento para la consulta.

SearchAddonSpec

SearchAddonSpec se usa para inhabilitar los complementos de búsqueda según el nuevo modelo de cambio de precios. De forma predeterminada, si no se especifica SearchAddonSpec, consideramos que el cliente quiere habilitarlos siempre que sea posible.

Representación JSON 
{
  "disableSemanticAddOn": boolean,
  "disableKpiPersonalizationAddOn": boolean,
  "disableGenerativeAnswerAddOn": boolean
}
Campos
disableSemanticAddOn

boolean

Opcional. Si es true, el complemento semántico se inhabilita. El complemento semántico incluye inserciones y jetstream.
disableKpiPersonalizationAddOn

boolean

Opcional. Si es true, inhabilita la personalización y la reválida de eventos para optimizar los KPIs y personalizar los resultados.
disableGenerativeAnswerAddOn

boolean

Opcional. Si se le asigna el valor true, el complemento de respuestas generativas se inhabilita. El complemento de respuestas generativas incluye lenguaje natural para filtros y respuestas sencillas.

QuerySetSpec

Describe la especificación del conjunto de consultas.

Representación JSON 
{
  "sampleQuerySet": string
}
Campos
sampleQuerySet

string

Opcional. Nombre completo del recurso SampleQuerySet usado en la evaluación, con el formato projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}.

QualityMetrics

Describe las métricas que genera la evaluación.

Representación JSON 
{
  "docRecall": {
    object (TopkMetrics)
  },
  "docPrecision": {
    object (TopkMetrics)
  },
  "docNdcg": {
    object (TopkMetrics)
  },
  "pageRecall": {
    object (TopkMetrics)
  },
  "pageNdcg": {
    object (TopkMetrics)
  }
}
Campos
docRecall

object (TopkMetrics)

Recuperación por documento en varios niveles de umbral top-k.

La recuperación es la fracción de documentos relevantes recuperados de entre todos los documentos relevantes.

Ejemplo (los 5 primeros): * Para un solo SampleQuery, si se recuperan 3 de los 5 documentos relevantes entre los 5 primeros, recuperación@5 = 3/5 = 0,6
docPrecision

object (TopkMetrics)

Precisión por documento en varios niveles de corte top-k.

La precisión es la fracción de documentos recuperados que son relevantes.

Ejemplo (los 5 primeros): * Para un solo SampleQuery, si 4 de los 5 documentos recuperados en los 5 primeros son relevantes, precisión@5 = 4/5 = 0,8
docNdcg

object (TopkMetrics)

Ganancia acumulativa normalizada descontada (NDCG) por documento, con varios niveles de corte top-k.

El NDCG mide la calidad de la clasificación y da más relevancia a los resultados principales.

Ejemplo (los 3 primeros): Supongamos que SampleQuery con tres documentos recuperados (D1, D2 y D3) y juicios de relevancia binarios (1 para relevante y 0 para no relevante):

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

Calcula 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)

Recuerdo por página, en varios niveles de corte top-k.

La cobertura es la fracción de páginas relevantes que se han recuperado de todas las páginas relevantes.

Ejemplo (5 primeros): * Para un solo SampleQuery, si se recuperan 3 de las 5 páginas relevantes en los 5 primeros resultados, recuperación@5 = 3/5 = 0,6
pageNdcg

object (TopkMetrics)

Ganancia acumulativa normalizada descontada (NDCG) por página, en varios niveles de corte superior k.

El NDCG mide la calidad de la clasificación y da más relevancia a los resultados principales.

Ejemplo (los 3 primeros): supongamos que SampleQuery con tres páginas recuperadas (P1, P2 y P3) y juicios de relevancia binarios (1 para relevante y 0 para no relevante):

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

Calcula 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

Almacena los valores de las métricas en niveles de los k elementos principales específicos.

Representación JSON 
{
  "top1": number,
  "top3": number,
  "top5": number,
  "top10": number
}
Campos
top1

number

El valor superior.
top3

number

El valor de los tres primeros.
top5

number

El valor de los cinco primeros.
top10

number

El valor de los 10 primeros.

Estado

Describe el estado de una evaluación.

Enumeraciones
STATE_UNSPECIFIED La evaluación no se ha especificado.
PENDING El servicio se está preparando para ejecutar la evaluación.
RUNNING La evaluación está en curso.
SUCCEEDED La evaluación se ha completado correctamente.
FAILED No se ha podido realizar la evaluación.

Métodos

create

 Crea un Evaluation.

get

 Obtiene un Evaluation.

list

 Obtiene una lista de Evaluations.

listResults

 Obtiene una lista de resultados de un Evaluation determinado.