2024-07-17
▼ ▲ discoveryengine.projects.locations.evaluations.get
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}
HTTP Method: GET
Parameters:
name
Description: Required. Full resource name of Evaluation, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned.
Pattern: ^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a Evaluation.
▼ ▲ discoveryengine.projects.locations.evaluations.list
Path: v1beta/{+parent}/evaluations
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/evaluations
HTTP Method: GET
Parameters:
parent
Description: Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
Location: query
Type: integer
Format: int32
pageToken
Description: A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a list of Evaluations.
▼ ▲ discoveryengine.projects.locations.evaluations.create
Path: v1beta/{+parent}/evaluations
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/evaluations
HTTP Method: POST
Parameters:
parent
Description: Required. The parent resource name, such as `projects/{project}/locations/{location}`.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.
▼ ▲ discoveryengine.projects.locations.evaluations.listResults
Path: v1beta/{+evaluation}:listResults
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}:listResults
HTTP Method: GET
Parameters:
evaluation
Description: Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned.
Pattern: ^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Maximum number of EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
Location: query
Type: integer
Format: int32
pageToken
Description: A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
Location: query
Type: string
Parameter Order: evaluation
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a list of results for a given a Evaluation.
▼ ▲ discoveryengine.projects.locations.sampleQuerySets.get
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}
HTTP Method: GET
Parameters:
name
Description: Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned.
Pattern: ^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a SampleQuerySet.
▼ ▲ discoveryengine.projects.locations.sampleQuerySets.list
Path: v1beta/{+parent}/sampleQuerySets
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets
HTTP Method: GET
Parameters:
parent
Description: Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
Location: query
Type: integer
Format: int32
pageToken
Description: A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a list of SampleQuerySets.
▼ ▲ discoveryengine.projects.locations.sampleQuerySets.create
Path: v1beta/{+parent}/sampleQuerySets
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets
HTTP Method: POST
Parameters:
parent
Description: Required. The parent resource name, such as `projects/{project}/locations/{location}`.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
sampleQuerySetId
Description: Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a SampleQuerySet
▼ ▲ discoveryengine.projects.locations.sampleQuerySets.patch
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}
HTTP Method: PATCH
Parameters:
name
Description: Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
Pattern: ^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a SampleQuerySet.
▼ ▲ discoveryengine.projects.locations.sampleQuerySets.delete
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned.
Pattern: ^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a SampleQuerySet.
▼ ▲ discoveryengine.projects.locations.sampleQuerySets.sampleQueries.get
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}
HTTP Method: GET
Parameters:
name
Description: Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned.
Pattern: ^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a SampleQuery.
▼ ▲ discoveryengine.projects.locations.sampleQuerySets.sampleQueries.list
Path: v1beta/{+parent}/sampleQueries
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries
HTTP Method: GET
Parameters:
parent
Description: Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.
Pattern: ^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
Location: query
Type: integer
Format: int32
pageToken
Description: A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a list of SampleQuerys.
▼ ▲ discoveryengine.projects.locations.sampleQuerySets.sampleQueries.create
Path: v1beta/{+parent}/sampleQueries
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries
HTTP Method: POST
Parameters:
parent
Description: Required. The parent resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
Pattern: ^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$
Location: path
Required: Yes
Type: string
sampleQueryId
Description: Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a SampleQuery
▼ ▲ discoveryengine.projects.locations.sampleQuerySets.sampleQueries.patch
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}
HTTP Method: PATCH
Parameters:
name
Description: Immutable. 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.
Pattern: ^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a SampleQuery.
▼ ▲ discoveryengine.projects.locations.sampleQuerySets.sampleQueries.delete
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}
HTTP Method: DELETE
Parameters:
name
Description: Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned.
Pattern: ^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a SampleQuery.
▼ ▲ discoveryengine.projects.locations.sampleQuerySets.sampleQueries.import
Path: v1beta/{+parent}/sampleQueries:import
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries:import
HTTP Method: POST
Parameters:
parent
Description: Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.
Pattern: ^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.