View Source GoogleApi.DataLabeling.V1beta1.Api.Projects (google_api_data_labeling v0.3.1)

API calls for all endpoints tagged Projects.

Summary

Functions

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

Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.

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

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.

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

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.

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

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

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

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.

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

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

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.

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.

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.

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Functions

Link to this function

datalabeling_projects_annotation_spec_sets_create(connection, projects_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_annotation_spec_sets_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1AnnotationSpecSet.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. AnnotationSpecSet resource parent, format: projects/{project_id}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1CreateAnnotationSpecSetRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1AnnotationSpecSet{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_annotation_spec_sets_delete(connection, projects_id, annotation_spec_sets_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_annotation_spec_sets_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataLabeling.V1beta1.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes an annotation spec set by resource name.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. AnnotationSpec resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}.
  • annotation_spec_sets_id (type: String.t) - Part of name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_annotation_spec_sets_get(connection, projects_id, annotation_spec_sets_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_annotation_spec_sets_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1AnnotationSpecSet.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets an annotation spec set by resource name.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. AnnotationSpecSet resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}
  • annotation_spec_sets_id (type: String.t) - Part of name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1AnnotationSpecSet{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_annotation_spec_sets_list(connection, projects_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_annotation_spec_sets_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1ListAnnotationSpecSetsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. Parent of AnnotationSpecSet resource, format: projects/{project_id}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - Optional. Filter is not supported at this moment.
    • :pageSize (type: integer()) - Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
    • :pageToken (type: String.t) - 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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1ListAnnotationSpecSetsResponse{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_annotated_datasets_data_items_get(connection, projects_id, datasets_id, annotated_datasets_id, data_items_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_annotated_datasets_data_items_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1DataItem.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}
  • datasets_id (type: String.t) - Part of name. See documentation of projectsId.
  • annotated_datasets_id (type: String.t) - Part of name. See documentation of projectsId.
  • data_items_id (type: String.t) - Part of name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1DataItem{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_annotated_datasets_data_items_list(connection, projects_id, datasets_id, annotated_datasets_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_annotated_datasets_data_items_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1ListDataItemsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}
  • datasets_id (type: String.t) - Part of parent. See documentation of projectsId.
  • annotated_datasets_id (type: String.t) - Part of parent. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - Optional. Filter is not supported at this moment.
    • :pageSize (type: integer()) - Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
    • :pageToken (type: String.t) - 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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1ListDataItemsResponse{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_annotated_datasets_delete(connection, projects_id, datasets_id, annotated_datasets_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_annotated_datasets_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataLabeling.V1beta1.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes an annotated dataset by resource name.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. Name of the annotated dataset to delete, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}
  • datasets_id (type: String.t) - Part of name. See documentation of projectsId.
  • annotated_datasets_id (type: String.t) - Part of name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_annotated_datasets_examples_get(connection, projects_id, datasets_id, annotated_datasets_id, examples_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_annotated_datasets_examples_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1Example.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets an example by resource name, including both data and annotation.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. Name of example, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}
  • datasets_id (type: String.t) - Part of name. See documentation of projectsId.
  • annotated_datasets_id (type: String.t) - Part of name. See documentation of projectsId.
  • examples_id (type: String.t) - Part of name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - Optional. An expression for filtering Examples. Filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1Example{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_annotated_datasets_examples_list(connection, projects_id, datasets_id, annotated_datasets_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_annotated_datasets_examples_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1ListExamplesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists examples in an annotated dataset. Pagination is supported.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. Example resource parent.
  • datasets_id (type: String.t) - Part of parent. See documentation of projectsId.
  • annotated_datasets_id (type: String.t) - Part of parent. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - 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 (type: integer()) - Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
    • :pageToken (type: String.t) - 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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1ListExamplesResponse{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_annotated_datasets_feedback_threads_delete(connection, projects_id, datasets_id, annotated_datasets_id, feedback_threads_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_annotated_datasets_feedback_threads_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataLabeling.V1beta1.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Delete a FeedbackThread.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. Name of the FeedbackThread that is going to be deleted. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}'.
  • datasets_id (type: String.t) - Part of name. See documentation of projectsId.
  • annotated_datasets_id (type: String.t) - Part of name. See documentation of projectsId.
  • feedback_threads_id (type: String.t) - Part of name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_annotated_datasets_feedback_threads_feedback_messages_create(connection, projects_id, datasets_id, annotated_datasets_id, feedback_threads_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_annotated_datasets_feedback_threads_feedback_messages_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataLabeling.V1beta1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Create a FeedbackMessage object.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. FeedbackMessage resource parent, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}.
  • datasets_id (type: String.t) - Part of parent. See documentation of projectsId.
  • annotated_datasets_id (type: String.t) - Part of parent. See documentation of projectsId.
  • feedback_threads_id (type: String.t) - Part of parent. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1FeedbackMessage.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_annotated_datasets_feedback_threads_feedback_messages_delete(connection, projects_id, datasets_id, annotated_datasets_id, feedback_threads_id, feedback_messages_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_annotated_datasets_feedback_threads_feedback_messages_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataLabeling.V1beta1.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Delete a FeedbackMessage.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. Name of the FeedbackMessage that is going to be deleted. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessages/{feedback_message_id}'.
  • datasets_id (type: String.t) - Part of name. See documentation of projectsId.
  • annotated_datasets_id (type: String.t) - Part of name. See documentation of projectsId.
  • feedback_threads_id (type: String.t) - Part of name. See documentation of projectsId.
  • feedback_messages_id (type: String.t) - Part of name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_annotated_datasets_feedback_threads_feedback_messages_get(connection, projects_id, datasets_id, annotated_datasets_id, feedback_threads_id, feedback_messages_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_annotated_datasets_feedback_threads_feedback_messages_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1FeedbackMessage.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get a FeedbackMessage object.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. Name of the feedback. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessages/{feedback_message_id}'.
  • datasets_id (type: String.t) - Part of name. See documentation of projectsId.
  • annotated_datasets_id (type: String.t) - Part of name. See documentation of projectsId.
  • feedback_threads_id (type: String.t) - Part of name. See documentation of projectsId.
  • feedback_messages_id (type: String.t) - Part of name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1FeedbackMessage{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_annotated_datasets_feedback_threads_feedback_messages_list(connection, projects_id, datasets_id, annotated_datasets_id, feedback_threads_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_annotated_datasets_feedback_threads_feedback_messages_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1ListFeedbackMessagesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List FeedbackMessages with pagination.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. FeedbackMessage resource parent. Format: "projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}"
  • datasets_id (type: String.t) - Part of parent. See documentation of projectsId.
  • annotated_datasets_id (type: String.t) - Part of parent. See documentation of projectsId.
  • feedback_threads_id (type: String.t) - Part of parent. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
    • :pageToken (type: String.t) - 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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1ListFeedbackMessagesResponse{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_annotated_datasets_feedback_threads_get(connection, projects_id, datasets_id, annotated_datasets_id, feedback_threads_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_annotated_datasets_feedback_threads_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1FeedbackThread.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get a FeedbackThread object.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. Name of the feedback. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}'.
  • datasets_id (type: String.t) - Part of name. See documentation of projectsId.
  • annotated_datasets_id (type: String.t) - Part of name. See documentation of projectsId.
  • feedback_threads_id (type: String.t) - Part of name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1FeedbackThread{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_annotated_datasets_feedback_threads_list(connection, projects_id, datasets_id, annotated_datasets_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_annotated_datasets_feedback_threads_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1ListFeedbackThreadsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List FeedbackThreads with pagination.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. FeedbackThread resource parent. Format: "projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}"
  • datasets_id (type: String.t) - Part of parent. See documentation of projectsId.
  • annotated_datasets_id (type: String.t) - Part of parent. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
    • :pageToken (type: String.t) - 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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1ListFeedbackThreadsResponse{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_annotated_datasets_get(connection, projects_id, datasets_id, annotated_datasets_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_annotated_datasets_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1AnnotatedDataset.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets an annotated dataset by resource name.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. Name of the annotated dataset to get, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}
  • datasets_id (type: String.t) - Part of name. See documentation of projectsId.
  • annotated_datasets_id (type: String.t) - Part of name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1AnnotatedDataset{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_annotated_datasets_list(connection, projects_id, datasets_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_annotated_datasets_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1ListAnnotatedDatasetsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists annotated datasets for a dataset. Pagination is supported.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. Name of the dataset to list annotated datasets, format: projects/{project_id}/datasets/{dataset_id}
  • datasets_id (type: String.t) - Part of parent. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - Optional. Filter is not supported at this moment.
    • :pageSize (type: integer()) - Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
    • :pageToken (type: String.t) - 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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1ListAnnotatedDatasetsResponse{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_create(connection, projects_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1Dataset.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates dataset. If success return a Dataset resource.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. Dataset resource parent, format: projects/{project_id}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1CreateDatasetRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1Dataset{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_data_items_get(connection, projects_id, datasets_id, data_items_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_data_items_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1DataItem.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}
  • datasets_id (type: String.t) - Part of name. See documentation of projectsId.
  • data_items_id (type: String.t) - Part of name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1DataItem{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_data_items_list(connection, projects_id, datasets_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_data_items_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1ListDataItemsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}
  • datasets_id (type: String.t) - Part of parent. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - Optional. Filter is not supported at this moment.
    • :pageSize (type: integer()) - Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
    • :pageToken (type: String.t) - 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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1ListDataItemsResponse{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_delete(connection, projects_id, datasets_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataLabeling.V1beta1.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a dataset by resource name.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
  • datasets_id (type: String.t) - Part of name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_evaluations_example_comparisons_search(connection, projects_id, datasets_id, evaluations_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_evaluations_example_comparisons_search(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1SearchExampleComparisonsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. Name of the Evaluation resource to search for example comparisons from. Format: "projects/{project_id}/datasets/{dataset_id}/evaluations/ {evaluation_id}"
  • datasets_id (type: String.t) - Part of parent. See documentation of projectsId.
  • evaluations_id (type: String.t) - Part of parent. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1SearchExampleComparisonsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1SearchExampleComparisonsResponse{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_evaluations_get(connection, projects_id, datasets_id, evaluations_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_evaluations_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1Evaluation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets an evaluation by resource name (to search, use projects.evaluations.search).

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. Name of the evaluation. Format: "projects/{project_id}/datasets/ {dataset_id}/evaluations/{evaluation_id}'
  • datasets_id (type: String.t) - Part of name. See documentation of projectsId.
  • evaluations_id (type: String.t) - Part of name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1Evaluation{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_export_data(connection, projects_id, datasets_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_export_data(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataLabeling.V1beta1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Exports data and annotations from dataset.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
  • datasets_id (type: String.t) - Part of name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1ExportDataRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_get(connection, projects_id, datasets_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1Dataset.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets dataset by resource name.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
  • datasets_id (type: String.t) - Part of name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1Dataset{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_image_label(connection, projects_id, datasets_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_image_label(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataLabeling.V1beta1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}
  • datasets_id (type: String.t) - Part of parent. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1LabelImageRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_import_data(connection, projects_id, datasets_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_import_data(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataLabeling.V1beta1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
  • datasets_id (type: String.t) - Part of name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1ImportDataRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_list(connection, projects_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1ListDatasetsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists datasets under a project. Pagination is supported.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. Dataset resource parent, format: projects/{project_id}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - Optional. Filter on dataset is not supported at this moment.
    • :pageSize (type: integer()) - Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
    • :pageToken (type: String.t) - 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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1ListDatasetsResponse{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_text_label(connection, projects_id, datasets_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_text_label(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataLabeling.V1beta1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. Name of the data set to request labeling task, format: projects/{project_id}/datasets/{dataset_id}
  • datasets_id (type: String.t) - Part of parent. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1LabelTextRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_datasets_video_label(connection, projects_id, datasets_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_datasets_video_label(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataLabeling.V1beta1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}
  • datasets_id (type: String.t) - Part of parent. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1LabelVideoRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_evaluation_jobs_create(connection, projects_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_evaluation_jobs_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1EvaluationJob.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates an evaluation job.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. Evaluation job resource parent. Format: "projects/{project_id}"
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1EvaluationJob{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_evaluation_jobs_delete(connection, projects_id, evaluation_jobs_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_evaluation_jobs_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataLabeling.V1beta1.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Stops and deletes an evaluation job.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. Name of the evaluation job that is going to be deleted. Format: "projects/{project_id}/evaluationJobs/{evaluation_job_id}"
  • evaluation_jobs_id (type: String.t) - Part of name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_evaluation_jobs_get(connection, projects_id, evaluation_jobs_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_evaluation_jobs_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1EvaluationJob.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets an evaluation job by resource name.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. Name of the evaluation job. Format: "projects/{project_id} /evaluationJobs/{evaluation_job_id}"
  • evaluation_jobs_id (type: String.t) - Part of name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1EvaluationJob{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_evaluation_jobs_list(connection, projects_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_evaluation_jobs_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1ListEvaluationJobsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. Evaluation job resource parent. Format: "projects/{project_id}"
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - 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 (type: integer()) - Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
    • :pageToken (type: String.t) - 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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1ListEvaluationJobsResponse{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_evaluation_jobs_patch(connection, projects_id, evaluation_jobs_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_evaluation_jobs_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1EvaluationJob.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of evaluationJob.name. 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}"
  • evaluation_jobs_id (type: String.t) - Part of evaluationJob.name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - 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 (type: GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1EvaluationJob.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1EvaluationJob{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_evaluation_jobs_pause(connection, projects_id, evaluation_jobs_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_evaluation_jobs_pause(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataLabeling.V1beta1.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. Name of the evaluation job that is going to be paused. Format: "projects/{project_id}/evaluationJobs/{evaluation_job_id}"
  • evaluation_jobs_id (type: String.t) - Part of name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1PauseEvaluationJobRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_evaluation_jobs_resume(connection, projects_id, evaluation_jobs_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_evaluation_jobs_resume(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataLabeling.V1beta1.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. Name of the evaluation job that is going to be resumed. Format: "projects/{project_id}/evaluationJobs/{evaluation_job_id}"
  • evaluation_jobs_id (type: String.t) - Part of name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1ResumeEvaluationJobRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_evaluations_search(connection, projects_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_evaluations_search(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1SearchEvaluationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Searches evaluations within a project.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. Evaluation search parent (project ID). Format: "projects/ {project_id}"
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - 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 (type: integer()) - Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
    • :pageToken (type: String.t) - 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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1SearchEvaluationsResponse{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_instructions_create(connection, projects_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_instructions_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataLabeling.V1beta1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates an instruction for how data should be labeled.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. Instruction resource parent, format: projects/{project_id}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1CreateInstructionRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_instructions_delete(connection, projects_id, instructions_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_instructions_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataLabeling.V1beta1.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes an instruction object by resource name.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
  • instructions_id (type: String.t) - Part of name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_instructions_get(connection, projects_id, instructions_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_instructions_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1Instruction.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets an instruction by resource name.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
  • instructions_id (type: String.t) - Part of name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1Instruction{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_instructions_list(connection, projects_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_instructions_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1ListInstructionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists instructions for a project. Pagination is supported.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. Instruction resource parent, format: projects/{project_id}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - Optional. Filter is not supported at this moment.
    • :pageSize (type: integer()) - Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
    • :pageToken (type: String.t) - 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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleCloudDatalabelingV1beta1ListInstructionsResponse{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_operations_cancel(connection, projects_id, operations_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_operations_cancel(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataLabeling.V1beta1.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. The name of the operation resource to be cancelled.
  • operations_id (type: String.t) - Part of name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_operations_delete(connection, projects_id, operations_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_operations_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataLabeling.V1beta1.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. The name of the operation resource to be deleted.
  • operations_id (type: String.t) - Part of name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_operations_get(connection, projects_id, operations_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_operations_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DataLabeling.V1beta1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. The name of the operation resource.
  • operations_id (type: String.t) - Part of name. See documentation of projectsId.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

datalabeling_projects_operations_list(connection, projects_id, optional_params \\ [], opts \\ [])

View Source
@spec datalabeling_projects_operations_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DataLabeling.V1beta1.Model.GoogleLongrunningListOperationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters

  • connection (type: GoogleApi.DataLabeling.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. The name of the operation's parent resource.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - The standard list filter.
    • :pageSize (type: integer()) - The standard list page size.
    • :pageToken (type: String.t) - The standard list page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DataLabeling.V1beta1.Model.GoogleLongrunningListOperationsResponse{}} on success
  • {:error, info} on failure