Class IndexingOptionsGeneric

Generic options that have properties for both V1 and V2.

Inheritance

System.Object

IndexingOptionsGeneric

IndexJobInfo

IndexResumeInfo

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Textkernel.Tx.Models.API.Indexes

Assembly: Textkernel.Tx.SDK.dll

Syntax

public class IndexingOptionsGeneric

Constructors

| Improve this Doc View Source

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

Create options to upload a document with Match V2

Declaration

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

Parameters

Type	Name	Description
System.String	documentId	The id to assign to the new document. This is restricted to alphanumeric with dashes and underscores.
System.Collections.Generic.List<System.String>	roles	The list of roles that are allowed to retrieve the document. If not set, `["all"]` will be used.
System.Collections.Generic.Dictionary<System.String, System.String>	customFields	A key-value collection of custom fields.

| Improve this Doc View Source

IndexingOptionsGeneric(String, String, List<String>)

Create options to index a document with Match V1

Declaration

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

Parameters

Type	Name	Description
System.String	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.
System.String	indexId	The id for the index where the document should be added (case-insensitive).
System.Collections.Generic.List<System.String>	userDefinedTags	The user-defined tags the document should have

Properties

| Improve this Doc View Source

CustomFields

A key-value collection of custom fields.

Declaration

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

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.String>

Remarks

Only use when SearchAndMatchVersion = V2

| Improve this Doc View Source

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.

Declaration

public string DocumentId { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

IndexId

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

Declaration

public string IndexId { get; set; }

Property Value

Type	Description
System.String

Remarks

Only use when SearchAndMatchVersion = V1

| Improve this Doc View Source

Roles

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

Declaration

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

Property Value

Type	Description
System.Collections.Generic.List<System.String>

Remarks

Only use when SearchAndMatchVersion = V2

| Improve this Doc View Source

SearchAndMatchEnvironment

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

Declaration

public MatchV2Environment SearchAndMatchEnvironment { get; }

Property Value

Type	Description
MatchV2Environment

Remarks

Only used when SearchAndMatchVersion = V2

| Improve this Doc View Source

SearchAndMatchVersion

The Search & Match Version to use for indexing.

Declaration

public SearchAndMatchVersion SearchAndMatchVersion { get; set; }

Property Value

Type	Description
SearchAndMatchVersion

| Improve this Doc View Source

UserDefinedTags

The user-defined tags the document should have

Declaration

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

Property Value

Type	Description
System.Collections.Generic.List<System.String>

Remarks

Only use when SearchAndMatchVersion = V1