Package google.cloud.healthcare.v1beta1.annotation

string

Identifier. Resource name of the Annotation, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}.

AnnotationSource

Required. Details of the source.

map<string, string>

Additional information for this annotation record, such as annotator and verifier information or study campaign.

ResourceAnnotation

Annotations for resource. For example, classification tags.

ImageAnnotation

Annotations for images. For example, bounding polygons.

SensitiveTextAnnotation

Annotations for sensitive texts. For example, a range that describes the location of sensitive text.

CloudHealthcareSource

Cloud Healthcare API resource.

string

Full path of a Cloud Healthcare API resource.

string

Identifier. Resource name of the Annotation store, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}.

map<string, string>

Optional. User-supplied key-value pairs used to organize Annotation stores.

Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}

Label values must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}

No more than 64 labels can be associated with a given store.

string

BigQuery URI to a table, up to 2000 characters long, must be of the form bq://projectId.bqDatasetId.tableId.

bool

Use write_disposition instead. If write_disposition is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE.

SchemaType

Specifies the schema format to export.

WriteDisposition

Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the force parameter is ignored.

string

Required. The name of the Annotation store this annotation belongs to. For example, projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore.

Authorization requires the following IAM permission on the specified resource parent:

• healthcare.annotations.create

Annotation

Required. Annotation to create.

string

Required. The name of the dataset this Annotation store belongs to.

Authorization requires the following IAM permission on the specified resource parent:

• healthcare.annotationStores.create

string

Required. The ID of the Annotation store that is being created. The string must match the following regex: [\p{L}\p{N}_\-\.]{1,256}.

AnnotationStore

Configuration info for this Annotation store.

string

Required. The resource name of the Annotation to delete.

Authorization requires the following IAM permission on the specified resource name:

• healthcare.annotations.delete

string

Required. The resource name of the Annotation store to delete.

Authorization requires the following IAM permission on the specified resource name:

• healthcare.annotationStores.delete

string

Required. The Annotation store to compare against golden_store, in the format of projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}.

Authorization requires the following IAM permission on the specified resource name:

• healthcare.annotationStores.evaluate

map<string, string>

Optional. InfoType mapping for eval_store. Different resources can map to the same infoType. For example, PERSON_NAME, PERSON, NAME, and HUMAN are different. To map all of these into a single infoType (such as PERSON_NAME), specify the following mapping:

  info_type_mapping["PERSON"] = "PERSON_NAME"
  info_type_mapping["NAME"] = "PERSON_NAME"
  info_type_mapping["HUMAN"] = "PERSON_NAME"

Unmentioned infoTypes, such as DATE, are treated as identity mapping. For example:

  info_type_mapping["DATE"] = "DATE"

InfoTypes are case-insensitive.

string

Required. The Annotation store to use as ground truth, in the format of projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}.

map<string, string>

Optional. Similar to eval_info_type_mapping, infoType mapping for golden_store.

InfoTypeConfig

BigQueryDestination

The BigQuery table where the server writes the output. BigQueryDestination requires the roles/bigquery.dataEditor and roles/bigquery.jobUser Cloud IAM roles.

bool

If TRUE, infoTypes described by filter are used for evaluation. Otherwise, infoTypes are not considered for evaluation. For example:

• Annotated text: "Toronto is a location"
• Finding 1: {"infoType": "PERSON", "quote": "Toronto", "start": 0, "end": 7}
• Finding 2: {"infoType": "CITY", "quote": "Toronto", "start": 0, "end": 7}
• Finding 3: {}
• Ground truth: {"infoType": "LOCATION", "quote": "Toronto", "start": 0, "end": 7}

When strict_matching is TRUE:

• Finding 1: 1 false positive
• Finding 2: 1 false positive
• Finding 3: 1 false negative

When strict_matching is FALSE:

• Finding 1: 1 true positive
• Finding 2: 1 true positive
• Finding 3: 1 false negative

FilterList

FilterList

string

These infoTypes are based on after the eval_info_type_mapping and golden_info_type_mapping.

string

Required. The name of the Annotation store to export annotations to, in the format of projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}.

Authorization requires the following IAM permission on the specified resource name:

• healthcare.annotationStores.export

GcsDestination

The Cloud Storage destination, which requires the roles/storage.objectAdmin Cloud IAM role.

BigQueryDestination

The BigQuery output destination, which requires two IAM roles: roles/bigquery.dataEditor and roles/bigquery.jobUser.

string

The Cloud Storage destination to export to. URI for a Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in uri_prefix.

string

Points to a Cloud Storage URI containing file(s) with content only. The URI must be in the following format: gs://{bucket_id}/{object_id}. The URI can include wildcards in object_id and thus identify multiple files. Supported wildcards: '*' to match 0 or more non-separator characters '**' to match 0 or more characters (including separators). Must be used at the end of a path and with no other wildcards in the path. Can also be used with a file extension (such as .dcm), which imports all files with the extension in the specified directory and its sub-directories. For example, gs://my-bucket/my-directory/**.json imports all files with .json extensions in my-directory/ and its sub-directories. '?' to match 1 character All other URI formats are invalid. Files matching the wildcard are expected to contain content only, no metadata.

string

Required. The resource name of the Annotation to retrieve.

Authorization requires the following IAM permission on the specified resource name:

• healthcare.annotations.get

string

Required. The resource name of the Annotation store to get.

Authorization requires the following IAM permission on the specified resource name:

• healthcare.annotationStores.get

BoundingPoly

The list of polygons outlining the sensitive regions in the image.

int32

0-based index of the image frame. For example, an image frame in a DICOM instance.

Vertex

List of the vertices of this polygon.

string

A description of this polygon.

float

X coordinate.

float

Y coordinate.

string

Required. The name of the Annotation store to which the server imports annotations, in the format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}.

Authorization requires the following IAM permission on the specified resource name:

• healthcare.annotationStores.import

GcsSource

string

Required. Name of the dataset.

Authorization requires the following IAM permission on the specified resource parent:

• healthcare.annotationStores.list

int32

Limit on the number of Annotation stores to return in a single response. If not specified, 100 is used. May not be larger than 1000.

string

The next_page_token value returned from the previous List request, if any.

string

Restricts stores returned to those matching a filter. The following syntax is available:

• A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (=), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with great in the comment field.
• A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (=), along with the less than/greater than operators (<, <=, >, >=). Note that there is no inequality (!=) operator. You can prepend the NOT operator to an expression to negate it.
• A date field value must be written in yyyy-mm-dd form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (=) , along with the less than/greater than operators (<, <=, >, >=). Note that there is no inequality (!=) operator. You can prepend the NOT operator to an expression to negate it.
• Multiple field query expressions can be combined in one query by adding AND or OR operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the NOT operator to an expression to negate it.

Only filtering on labels is supported, for example labels.key=value.

AnnotationStore

The returned Annotation stores. Won't be more Annotation stores than the value of page_size in the request.

string

Token to retrieve the next page of results or empty if there are no more results in the list.

string

Required. Name of the Annotation store to retrieve Annotations from.

Authorization requires the following IAM permission on the specified resource parent:

• healthcare.annotations.list

int32

Limit on the number of Annotations to return in a single response. If not specified, 100 is used. May not be larger than 1000.

string

The next_page_token value returned from the previous List request, if any.

string

Restricts Annotations returned to those matching a filter. Functions available for filtering are:

• matches("annotation_source.cloud_healthcare_source.name", substring). Filter on cloud_healthcare_source.name. For example: matches("annotation_source.cloud_healthcare_source.name", "some source").

• matches("annotation", substring). Filter on all fields of annotation. For example: matches("annotation", "some-content").

• type("text"), type("image"), type("resource"). Filter on the type of annotation data.

AnnotationView

Controls which fields are populated in the response.

Annotation

The returned Annotations. Won't be more values than the value of page_size in the request. See AnnotationView in the request for populated fields.

string

Token to retrieve the next page of results or empty if there are no more results in the list.

string

A description of the annotation record.

map<string, Detail>

Maps from a resource slice. For example, FHIR resource field path to a set of sensitive text findings. For example, Appointment.Narrative text1 --> {findings_1, findings_2, findings_3}

Finding

string

The type of information stored in this text range. For example, HumanName, BirthDate, or Address.

int64

Zero-based starting index of the found text, inclusively.

int64

Zero-based ending index of the found text, exclusively.

string

The snippet of the sensitive text. This field is only populated during deidentification if store_quote is set to true in DeidentifyConfig.

Annotation

Required. The annotation resource which updates the resource on the server. Only fields listed in update_mask are applied.

Authorization requires the following IAM permission on the specified resource annotation:

• healthcare.annotations.update

FieldMask

Required. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

AnnotationStore

Required. The Annotation store resource that updates the resource on the server. Only updating labels is supported.

Authorization requires the following IAM permission on the specified resource annotationStore:

• healthcare.annotationStores.update

FieldMask

Required. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask