Skip to content

Commit

Permalink
feat(ml): Update SmartSnippets preview response (#770)
Browse files Browse the repository at this point in the history
* feat(ml): update SmartSnippets preview response

Add deprecated tag
  • Loading branch information
JTangCoveo authored Nov 15, 2023
1 parent f5ddbca commit 2e60355
Showing 1 changed file with 23 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export interface SmartSnippetsConfigurationModel {
documentTypes?: DocumentType[];
}

export type SmartSnippetsDocumentRequirementStatus = 'OK' | 'INSUFFICIENT_DOCUMENTS';
export type SmartSnippetsDocumentRequirementStatus = 'OK' | 'INSUFFICIENT_DOCUMENTS' | 'NB_OF_DOCUMENTS_OVER_LIMIT';

export interface SmartSnippetsDocumentGroupPreviewParams {
/**
Expand All @@ -59,28 +59,42 @@ export interface SmartSnippetsDocumentGroupPreviewParams {
export interface SmartSnippetsDocumentGroupPreview {
/**
* The query that was used to fetch document information.
*
* @Example @source==("Salesforce Notifier")
*/
query: string;
/**
* Status indicating whether there are enough candidates for learning.
* @Deprecated use `numberOfDocumentsInSources` instead
*/
documentRequirementStatus: SmartSnippetsDocumentRequirementStatus;
numberOfDocuments: number;
/**
* The total number of documents in all sources.
* The total number of documents in the selected sources.
*/
numberOfDocuments: number;
numberOfDocumentsInSources: number;
/**
* The number of documents that are candidates for learning.
*/
numberOfValidDocuments: number;
/**
* The number of documents that match the conditions.
* @Deprecated use `numberOfDocumentsInSourcesMatchingFilters` instead
*/
numberOfDocumentsMatchingConditions: number;
/**
* The number of documents that match the conditions and have a permanent id.
* The number of documents in the selected sources that match the conditions.
*/
numberOfDocumentsInSourcesMatchingFilters: number;
/**
* @Deprecated use `numberOfDocumentsInSourcesMatchingFiltersWithPermanentId` instead
*/
numberOfDocumentsWithPermanentId: number;
/**
* The number of documents that are candidates for learning.
* The number of documents in the selected sources that match the conditions and have a permanentid
*/
numberOfValidDocuments: number;
numberOfDocumentsInSourcesMatchingFiltersWithPermanentId: number;
/**
* Status for the number of required documents to build the model.
*/
documentRequirementStatus: SmartSnippetsDocumentRequirementStatus;
}

export interface SmartSnippetsContentFieldsParams {
Expand Down

0 comments on commit 2e60355

Please sign in to comment.