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

# <a id="SuperOffice_WebApi_Data_CopilotDataSourceEntity" /> Class CopilotDataSourceEntity

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

Carrier object for CopilotDataSourceEntity.
Copilot data source - contains a list of settings for this source

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

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[CopilotDataSourceEntity](SuperOffice.WebApi.Data.CopilotDataSourceEntity.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 CopilotDataSourceEntity 123 using the WebApi client:
<pre><code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new AIAgent(configuration);
var copilotDataSourceEntity = agent.GetCopilotDataSourceEntity( 123 );</code></pre>

## Constructors

### <a id="SuperOffice_WebApi_Data_CopilotDataSourceEntity__ctor" /> CopilotDataSourceEntity()

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_CopilotDataSourceEntity_CopilotDataSourceId" /> CopilotDataSourceId

Primary key

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_CopilotDataSourceEntity_CopilotDataSourceType" /> CopilotDataSourceType

Type of copilot data source
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public CopilotDataSourceType? CopilotDataSourceType { get; set; }
```

#### Property Value

[CopilotDataSourceType](SuperOffice.WebApi.Data.CopilotDataSourceType.md)?

#### See Also

[CopilotDataSourceEntity](SuperOffice.WebApi.Data.CopilotDataSourceEntity.md).[CopilotDataSourceType\_String](SuperOffice.WebApi.Data.CopilotDataSourceEntity.md#SuperOffice_WebApi_Data_CopilotDataSourceEntity_CopilotDataSourceType_String)

### <a id="SuperOffice_WebApi_Data_CopilotDataSourceEntity_CopilotDataSourceType_String" /> CopilotDataSourceType\_String

Type of copilot data source
Raw string enum value.

```csharp theme={null}
[JsonProperty("CopilotDataSourceType")]
public string CopilotDataSourceType_String { get; set; }
```

#### Property Value

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

#### See Also

[CopilotDataSourceEntity](SuperOffice.WebApi.Data.CopilotDataSourceEntity.md).[CopilotDataSourceType](SuperOffice.WebApi.Data.CopilotDataSourceEntity.md#SuperOffice_WebApi_Data_CopilotDataSourceEntity_CopilotDataSourceType)

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

The associated copilot

```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_CopilotDataSourceEntity_Description" /> Description

Description of data source

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

#### Property Value

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

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

Name of data source

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_CopilotDataSourceEntity_Settings" /> Settings

Collection of data source settings - each setting has key + value

```csharp theme={null}
public virtual CopilotDataSourceSetting[] Settings { get; set; }
```

#### Property Value

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

## 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.CopilotEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.CopilotEntity.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.Carrier](/en/api/reference/webapi/SuperOffice.WebApi.Data.Carrier.md)