New to Telerik Reporting? Start a free 30-day trial

AIAssistantByRefAttribute

Class

Marks a property whose JSON value is a name-reference (string) that identifies an object defined elsewhere in the same report-item definition.

In the Telerik Reporting JSON format some properties (e.g. CartesianCoordinateSystem.XAxis) are stored not as inline objects but as the Name of an object declared in another collection. For example "XAxis": "graphAxis1" refers to the GraphAxis whose Name is graphAxis1 in the /Axes collection.

The CollectionPath parameter should be the JSON Pointer path (relative to the root of the enclosing definition) where the referenced objects are declared, e.g. "/Axes", "/CoordinateSystems".

The schema generator uses this attribute to emit type: string for the property and appends a description that guides an AI agent on which value to supply.

Definition

Namespace:Telerik.Reporting

Assembly:Telerik.Reporting.dll

Syntax:

[AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = true)]
public sealed class AIAssistantByRefAttribute : Attribute

Inheritance: objectAttributeAIAssistantByRefAttribute

Constructors

AIAssistantByRefAttribute(string)

Initialises the attribute with the JSON Pointer path of the collection that holds the objects that can be referenced.

public AIAssistantByRefAttribute(string collectionPath)

Parameters:collectionPathstring

JSON Pointer path from the root of the enclosing definition to the collection whose items may be referenced, e.g. "/Axes".

Properties

CollectionPath

string

Gets the JSON Pointer path to the collection that contains the objects that can be referenced by name.

public string CollectionPath { get; }