Interface IXperiflowAIClient
Namespace: Workspace.XBR.Xperiflow.Core.RestApi.AI
Assembly: Xperiflow.dll
Declaration
public interface IXperiflowAIClient
Methods
PostLLMChatResourceAsync(XperiflowSessionInfo, BodyLlmChatContext, MemoizedCacheInfo?, CancellationToken)
LLMChatResource
Declaration
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
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.