Class IndexingOptionsGeneric

Namespace

Textkernel.Tx.Models.API.Indexes

Assembly

Textkernel.Tx.SDK.dll

Generic options that have properties for both V1 and V2.

public class IndexingOptionsGeneric

Inheritance

object

IndexingOptionsGeneric

Derived

IndexJobInfo

IndexResumeInfo

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

IndexingOptionsGeneric(string, List<string>, Dictionary<string, string>)

Create options to upload a document with Match V2

public IndexingOptionsGeneric(string documentId, List<string> roles = null, Dictionary<string, string> customFields = null)

Parameters

documentId string

The id to assign to the new document. This is restricted to alphanumeric with dashes and underscores.

roles List<string>

The list of roles that are allowed to retrieve the document. If not set, ["all"] will be used.

customFields Dictionary<string, string>

A key-value collection of custom fields.

IndexingOptionsGeneric(string, string, List<string>)

Create options to index a document with Match V1

public IndexingOptionsGeneric(string documentId, string indexId, List<string> userDefinedTags = null)

Parameters

documentId string

The id to assign to the new document. This is restricted to alphanumeric with dashes and underscores. All values will be converted to lower-case.

indexId string

The id for the index where the document should be added (case-insensitive).

userDefinedTags List<string>

The user-defined tags the document should have

Properties

CustomFields

A key-value collection of custom fields.

public Dictionary<string, string> CustomFields { get; set; }

Property Value

Dictionary<string, string>

Remarks

Only use when SearchAndMatchVersion = V2

DocumentId

The id to assign to the new document. This is restricted to alphanumeric with dashes and underscores. All values will be converted to lower-case.
NOTE: If you are using the BatchParser, it will set the DocumentId for each document.

public string DocumentId { get; set; }

Property Value

string

IndexId

The id for the index where the document should be added (case-insensitive).

public string IndexId { get; set; }

Property Value

string

Remarks

Only use when SearchAndMatchVersion = V1

Roles

The list of roles that are allowed to retrieve the document. If not set, ["all"] will be used.

public List<string> Roles { get; set; }

Property Value

List<string>

Remarks

Only use when SearchAndMatchVersion = V2

SearchAndMatchEnvironment

The target environment where the document will be uploaded. This will be set from MatchV2Environment if needed.

public MatchV2Environment SearchAndMatchEnvironment { get; }

Property Value

MatchV2Environment

Remarks

Only used when SearchAndMatchVersion = V2

SearchAndMatchVersion

The Search & Match Version to use for indexing.

public SearchAndMatchVersion SearchAndMatchVersion { get; set; }

Property Value

SearchAndMatchVersion

UserDefinedTags

The user-defined tags the document should have

public List<string> UserDefinedTags { get; set; }

Property Value

List<string>

Remarks

Only use when SearchAndMatchVersion = V1