REST Resource: projects.locations.sampleQuerySets.sampleQueries

Ressource: SampleQuery

Mit der Beispielabfrage werden Metadaten für die Bewertung erfasst.

JSON-Darstellung
{
  "name": string,
  "createTime": string,

  // Union field content can be only one of the following:
  "queryEntry": {
    object (QueryEntry)
  }
  // End of list of possible types for union field content.
}
Felder
name

string

ID. Der vollständige Ressourcenname der Beispielabfrage im Format projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}.

Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 1.024 Zeichen sein.

createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung von SampleQuery

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

Union-Feld content. Der Inhalt der Beispielabfrage. Für content ist nur einer der folgenden Werte zulässig:
queryEntry

object (QueryEntry)

Der Abfrageeintrag.

QueryEntry

Mit dem Abfrageeintrag werden Metadaten für die Bewertung der Suche erfasst.

JSON-Darstellung
{
  "query": string,
  "targets": [
    {
      object (Target)
    }
  ]
}
Felder
query

string

Erforderlich. Die Abfrage.

targets[]

object (Target)

Liste der Ziele für die Abfrage.

Ziel

Definiert die Parameter des erwarteten Ergebnisses der Abfrage.

JSON-Darstellung
{
  "uri": string,
  "pageNumbers": [
    integer
  ],
  "score": number
}
Felder
uri

string

Erwarteter URI des Ziels.

Dieses Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 2.048 Zeichen sein.

Beispiele für gültige URIs: https://example.com/abc, gcs://example/example.pdf.

pageNumbers[]

integer

Erwartete Seitenzahlen des Ziels.

Jede Seitenzahl darf nicht negativ sein.

score

number

Relevanzwert des Ziels.

Methoden

create

Erstellt eine SampleQuery

delete

Löscht eine SampleQuery.

get

Ruft ein SampleQuery ab.

import

Bulk-Import mehrerer SampleQuerys.

list

Ruft eine Liste der SampleQuerys ab.

patch

Aktualisiert ein SampleQuery