> ## 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.

# SuperOffice.WebApi.Data.NaturalLanguageSearch

# <a id="SuperOffice_WebApi_Data_NaturalLanguageSearch" /> Class NaturalLanguageSearch

Namespace: [SuperOffice.WebApi.Data](SuperOffice.WebApi.Data.md)\
Assembly: SuperOffice.WebApi.dll

Carrier object for NaturalLanguageSearch.
Natural language search results.

```csharp theme={null}
public class NaturalLanguageSearch
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[NaturalLanguageSearch](SuperOffice.WebApi.Data.NaturalLanguageSearch.md)

#### Inherited Members

[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Constructors

### <a id="SuperOffice_WebApi_Data_NaturalLanguageSearch__ctor" /> NaturalLanguageSearch()

Default constructor - defaults any enum props to 0.

```csharp theme={null}
public NaturalLanguageSearch()
```

## Properties

### <a id="SuperOffice_WebApi_Data_NaturalLanguageSearch_Entity" /> Entity

Type of entity we are searching. e.g. 'contact', 'project' etc.

```csharp theme={null}
public virtual string Entity { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_NaturalLanguageSearch_InternalContext" /> InternalContext

AI internal context - opaque to callers.

```csharp theme={null}
public virtual string InternalContext { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_NaturalLanguageSearch_ODataQuery" /> ODataQuery

Search criteria in ODATA format

```csharp theme={null}
public virtual string ODataQuery { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_NaturalLanguageSearch_Query" /> Query

User's query.

```csharp theme={null}
public virtual string Query { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_NaturalLanguageSearch_ResponseMarkdown" /> ResponseMarkdown

Markdown response from the AI.

```csharp theme={null}
public virtual string ResponseMarkdown { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_NaturalLanguageSearch_Restrictions" /> Restrictions

Archive restrictions for the search query.

```csharp theme={null}
public virtual ArchiveRestrictionInfo[] Restrictions { get; set; }
```

#### Property Value

[ArchiveRestrictionInfo](SuperOffice.WebApi.Data.ArchiveRestrictionInfo.md)\[]

## See Also

[AIAgent](SuperOffice.WebApi.Agents.AIAgent.md)


## Related topics

- [SuperOffice.WebApi.Data.AI ParseQueryIntoRestrictionsRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.AI_ParseQueryIntoRestrictionsRequest.md)
- [SuperOffice.WebApi.Agents.AIAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.AIAgent.md)
- [SuperOffice.WebApi.Agents.IAIAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IAIAgent.md)
- [SuperOffice.WebApi.Data.NewsFeedItem](/en/api/reference/webapi/SuperOffice.WebApi.Data.NewsFeedItem.md)
- [SuperOffice.WebApi.Data.CultureDataFormatter](/en/api/reference/webapi/SuperOffice.WebApi.Data.CultureDataFormatter.md)
- [SuperOffice.WebApi.RequestOptions](/en/api/reference/webapi/SuperOffice.WebApi.RequestOptions.md)