<PackageReference Include="Relativity.Services.DataContracts.SDK" Version="13.6.2" />

AnalyticsSearch

public class AnalyticsSearch : SavedSearchRef, ISavedSearch, IRelativityApplicationAssociable
Represents an instance of analytics search. Relativity analytics search enables semantic analysis of large data sets.
public int ArtifactTypeID { get; set; }

The Artifact Type ID of the object for the search (currently only Document is supported).

public string ConceptsText { get; set; }

Concept text for the analytics search.

public DashboardRef Dashboard { get; set; }

Dashboard associated with the saved search.

public List<FieldRef> Fields { get; set; }

The fields to be included in the search result set specified as a collection of Field objects.

public int FuzzinessLevel { get; set; }

Fuzziness Level

public FieldRef Includes { get; set; }

Field identifying documents related to the documents matching the search criteria. The related documents will be included in the result set alongside with the documents that match the search criteria.

public string Keywords { get; set; }

Optional field for recording additional information associated with the search as keywords.

public string KeywordsText { get; set; }

Keywords Text

public string MinimumConceptRank { get; set; }

Minimum qualifying score for documents to be included in the results. The score is a value between 0 and 1, for example, 0.6. 1 indicates that the documents are conceptually identical.

public string Notes { get; set; }

Detailed description of the saved search.

public UserRef Owner { get; set; }

User(s) who can access the saved search. Setting the ArtifactID value to 0 enables all users with permissions to the saved search are able to see it.

public string QueryHint { get; set; }

String parameter used to optimize views. Only use the query hint if instructed by the kCura Client Services team. Currently, you can use Hashjoin:(true/false) or Maxdrop:(x) to populate the field.

public List<RelativityApplicationRef> RelativityApplications { get; set; }

RelativityApplications associated with this saved search.

public bool RequiresManualRun { get; set; }

Requires users to rerun a saved search when they return to it to ensure up-to-date results.

public ScopeType Scope { get; set; }

The scope of the search specified as a ScopeType enumeration.

public SearchContainerRef SearchContainer { get; set; }

SearchContainer of the saved search folder. If no value is specified, the search will be saved at the logical root of the saved search view.

public CriteriaCollection SearchCriteria { get; set; }

Search Criteria specified as a CriteriaCollection object.

public List<FolderRef> SearchFolders { get; set; }

If folders or subfolders are specified as the AnalyticsSearch.

public SearchIndexRef SearchIndex { get; set; }

SearchIndex of the analytics index used by the search.

public bool SortByRank { get; set; }

Indicates that the search results must be sort by relevance rank.

public List<Sort> Sorts { get; set; }

Sort order for search results specified as a Sorts object.

public UserRef SystemCreatedBy { get; set; }

ArtifactID of the user who created the saved search.

public DateTime? SystemCreatedOn { get; set; }

Date and time in UTC when the saved search was created.

public UserRef SystemLastModifiedBy { get; set; }

ArtifactID of the user who last modified the saved search.

public DateTime? SystemLastModifiedOn { get; set; }

Date and time in UTC when the search was last modified.

public AnalyticsSearch()

AnalyticsSearch constructor.

public AnalyticsSearch(int artifactId)