> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# NSFreeTextAgent

> This agent can be used to manage the free text system.

This agent can be used to manage the free text system.

## Constructors

### NSFreeTextAgent()

```crmscript theme={null}
NSFreeTextAgent
```

This agent can be used to manage the free text system.

## Methods

## AddWords(String)

Adds the words in the string to the stop word list

```crmscript theme={null}
Void AddWords(String stopWords)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFreeTextAgent agent;
String stopWords;
agent.AddWords(stopWords);
```

## DeleteStopWordsById(Integer\[])

Deletes the stop words with these IDs

```crmscript theme={null}
Void DeleteStopWordsById(Integer[] stopWordIds)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFreeTextAgent agent;
Integer[] stopWordIds;
agent.DeleteStopWordsById(stopWordIds);
```

## GetStatus()

Returns status for the free-text search words

```crmscript theme={null}
NSFreeText GetStatus()
```

**Returns:** [CRMScript.NetServer.NSFreeText](CRMScript.NetServer.NSFreeText)

**Example:**

```crmscript theme={null}
NSFreeTextAgent agent;
NSFreeText res = agent.GetStatus();
```

## GetStopWordList()

Returns the list of stop words

```crmscript theme={null}
String[] GetStopWordList()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String)\[] - list of stop words.

**Example:**

```crmscript theme={null}
NSFreeTextAgent agent;
String[] res = agent.GetStopWordList();
```

## GetSuggestedStopWords(Integer)

Returns the top used words in the free-text index table, sorted as most used first

```crmscript theme={null}
NSMDOListItem[] GetSuggestedStopWords(Integer countWords)
```

**Returns:** [CRMScript.NetServer.NSMDOListItem](CRMScript.NetServer.NSMDOListItem)\[]

**Example:**

```crmscript theme={null}
NSFreeTextAgent agent;
Integer countWords;
NSMDOListItem[] res = agent.GetSuggestedStopWords(countWords);
```

## RegenerateIndex(Bool)

Wipes and regenerates the free-text index by scanning the database (free-text search will be unavailable while this operation runs

```crmscript theme={null}
NSBatchTaskInfo RegenerateIndex(Bool runAsBatch)
```

**Returns:** [CRMScript.NetServer.NSBatchTaskInfo](CRMScript.NetServer.NSBatchTaskInfo)

**Example:**

```crmscript theme={null}
NSFreeTextAgent agent;
Bool runAsBatch;
NSBatchTaskInfo res = agent.RegenerateIndex(runAsBatch);
```

## SetAutoEnableTravelAreas(Bool)

```crmscript theme={null}
Void SetAutoEnableTravelAreas(Bool autoEnable)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFreeTextAgent agent;
Bool autoEnable;
agent.SetAutoEnableTravelAreas(autoEnable);
```

## SetEnabled(Bool)

Sets free-text search to enabled (true) or disabled (false)

```crmscript theme={null}
Void SetEnabled(Bool enabled)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFreeTextAgent agent;
Bool enabled;
agent.SetEnabled(enabled);
```

## SetMultiWordOperator(Integer)

Sets the operator used when matching multiple words

```crmscript theme={null}
Void SetMultiWordOperator(Integer freeTextOperator)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFreeTextAgent agent;
Integer freeTextOperator;
agent.SetMultiWordOperator(freeTextOperator);
```

## SetSingleWordOperator(Integer)

Sets the operator used when matching single words

```crmscript theme={null}
Void SetSingleWordOperator(Integer freeTextOperator)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSFreeTextAgent agent;
Integer freeTextOperator;
agent.SetSingleWordOperator(freeTextOperator);
```


## Related topics

- [SuperOffice.WebApi.Agents.FreeTextAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.FreeTextAgent.md)
- [SuperOffice.WebApi.Agents.IFreeTextAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IFreeTextAgent.md)
- [NSFreeText](/en/automation/crmscript/reference/CRMScript.NetServer.NSFreeText.md)
- [Configure free-text search](/en/search-options/admin/configure-free-text-search.md)
- [SuperOffice.WebApi.Data.FreeText](/en/api/reference/webapi/SuperOffice.WebApi.Data.FreeText.md)
- [Enum FreeTextOperator](/en/automation/crmscript/reference/CRMScript.NetServer.FreeTextOperator.md)