1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="healthcare_v1beta1.html">Cloud Healthcare API</a> . <a href="healthcare_v1beta1.projects.html">projects</a> . <a href="healthcare_v1beta1.projects.locations.html">locations</a> . <a href="healthcare_v1beta1.projects.locations.datasets.html">datasets</a> . <a href="healthcare_v1beta1.projects.locations.datasets.annotationStores.html">annotationStores</a> . <a href="healthcare_v1beta1.projects.locations.datasets.annotationStores.annotations.html">annotations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new Annotation record. It is valid to create Annotation objects for the same source more than once since a unique ID is assigned to each record by this service.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an Annotation or returns NOT_FOUND if it does not exist.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an Annotation.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the Annotations in the given Annotation store for a source resource.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the Annotation.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a new Annotation record. It is valid to create Annotation objects for the same source more than once since a unique ID is assigned to each record by this service.
Args:
parent: string, Required. The name of the Annotation store this annotation belongs to. For example, `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore`. (required)
body: object, The request body.
The object takes the form of:
{ # An annotation record.
"annotationSource": { # AnnotationSource holds the source information of the annotation. # Required. Details of the source.
"cloudHealthcareSource": { # Cloud Healthcare API resource. # Cloud Healthcare API resource.
"name": "A String", # Full path of a Cloud Healthcare API resource.
},
},
"customData": { # Additional information for this annotation record, such as annotator and verifier information or study campaign.
"a_key": "A String",
},
"imageAnnotation": { # Image annotation. # Annotations for images. For example, bounding polygons.
"boundingPolys": [ # The list of polygons outlining the sensitive regions in the image.
{ # A bounding polygon for the detected image annotation.
"label": "A String", # A description of this polygon.
"vertices": [ # List of the vertices of this polygon.
{ # A 2D coordinate in an image. The origin is the top-left.
"x": 3.14, # X coordinate.
"y": 3.14, # Y coordinate.
},
],
},
],
"frameIndex": 42, # 0-based index of the image frame. For example, an image frame in a DICOM instance.
},
"name": "A 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}`.
"resourceAnnotation": { # Resource level annotation. # Annotations for resource. For example, classification tags.
"label": "A String", # A description of the annotation record.
},
"textAnnotation": { # A TextAnnotation specifies a text range that includes sensitive information. # Annotations for sensitive texts. For example, a range that describes the location of sensitive text.
"details": { # 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}
"a_key": { # Contains multiple sensitive information findings for each resource slice.
"findings": [
{
"end": "A String", # Zero-based ending index of the found text, exclusively.
"infoType": "A String", # The type of information stored in this text range. For example, HumanName, BirthDate, or Address.
"quote": "A String", # The snippet of the sensitive text. This field is only populated during deidentification if `store_quote` is set to true in DeidentifyConfig.
"start": "A String", # Zero-based starting index of the found text, inclusively.
},
],
},
},
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An annotation record.
"annotationSource": { # AnnotationSource holds the source information of the annotation. # Required. Details of the source.
"cloudHealthcareSource": { # Cloud Healthcare API resource. # Cloud Healthcare API resource.
"name": "A String", # Full path of a Cloud Healthcare API resource.
},
},
"customData": { # Additional information for this annotation record, such as annotator and verifier information or study campaign.
"a_key": "A String",
},
"imageAnnotation": { # Image annotation. # Annotations for images. For example, bounding polygons.
"boundingPolys": [ # The list of polygons outlining the sensitive regions in the image.
{ # A bounding polygon for the detected image annotation.
"label": "A String", # A description of this polygon.
"vertices": [ # List of the vertices of this polygon.
{ # A 2D coordinate in an image. The origin is the top-left.
"x": 3.14, # X coordinate.
"y": 3.14, # Y coordinate.
},
],
},
],
"frameIndex": 42, # 0-based index of the image frame. For example, an image frame in a DICOM instance.
},
"name": "A 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}`.
"resourceAnnotation": { # Resource level annotation. # Annotations for resource. For example, classification tags.
"label": "A String", # A description of the annotation record.
},
"textAnnotation": { # A TextAnnotation specifies a text range that includes sensitive information. # Annotations for sensitive texts. For example, a range that describes the location of sensitive text.
"details": { # 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}
"a_key": { # Contains multiple sensitive information findings for each resource slice.
"findings": [
{
"end": "A String", # Zero-based ending index of the found text, exclusively.
"infoType": "A String", # The type of information stored in this text range. For example, HumanName, BirthDate, or Address.
"quote": "A String", # The snippet of the sensitive text. This field is only populated during deidentification if `store_quote` is set to true in DeidentifyConfig.
"start": "A String", # Zero-based starting index of the found text, inclusively.
},
],
},
},
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes an Annotation or returns NOT_FOUND if it does not exist.
Args:
name: string, Required. The resource name of the Annotation to delete. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets an Annotation.
Args:
name: string, Required. The resource name of the Annotation to retrieve. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An annotation record.
"annotationSource": { # AnnotationSource holds the source information of the annotation. # Required. Details of the source.
"cloudHealthcareSource": { # Cloud Healthcare API resource. # Cloud Healthcare API resource.
"name": "A String", # Full path of a Cloud Healthcare API resource.
},
},
"customData": { # Additional information for this annotation record, such as annotator and verifier information or study campaign.
"a_key": "A String",
},
"imageAnnotation": { # Image annotation. # Annotations for images. For example, bounding polygons.
"boundingPolys": [ # The list of polygons outlining the sensitive regions in the image.
{ # A bounding polygon for the detected image annotation.
"label": "A String", # A description of this polygon.
"vertices": [ # List of the vertices of this polygon.
{ # A 2D coordinate in an image. The origin is the top-left.
"x": 3.14, # X coordinate.
"y": 3.14, # Y coordinate.
},
],
},
],
"frameIndex": 42, # 0-based index of the image frame. For example, an image frame in a DICOM instance.
},
"name": "A 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}`.
"resourceAnnotation": { # Resource level annotation. # Annotations for resource. For example, classification tags.
"label": "A String", # A description of the annotation record.
},
"textAnnotation": { # A TextAnnotation specifies a text range that includes sensitive information. # Annotations for sensitive texts. For example, a range that describes the location of sensitive text.
"details": { # 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}
"a_key": { # Contains multiple sensitive information findings for each resource slice.
"findings": [
{
"end": "A String", # Zero-based ending index of the found text, exclusively.
"infoType": "A String", # The type of information stored in this text range. For example, HumanName, BirthDate, or Address.
"quote": "A String", # The snippet of the sensitive text. This field is only populated during deidentification if `store_quote` is set to true in DeidentifyConfig.
"start": "A String", # Zero-based starting index of the found text, inclusively.
},
],
},
},
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
<pre>Lists the Annotations in the given Annotation store for a source resource.
Args:
parent: string, Required. Name of the Annotation store to retrieve Annotations from. (required)
filter: 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`.
pageSize: integer, Limit on the number of Annotations to return in a single response. If not specified, 100 is used. May not be larger than 1000.
pageToken: string, The next_page_token value returned from the previous List request, if any.
view: string, Controls which fields are populated in the response.
Allowed values
ANNOTATION_VIEW_UNSPECIFIED - Same as BASIC.
ANNOTATION_VIEW_BASIC - Only `name`, `annotation_source` and `custom_data` fields are populated.
ANNOTATION_VIEW_FULL - All fields are populated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Lists the Annotations in the specified Annotation store.
"annotations": [ # 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.
{ # An annotation record.
"annotationSource": { # AnnotationSource holds the source information of the annotation. # Required. Details of the source.
"cloudHealthcareSource": { # Cloud Healthcare API resource. # Cloud Healthcare API resource.
"name": "A String", # Full path of a Cloud Healthcare API resource.
},
},
"customData": { # Additional information for this annotation record, such as annotator and verifier information or study campaign.
"a_key": "A String",
},
"imageAnnotation": { # Image annotation. # Annotations for images. For example, bounding polygons.
"boundingPolys": [ # The list of polygons outlining the sensitive regions in the image.
{ # A bounding polygon for the detected image annotation.
"label": "A String", # A description of this polygon.
"vertices": [ # List of the vertices of this polygon.
{ # A 2D coordinate in an image. The origin is the top-left.
"x": 3.14, # X coordinate.
"y": 3.14, # Y coordinate.
},
],
},
],
"frameIndex": 42, # 0-based index of the image frame. For example, an image frame in a DICOM instance.
},
"name": "A 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}`.
"resourceAnnotation": { # Resource level annotation. # Annotations for resource. For example, classification tags.
"label": "A String", # A description of the annotation record.
},
"textAnnotation": { # A TextAnnotation specifies a text range that includes sensitive information. # Annotations for sensitive texts. For example, a range that describes the location of sensitive text.
"details": { # 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}
"a_key": { # Contains multiple sensitive information findings for each resource slice.
"findings": [
{
"end": "A String", # Zero-based ending index of the found text, exclusively.
"infoType": "A String", # The type of information stored in this text range. For example, HumanName, BirthDate, or Address.
"quote": "A String", # The snippet of the sensitive text. This field is only populated during deidentification if `store_quote` is set to true in DeidentifyConfig.
"start": "A String", # Zero-based starting index of the found text, inclusively.
},
],
},
},
},
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results or empty if there are no more results in the list.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the Annotation.
Args:
name: 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}`. (required)
body: object, The request body.
The object takes the form of:
{ # An annotation record.
"annotationSource": { # AnnotationSource holds the source information of the annotation. # Required. Details of the source.
"cloudHealthcareSource": { # Cloud Healthcare API resource. # Cloud Healthcare API resource.
"name": "A String", # Full path of a Cloud Healthcare API resource.
},
},
"customData": { # Additional information for this annotation record, such as annotator and verifier information or study campaign.
"a_key": "A String",
},
"imageAnnotation": { # Image annotation. # Annotations for images. For example, bounding polygons.
"boundingPolys": [ # The list of polygons outlining the sensitive regions in the image.
{ # A bounding polygon for the detected image annotation.
"label": "A String", # A description of this polygon.
"vertices": [ # List of the vertices of this polygon.
{ # A 2D coordinate in an image. The origin is the top-left.
"x": 3.14, # X coordinate.
"y": 3.14, # Y coordinate.
},
],
},
],
"frameIndex": 42, # 0-based index of the image frame. For example, an image frame in a DICOM instance.
},
"name": "A 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}`.
"resourceAnnotation": { # Resource level annotation. # Annotations for resource. For example, classification tags.
"label": "A String", # A description of the annotation record.
},
"textAnnotation": { # A TextAnnotation specifies a text range that includes sensitive information. # Annotations for sensitive texts. For example, a range that describes the location of sensitive text.
"details": { # 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}
"a_key": { # Contains multiple sensitive information findings for each resource slice.
"findings": [
{
"end": "A String", # Zero-based ending index of the found text, exclusively.
"infoType": "A String", # The type of information stored in this text range. For example, HumanName, BirthDate, or Address.
"quote": "A String", # The snippet of the sensitive text. This field is only populated during deidentification if `store_quote` is set to true in DeidentifyConfig.
"start": "A String", # Zero-based starting index of the found text, inclusively.
},
],
},
},
},
}
updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An annotation record.
"annotationSource": { # AnnotationSource holds the source information of the annotation. # Required. Details of the source.
"cloudHealthcareSource": { # Cloud Healthcare API resource. # Cloud Healthcare API resource.
"name": "A String", # Full path of a Cloud Healthcare API resource.
},
},
"customData": { # Additional information for this annotation record, such as annotator and verifier information or study campaign.
"a_key": "A String",
},
"imageAnnotation": { # Image annotation. # Annotations for images. For example, bounding polygons.
"boundingPolys": [ # The list of polygons outlining the sensitive regions in the image.
{ # A bounding polygon for the detected image annotation.
"label": "A String", # A description of this polygon.
"vertices": [ # List of the vertices of this polygon.
{ # A 2D coordinate in an image. The origin is the top-left.
"x": 3.14, # X coordinate.
"y": 3.14, # Y coordinate.
},
],
},
],
"frameIndex": 42, # 0-based index of the image frame. For example, an image frame in a DICOM instance.
},
"name": "A 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}`.
"resourceAnnotation": { # Resource level annotation. # Annotations for resource. For example, classification tags.
"label": "A String", # A description of the annotation record.
},
"textAnnotation": { # A TextAnnotation specifies a text range that includes sensitive information. # Annotations for sensitive texts. For example, a range that describes the location of sensitive text.
"details": { # 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}
"a_key": { # Contains multiple sensitive information findings for each resource slice.
"findings": [
{
"end": "A String", # Zero-based ending index of the found text, exclusively.
"infoType": "A String", # The type of information stored in this text range. For example, HumanName, BirthDate, or Address.
"quote": "A String", # The snippet of the sensitive text. This field is only populated during deidentification if `store_quote` is set to true in DeidentifyConfig.
"start": "A String", # Zero-based starting index of the found text, inclusively.
},
],
},
},
},
}</pre>
</div>
</body></html>
|
