REST Resource: projects.locations.sampleQuerySets.sampleQueries

Recurso: SampleQuery

La consulta de muestra captura metadatos que se usarán para la evaluación.

Representación JSON
{
  "name": string,
  "createTime": string,

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

string

Es el identificador. Es el nombre completo del recurso de la consulta de muestra, en el formato projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}.

Este campo debe ser una cadena codificada en UTF-8 con un límite de longitud de 1,024 caracteres.

createTime

string (Timestamp format)

Solo salida. Es la marca de tiempo en la que se creó la SampleQuery.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

Es el contenido de la consulta de muestra. A continuación, se incluye una lista de campos mutuamente excluyentes. Se establecerá como máximo uno de los campos en una respuesta:
queryEntry

object (QueryEntry)

Es la entrada de la consulta.

Fin de los campos mutuamente excluyentes.

QueryEntry

La entrada de la consulta captura metadatos que se usarán para la evaluación de la búsqueda.

Representación JSON
{
  "query": string,
  "targets": [
    {
      object (Target)
    }
  ]
}
Campos
query

string

Obligatorio. Es la consulta.

targets[]

object (Target)

Es la lista de objetivos para la consulta.

Objetivo

Define los parámetros del resultado esperado de la consulta.

Representación JSON
{
  "uri": string,
  "pageNumbers": [
    integer
  ],
  "score": number
}
Campos
uri

string

Es el URI esperado del objetivo.

Este campo debe ser una cadena codificada en UTF-8 con un límite de longitud de 2,048 caracteres.

Ejemplos de URIs válidos: https://example.com/abc, gcs://example/example.pdf.

pageNumbers[]

integer

Son los números de página esperados del objetivo.

Cada número de página no debe ser negativo.

score

number

Es la puntuación de relevancia del objetivo.

Métodos

create

Crea una SampleQuery.

delete

Borra una SampleQuery.

get

Obtiene una SampleQuery.

import

Importación masiva de varias SampleQuerys.

list

Obtiene una lista de SampleQuerys.

patch

Actualiza una SampleQuery.