Class
SpreadProcessingAnalysisAgentTools

Provides high-level data analysis tools for spreadsheets using Split-Apply-Combine operations. These tools enable filtering, grouping, and aggregation without requiring formula knowledge.

Definition

Namespace:Telerik.Documents.AI.AgentTools.Spreadsheet

Assembly:Telerik.Documents.AI.AgentTools.Spreadsheet.dll

Syntax:

cs-api-definition

public sealed class SpreadProcessingAnalysisAgentTools : SpreadProcessingAgentToolsBase

Inheritance: objectAgentToolBaseSpreadProcessingAgentToolsBaseSpreadProcessingAnalysisAgentTools

Inherited Members AgentToolBase.GetTools()

Constructors

SpreadProcessingAnalysisAgentTools(IWorkbookRepository)

Initializes a new instance with the specified workbook repository.

Declaration

cs-api-definition

public SpreadProcessingAnalysisAgentTools(IWorkbookRepository repository)

Parameters

repository

IWorkbookRepository

The workbook repository for document access.

Methods

Aggregate(AggregationType, int?, string, List<Criterion>, CriteriaLogic, List<int>, SortOrder?, int?, HavingCriterion, string, string, int?, int?, int?)

Aggregates data with optional filtering and grouping.

Declaration

cs-api-definition

[Tool]
public CallToolResult Aggregate(AggregationType function, int? valueColumnIndex = null, string valueExpression = null, List<Criterion> criteria = null, CriteriaLogic criteriaLogic = CriteriaLogic.And, List<int> groupByColumns = null, SortOrder? orderBy = null, int? limit = null, HavingCriterion havingCriteria = null, string worksheetName = null, string documentId = null, int? regionIndex = null, int? headerRowIndex = null, int? dataStartColumnIndex = null)

Parameters

function

AggregationType

valueColumnIndex

int?

valueExpression

string

criteria

List<Criterion>

criteriaLogic

CriteriaLogic

groupByColumns

List<int>

orderBy

SortOrder?

limit

int?

havingCriteria

HavingCriterion

worksheetName

string

documentId

string

regionIndex

int?

headerRowIndex

int?

dataStartColumnIndex

int?

Returns

CallToolResult

DescribeData(string, string, bool)

Gets worksheet structure and column information in a single call.

Declaration

cs-api-definition

[Tool]
public CallToolResult DescribeData(string worksheetName = null, string documentId = null, bool detectAllRegions = false)

Parameters

worksheetName

documentId

detectAllRegions

Returns

GetRows(List<Criterion>, CriteriaLogic, List<int>, int, int, string, int?, string)

Retrieves rows matching filter criteria.

Declaration

cs-api-definition

[Tool]
public CallToolResult GetRows(List<Criterion> criteria = null, CriteriaLogic criteriaLogic = CriteriaLogic.And, List<int> returnColumns = null, int offset = 0, int limit = 20, string worksheetName = null, int? regionIndex = null, string documentId = null)