PlagiarismService

class PlagiarismService

Methods

get	Get a .models.PlagiarismRun.
delete	Delete a given plagiarism run and all its cases.
get_providers	Get all plagiarism providers for this instance.
get_case	Get a single plagiarism case.
get_log	Get the log of a plagiarism run.
get_matches	Get the matches in a plagiarism case.
get_cases	Get all the .models.PlagiarismCase`s for the given `.models.PlagiarismRun.

get(*, plagiarism_id)

Get a .models.PlagiarismRun.

Parameters:

• plagiarism_id (int) – The of the plagiarism run.

• self (PlagiarismService[AuthenticatedClient]) –

Returns:

An single plagiarism run.

Return type:

PlagiarismRun

delete(*, plagiarism_id)

Delete a given plagiarism run and all its cases.

This is irreversible, so make sure the user really wants this!

Parameters:

• plagiarism_id (int) – The id of the run to delete.

• self (PlagiarismService[AuthenticatedClient]) –

Returns:

Nothing.

Return type:

None

get_providers(*, page_size=20)

Get all plagiarism providers for this instance.

Parameters:

page_size (int) – The size of a single page, maximum is 50.

Returns:

An array of plagiarism providers.

Return type:

Response[Mapping[str, Any]]

get_case(*, plagiarism_id, case_id)

Get a single plagiarism case.

Parameters:

• plagiarism_id (int) – The id of the run the case should belong to.

• case_id (int) – The id of the case requested.

• self (PlagiarismService[AuthenticatedClient]) –

Returns:

The requested case.

Return type:

PlagiarismCase

get_log(*, plagiarism_id)

Get the log of a plagiarism run.

Parameters:

• plagiarism_id (int) – The id of the run of which you want to get the log.

• self (PlagiarismService[AuthenticatedClient]) –

Returns:

The log of the run.

Return type:

bytes

get_matches(*, plagiarism_id, case_id, page_size=20)

Get the matches in a plagiarism case.

Parameters:

• plagiarism_id (int) – The id of the run the case should belong to.

• case_id (int) – The id of the case requested.

• page_size (int) – The size of a single page, maximum is 50.

• self (PlagiarismService[AuthenticatedClient]) –

Returns:

The matches of this case, ordered by id.

Return type:

Response[PlagiarismMatch]

get_cases(*, plagiarism_id, q='', page_size=20)

Get all the .models.PlagiarismCase`s for the given `.models.PlagiarismRun.

Parameters:

• plagiarism_id (int) – The of the plagiarism run.

• q (str) – Search the cases based on this value.

• page_size (int) – The size of a single page, maximum is 50.

• self (PlagiarismService[AuthenticatedClient]) –

Returns:

An array of plagiarism cases.

Return type:

Response[PlagiarismCase]