Class XperiflowAIClient

Namespace: Workspace.XBR.Xperiflow.Core.RestApi.AI

Assembly: Xperiflow.dll

Declaration

public class XperiflowAIClient : IXperiflowAIClient

Implements: Workspace.XBR.Xperiflow.Core.RestApi.AI.IXperiflowAIClient

Properties

JsonSerializerSettings

Declaration

protected JsonSerializerSettings JsonSerializerSettings { get; }

ReadResponseAsString

Declaration

public bool ReadResponseAsString { get; set; }

Methods

PostLLMChatResourceAsync(XperiflowSessionInfo, BodyLlmChatContext, MemoizedCacheInfo?, CancellationToken)

LLMChatResource

Declaration

public virtual Task<PostLlmChatResponseContext> PostLLMChatResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, BodyLlmChatContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Interact with an LLM chat model

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.AI.PostLlmChatResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
Workspace.XBR.Xperiflow.Core.RestApi.AI.BodyLlmChatContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PostLLMEmbeddingResourceAsync(XperiflowSessionInfo, BodyLlmEmbeddingsContext, MemoizedCacheInfo?, CancellationToken)

LLMEmbeddingResource

Declaration

public virtual Task<PostLlmEmbeddingResponseContext> PostLLMEmbeddingResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, BodyLlmEmbeddingsContext body, MemoizedCacheInfo? cacheInfo = null, CancellationToken cancellationToken = default)

Remarks

Interact with an LLM text embedding model

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.AI.PostLlmEmbeddingResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
Workspace.XBR.Xperiflow.Core.RestApi.AI.BodyLlmEmbeddingsContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<string, IEnumerable<string>>, CancellationToken)

Declaration

protected virtual Task<XperiflowAIClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)

Returns

Task<Workspace.XBR.Xperiflow.Core.RestApi.AI.XperiflowAIClient.ObjectResponseResult{{T}}>

Parameters

Type	Name
System.Net.Http.HttpResponseMessage	response
System.Collections.Generic.IReadOnlyDictionary<System.String,System.Collections.Generic.IEnumerable{System.String}>	headers
System.Threading.CancellationToken	cancellationToken

Type Parameters

• T

Implements

• Workspace.XBR.Xperiflow.Core.RestApi.AI.IXperiflowAIClient

Inherited Members

• System.Object.Equals(System.Object)
• System.Object.Equals(System.Object,System.Object)
• System.Object.GetHashCode
• System.Object.GetType
• System.Object.MemberwiseClone
• System.Object.ReferenceEquals(System.Object,System.Object)
• System.Object.ToString