REST Resource: projects.locations.sampleQuerySets.sampleQueries

Resource: SampleQuery

Sample Query captures metadata to be used for evaluation.

JSON representation
{
  "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.
}
Fields
name

string

Identifier. The full resource name of the sample query, in the format of projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

createTime

string (Timestamp format)

Output only. Timestamp the SampleQuery was created at.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

Union field content. The content of the sample query. content can be only one of the following:
queryEntry

object (QueryEntry)

The query entry.

QueryEntry

Query Entry captures metadata to be used for search evaluation.

JSON representation
{
  "query": string,
  "targets": [
    {
      object (Target)
    }
  ]
}
Fields
query

string

Required. The query.

targets[]

object (Target)

List of targets for the query.

Target

Defines the parameters of the query's expected outcome.

JSON representation
{
  "uri": string,
  "pageNumbers": [
    integer
  ],
  "score": number
}
Fields
uri

string

Expected uri of the target.

This field must be a UTF-8 encoded string with a length limit of 2048 characters.

Example of valid uris: https://example.com/abc, gcs://example/example.pdf.

pageNumbers[]

integer

Expected page numbers of the target.

Each page number must be non negative.

score

number

Relevance score of the target.

Methods

create

Creates a SampleQuery

delete

Deletes a SampleQuery.

get

Gets a SampleQuery.

import

Bulk import of multiple SampleQuerys.

list

Gets a list of SampleQuerys.

Updates a SampleQuery.