MLCandidateSetMixin

MLCandidateSetMixin#

class MLCandidateSetMixin#

Bases: object

Methods Summary

delete_candidate_set(project_id, ...)

Delete Candidate Set

get_candidate_set(project_id, candidate_set_id)

Return single Candidate Set.

get_candidate_sets(project_id)

Return all Candidate Sets for a project.

modify_candidate_set(project_id, ...[, query])

Modify an existing Candidate Set.

new_candidate_set(project_id, name, query)

Create a new Candidate Set.

Methods Documentation

delete_candidate_set(project_id, candidate_set_id)#

Delete Candidate Set

Parameters:

  • project_id – Id of the Squirro project.

  • candidate_set_id – Id of the Candidate Set.

get_candidate_set(project_id, candidate_set_id)#

Return single Candidate Set.

Parameters:

  • project_id – Id of the Squirro project.

  • candidate_set_id – id of the candidate set.

get_candidate_sets(project_id)#

Return all Candidate Sets for a project.

Parameters:

project_id – Id of the Squirro project.

modify_candidate_set(project_id, candidate_set_id, name, query=None)#

Modify an existing Candidate Set.

Parameters:

  • project_id – Id of the Squirro project.

  • candidate_set_id – Id of the Candidate Set.

  • name – Name of Candidate Set.

  • query – candidate set query to be sobstitute.

new_candidate_set(project_id, name, query)#

Create a new Candidate Set.

Parameters:

  • project_id – Id of the Squirro project.

  • name – Name of the Candidate Set.

  • query – Candidate Set Query.

Contents