API referenceresources
ovok_sdk.resources.ai
AI features: translation, natural-language FHIR search and chat.
- Stable unknown
- Release candidate since 0.1.0-rc.4
- Development since 0.1.0-dev.25+2ba84b0
AI features: translation, natural-language FHIR search and chat.
ChatSessionsResource
ChatSessionsResource(http: HttpClient)AI chat sessions; access it as ovok.ai.chat.sessions.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
http | HttpClient | The HTTP client scoped to the AI routes. |
create()
create(body: Resource) -> ResourceStart a chat session.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
body | Resource | The session as the API takes it. |
Returns
Resource: The created session.
list()
list(params: QueryParams | None = None) -> ResourceList chat sessions.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
params | QueryParams | None | None | Optional query parameters passed to the API. |
Returns
Resource: The API's list response.
retrieve()
retrieve(session_id: str, params: QueryParams | None = None) -> ResourceRead one chat session.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
session_id | str | The session ID. | |
params | QueryParams | None | None | Optional query parameters passed to the API. |
Returns
Resource: The session.
ChatMessagesResource
ChatMessagesResource(http: HttpClient)Messages in an AI chat session; access it as ovok.ai.chat.messages.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
http | HttpClient | The HTTP client scoped to the AI routes. |
list()
list(session_id: str, params: QueryParams | None = None) -> ResourceList a session's messages.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
session_id | str | The session ID. | |
params | QueryParams | None | None | Optional query parameters passed to the API. |
Returns
Resource: The API's list response.
send()
send(session_id: str, body: Resource) -> ResourceSend a message to a session.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
session_id | str | The session ID. | |
body | Resource | The message as the API takes it. |
Returns
Resource: The API's reply.
AiChatResource
AiChatResource(http: HttpClient)AI chat sessions and their messages; access it as ovok.ai.chat.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
http | HttpClient | The HTTP client scoped to the AI routes. |
AiResource
AiResource(http: HttpClient)Translation, natural-language FHIR search and chat.
Created by Ovok; access it as ovok.ai.
translate()
translate(body: Resource) -> ResourceTranslate text.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
body | Resource | The translation request as the API takes it. |
Returns
Resource: The translation.
fhir_search()
fhir_search(body: Resource) -> ResourceSearch FHIR data with a natural-language query.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
body | Resource | The search request as the API takes it. |
Returns
Resource: The search result.
Last updated on