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

# <a id="SuperOffice_WebApi_Data_CopilotEntity" /> Class CopilotEntity

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

Carrier object for CopilotEntity.
Entity for Copilot configuration

```csharp theme={null}
public class CopilotEntity : Carrier
```

#### Inheritance

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

#### Inherited Members

[Carrier.TableRight](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_TableRight),
[Carrier.FieldProperties](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_FieldProperties),
[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)

## Examples

Get CopilotEntity 123 using the WebApi client:
<pre><code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new AIAgent(configuration);
var copilotEntity = agent.GetCopilotEntity( 123 );</code></pre>

## Constructors

### <a id="SuperOffice_WebApi_Data_CopilotEntity__ctor" /> CopilotEntity()

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_CopilotEntity_CopilotDataSources" /> CopilotDataSources

Data sources

```csharp theme={null}
public virtual CopilotDataSourceEntity[] CopilotDataSources { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_CopilotEntity_CopilotId" /> CopilotId

Primary key

```csharp theme={null}
public virtual int CopilotId { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_CopilotEntity_Name" /> Name

The name of copilot

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

#### Property Value

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

## See Also

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


## Related topics

- [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.CopilotDataSourceEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.CopilotDataSourceEntity.md)
- [SuperOffice.WebApi.Data.CopilotDataSourceType](/en/api/reference/webapi/SuperOffice.WebApi.Data.CopilotDataSourceType.md)
- [SuperOffice.WebApi.Data.CopilotDataSourceSetting](/en/api/reference/webapi/SuperOffice.WebApi.Data.CopilotDataSourceSetting.md)
- [SuperOffice.WebApi.Data.UserPreferenceStrings.Copilot](/en/api/reference/webapi/SuperOffice.WebApi.Data.UserPreferenceStrings.Copilot.md)