Class
SpreadProcessingReadAgentTools

Provides read-only agent tools for querying and analyzing spreadsheet data without modification. These tools are safe for analysis-only scenarios.

Definition

Namespace:Telerik.Documents.AI.AgentTools.Spreadsheet

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

Syntax:

cs-api-definition
public class SpreadProcessingReadAgentTools : SpreadProcessingAgentToolsBase

Inheritance: objectAgentToolBaseSpreadProcessingAgentToolsBaseSpreadProcessingReadAgentTools

Inherited Members SpreadProcessingAgentToolsBase.RepositoryAgentToolBase.GetTools()

Constructors

SpreadProcessingReadAgentTools(IWorkbookRepository)

Declaration

cs-api-definition
public SpreadProcessingReadAgentTools(IWorkbookRepository repository)

Parameters

repository

IWorkbookRepository

Methods

FilterAndExtract(int, List<string>, List<int>, string, string, int)

Declaration

cs-api-definition
[Tool]
public CallToolResult FilterAndExtract(int filterColumnIndex, List<string> filterValues, List<int> columnsToReturn, string worksheetName = null, string documentId = null, int maxSampleRows = 5)

Parameters

filterColumnIndex

int

filterValues

List<string>

columnsToReturn

List<int>

worksheetName

string

documentId

string

maxSampleRows

int

Returns

CallToolResult

FindAll(string, Range[], string, string, int)

Declaration

cs-api-definition
[Tool]
public CallToolResult FindAll(string findWhat, Range[] searchRanges, string worksheetName = null, string documentId = null, int maxSampleLocations = 10)

Parameters

findWhat

string

searchRanges

Range[]

worksheetName

string

documentId

string

maxSampleLocations

int

Returns

CallToolResult

GetCellStyles(int, int, int, int, string, string)

Declaration

cs-api-definition
[Tool]
public CallToolResult GetCellStyles(int fromRowIndex, int fromColumnIndex, int toRowIndex, int toColumnIndex, string worksheetName = null, string documentId = null)

Parameters

fromRowIndex

int

fromColumnIndex

int

toRowIndex

int

toColumnIndex

int

worksheetName

string

documentId

string

Returns

CallToolResult

GetCellValues(int, int, int, int, string, string)

Declaration

cs-api-definition
[Tool]
public CallToolResult GetCellValues(int fromRowIndex, int fromColumnIndex, int toRowIndex, int toColumnIndex, string worksheetName = null, string documentId = null)

Parameters

fromRowIndex

int

fromColumnIndex

int

toRowIndex

int

toColumnIndex

int

worksheetName

string

documentId

string

Returns

CallToolResult

GetStyleProperties(List<string>, string)

Declaration

cs-api-definition
[Tool]
public CallToolResult GetStyleProperties(List<string> styleNames, string documentId = null)

Parameters

styleNames

List<string>

documentId

string

Returns

CallToolResult

GetUniqueValues(Range, string, string)

Declaration

cs-api-definition
[Tool]
public CallToolResult GetUniqueValues(Range range, string worksheetName = null, string documentId = null)

Parameters

range

Range

worksheetName

string

documentId

string

Returns

CallToolResult

GetUsedCellRange(string, string)

Declaration

cs-api-definition
[Tool]
public CallToolResult GetUsedCellRange(string worksheetName = null, string documentId = null)

Parameters

worksheetName

string

documentId

string

Returns

CallToolResult

GetWorkbookStyles(string)

Declaration

cs-api-definition
[Tool]
public CallToolResult GetWorkbookStyles(string documentId = null)

Parameters

documentId

string

Returns

CallToolResult

GetWorksheetNames(string)

Declaration

cs-api-definition
[Tool]
public CallToolResult GetWorksheetNames(string documentId = null)

Parameters

documentId

string

Returns

CallToolResult

ListAvailableStyles(string)

Declaration

cs-api-definition
[Tool]
public CallToolResult ListAvailableStyles(string documentId = null)

Parameters

documentId

string

Returns

CallToolResult