happygapi.datalabeling.projects — happygapi 0.4.8

Data Labeling API: projects. Public API for Google Cloud AI Data Labeling Service. See: https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects

annotationSpecSets-create$ clj

(annotationSpecSets-create$ auth parameters body)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/annotationSpecSets/create

Required parameters: parent

Optional parameters: none

Body:

{:annotationSpecSet {:name string, :description string, :blockingResources [string], :displayName string, :annotationSpecs [GoogleCloudDatalabelingV1beta1AnnotationSpec]}}

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

annotationSpecSets-delete$ clj

(annotationSpecSets-delete$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/annotationSpecSets/delete

Required parameters: name

Optional parameters: none

Deletes an annotation spec set by resource name.

annotationSpecSets-get$ clj

(annotationSpecSets-get$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/annotationSpecSets/get

Required parameters: name

Optional parameters: none

Gets an annotation spec set by resource name.

annotationSpecSets-list$ clj

(annotationSpecSets-list$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/annotationSpecSets/list

Required parameters: parent

Optional parameters: filter, pageSize, pageToken

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

datasets-annotatedDatasets-dataItems-get$ clj

(datasets-annotatedDatasets-dataItems-get$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/annotatedDatasets/dataItems/get

Required parameters: name

Optional parameters: none

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

datasets-annotatedDatasets-dataItems-list$ clj

(datasets-annotatedDatasets-dataItems-list$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/annotatedDatasets/dataItems/list

Required parameters: parent

Optional parameters: pageToken, pageSize, filter

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

datasets-annotatedDatasets-delete$ clj

(datasets-annotatedDatasets-delete$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/annotatedDatasets/delete

Required parameters: name

Optional parameters: none

Deletes an annotated dataset by resource name.

datasets-annotatedDatasets-examples-get$ clj

(datasets-annotatedDatasets-examples-get$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/annotatedDatasets/examples/get

Required parameters: name

Optional parameters: filter

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

datasets-annotatedDatasets-examples-list$ clj

(datasets-annotatedDatasets-examples-list$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/annotatedDatasets/examples/list

Required parameters: parent

Optional parameters: pageToken, filter, pageSize

Lists examples in an annotated dataset. Pagination is supported.

datasets-annotatedDatasets-feedbackThreads-delete$ clj

(datasets-annotatedDatasets-feedbackThreads-delete$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/annotatedDatasets/feedbackThreads/delete

Required parameters: name

Optional parameters: none

Delete a FeedbackThread.

datasets-annotatedDatasets-feedbackThreads-feedbackMessages-create$ clj

(datasets-annotatedDatasets-feedbackThreads-feedbackMessages-create$ auth
                                                                     parameters
                                                                     body)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/annotatedDatasets/feedbackThreads/feedbackMessages/create

Required parameters: parent

Optional parameters: none

Body:

{:requesterFeedbackMetadata {}, :body string, :image string, :operatorFeedbackMetadata {}, :name string, :createTime string}

Create a FeedbackMessage object.

datasets-annotatedDatasets-feedbackThreads-feedbackMessages-delete$ clj

(datasets-annotatedDatasets-feedbackThreads-feedbackMessages-delete$ auth
                                                                     parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/annotatedDatasets/feedbackThreads/feedbackMessages/delete

Required parameters: name

Optional parameters: none

Delete a FeedbackMessage.

datasets-annotatedDatasets-feedbackThreads-feedbackMessages-get$ clj

(datasets-annotatedDatasets-feedbackThreads-feedbackMessages-get$ auth
                                                                  parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/annotatedDatasets/feedbackThreads/feedbackMessages/get

Required parameters: name

Optional parameters: none

Get a FeedbackMessage object.

datasets-annotatedDatasets-feedbackThreads-feedbackMessages-list$ clj

(datasets-annotatedDatasets-feedbackThreads-feedbackMessages-list$ auth
                                                                   parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/annotatedDatasets/feedbackThreads/feedbackMessages/list

Required parameters: parent

Optional parameters: pageSize, pageToken

List FeedbackMessages with pagination.

datasets-annotatedDatasets-feedbackThreads-get$ clj

(datasets-annotatedDatasets-feedbackThreads-get$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/annotatedDatasets/feedbackThreads/get

Required parameters: name

Optional parameters: none

Get a FeedbackThread object.

datasets-annotatedDatasets-feedbackThreads-list$ clj

(datasets-annotatedDatasets-feedbackThreads-list$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/annotatedDatasets/feedbackThreads/list

Required parameters: parent

Optional parameters: pageToken, pageSize

List FeedbackThreads with pagination.

datasets-annotatedDatasets-get$ clj

(datasets-annotatedDatasets-get$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/annotatedDatasets/get

Required parameters: name

Optional parameters: none

Gets an annotated dataset by resource name.

datasets-annotatedDatasets-list$ clj

(datasets-annotatedDatasets-list$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/annotatedDatasets/list

Required parameters: parent

Optional parameters: filter, pageSize, pageToken

Lists annotated datasets for a dataset. Pagination is supported.

datasets-create$ clj

(datasets-create$ auth parameters body)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/create

Required parameters: parent

Optional parameters: none

Body:

{:dataset {:displayName string, :dataItemCount string, :description string, :lastMigrateTime string, :blockingResources [string], :inputConfigs [GoogleCloudDatalabelingV1beta1InputConfig], :createTime string, :name string}}

Creates dataset. If success return a Dataset resource.

datasets-dataItems-get$ clj

(datasets-dataItems-get$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/dataItems/get

Required parameters: name

Optional parameters: none

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

datasets-dataItems-list$ clj

(datasets-dataItems-list$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/dataItems/list

Required parameters: parent

Optional parameters: pageSize, pageToken, filter

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

datasets-delete$ clj

(datasets-delete$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/delete

Required parameters: name

Optional parameters: none

Deletes a dataset by resource name.

datasets-evaluations-exampleComparisons-search$ clj

(datasets-evaluations-exampleComparisons-search$ auth parameters body)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/evaluations/exampleComparisons/search

Required parameters: parent

Optional parameters: none

Body:

{:pageToken string, :pageSize integer}

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.

datasets-evaluations-get$ clj

(datasets-evaluations-get$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/evaluations/get

Required parameters: name

Optional parameters: none

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

datasets-exportData$ clj

(datasets-exportData$ auth parameters body)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/exportData

Required parameters: name

Optional parameters: none

Body:

{:filter string, :annotatedDataset string, :userEmailAddress string, :outputConfig {:gcsFolderDestination GoogleCloudDatalabelingV1beta1GcsFolderDestination, :gcsDestination GoogleCloudDatalabelingV1beta1GcsDestination}}

Exports data and annotations from dataset.

datasets-get$ clj

(datasets-get$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/get

Required parameters: name

Optional parameters: none

Gets dataset by resource name.

datasets-image-label$ clj

(datasets-image-label$ auth parameters body)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/image/label

Required parameters: parent

Optional parameters: none

Body:

{:imageClassificationConfig {:allowMultiLabel boolean, :annotationSpecSet string, :answerAggregationType string}, :basicConfig {:annotatedDatasetDisplayName string, :annotatedDatasetDescription string, :labelGroup string, :languageCode string, :userEmailAddress string, :contributorEmails [string], :replicaCount integer, :instruction string, :questionDuration string}, :feature string, :polylineConfig {:instructionMessage string, :annotationSpecSet string}, :segmentationConfig {:instructionMessage string, :annotationSpecSet string}, :boundingPolyConfig {:instructionMessage string, :annotationSpecSet string}}

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

datasets-importData$ clj

(datasets-importData$ auth parameters body)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/importData

Required parameters: name

Optional parameters: none

Body:

{:userEmailAddress string, :inputConfig {:bigquerySource GoogleCloudDatalabelingV1beta1BigQuerySource, :dataType string, :gcsSource GoogleCloudDatalabelingV1beta1GcsSource, :textMetadata GoogleCloudDatalabelingV1beta1TextMetadata, :annotationType string, :classificationMetadata GoogleCloudDatalabelingV1beta1ClassificationMetadata}}

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.

datasets-list$ clj

(datasets-list$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/list

Required parameters: parent

Optional parameters: filter, pageToken, pageSize

Lists datasets under a project. Pagination is supported.

datasets-text-label$ clj

(datasets-text-label$ auth parameters body)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/text/label

Required parameters: parent

Optional parameters: none

Body:

{:feature string, :textClassificationConfig {:allowMultiLabel boolean, :annotationSpecSet string, :sentimentConfig GoogleCloudDatalabelingV1beta1SentimentConfig}, :basicConfig {:annotatedDatasetDisplayName string, :annotatedDatasetDescription string, :labelGroup string, :languageCode string, :userEmailAddress string, :contributorEmails [string], :replicaCount integer, :instruction string, :questionDuration string}, :textEntityExtractionConfig {:annotationSpecSet string}}

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

datasets-video-label$ clj

(datasets-video-label$ auth parameters body)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/datasets/video/label

Required parameters: parent

Optional parameters: none

Body:

{:eventConfig {:clipLength integer, :annotationSpecSets [string], :overlapLength integer}, :objectDetectionConfig {:extractionFrameRate number, :annotationSpecSet string}, :objectTrackingConfig {:overlapLength integer, :annotationSpecSet string, :clipLength integer}, :basicConfig {:annotatedDatasetDisplayName string, :annotatedDatasetDescription string, :labelGroup string, :languageCode string, :userEmailAddress string, :contributorEmails [string], :replicaCount integer, :instruction string, :questionDuration string}, :feature string, :videoClassificationConfig {:applyShotDetection boolean, :annotationSpecSetConfigs [GoogleCloudDatalabelingV1beta1AnnotationSpecSetConfig]}}

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

evaluationJobs-create$ clj

(evaluationJobs-create$ auth parameters body)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/evaluationJobs/create

Required parameters: parent

Optional parameters: none

Body:

{:job {:description string, :evaluationJobConfig GoogleCloudDatalabelingV1beta1EvaluationJobConfig, :schedule string, :labelMissingGroundTruth boolean, :name string, :attempts [GoogleCloudDatalabelingV1beta1Attempt], :createTime string, :state string, :annotationSpecSet string, :modelVersion string}}

Creates an evaluation job.

evaluationJobs-delete$ clj

(evaluationJobs-delete$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/evaluationJobs/delete

Required parameters: name

Optional parameters: none

Stops and deletes an evaluation job.

evaluationJobs-get$ clj

(evaluationJobs-get$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/evaluationJobs/get

Required parameters: name

Optional parameters: none

Gets an evaluation job by resource name.

evaluationJobs-list$ clj

(evaluationJobs-list$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/evaluationJobs/list

Required parameters: parent

Optional parameters: pageSize, pageToken, filter

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

evaluationJobs-patch$ clj

(evaluationJobs-patch$ auth parameters body)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/evaluationJobs/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:description string, :evaluationJobConfig {:boundingPolyConfig GoogleCloudDatalabelingV1beta1BoundingPolyConfig, :humanAnnotationConfig GoogleCloudDatalabelingV1beta1HumanAnnotationConfig, :exampleSamplePercentage number, :imageClassificationConfig GoogleCloudDatalabelingV1beta1ImageClassificationConfig, :exampleCount integer, :bigqueryImportKeys {}, :evaluationConfig GoogleCloudDatalabelingV1beta1EvaluationConfig, :evaluationJobAlertConfig GoogleCloudDatalabelingV1beta1EvaluationJobAlertConfig, :textClassificationConfig GoogleCloudDatalabelingV1beta1TextClassificationConfig, :inputConfig GoogleCloudDatalabelingV1beta1InputConfig}, :schedule string, :labelMissingGroundTruth boolean, :name string, :attempts [{:attemptTime string, :partialFailures [GoogleRpcStatus]}], :createTime string, :state string, :annotationSpecSet string, :modelVersion string}

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.

evaluationJobs-pause$ clj

(evaluationJobs-pause$ auth parameters body)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/evaluationJobs/pause

Required parameters: name

Optional parameters: none

Body:

{}

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

evaluationJobs-resume$ clj

(evaluationJobs-resume$ auth parameters body)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/evaluationJobs/resume

Required parameters: name

Optional parameters: none

Body:

{}

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

evaluations-search$ clj

(evaluations-search$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/evaluations/search

Required parameters: parent

Optional parameters: filter, pageToken, pageSize

Searches evaluations within a project.

instructions-create$ clj

(instructions-create$ auth parameters body)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/instructions/create

Required parameters: parent

Optional parameters: none

Body:

{:instruction {:description string, :pdfInstruction GoogleCloudDatalabelingV1beta1PdfInstruction, :displayName string, :name string, :createTime string, :updateTime string, :csvInstruction GoogleCloudDatalabelingV1beta1CsvInstruction, :dataType string, :blockingResources [string]}}

Creates an instruction for how data should be labeled.

instructions-delete$ clj

(instructions-delete$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/instructions/delete

Required parameters: name

Optional parameters: none

Deletes an instruction object by resource name.

instructions-get$ clj

(instructions-get$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/instructions/get

Required parameters: name

Optional parameters: none

Gets an instruction by resource name.

instructions-list$ clj

(instructions-list$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/instructions/list

Required parameters: parent

Optional parameters: pageSize, pageToken, filter

Lists instructions for a project. Pagination is supported.

operations-cancel$ clj

(operations-cancel$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/operations/cancel

Required parameters: name

Optional parameters: none

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.

operations-delete$ clj

(operations-delete$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/operations/delete

Required parameters: name

Optional parameters: none

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.

operations-get$ clj

(operations-get$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/operations/get

Required parameters: name

Optional parameters: none

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.

operations-list$ clj

(operations-list$ auth parameters)

https://cloud.google.com/data-labeling/docs/api/reference/rest/v1beta1/projects/operations/list

Required parameters: name

Optional parameters: filter, pageSize, pageToken

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