Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • arkindex/api-client
1 result
Show changes
Commits on Source (2)
Hide whitespace changes
Inline Side-by-side
Showing
with 456 additions and 4 deletions
arkindex/schema.yml
View file @ 6f9c1cdd
......@@ -121,6 +121,43 @@ paths:
description: ''
tags:
- ml
/api/v1/classifications/selection/:
post:
description: Create multiple classifications at once for a list of selected
elements for a specific corpus.
operationId: CreateClassificationsSelection
parameters: []
requestBody:
content:
application/json:
schema:
properties:
corpus_id:
format: uuid
type: string
ml_class:
type: string
required:
- ml_class
- corpus_id
x-name: body
responses:
'200':
content:
application/json:
schema:
properties:
corpus_id:
format: uuid
type: string
ml_class:
type: string
required:
- ml_class
- corpus_id
description: ''
tags:
- ml
/api/v1/classifications/{id}/reject/:
put:
description: Reject an existing classification.
......@@ -3431,6 +3468,421 @@ paths:
security: []
tags:
- search
/api/v1/elements/selection/:
delete:
description: Remove a specific element or delete any selection
operationId: RemoveSelection
parameters:
- description: Class
in: query
name: ml_class
required: false
schema:
type: string
- description: ml_class_unvalidated
in: query
name: ml_class_unvalidated
required: false
schema:
type: string
requestBody:
content:
application/json:
schema:
properties:
id:
format: uuid
type: string
x-name: body
responses:
'204':
description: ''
security: &id001 []
tags:
- elements
get:
description: List all elements selected
operationId: ListSelection
parameters:
- description: A page number within the paginated result set.
in: query
name: page
required: false
schema:
type: integer
- description: Number of results to return per page.
in: query
name: page_size
required: false
schema:
type: integer
- description: Class
in: query
name: ml_class
required: false
schema:
type: string
- description: ml_class_unvalidated
in: query
name: ml_class_unvalidated
required: false
schema:
type: string
- description: List best classifications for each element. If not set, elements
best_classes field will always be null
in: query
name: best_classes
required: false
schema:
type: boolean
responses:
'200':
content:
application/json:
schema:
properties:
count:
example: 123
type: integer
next:
nullable: true
type: string
number:
example: 123
type: integer
previous:
nullable: true
type: string
results:
items:
properties:
best_classes:
items:
properties:
best:
readOnly: true
type: boolean
confidence:
readOnly: true
type: number
id:
format: uuid
readOnly: true
type: string
ml_class:
properties:
id:
format: uuid
type: string
name:
maxLength: 100
type: string
required:
- name
type: object
source:
properties:
id:
format: uuid
type: string
internal:
type: boolean
name:
maxLength: 100
type: string
revision:
maxLength: 100
type: string
slug:
maxLength: 100
type: string
type:
enum:
- classifier
- recognizer
- ner
- dla
- word-segmenter
required:
- type
- slug
- name
- revision
- internal
type: object
state:
enum:
- pending
- validated
- rejected
required:
- source
- ml_class
- state
readOnly: true
type: array
corpus:
properties:
id:
format: uuid
type: string
name:
maxLength: 250
type: string
public:
type: boolean
readOnly: true
required:
- name
type: object
id:
format: uuid
readOnly: true
type: string
name:
maxLength: 250
type: string
thumbnail_put_url:
readOnly: true
type: string
thumbnail_url:
readOnly: true
type: string
type:
type: string
zone:
properties:
center:
items:
type: integer
type: array
id:
format: uuid
type: string
image:
properties:
height:
readOnly: true
type: integer
id:
format: uuid
readOnly: true
type: string
path:
readOnly: true
type: string
s3_url:
readOnly: true
type: string
status:
enum:
- checked
- unchecked
- error
url:
readOnly: true
type: string
width:
readOnly: true
type: integer
required:
- status
type: object
polygon:
items:
type: array
type: array
url:
readOnly: true
type: string
readOnly: true
required:
- polygon
- center
- image
type: object
required:
- type
- name
type: array
type: object
description: ''
security: *id001
tags:
- elements
post:
description: Add a specific element
operationId: AddSelection
parameters: []
requestBody:
content:
application/json:
schema:
properties:
id:
format: uuid
type: string
required:
- id
x-name: body
responses:
'200':
content:
application/json:
schema:
properties:
best_classes:
items:
properties:
best:
readOnly: true
type: boolean
confidence:
readOnly: true
type: number
id:
format: uuid
readOnly: true
type: string
ml_class:
properties:
id:
format: uuid
type: string
name:
maxLength: 100
type: string
required:
- name
type: object
source:
properties:
id:
format: uuid
type: string
internal:
type: boolean
name:
maxLength: 100
type: string
revision:
maxLength: 100
type: string
slug:
maxLength: 100
type: string
type:
enum:
- classifier
- recognizer
- ner
- dla
- word-segmenter
required:
- type
- slug
- name
- revision
- internal
type: object
state:
enum:
- pending
- validated
- rejected
required:
- source
- ml_class
- state
readOnly: true
type: array
corpus:
properties:
id:
format: uuid
type: string
name:
maxLength: 250
type: string
public:
type: boolean
readOnly: true
required:
- name
type: object
id:
format: uuid
readOnly: true
type: string
name:
maxLength: 250
type: string
thumbnail_put_url:
readOnly: true
type: string
thumbnail_url:
readOnly: true
type: string
type:
type: string
zone:
properties:
center:
items:
type: integer
type: array
id:
format: uuid
type: string
image:
properties:
height:
readOnly: true
type: integer
id:
format: uuid
readOnly: true
type: string
path:
readOnly: true
type: string
s3_url:
readOnly: true
type: string
status:
enum:
- checked
- unchecked
- error
url:
readOnly: true
type: string
width:
readOnly: true
type: integer
required:
- status
type: object
polygon:
items:
type: array
type: array
url:
readOnly: true
type: string
readOnly: true
required:
- polygon
- center
- image
type: object
required:
- type
- name
description: ''
security: *id001
tags:
- elements
/api/v1/elements/{id}/:
get:
description: List all parents and children of a single element
......@@ -9866,7 +10318,7 @@ paths:
- analyser
- regions
description: ''
tags: &id001
tags: &id002
- ml
put:
description: Add new regions from a machine learning tool; if this tool already
......@@ -9938,7 +10390,7 @@ paths:
- analyser
- regions
description: ''
tags: *id001
tags: *id002
/api/v1/region/{id}/:
get:
description: Retrieve detailed information about a region
......@@ -10199,7 +10651,7 @@ paths:
- recognizer
- transcriptions
x-name: body
responses: &id002
responses: &id003
'201':
description: All transcriptions have been created.
tags:
......@@ -10249,7 +10701,7 @@ paths:
- recognizer
- transcriptions
x-name: body
responses: *id002
responses: *id003
tags:
- ml
/api/v1/transcription/{id}/entities/:
......