Element¶
arkindex_worker.worker.element ¶
ElementsWorker methods for elements and element types.
ElementType ¶
ElementMixin ¶
Bases: object
create_required_types ¶
create_required_types(element_types)
Creates given element types in the corpus.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
corpus |
Corpus
|
The corpus to create types on. |
required |
element_types |
List[ElementType]
|
The missing element types to create. |
required |
Source code in arkindex_worker/worker/element.py
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
|
check_required_types ¶
check_required_types(*type_slugs, create_missing=False)
Check that a corpus has a list of required element types, and raise an exception if any of them are missing.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
*type_slugs |
str
|
Type slugs to look for. |
()
|
create_missing |
bool
|
Whether missing types should be created. |
False
|
Returns:
Type | Description |
---|---|
bool
|
Whether all of the specified type slugs have been found. |
Raises:
Type | Description |
---|---|
MissingTypeError
|
If any of the specified type slugs were not found. |
Source code in arkindex_worker/worker/element.py
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 |
|
create_sub_element ¶
create_sub_element(
element,
type,
name,
polygon,
confidence=None,
slim_output=True,
)
Create a child element on the given element through the API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
Element
|
The parent element. |
required |
type |
str
|
Slug of the element type for this child element. |
required |
name |
str
|
Name of the child element. |
required |
polygon |
List[List[Union[int, float]]]
|
Polygon of the child element. |
required |
confidence |
Optional[float]
|
Optional confidence score, between 0.0 and 1.0. |
None
|
Returns:
Type | Description |
---|---|
str
|
UUID of the created element. |
Source code in arkindex_worker/worker/element.py
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 |
|
create_elements ¶
create_elements(parent, elements)
Create child elements on the given element in a single API request.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
parent |
Union[Element, CachedElement]
|
Parent element for all the new child elements. The parent must have an image and a polygon. |
required |
elements |
List[Dict[str, Union[str, List[List[Union[int, float]]], float, None]]]
|
List of dicts, one per element. Each dict can have the following keys: name (str) Required. Name of the element. type (str) Required. Slug of the element type for this element. polygon (list(list(int or float))) Required. Polygon for this child element. Must have at least three points, with each point having two non-negative coordinates and being inside of the parent element’s image. confidence (float or None) Optional confidence score, between 0.0 and 1.0. |
required |
Returns:
Type | Description |
---|---|
List[Dict[str, str]]
|
List of dicts, with each dict having a single key, |
Source code in arkindex_worker/worker/element.py
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 |
|
update_element ¶
update_element(
element,
type=None,
name=None,
polygon=None,
confidence=None,
)
Partially update an element through the API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
Union[Element, CachedElement]
|
The element to update. |
required |
type |
Optional[str]
|
Optional new slug type of the element. |
None
|
name |
Optional[str]
|
Optional new name of the element. |
None
|
polygon |
Optional[List[List[Union[int, float]]]]
|
Optional new polygon of the element. |
None
|
confidence |
Optional[float]
|
Optional new confidence score, between 0.0 and 1.0. |
None
|
Returns:
Type | Description |
---|---|
dict
|
A dict from the |
Source code in arkindex_worker/worker/element.py
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 |
|
list_element_children ¶
list_element_children(
element,
folder=None,
name=None,
recursive=None,
transcription_worker_version=None,
transcription_worker_run=None,
type=None,
with_classes=None,
with_corpus=None,
with_metadata=None,
with_has_children=None,
with_zone=None,
worker_version=None,
worker_run=None,
)
List children of an element.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
Union[Element, CachedElement]
|
Parent element to find children of. |
required |
folder |
Optional[bool]
|
Restrict to or exclude elements with folder types. This parameter is not supported when caching is enabled. |
None
|
name |
Optional[str]
|
Restrict to elements whose name contain a substring (case-insensitive). This parameter is not supported when caching is enabled. |
None
|
recursive |
Optional[bool]
|
Look for elements recursively (grand-children, etc.) This parameter is not supported when caching is enabled. |
None
|
transcription_worker_version |
Optional[Union[str, bool]]
|
Restrict to elements that have a transcription created by a worker version with this UUID. This parameter is not supported when caching is enabled. |
None
|
transcription_worker_run |
Optional[Union[str, bool]]
|
Restrict to elements that have a transcription created by a worker run with this UUID. This parameter is not supported when caching is enabled. |
None
|
type |
Optional[str]
|
Restrict to elements with a specific type slug This parameter is not supported when caching is enabled. |
None
|
with_classes |
Optional[bool]
|
Include each element’s classifications in the response. This parameter is not supported when caching is enabled. |
None
|
with_corpus |
Optional[bool]
|
Include each element’s corpus in the response. This parameter is not supported when caching is enabled. |
None
|
with_has_children |
Optional[bool]
|
Include the |
None
|
with_metadata |
Optional[bool]
|
Include each element’s metadata in the response. This parameter is not supported when caching is enabled. |
None
|
with_zone |
Optional[bool]
|
Include the |
None
|
worker_version |
Optional[Union[str, bool]]
|
Restrict to elements created by a worker version with this UUID. |
None
|
worker_run |
Optional[Union[str, bool]]
|
Restrict to elements created by a worker run with this UUID. |
None
|
Returns:
Type | Description |
---|---|
Union[Iterable[dict], Iterable[CachedElement]]
|
An iterable of dicts from the |
Source code in arkindex_worker/worker/element.py
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 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 |
|
list_element_parents ¶
list_element_parents(
element,
folder=None,
name=None,
recursive=None,
transcription_worker_version=None,
transcription_worker_run=None,
type=None,
with_classes=None,
with_corpus=None,
with_metadata=None,
with_has_children=None,
with_zone=None,
worker_version=None,
worker_run=None,
)
List parents of an element.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
Union[Element, CachedElement]
|
Child element to find parents of. |
required |
folder |
Optional[bool]
|
Restrict to or exclude elements with folder types. This parameter is not supported when caching is enabled. |
None
|
name |
Optional[str]
|
Restrict to elements whose name contain a substring (case-insensitive). This parameter is not supported when caching is enabled. |
None
|
recursive |
Optional[bool]
|
Look for elements recursively (grand-children, etc.) This parameter is not supported when caching is enabled. |
None
|
transcription_worker_version |
Optional[Union[str, bool]]
|
Restrict to elements that have a transcription created by a worker version with this UUID. This parameter is not supported when caching is enabled. |
None
|
transcription_worker_run |
Optional[Union[str, bool]]
|
Restrict to elements that have a transcription created by a worker run with this UUID. This parameter is not supported when caching is enabled. |
None
|
type |
Optional[str]
|
Restrict to elements with a specific type slug This parameter is not supported when caching is enabled. |
None
|
with_classes |
Optional[bool]
|
Include each element’s classifications in the response. This parameter is not supported when caching is enabled. |
None
|
with_corpus |
Optional[bool]
|
Include each element’s corpus in the response. This parameter is not supported when caching is enabled. |
None
|
with_has_children |
Optional[bool]
|
Include the |
None
|
with_metadata |
Optional[bool]
|
Include each element’s metadata in the response. This parameter is not supported when caching is enabled. |
None
|
with_zone |
Optional[bool]
|
Include the |
None
|
worker_version |
Optional[Union[str, bool]]
|
Restrict to elements created by a worker version with this UUID. |
None
|
worker_run |
Optional[Union[str, bool]]
|
Restrict to elements created by a worker run with this UUID. |
None
|
Returns:
Type | Description |
---|---|
Union[Iterable[dict], Iterable[CachedElement]]
|
An iterable of dicts from the |
Source code in arkindex_worker/worker/element.py
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 |
|
create_required_types ¶
create_required_types(element_types)
Creates given element types in the corpus.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
corpus |
Corpus
|
The corpus to create types on. |
required |
element_types |
List[ElementType]
|
The missing element types to create. |
required |
Source code in arkindex_worker/worker/element.py
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
|
check_required_types ¶
check_required_types(*type_slugs, create_missing=False)
Check that a corpus has a list of required element types, and raise an exception if any of them are missing.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
*type_slugs |
str
|
Type slugs to look for. |
()
|
create_missing |
bool
|
Whether missing types should be created. |
False
|
Returns:
Type | Description |
---|---|
bool
|
Whether all of the specified type slugs have been found. |
Raises:
Type | Description |
---|---|
MissingTypeError
|
If any of the specified type slugs were not found. |
Source code in arkindex_worker/worker/element.py
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 |
|
create_sub_element ¶
create_sub_element(
element,
type,
name,
polygon,
confidence=None,
slim_output=True,
)
Create a child element on the given element through the API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
Element
|
The parent element. |
required |
type |
str
|
Slug of the element type for this child element. |
required |
name |
str
|
Name of the child element. |
required |
polygon |
List[List[Union[int, float]]]
|
Polygon of the child element. |
required |
confidence |
Optional[float]
|
Optional confidence score, between 0.0 and 1.0. |
None
|
Returns:
Type | Description |
---|---|
str
|
UUID of the created element. |
Source code in arkindex_worker/worker/element.py
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 |
|
create_elements ¶
create_elements(parent, elements)
Create child elements on the given element in a single API request.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
parent |
Union[Element, CachedElement]
|
Parent element for all the new child elements. The parent must have an image and a polygon. |
required |
elements |
List[Dict[str, Union[str, List[List[Union[int, float]]], float, None]]]
|
List of dicts, one per element. Each dict can have the following keys: name (str) Required. Name of the element. type (str) Required. Slug of the element type for this element. polygon (list(list(int or float))) Required. Polygon for this child element. Must have at least three points, with each point having two non-negative coordinates and being inside of the parent element’s image. confidence (float or None) Optional confidence score, between 0.0 and 1.0. |
required |
Returns:
Type | Description |
---|---|
List[Dict[str, str]]
|
List of dicts, with each dict having a single key, |
Source code in arkindex_worker/worker/element.py
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 |
|
update_element ¶
update_element(
element,
type=None,
name=None,
polygon=None,
confidence=None,
)
Partially update an element through the API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
Union[Element, CachedElement]
|
The element to update. |
required |
type |
Optional[str]
|
Optional new slug type of the element. |
None
|
name |
Optional[str]
|
Optional new name of the element. |
None
|
polygon |
Optional[List[List[Union[int, float]]]]
|
Optional new polygon of the element. |
None
|
confidence |
Optional[float]
|
Optional new confidence score, between 0.0 and 1.0. |
None
|
Returns:
Type | Description |
---|---|
dict
|
A dict from the |
Source code in arkindex_worker/worker/element.py
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 |
|
list_element_children ¶
list_element_children(
element,
folder=None,
name=None,
recursive=None,
transcription_worker_version=None,
transcription_worker_run=None,
type=None,
with_classes=None,
with_corpus=None,
with_metadata=None,
with_has_children=None,
with_zone=None,
worker_version=None,
worker_run=None,
)
List children of an element.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
Union[Element, CachedElement]
|
Parent element to find children of. |
required |
folder |
Optional[bool]
|
Restrict to or exclude elements with folder types. This parameter is not supported when caching is enabled. |
None
|
name |
Optional[str]
|
Restrict to elements whose name contain a substring (case-insensitive). This parameter is not supported when caching is enabled. |
None
|
recursive |
Optional[bool]
|
Look for elements recursively (grand-children, etc.) This parameter is not supported when caching is enabled. |
None
|
transcription_worker_version |
Optional[Union[str, bool]]
|
Restrict to elements that have a transcription created by a worker version with this UUID. This parameter is not supported when caching is enabled. |
None
|
transcription_worker_run |
Optional[Union[str, bool]]
|
Restrict to elements that have a transcription created by a worker run with this UUID. This parameter is not supported when caching is enabled. |
None
|
type |
Optional[str]
|
Restrict to elements with a specific type slug This parameter is not supported when caching is enabled. |
None
|
with_classes |
Optional[bool]
|
Include each element’s classifications in the response. This parameter is not supported when caching is enabled. |
None
|
with_corpus |
Optional[bool]
|
Include each element’s corpus in the response. This parameter is not supported when caching is enabled. |
None
|
with_has_children |
Optional[bool]
|
Include the |
None
|
with_metadata |
Optional[bool]
|
Include each element’s metadata in the response. This parameter is not supported when caching is enabled. |
None
|
with_zone |
Optional[bool]
|
Include the |
None
|
worker_version |
Optional[Union[str, bool]]
|
Restrict to elements created by a worker version with this UUID. |
None
|
worker_run |
Optional[Union[str, bool]]
|
Restrict to elements created by a worker run with this UUID. |
None
|
Returns:
Type | Description |
---|---|
Union[Iterable[dict], Iterable[CachedElement]]
|
An iterable of dicts from the |
Source code in arkindex_worker/worker/element.py
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 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 |
|
list_element_parents ¶
list_element_parents(
element,
folder=None,
name=None,
recursive=None,
transcription_worker_version=None,
transcription_worker_run=None,
type=None,
with_classes=None,
with_corpus=None,
with_metadata=None,
with_has_children=None,
with_zone=None,
worker_version=None,
worker_run=None,
)
List parents of an element.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
element |
Union[Element, CachedElement]
|
Child element to find parents of. |
required |
folder |
Optional[bool]
|
Restrict to or exclude elements with folder types. This parameter is not supported when caching is enabled. |
None
|
name |
Optional[str]
|
Restrict to elements whose name contain a substring (case-insensitive). This parameter is not supported when caching is enabled. |
None
|
recursive |
Optional[bool]
|
Look for elements recursively (grand-children, etc.) This parameter is not supported when caching is enabled. |
None
|
transcription_worker_version |
Optional[Union[str, bool]]
|
Restrict to elements that have a transcription created by a worker version with this UUID. This parameter is not supported when caching is enabled. |
None
|
transcription_worker_run |
Optional[Union[str, bool]]
|
Restrict to elements that have a transcription created by a worker run with this UUID. This parameter is not supported when caching is enabled. |
None
|
type |
Optional[str]
|
Restrict to elements with a specific type slug This parameter is not supported when caching is enabled. |
None
|
with_classes |
Optional[bool]
|
Include each element’s classifications in the response. This parameter is not supported when caching is enabled. |
None
|
with_corpus |
Optional[bool]
|
Include each element’s corpus in the response. This parameter is not supported when caching is enabled. |
None
|
with_has_children |
Optional[bool]
|
Include the |
None
|
with_metadata |
Optional[bool]
|
Include each element’s metadata in the response. This parameter is not supported when caching is enabled. |
None
|
with_zone |
Optional[bool]
|
Include the |
None
|
worker_version |
Optional[Union[str, bool]]
|
Restrict to elements created by a worker version with this UUID. |
None
|
worker_run |
Optional[Union[str, bool]]
|
Restrict to elements created by a worker run with this UUID. |
None
|
Returns:
Type | Description |
---|---|
Union[Iterable[dict], Iterable[CachedElement]]
|
An iterable of dicts from the |
Source code in arkindex_worker/worker/element.py
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 |
|