Class RagAIHelper

Call AI RAG backend services. Requires ServiceCopilot feature toggle or AiPlatform + AiTextServices/AiCategorization licenses. Gets options from appsettings.json via RagConfiguration options.

Inheritance

object

RagAIHelper

Implements

IAccessTokenProvider

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: SuperOffice.Util

Assembly: SoDataBase.BusinessLogic.dll

Syntax

public class RagAIHelper : IAccessTokenProvider

Constructors

RagAIHelper(IOptions<RagAIConfiguration>, ILogger<RagAIHelper>, ICacheManager)

Call AI RAG backend services. Requires ServiceCopilot feature toggle or AiPlatform + AiTextServices/AiCategorization licenses. Gets options from appsettings.json via RagConfiguration options.

Declaration

public RagAIHelper(IOptions<RagAIConfiguration> options, ILogger<RagAIHelper> logger, ICacheManager cacheManager)

Parameters

Type	Name	Description
IOptions<RagAIConfiguration>	options
ILogger<RagAIHelper>	logger
ICacheManager	cacheManager

Fields

ServiceCopilotNS

Call AI RAG backend services. Requires ServiceCopilot feature toggle or AiPlatform + AiTextServices/AiCategorization licenses. Gets options from appsettings.json via RagConfiguration options.

Declaration

public const string ServiceCopilotNS = "ServiceCopilot"

Field Value

Type	Description
string

_sharedHttpClient

This HttpClient is created with an explicit IHttpClientHandler, to avoid Kiota creating one using its own factory. This is because when on .NET Framework, Kiota defaults to using a different IHttpClientHandler implementation (WinHttpHandler.cs) than the one used in the rest of the codebase, and we want to use the same implementation everywhere to ensure HTTP requests behaves consistently and predictably.

Declaration

protected static HttpClient _sharedHttpClient

Field Value

Type	Description
HttpClient

Properties

AllowedHostsValidator

Call AI RAG backend services. Requires ServiceCopilot feature toggle or AiPlatform + AiTextServices/AiCategorization licenses. Gets options from appsettings.json via RagConfiguration options.

Declaration

public AllowedHostsValidator AllowedHostsValidator { get; }

Property Value

Type	Description
AllowedHostsValidator

Methods

AnswerAcceptedAsync(string)

Call AI RAG backend services. Requires ServiceCopilot feature toggle or AiPlatform + AiTextServices/AiCategorization licenses. Gets options from appsettings.json via RagConfiguration options.

Declaration

public Task AnswerAcceptedAsync(string trackingId)

Parameters

Type	Name	Description
string	trackingId

Returns

Type	Description
Task

AnswerFeedbackAsync(string, bool)

Call AI RAG backend services. Requires ServiceCopilot feature toggle or AiPlatform + AiTextServices/AiCategorization licenses. Gets options from appsettings.json via RagConfiguration options.

Declaration

public Task AnswerFeedbackAsync(string trackingId, bool isThumbsUp)

Parameters

Type	Name	Description
string	trackingId
bool	isThumbsUp

Returns

Type	Description
Task

CancelIndexing(string, string, CancellationToken)

Call AI RAG backend services. Requires ServiceCopilot feature toggle or AiPlatform + AiTextServices/AiCategorization licenses. Gets options from appsettings.json via RagConfiguration options.

Declaration

public Task<NamespaceStatus> CancelIndexing(string namespaceName, string indexTag, CancellationToken cancellation)

Parameters

Type	Name	Description
string	namespaceName
string	indexTag
CancellationToken	cancellation

Returns

Type	Description
Task<NamespaceStatus>

CreateFormsDesignSessionFromImage(Stream, string, CancellationToken)

Call AI RAG backend services. Requires ServiceCopilot feature toggle or AiPlatform + AiTextServices/AiCategorization licenses. Gets options from appsettings.json via RagConfiguration options.

Declaration

public Task<CssGenerationApiResponse> CreateFormsDesignSessionFromImage(Stream image, string cssClass, CancellationToken cancellationToken)

Parameters

Type	Name	Description
Stream	image	Image stream
string	cssClass	Starting CSS class to return: ".foo"
CancellationToken	cancellationToken	cancel?

Returns

Type	Description
Task<CssGenerationApiResponse>	CSS rule + internal state blob. Fetch next class by calling NextSessionCssRule with the state argument and another CSS class name

CreateFormsDesignSessionFromUrl(string, string, CancellationToken)

Starts forms analysis

Declaration

public Task<CssGenerationApiResponse> CreateFormsDesignSessionFromUrl(string url, string cssClass, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	url	URL of webpage to fetch
string	cssClass	Starting CSS class to return: ".foo"
CancellationToken	cancellationToken	cancel?

Returns

Type	Description
Task<CssGenerationApiResponse>	CSS rule + internal state blob. Fetch next class by calling NextSessionCssRule with the state argument and another CSS class name

DeleteNamespace(string)

Call AI RAG backend services. Requires ServiceCopilot feature toggle or AiPlatform + AiTextServices/AiCategorization licenses. Gets options from appsettings.json via RagConfiguration options.

Declaration

public Task DeleteNamespace(string namespaceName)

Parameters

Type	Name	Description
string	namespaceName

Returns

Type	Description
Task

EnrichmentSearchAsync(string, string, CancellationToken)

Call AI RAG backend services. Requires ServiceCopilot feature toggle or AiPlatform + AiTextServices/AiCategorization licenses. Gets options from appsettings.json via RagConfiguration options.

Declaration

public Task<List<(string, string)>> EnrichmentSearchAsync(string q, string isoCode, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	q
string	isoCode
CancellationToken	cancellationToken

Returns

Type	Description
Task<List<(string, string)>>

GetAuthorizationTokenAsync(Uri, Dictionary<string, object>, CancellationToken)

Call AI RAG backend services. Requires ServiceCopilot feature toggle or AiPlatform + AiTextServices/AiCategorization licenses. Gets options from appsettings.json via RagConfiguration options.

Declaration

public Task<string> GetAuthorizationTokenAsync(Uri uri, Dictionary<string, object> additionalAuthenticationContext = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Uri	uri
Dictionary<string, object>	additionalAuthenticationContext
CancellationToken	cancellationToken

Returns

Type	Description
Task<string>

GetFormsDesignCssFromImage(Stream, string[], CancellationToken)

Call AI RAG backend services. Requires ServiceCopilot feature toggle or AiPlatform + AiTextServices/AiCategorization licenses. Gets options from appsettings.json via RagConfiguration options.

Declaration

public Task<DesignCssResult> GetFormsDesignCssFromImage(Stream image, string[] classes, CancellationToken cancellationToken)

Parameters

Type	Name	Description
Stream	image
string[]	classes
CancellationToken	cancellationToken

Returns

Type	Description
Task<DesignCssResult>

GetFormsDesignCssFromUrl(string, string[], CancellationToken)

Call AI RAG backend services. Requires ServiceCopilot feature toggle or AiPlatform + AiTextServices/AiCategorization licenses. Gets options from appsettings.json via RagConfiguration options.

Declaration

public Task<DesignCssResult> GetFormsDesignCssFromUrl(string url, string[] classes, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	url
string[]	classes
CancellationToken	cancellationToken

Returns

Type	Description
Task<DesignCssResult>

GetFormsDesignFromImage(Stream, CancellationToken)

Call AI RAG backend services. Requires ServiceCopilot feature toggle or AiPlatform + AiTextServices/AiCategorization licenses. Gets options from appsettings.json via RagConfiguration options.

Declaration

public Task<Dictionary<string, string>> GetFormsDesignFromImage(Stream image, CancellationToken cancellationToken)

Parameters

Type	Name	Description
Stream	image
CancellationToken	cancellationToken

Returns

Type	Description
Task<Dictionary<string, string>>

GetFormsDesignFromUrl(string, CancellationToken)

Call AI RAG backend services. Requires ServiceCopilot feature toggle or AiPlatform + AiTextServices/AiCategorization licenses. Gets options from appsettings.json via RagConfiguration options.

Declaration

public Task<Dictionary<string, string>> GetFormsDesignFromUrl(string url, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	url
CancellationToken	cancellationToken

Returns

Type	Description
Task<Dictionary<string, string>>

IndexingFinished(string, string)

Ends the indexing process for a given source in a namespace. Removes all documents NOT marked with the indexTag.

Declaration

public Task<NamespaceStatus> IndexingFinished(string namespaceName, string indexTag)

Parameters

Type	Name	Description
string	namespaceName	"ServiceCopilot" or "AllNames"
string	indexTag	The unique id of the indexing run

Returns

Type	Description
Task<NamespaceStatus>

IndexingStarted(string, string)

Start the indexing process for a given source in a namespace. Marks all new/updated documents with the indexTag.

Declaration

public Task IndexingStarted(string namespaceName, string indexTag)

Parameters

Type	Name	Description
string	namespaceName	"ServiceCopilot" or "AllNames"
string	indexTag	The unique id of the indexing run

Returns

Type	Description
Task

IndexingStatus(string, CancellationToken)

Call AI RAG backend services. Requires ServiceCopilot feature toggle or AiPlatform + AiTextServices/AiCategorization licenses. Gets options from appsettings.json via RagConfiguration options.

Declaration

public Task<NamespaceStatus> IndexingStatus(string namespaceName, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	namespaceName
CancellationToken	cancellationToken

Returns

Type	Description
Task<NamespaceStatus>

InitNamespace(string)

Call AI RAG backend services. Requires ServiceCopilot feature toggle or AiPlatform + AiTextServices/AiCategorization licenses. Gets options from appsettings.json via RagConfiguration options.

Declaration

public Task InitNamespace(string namespaceName)

Parameters

Type	Name	Description
string	namespaceName

Returns

Type	Description
Task

Markdownize(bool, string)

Call AI RAG backend services. Requires ServiceCopilot feature toggle or AiPlatform + AiTextServices/AiCategorization licenses. Gets options from appsettings.json via RagConfiguration options.

Declaration

public Task<string> Markdownize(bool isHtml, string documentContent)

Parameters

Type	Name	Description
bool	isHtml
string	documentContent

Returns

Type	Description
Task<string>

Markdownize(string, string, Stream)

Call AI RAG backend services. Requires ServiceCopilot feature toggle or AiPlatform + AiTextServices/AiCategorization licenses. Gets options from appsettings.json via RagConfiguration options.

Declaration

public Task<string> Markdownize(string filename, string mimeType, Stream documentContent)

Parameters

Type	Name	Description
string	filename
string	mimeType
Stream	documentContent

Returns

Type	Description
Task<string>

Markdownize(string, string, string)

Call AI RAG backend services. Requires ServiceCopilot feature toggle or AiPlatform + AiTextServices/AiCategorization licenses. Gets options from appsettings.json via RagConfiguration options.

Declaration

public Task<string> Markdownize(string filename, string mimeType, string documentContent)

Parameters

Type	Name	Description
string	filename
string	mimeType
string	documentContent

Returns

Type	Description
Task<string>

NextFormsDesignSessionCssRule(string, string, CancellationToken)

Call AI RAG backend services. Requires ServiceCopilot feature toggle or AiPlatform + AiTextServices/AiCategorization licenses. Gets options from appsettings.json via RagConfiguration options.

Declaration

public Task<CssGenerationApiResponse> NextFormsDesignSessionCssRule(string cssClass, string state, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	cssClass
string	state
CancellationToken	cancellationToken

Returns

Type	Description
Task<CssGenerationApiResponse>

PutDocument(string, string, string, string, RagType, Dictionary<string, object>)

Call AI RAG backend services. Requires ServiceCopilot feature toggle or AiPlatform + AiTextServices/AiCategorization licenses. Gets options from appsettings.json via RagConfiguration options.

Declaration

public Task PutDocument(string namespaceName, string indexRunTag, string id, string documentContent, RagType ragType, Dictionary<string, object> metadata = null)

Parameters

Type	Name	Description
string	namespaceName
string	indexRunTag
string	id
string	documentContent
RagType	ragType
Dictionary<string, object>	metadata

Returns

Type	Description
Task

Implements

Microsoft.Kiota.Abstractions.Authentication.IAccessTokenProvider

Extension Methods

EnumUtil.MapEnums<From, To>(From)

Converters.MapEnums<From, To>(From)