LogoLogo
HomeNewsSupportVideos
  • Welcome
  • Wisej.NET
  • Concepts
    • Getting Started
    • General Concepts
    • Architecture
    • Extensibility
    • AI Providers
    • Vector Databases
    • Usage Metrics
    • Logging & Error Handling
  • Markup
  • Components
    • API
      • SmartAdapter
        • SmartAudioTTSAdapter
        • SmartAudioWhisperAdapter
        • SmartCalendarAdapter
        • SmartChartAdapter
        • SmartChartJS3Adapter
        • SmartChatBoxAdapter
        • SmartComboBoxAdapter
        • SmartCopilotAdapter
        • SmartDataEntryAdapter
        • SmartDocumentAdapter
        • SmartFullCalendarAdapter
        • SmartObjectAdapter
        • SmartPictureBoxAdapter
        • SmartQueryAdapter
        • SmartRealtimeAdapter
        • SmartReportAdapter
        • SmartTextBoxAdapter
        • SmartAdapter.ExtendsAttribute
        • SmartAdapter.FieldNameAttribute
        • SmartAdapter.FieldPromptAttribute
        • SmartAdapter.FieldRectangleAttribute
        • SmartAdapter.WorksWithAttribute
      • SmartEndpoint
        • AmazonBedrockEndpoint
        • AnthropicEndpoint
        • AzureAIEndpoint
        • CerebrasEndpoint
        • DeepSeekEndpoint
        • GoogleAIEndpoint
        • GroqCloudEndpoint
        • GroqCloudEndpointWhisper
        • HuggingFaceEndpoint
        • HuggingFaceJavaScriptEndpoint
        • LocalAIEndpoint
        • LocalAIEndpointImageGen
        • LocalAIEndpointTTS
        • LocalAIEndpointWhisper
        • NvidiaAIEndpoint
        • OllamaEndpoint
        • OpenAIEndpoint
        • OpenAIEndpointDallE
        • OpenAIEndpointRealtime
        • OpenAIEndpointTTS
        • OpenAIEndpointWhisper
        • SambaNovaEndpoint
        • SmartHttpEndpoint
        • TogetherAIEndpoint
        • XAIEndpoint
        • SmartEndpoint.Metrics
        • SmartEndpoint.Response
      • SmartExtensions
      • SmartHub
        • SmartSession.ConvertParameterEventArgs
        • SmartSession.ConvertParameterEventHandler
        • SmartSession.ErrorEventArgs
        • SmartSession.ErrorEventHandler
        • SmartSession.InvokeToolEventArgs
        • SmartSession.InvokeToolEventHandler
        • SmartSession.MessagesEventArgs
        • SmartSession.MessagesEventHandler
      • SmartObject
      • SmartPrompt
        • SmartAgentPrompt
        • SmartParallelPrompt
        • SmartPrompt.Parameter
        • SmartSession.ConvertParameterEventArgs
        • SmartSession.ConvertParameterEventHandler
        • SmartSession.ErrorEventArgs
        • SmartSession.ErrorEventHandler
        • SmartSession.InvokeToolEventArgs
        • SmartSession.InvokeToolEventHandler
        • SmartSession.MessagesEventArgs
        • SmartSession.MessagesEventHandler
      • SmartRealtimeSession
      • SmartSession
        • SmartSession.ConvertParameterEventArgs
        • SmartSession.ConvertParameterEventHandler
        • SmartSession.ErrorEventArgs
        • SmartSession.ErrorEventHandler
        • SmartSession.InvokeToolEventArgs
        • SmartSession.InvokeToolEventHandler
        • SmartSession.Message
        • SmartSession.MessageCollection
        • SmartSession.MessageRole
        • SmartSession.MessagesEventArgs
        • SmartSession.MessagesEventHandler
        • SmartSession.TrimmingStrategy
      • SmartTool
        • SmartTool.IToolProvider
        • SmartTool.ToolAttribute
        • SmartTool.ToolContext
      • Markup
        • MarkupExtensions
      • Controls
        • UVLightOverlay
      • Embeddings
        • EmbeddedDocument
        • Embedding
        • Matches
        • Metadata
      • Helpers
        • ApiKeys
        • Markdown
        • TextTokenizer
      • Services
        • DefaultSessionTrimmingService
        • IDocumentConversionService
          • DefaultDocumentConversionService
        • IEmbeddingGenerationService
          • DefaultEmbeddingGenerationService
          • HuggingFaceEmbeddingGenerationService
        • IEmbeddingStorageService
          • AzureAISearchEmbeddingStorageService
          • ChromaEmbeddingStorageService
          • FileSystemEmbeddingStorageService
          • MemoryEmbeddingStorageService
          • PineconeEmbeddingStorageService
          • QdrantEmbeddingStorageService
        • IHttpClientService
          • DefaultHttpClientService
        • ILoggerService
          • DefaultLoggerService
        • IOCRService
          • DefaultOCRService
        • IRerankingService
          • DefaultRerankingService
          • LocalAIRerankingService
          • PineconeRerankingService
        • ISessionTrimmingService
          • DefaultSessionTrimmingService
        • ITextSplitterService
          • RecursiveCharacterTextSplitterService
          • TextSplitterServiceBase
        • ITokenizerService
          • DefaultTokenizerService
        • IWebSearchService
          • BingWebSearchService
          • BraveWebSearchService
          • GoogleWebSearchService
      • Tools
        • ArxivTools
        • ChartJS3Tools
        • DatabaseTools
        • DataTableFilterTools
        • DocumentSearchTools
        • DocumentTools
        • FullCalendarTools
        • IToolsContainer
        • MathTools
        • ToolsContainer
        • UtilityTools
        • WebSearchTools
    • Built-in Services
      • IOCRService
      • ILoggerService
      • ITextSplitterService
      • ITokenizerService
      • IHttpClientService
      • IWebSearchService
      • IRerankingService
      • ISessionTrimmingService
      • IDocumentConversionService
      • IEmbeddingStorageService
      • IEmbeddingGenerationService
    • Built-in SmartTools
      • ToolsContainer
      • MathTools
      • UtilityTools
      • DatabaseTools
      • DocumentTools
      • DocumentSearchTools
      • WebSearchTools
      • ChartJS3Tools
      • FullCalendarTools
    • Built-in SmartAdapters
      • SmartAdapter
      • SmartAudioTTSAdapter
      • SmartAudioWhisperAdapter
      • SmartCalendarAdapter
      • SmartChartAdapter
      • SmartChartJS3Adapter
      • SmartChatBoxAdapter
      • SmartComboBoxAdapter
      • SmartCopilotAdapter
      • SmartDataEntryAdapter
      • SmartDocumentAdapter
      • SmartFullCalendarAdapter
      • SmartObjectAdapter
      • SmartPictureBoxAdapter
      • SmartQueryAdapter
      • SmartRealtimeAdapter
      • SmartReportAdapter
      • SmartTextBoxAdapter
    • Configure Services
    • Using SmartHub
    • Using SmartTools
    • Using SmartPrompt
    • Using SmartSession
    • Using SmartRealTimeAdapter
    • UVLightOverlay Control
Powered by GitBook
On this page
  • Constructors
  • SmartReportAdapter()
  • Properties
  • AutoReset
  • BotAvatar
  • BotName
  • ChatBox
  • ConversionService
  • Prompt
  • ReportPdfSource
  • User
  • Methods
  • AskAsync(question)
  • evaluate_expression(expression)
  • OnAnswerReceived(e)
  • OnControlCreated(control)
  • OnControlDisposed(control)
  • OnReadingReport(e)
  • ResetSession(removeMessages)
  • RunAsyncCore(control)
  • Events
  • AnswerReceived
  • ReadingReport
  • Implements
Export as PDF
  1. Components
  2. API
  3. SmartAdapter

SmartReportAdapter

Wisej.AI.Adapters.SmartReportAdapter

PreviousSmartRealtimeAdapterNextSmartTextBoxAdapter

Last updated 5 days ago

Namespace: Wisej.AI.Adapters

Assembly: Wisej.AI (3.5.0.0)

Enhances the ChatBox control to allow seamless PDF report queries using an AI provider.

public class SmartReportAdapter : SmartAdapter
Public Class SmartReportAdapter
    Inherits SmartAdapter

Utilizes these services: . The class extends the functionality of a to provide capabilities for reading and interpreting reports. It utilizes prompts and sessions to interact with the user and process report data.

Constructors

SmartReportAdapter()

Initializes a new instance of the class.

Properties

AutoReset

: Gets or sets a value indicating whether the history of the conversation is cleared after each response. (Default: False)

BotAvatar

Methods

Parameter
Type
Description

question

Throws:

Evaluates a mathematical expression asynchronously.

Parameter
Type
Description

expression

The mathematical expression to evaluate.

This method uses the browser's evaluation engine to compute the result of the given expression.

Parameter
Type
Description

e

Parameter
Type
Description

control

Parameter
Type
Description

control

Parameter
Type
Description

e

Resets the conversation history.

Parameter
Type
Description

removeMessages

Indicates whether all messages from the ChatBox control should also be removed.

Executes the core logic asynchronously for running the session.

Parameter
Type
Description

control

The control associated with the session.

Events

Implements

Name
Description

Represents a provider that supplies tools.

: Gets or sets the avatar image source for the bot. (Default: "resource.wx/Wisej.AI/Icons/wisej-avatar.svg")

BotName

: Gets or sets the name of the bot. (Default: "Wisej.AI")

ChatBox

: Gets the control associated with this adapter.

ConversionService

: Gets or sets the document conversion service used for converting documents to text.

Prompt

: Gets or sets the prompt to execute. Used only when the adapter is not connected to a . (Default: null)

ReportPdfSource

: Gets or sets the PDF source stream for the report.

User

: Gets the user associated with the bot.

AskAsync(question)

Returns: .

When question is null.

evaluate_expression(expression)

Returns: . A task that represents the asynchronous operation. The task result contains the evaluated result of the expression.

OnAnswerReceived(e)

Raises the event.

The instance containing the event data.

OnControlCreated(control)

OnControlDisposed(control)

OnReadingReport(e)

Raises the event.

The instance containing the event data.

ResetSession(removeMessages)

RunAsyncCore(control)

Returns: . A task representing the asynchronous operation.

AnswerReceived

Occurs when an answer is received from the session.

ReadingReport

Occurs when a report is being read.

String
String
IDocumentConversionService
Stream
User
Task<String>
ArgumentNullException
Task<Object>
Task<Message>
AnswerReceivedHandler
ReadingReportEventHandler
ChatBox
ChatBox
String
ChatBox
AnswerReceived
ReadingReport
String
String
AnswerReceivedArgs
AnswerReceivedArgs
Control
Control
ReadingReportEventArgs
ReadingReportEventArgs
Boolean
Control
IToolProvider
SmartAdapter
SmartReportAdapter
IDocumentConversionService
SmartReportAdapter
SmartReportAdapter
Boolean
ChatBox