/// <summary>
/// Create a Matching UI session to search for resumes or jobs that meet specific criteria
/// </summary>
/// <param name="sovClient">The SovrenClient</param>
/// <param name="indexesToQuery">The indexes to find results in. These must all be of the same type (resumes or jobs)</param>
/// <param name="query">The search query. A result must satisfy all of these criteria</param>
/// <param name="settings">The settings for this search request</param>
/// <param name="pagination">Pagination settings. If not specified the default will be used</param>
/// <exception cref="SovrenException">Thrown when an API error occurs</exception>
public static async Task <GenerateUIResponse> Search(
this SovrenClientWithUI sovClient,
IEnumerable <string> indexesToQuery,
FilterCriteria query,
SearchMatchSettings settings = null,
PaginationSettings pagination = null)
{
SearchRequest request = sovClient.InternalClient.CreateRequest(indexesToQuery, query, settings, pagination);
UISearchRequest uiRequest = new UISearchRequest(request, sovClient.UISessionOptions);
return(await sovClient.InternalClient.UISearch(uiRequest));
}
/// <summary>
/// Create a Matching UI session to score one or more target documents against a source job
/// </summary>
/// <param name="sovClient">The SovrenClient</param>
/// <param name="sourceJob">The source job</param>
/// <param name="targetDocuments">The target resumes/jobs</param>
/// <param name="preferredWeights">
/// The preferred category weights for scoring the results. If none are provided,
/// Sovren will determine the best values based on the source job
/// </param>
/// <param name="settings">Settings to be used for this scoring request</param>
/// <typeparam name="TTarget">Either <see cref="ParsedResumeWithId"/> or <see cref="ParsedJobWithId"/></typeparam>
/// <exception cref="SovrenException">Thrown when an API error occurs</exception>
public static async Task <GenerateUIResponse> BimetricScore <TTarget>(
this SovrenClientWithUI sovClient,
ParsedJobWithId sourceJob,
List <TTarget> targetDocuments,
CategoryWeights preferredWeights = null,
SearchMatchSettings settings = null) where TTarget : IParsedDocWithId
{
BimetricScoreJobRequest request = sovClient.InternalClient.CreateRequest(sourceJob, targetDocuments, preferredWeights, settings);
UIBimetricScoreJobRequest uiRequest = new UIBimetricScoreJobRequest(request, sovClient.UISessionOptions);
return(await sovClient.InternalClient.UIBimetricScore(uiRequest));
}
/// <summary>
/// Create a Matching UI session to find matches for a non-indexed job
/// </summary>
/// <param name="sovClient">The SovrenClient</param>
/// <param name="job">The job (generated by the Sovren Job Parser) to use as the source for a match query</param>
/// <param name="indexesToQuery">The indexes to find results in. These must all be of the same type (resumes or jobs)</param>
/// <param name="preferredWeights">
/// The preferred category weights for scoring the results. If none are provided,
/// Sovren will determine the best values based on the source job
/// </param>
/// <param name="filters">Any filters to apply prior to the match (a result must satisfy all the filters)</param>
/// <param name="settings">Settings for this match</param>
/// <param name="numResults">The number of results to show. If not specified, the default will be used.</param>
/// <exception cref="SovrenException">Thrown when an API error occurs</exception>
public static async Task <GenerateUIResponse> Match(
this SovrenClientWithUI sovClient,
ParsedJob job,
IEnumerable <string> indexesToQuery,
CategoryWeights preferredWeights = null,
FilterCriteria filters = null,
SearchMatchSettings settings = null,
int numResults = 0)
{
MatchJobRequest request = sovClient.InternalClient.CreateRequest(job, indexesToQuery, preferredWeights, filters, settings, numResults);
UIMatchJobRequest uiRequest = new UIMatchJobRequest(request, sovClient.UISessionOptions);
return(await sovClient.InternalClient.UIMatch(uiRequest));
}
/// <summary>
/// Create a Matching UI session to find matches for a resume or job that is already indexed
/// </summary>
/// <param name="sovClient">The SovrenClient</param>
/// <param name="indexId">The index containing the document you want to match</param>
/// <param name="documentId">The ID of the document to match</param>
/// <param name="indexesToQuery">The indexes to find results in. These must all be of the same type (resumes or jobs)</param>
/// <param name="preferredWeights">
/// The preferred category weights for scoring the results. If none are provided,
/// Sovren will determine the best values based on the source resume/job
/// </param>
/// <param name="filters">Any filters to apply prior to the match (a result must satisfy all the filters)</param>
/// <param name="settings">Settings for this match</param>
/// <param name="numResults">The number of results to show. If not specified, the default will be used.</param>
/// <exception cref="SovrenException">Thrown when an API error occurs</exception>
public static async Task <GenerateUIResponse> Match(
this SovrenClientWithUI sovClient,
string indexId,
string documentId,
IEnumerable <string> indexesToQuery,
CategoryWeights preferredWeights = null,
FilterCriteria filters = null,
SearchMatchSettings settings = null,
int numResults = 0)
{
MatchByDocumentIdOptions options = sovClient.InternalClient.CreateRequest(indexesToQuery, preferredWeights, filters, settings, numResults);
UIMatchByDocumentIdOptions uiOptions = new UIMatchByDocumentIdOptions(options, sovClient.UISessionOptions);
return(await sovClient.InternalClient.UIMatch(indexId, documentId, uiOptions));
}
/// <summary>
/// Create a Matching UI session to view a single result from an AI Matching API response
/// </summary>
/// <param name="sovClient">The SovrenClient</param>
/// <param name="matchResponse">The AI Matching API response containing the result you want to view</param>
/// <param name="matchId">The id of the specific result in the result set that you want to view</param>
/// <param name="sourceDocType">The type of document this result was scored against</param>
/// <param name="htmlDocument">Optionally, the HTML resume/job to display in the details view</param>
/// <exception cref="SovrenException">Thrown when an API error occurs</exception>
public static async Task <GenerateUIResponse> ViewDetails(
this SovrenClientWithUI sovClient,
MatchResponseValue matchResponse,
string matchId,
Models.Matching.IndexType sourceDocType,
string htmlDocument = null)
{
AIMatchDetails details = new AIMatchDetails
{
Result = matchResponse.Matches.Single(m => m.Id == matchId),
AppliedCategoryWeights = matchResponse.AppliedCategoryWeights,
SourceDocumentType = sourceDocType,
HtmlDocument = htmlDocument
};
UIMatchDetailsRequest uiRequest = new UIMatchDetailsRequest(details, sovClient.UISessionOptions?.UIOptions);
return(await sovClient.InternalClient.UIViewDetails(uiRequest));
}
/// <summary>
/// Create a Matching UI session to view a single job from a Bimetric Score API response
/// </summary>
/// <param name="sovClient">The SovrenClient</param>
/// <param name="bimetricResponse">The Bimetric Score API response containing the result you want to view</param>
/// <param name="job">The specific job/id in the result set that you want to view</param>
/// <param name="sourceDocType">The type of document this result was scored against</param>
/// <param name="htmlJob">Optionally, the HTML job to display in the details view</param>
/// <exception cref="SovrenException">Thrown when an API error occurs</exception>
public static async Task <GenerateUIResponse> ViewDetails(
this SovrenClientWithUI sovClient,
BimetricScoreResponseValue bimetricResponse,
ParsedJobWithId job,
Models.Matching.IndexType sourceDocType,
string htmlJob = null)
{
BimetricScoreJobDetails details = new BimetricScoreJobDetails
{
Result = bimetricResponse.Matches.Single(m => m.Id == job.Id),
AppliedCategoryWeights = bimetricResponse.AppliedCategoryWeights,
JobData = job.JobData,
SourceDocumentType = sourceDocType,
HtmlDocument = htmlJob
};
UIBimetricScoreJobDetailsRequest uiRequest = new UIBimetricScoreJobDetailsRequest(details, sovClient.UISessionOptions?.UIOptions);
return(await sovClient.InternalClient.UIViewDetails(uiRequest));
}
