3.0.0 • Published 5 years ago

@datafire/google_datalabeling v3.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/google_datalabeling

Client library for Data Labeling API

Installation and Usage

npm install --save @datafire/google_datalabeling
let google_datalabeling = require('@datafire/google_datalabeling').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Public API for Google Cloud AI Data Labeling Service.

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

google_datalabeling.oauthCallback({
  "code": ""
}, context)

Input

  • input object
    • code required string

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

oauthRefresh

Exchange a refresh_token for an access_token

google_datalabeling.oauthRefresh(null, context)

Input

This action has no parameters

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

datalabeling.projects.operations.delete

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

google_datalabeling.datalabeling.projects.operations.delete({
  "name": ""
}, context)

Input

  • input object
    • name required string: The name of the operation resource to be deleted.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.operations.get

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

google_datalabeling.datalabeling.projects.operations.get({
  "name": ""
}, context)

Input

  • input object
    • name required string: The name of the operation resource.
    • filter string: Optional. An expression for filtering Examples. Filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.evaluationJobs.patch

Updates an evaluation job. You can only update certain fields of the job's EvaluationJobConfig: humanAnnotationConfig.instruction, exampleCount, and exampleSamplePercentage. If you want to change any other aspect of the evaluation job, you must delete the job and create a new one.

google_datalabeling.datalabeling.projects.evaluationJobs.patch({
  "name": ""
}, context)

Input

  • input object
    • name required string: Output only. After you create a job, Data Labeling Service assigns a name to the job with the following format: "projects/{project_id}/evaluationJobs/ {evaluation_job_id}"
    • updateMask string: Optional. Mask for which fields to update. You can only provide the following fields: evaluationJobConfig.humanAnnotationConfig.instruction evaluationJobConfig.exampleCount * evaluationJobConfig.exampleSamplePercentage You can provide more than one of these fields by separating them with commas.
    • body GoogleCloudDatalabelingV1beta1EvaluationJob
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.operations.list

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

google_datalabeling.datalabeling.projects.operations.list({
  "name": ""
}, context)

Input

  • input object
    • name required string: The name of the operation's parent resource.
    • filter string: The standard list filter.
    • pageSize integer: The standard list page size.
    • pageToken string: The standard list page token.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.operations.cancel

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

google_datalabeling.datalabeling.projects.operations.cancel({
  "name": ""
}, context)

Input

  • input object
    • name required string: The name of the operation resource to be cancelled.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.datasets.exportData

Exports data and annotations from dataset.

google_datalabeling.datalabeling.projects.datasets.exportData({
  "name": ""
}, context)

Input

  • input object
    • name required string: Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
    • body GoogleCloudDatalabelingV1beta1ExportDataRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.datasets.importData

Imports data into dataset based on source locations defined in request. It can be called multiple times for the same dataset. Each dataset can only have one long running operation running on it. For example, no labeling task (also long running operation) can be started while importing is still ongoing. Vice versa.

google_datalabeling.datalabeling.projects.datasets.importData({
  "name": ""
}, context)

Input

  • input object
    • name required string: Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
    • body GoogleCloudDatalabelingV1beta1ImportDataRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.evaluationJobs.pause

Pauses an evaluation job. Pausing an evaluation job that is already in a PAUSED state is a no-op.

google_datalabeling.datalabeling.projects.evaluationJobs.pause({
  "name": ""
}, context)

Input

  • input object
    • name required string: Required. Name of the evaluation job that is going to be paused. Format: "projects/{project_id}/evaluationJobs/{evaluation_job_id}"
    • body GoogleCloudDatalabelingV1beta1PauseEvaluationJobRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.evaluationJobs.resume

Resumes a paused evaluation job. A deleted evaluation job can't be resumed. Resuming a running or scheduled evaluation job is a no-op.

google_datalabeling.datalabeling.projects.evaluationJobs.resume({
  "name": ""
}, context)

Input

  • input object
    • name required string: Required. Name of the evaluation job that is going to be resumed. Format: "projects/{project_id}/evaluationJobs/{evaluation_job_id}"
    • body GoogleCloudDatalabelingV1beta1ResumeEvaluationJobRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.datasets.annotatedDatasets.list

Lists annotated datasets for a dataset. Pagination is supported.

google_datalabeling.datalabeling.projects.datasets.annotatedDatasets.list({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. Name of the dataset to list annotated datasets, format: projects/{project_id}/datasets/{dataset_id}
    • filter string: Optional. Filter is not supported at this moment.
    • pageSize integer: Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
    • pageToken string: Optional. A token identifying a page of results for the server to return. Typically obtained by ListAnnotatedDatasetsResponse.next_page_token of the previous DataLabelingService.ListAnnotatedDatasets call. Return first page if empty.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.annotationSpecSets.list

Lists annotation spec sets for a project. Pagination is supported.

google_datalabeling.datalabeling.projects.annotationSpecSets.list({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. Parent of AnnotationSpecSet resource, format: projects/{project_id}
    • filter string: Optional. Filter is not supported at this moment.
    • pageSize integer: Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
    • pageToken string: Optional. A token identifying a page of results for the server to return. Typically obtained by ListAnnotationSpecSetsResponse.next_page_token of the previous DataLabelingService.ListAnnotationSpecSets call. Return first page if empty.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.annotationSpecSets.create

Creates an annotation spec set by providing a set of labels.

google_datalabeling.datalabeling.projects.annotationSpecSets.create({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. AnnotationSpecSet resource parent, format: projects/{project_id}
    • body GoogleCloudDatalabelingV1beta1CreateAnnotationSpecSetRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.datasets.dataItems.list

Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.

google_datalabeling.datalabeling.projects.datasets.dataItems.list({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}
    • filter string: Optional. Filter is not supported at this moment.
    • pageSize integer: Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
    • pageToken string: Optional. A token identifying a page of results for the server to return. Typically obtained by ListDataItemsResponse.next_page_token of the previous DataLabelingService.ListDataItems call. Return first page if empty.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.datasets.list

Lists datasets under a project. Pagination is supported.

google_datalabeling.datalabeling.projects.datasets.list({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. Dataset resource parent, format: projects/{project_id}
    • filter string: Optional. Filter on dataset is not supported at this moment.
    • pageSize integer: Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
    • pageToken string: Optional. A token identifying a page of results for the server to return. Typically obtained by ListDatasetsResponse.next_page_token of the previous DataLabelingService.ListDatasets call. Returns the first page if empty.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.datasets.create

Creates dataset. If success return a Dataset resource.

google_datalabeling.datalabeling.projects.datasets.create({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. Dataset resource parent, format: projects/{project_id}
    • body GoogleCloudDatalabelingV1beta1CreateDatasetRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.evaluationJobs.list

Lists all evaluation jobs within a project with possible filters. Pagination is supported.

google_datalabeling.datalabeling.projects.evaluationJobs.list({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. Evaluation job resource parent. Format: "projects/{project_id}"
    • filter string: Optional. You can filter the jobs to list by model_id (also known as model_name, as described in EvaluationJob.modelVersion) or by evaluation job state (as described in EvaluationJob.state). To filter by both criteria, use the AND operator or the OR operator. For example, you can use the following string for your filter: "evaluation_job.model_id = {model_name} AND evaluation_job.state = {evaluation_job_state}"
    • pageSize integer: Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
    • pageToken string: Optional. A token identifying a page of results for the server to return. Typically obtained by the nextPageToken in the response to the previous request. The request returns the first page if this is empty.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.evaluationJobs.create

Creates an evaluation job.

google_datalabeling.datalabeling.projects.evaluationJobs.create({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. Evaluation job resource parent. Format: "projects/{project_id}"
    • body GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.evaluations.search

Searches evaluations within a project.

google_datalabeling.datalabeling.projects.evaluations.search({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. Evaluation search parent (project ID). Format: "projects/ {project_id}"
    • filter string: Optional. To search evaluations, you can filter by the following: evaluation_job.evaluation_job_id (the last part of EvaluationJob.name) evaluation_job.model_id (the {model_name} portion of EvaluationJob.modelVersion) evaluation_job.evaluation_job_run_time_start (Minimum threshold for the evaluationJobRunTime that created the evaluation) evaluation_job.evaluation_job_run_time_end (Maximum threshold for the evaluationJobRunTime that created the evaluation) evaluation_job.job_state (EvaluationJob.state) annotation_spec.display_name (the Evaluation contains a metric for the annotation spec with this displayName) To filter by multiple critiera, use the AND operator or the OR operator. The following examples shows a string that filters by several critiera: "evaluation_job.evaluation_job_id = {evaluation_job_id} AND evaluation_job.model_id = {model_name} AND evaluation_job.evaluation_job_run_time_start = {timestamp_1} AND evaluation_job.evaluation_job_run_time_end = {timestamp_2} AND annotation_spec.display_name = {display_name}"
    • pageSize integer: Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
    • pageToken string: Optional. A token identifying a page of results for the server to return. Typically obtained by the nextPageToken of the response to a previous search request. If you don't specify this field, the API call requests the first page of the search.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.datasets.evaluations.exampleComparisons.search

Searches example comparisons from an evaluation. The return format is a list of example comparisons that show ground truth and prediction(s) for a single input. Search by providing an evaluation ID.

google_datalabeling.datalabeling.projects.datasets.evaluations.exampleComparisons.search({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. Name of the Evaluation resource to search for example comparisons from. Format: "projects/{project_id}/datasets/{dataset_id}/evaluations/ {evaluation_id}"
    • body GoogleCloudDatalabelingV1beta1SearchExampleComparisonsRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.datasets.annotatedDatasets.examples.list

Lists examples in an annotated dataset. Pagination is supported.

google_datalabeling.datalabeling.projects.datasets.annotatedDatasets.examples.list({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. Example resource parent.
    • filter string: Optional. An expression for filtering Examples. For annotated datasets that have annotation spec set, filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"
    • pageSize integer: Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
    • pageToken string: Optional. A token identifying a page of results for the server to return. Typically obtained by ListExamplesResponse.next_page_token of the previous DataLabelingService.ListExamples call. Return first page if empty.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.list

List FeedbackMessages with pagination.

google_datalabeling.datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.list({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. FeedbackMessage resource parent. Format: "projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}"
    • pageSize integer: Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
    • pageToken string: Optional. A token identifying a page of results for the server to return. Typically obtained by ListFeedbackMessages.next_page_token of the previous DataLabelingService.ListFeedbackMessages call. Return first page if empty.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.create

Create a FeedbackMessage object.

google_datalabeling.datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.create({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. FeedbackMessage resource parent, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}.
    • body GoogleCloudDatalabelingV1beta1FeedbackMessage
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.list

List FeedbackThreads with pagination.

google_datalabeling.datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.list({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. FeedbackThread resource parent. Format: "projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}"
    • pageSize integer: Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
    • pageToken string: Optional. A token identifying a page of results for the server to return. Typically obtained by ListFeedbackThreads.next_page_token of the previous DataLabelingService.ListFeedbackThreads call. Return first page if empty.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.datasets.image.label

Starts a labeling task for image. The type of image labeling task is configured by feature in the request.

google_datalabeling.datalabeling.projects.datasets.image.label({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}
    • body GoogleCloudDatalabelingV1beta1LabelImageRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.instructions.list

Lists instructions for a project. Pagination is supported.

google_datalabeling.datalabeling.projects.instructions.list({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. Instruction resource parent, format: projects/{project_id}
    • filter string: Optional. Filter is not supported at this moment.
    • pageSize integer: Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
    • pageToken string: Optional. A token identifying a page of results for the server to return. Typically obtained by ListInstructionsResponse.next_page_token of the previous DataLabelingService.ListInstructions call. Return first page if empty.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.instructions.create

Creates an instruction for how data should be labeled.

google_datalabeling.datalabeling.projects.instructions.create({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. Instruction resource parent, format: projects/{project_id}
    • body GoogleCloudDatalabelingV1beta1CreateInstructionRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.datasets.text.label

Starts a labeling task for text. The type of text labeling task is configured by feature in the request.

google_datalabeling.datalabeling.projects.datasets.text.label({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. Name of the data set to request labeling task, format: projects/{project_id}/datasets/{dataset_id}
    • body GoogleCloudDatalabelingV1beta1LabelTextRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

datalabeling.projects.datasets.video.label

Starts a labeling task for video. The type of video labeling task is configured by feature in the request.

google_datalabeling.datalabeling.projects.datasets.video.label({
  "parent": ""
}, context)

Input

  • input object
    • parent required string: Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}
    • body GoogleCloudDatalabelingV1beta1LabelVideoRequest
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

Definitions

GoogleCloudDatalabelingV1alpha1CreateInstructionMetadata

  • GoogleCloudDatalabelingV1alpha1CreateInstructionMetadata object: Metadata of a CreateInstruction operation.
    • createTime string: Timestamp when create instruction request was created.
    • instruction string: The name of the created Instruction. projects/{project_id}/instructions/{instruction_id}
    • partialFailures array: Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.

GoogleCloudDatalabelingV1alpha1ExportDataOperationMetadata

  • GoogleCloudDatalabelingV1alpha1ExportDataOperationMetadata object: Metadata of an ExportData operation.
    • annotatedDataset string: Output only. The name of annotated dataset in format "projects//datasets//annotatedDatasets/*".
    • createTime string: Output only. Timestamp when export dataset request was created.
    • dataset string: Output only. The name of dataset to be exported. "projects//datasets/"
    • partialFailures array: Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.

GoogleCloudDatalabelingV1alpha1ExportDataOperationResponse

  • GoogleCloudDatalabelingV1alpha1ExportDataOperationResponse object: Response used for ExportDataset longrunning operation.
    • annotatedDataset string: Output only. The name of annotated dataset in format "projects//datasets//annotatedDatasets/*".
    • dataset string: Ouptut only. The name of dataset. "projects//datasets/"
    • exportCount integer: Output only. Number of examples exported successfully.
    • labelStats GoogleCloudDatalabelingV1alpha1LabelStats
    • outputConfig GoogleCloudDatalabelingV1alpha1OutputConfig
    • totalCount integer: Output only. Total number of examples requested to export

GoogleCloudDatalabelingV1alpha1GcsDestination

  • GoogleCloudDatalabelingV1alpha1GcsDestination object: Export destination of the data.Only gcs path is allowed in output_uri.
    • mimeType string: Required. The format of the gcs destination. Only "text/csv" and "application/json" are supported.
    • outputUri string: Required. The output uri of destination file.

GoogleCloudDatalabelingV1alpha1GcsFolderDestination

  • GoogleCloudDatalabelingV1alpha1GcsFolderDestination object: Export folder destination of the data.
    • outputFolderUri string: Required. Cloud Storage directory to export data to.

GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig

  • GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig object: Configuration for how human labeling task should be done.
    • annotatedDatasetDescription string: Optional. A human-readable description for AnnotatedDataset. The description can be up to 10000 characters long.
    • annotatedDatasetDisplayName string: Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters .
    • contributorEmails array: Optional. If you want your own labeling contributors to manage and work on this labeling request, you can set these contributors here. We will give them access to the question types in crowdcompute. Note that these emails must be registered in crowdcompute worker UI: https://crowd-compute.appspot.com/
      • items string
    • instruction string: Required. Instruction resource name.
    • labelGroup string: Optional. A human-readable label used to logically group labeling tasks. This string must match the regular expression [a-zA-Z\\d_-]{0,128}.
    • languageCode string: Optional. The Language of this question, as a BCP-47. Default value is en-US. Only need to set this when task is language related. For example, French text classification.
    • questionDuration string: Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds.
    • replicaCount integer: Optional. Replication of questions. Each question will be sent to up to this number of contributors to label. Aggregated answers will be returned. Default is set to 1. For image related labeling, valid values are 1, 3, 5.
    • userEmailAddress string: Email of the user who started the labeling task and should be notified by email. If empty no notification will be sent.

GoogleCloudDatalabelingV1alpha1ImportDataOperationMetadata

  • GoogleCloudDatalabelingV1alpha1ImportDataOperationMetadata object: Metadata of an ImportData operation.
    • createTime string: Output only. Timestamp when import dataset request was created.
    • dataset string: Output only. The name of imported dataset. "projects//datasets/"
    • partialFailures array: Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.

GoogleCloudDatalabelingV1alpha1ImportDataOperationResponse

  • GoogleCloudDatalabelingV1alpha1ImportDataOperationResponse object: Response used for ImportData longrunning operation.
    • dataset string: Ouptut only. The name of imported dataset.
    • importCount integer: Output only. Number of examples imported successfully.
    • totalCount integer: Output only. Total number of examples requested to import

GoogleCloudDatalabelingV1alpha1LabelImageBoundingBoxOperationMetadata

GoogleCloudDatalabelingV1alpha1LabelImageBoundingPolyOperationMetadata

GoogleCloudDatalabelingV1alpha1LabelImageClassificationOperationMetadata

GoogleCloudDatalabelingV1alpha1LabelImageOrientedBoundingBoxOperationMetadata

GoogleCloudDatalabelingV1alpha1LabelImagePolylineOperationMetadata

GoogleCloudDatalabelingV1alpha1LabelImageSegmentationOperationMetadata

GoogleCloudDatalabelingV1alpha1LabelOperationMetadata

GoogleCloudDatalabelingV1alpha1LabelStats

  • GoogleCloudDatalabelingV1alpha1LabelStats object: Statistics about annotation specs.
    • exampleCount object: Map of each annotation spec's example count. Key is the annotation spec name and value is the number of examples for that annotation spec. If the annotated dataset does not have annotation spec, the map will return a pair where the key is empty string and value is the total number of annotations.

GoogleCloudDatalabelingV1alpha1LabelTextClassificationOperationMetadata

GoogleCloudDatalabelingV1alpha1LabelTextEntityExtractionOperationMetadata

GoogleCloudDatalabelingV1alpha1LabelVideoClassificationOperationMetadata

GoogleCloudDatalabelingV1alpha1LabelVideoEventOperationMetadata

GoogleCloudDatalabelingV1alpha1LabelVideoObjectDetectionOperationMetadata

GoogleCloudDatalabelingV1alpha1LabelVideoObjectTrackingOperationMetadata

GoogleCloudDatalabelingV1alpha1OutputConfig

GoogleCloudDatalabelingV1beta1AnnotatedDataset

  • GoogleCloudDatalabelingV1beta1AnnotatedDataset object: AnnotatedDataset is a set holding annotations for data in a Dataset. Each labeling task will generate an AnnotatedDataset under the Dataset that the task is requested for.
    • annotationSource string (values: ANNOTATION_SOURCE_UNSPECIFIED, OPERATOR): Output only. Source of the annotation.
    • annotationType string (values: ANNOTATIONTYPE_UNSPECIFIED, IMAGE_CLASSIFICATION_ANNOTATION, IMAGE
datafire
@infinitebrahmanuniverse/nolb-_datafire_g@everything-registry/sub-chunk-222@zalastax/nolb-_datafire_g
3.0.0

5 years ago