AI resource

AiChatResourceCopy Anchor Link

class AiChatResource

AI chat. Reached through ovok.ai.chat.

ConstructorsCopy Anchor Link

AiChatResource.newCopy Anchor Link

AiChatResource(HttpClient ai)

Built by Ovok; use ovok.ai.chat instead.

PropertiesCopy Anchor Link

AiChatResource.sessionsCopy Anchor Link

final ChatSessionsResource sessions

Chat sessions.

AiChatResource.messagesCopy Anchor Link

final ChatMessagesResource messages

Messages in a chat session.

AiResourceCopy Anchor Link

class AiResource

AI translation, FHIR search and chat. Reached through ovok.ai.

Every request throws an OvokException subclass when it fails.

ConstructorsCopy Anchor Link

AiResource.newCopy Anchor Link

AiResource(HttpClient http)

Built by Ovok; use ovok.ai instead.

PropertiesCopy Anchor Link

AiResource.chatCopy Anchor Link

final AiChatResource chat

Chat sessions and their messages.

MethodsCopy Anchor Link

AiResource.translateCopy Anchor Link

Future<JsonMap> translate(JsonMap body)

Translates text. Calls POST ai/translation.

Returns Future<Map<String, dynamic>>.

AiResource.fhirSearchCopy Anchor Link

Future<JsonMap> fhirSearch(JsonMap body)

Answers a question by searching FHIR. Calls POST ai/fhir/search.

An LLM plans and runs the FHIR queries, so the answer can be wrong or invented.

Returns Future<Map<String, dynamic>>.

ChatMessagesResourceCopy Anchor Link

class ChatMessagesResource

Messages in an AI chat session. Reached through ovok.ai.chat.messages.

ConstructorsCopy Anchor Link

ChatMessagesResource.newCopy Anchor Link

ChatMessagesResource(HttpClient _ai)

Built by Ovok; use ovok.ai.chat.messages instead.

MethodsCopy Anchor Link

ChatMessagesResource.listCopy Anchor Link

Future<JsonMap> list(String sessionId, [QueryParams params = const {}])

Lists a session's messages. Calls GET ai/session/{sessionId}/message.

Returns Future<Map<String, dynamic>>.

ChatMessagesResource.sendCopy Anchor Link

Future<JsonMap> send(String sessionId, JsonMap body)

Sends a message to a session. Calls POST ai/session/{sessionId}/message.

Returns Future<Map<String, dynamic>>.

ChatSessionsResourceCopy Anchor Link

class ChatSessionsResource

AI chat sessions. Reached through ovok.ai.chat.sessions.

ConstructorsCopy Anchor Link

ChatSessionsResource.newCopy Anchor Link

ChatSessionsResource(HttpClient _ai)

Built by Ovok; use ovok.ai.chat.sessions instead.

MethodsCopy Anchor Link

ChatSessionsResource.createCopy Anchor Link

Future<JsonMap> create(JsonMap body)

Creates a chat session. Calls POST ai/session.

Returns Future<Map<String, dynamic>>.

ChatSessionsResource.listCopy Anchor Link

Future<JsonMap> list([QueryParams params = const {}])

Lists chat sessions. Calls GET ai/session with params.

Returns Future<Map<String, dynamic>>.

ChatSessionsResource.retrieveCopy Anchor Link

Future<JsonMap> retrieve(String sessionId, [QueryParams params = const {}])

Retrieves a chat session. Calls GET ai/session/{sessionId}.

Returns Future<Map<String, dynamic>>.