glopenai - v1.0.0

glopenai/chatkit

Types

Annotation

</> 
pub type Annotation {
  FileAnnotation(source: FileAnnotationSource)
  UrlAnnotation(source: UrlAnnotationSource)
}

Constructors

Attachment

</> 
pub type Attachment {
  Attachment(
    attachment_type: AttachmentType,
    id: String,
    name: String,
    mime_type: String,
    preview_url: option.Option(String),
  )
}

Constructors

AttachmentType

</> 
pub type AttachmentType {
  AttachmentImage
  AttachmentFile
}

Constructors 

  • AttachmentImage
  • AttachmentFile

AutomaticThreadTitlingParam

</> 
pub type AutomaticThreadTitlingParam {
  AutomaticThreadTitlingParam(enabled: option.Option(Bool))
}

Constructors

ChatSessionAutomaticThreadTitling

</> 
pub type ChatSessionAutomaticThreadTitling {
  ChatSessionAutomaticThreadTitling(enabled: Bool)
}

Constructors 

  • ChatSessionAutomaticThreadTitling(enabled: Bool)

ChatSessionChatkitConfiguration

</> 
pub type ChatSessionChatkitConfiguration {
  ChatSessionChatkitConfiguration(
    automatic_thread_titling: ChatSessionAutomaticThreadTitling,
    file_upload: ChatSessionFileUpload,
    history: ChatSessionHistory,
  )
}

Constructors

ChatSessionFileUpload

</> 
pub type ChatSessionFileUpload {
  ChatSessionFileUpload(
    enabled: Bool,
    max_file_size: option.Option(Int),
    max_files: option.Option(Int),
  )
}

Constructors

ChatSessionHistory

</> 
pub type ChatSessionHistory {
  ChatSessionHistory(
    enabled: Bool,
    recent_threads: option.Option(Int),
  )
}

Constructors 

  • ChatSessionHistory(
  enabled: Bool,
  recent_threads: option.Option(Int),
)

ChatSessionRateLimits

</> 
pub type ChatSessionRateLimits {
  ChatSessionRateLimits(max_requests_per_1_minute: Int)
}

Constructors 

  • ChatSessionRateLimits(max_requests_per_1_minute: Int)

ChatSessionResource

</> 
pub type ChatSessionResource {
  ChatSessionResource(
    id: String,
    object: String,
    expires_at: Int,
    client_secret: String,
    workflow: ChatkitWorkflow,
    user: String,
    rate_limits: ChatSessionRateLimits,
    max_requests_per_1_minute: Int,
    status: ChatSessionStatus,
    chatkit_configuration: ChatSessionChatkitConfiguration,
  )
}

Constructors

ChatSessionStatus

</> 
pub type ChatSessionStatus {
  SessionActive
  SessionExpired
  SessionCancelled
}

Constructors 

  • SessionActive
  • SessionExpired
  • SessionCancelled

ChatkitConfigurationParam

</> 
pub type ChatkitConfigurationParam {
  ChatkitConfigurationParam(
    automatic_thread_titling: option.Option(
      AutomaticThreadTitlingParam,
    ),
    file_upload: option.Option(FileUploadParam),
    history: option.Option(HistoryParam),
  )
}

Constructors

ChatkitWorkflow

</> 
pub type ChatkitWorkflow {
  ChatkitWorkflow(
    id: String,
    version: option.Option(String),
    state_variables: option.Option(
      dict.Dict(String, dynamic.Dynamic),
    ),
    tracing: ChatkitWorkflowTracing,
  )
}

Constructors

ChatkitWorkflowTracing

</> 
pub type ChatkitWorkflowTracing {
  ChatkitWorkflowTracing(enabled: Bool)
}

Constructors 

  • ChatkitWorkflowTracing(enabled: Bool)

ClientToolCallStatus

</> 
pub type ClientToolCallStatus {
  ClientToolInProgress
  ClientToolCompleted
}

Constructors 

  • ClientToolInProgress
  • ClientToolCompleted

CreateChatSessionBody

</> 
pub type CreateChatSessionBody {
  CreateChatSessionBody(
    workflow: WorkflowParam,
    user: String,
    expires_after: option.Option(ExpiresAfterParam),
    rate_limits: option.Option(RateLimitsParam),
    chatkit_configuration: option.Option(
      ChatkitConfigurationParam,
    ),
  )
}

Constructors

DeletedThreadResource

</> 
pub type DeletedThreadResource {
  DeletedThreadResource(
    id: String,
    object: String,
    deleted: Bool,
  )
}

Constructors 

  • DeletedThreadResource(id: String, object: String, deleted: Bool)

ExpiresAfterParam

</> 
pub type ExpiresAfterParam {
  ExpiresAfterParam(anchor: String, seconds: Int)
}

Constructors 

  • ExpiresAfterParam(anchor: String, seconds: Int)

FileAnnotationSource

</> 
pub type FileAnnotationSource {
  FileAnnotationSource(filename: String)
}

Constructors 

  • FileAnnotationSource(filename: String)

FileUploadParam

</> 
pub type FileUploadParam {
  FileUploadParam(
    enabled: option.Option(Bool),
    max_file_size: option.Option(Int),
    max_files: option.Option(Int),
  )
}

Constructors

HistoryParam

</> 
pub type HistoryParam {
  HistoryParam(
    enabled: option.Option(Bool),
    recent_threads: option.Option(Int),
  )
}

Constructors

InferenceOptions

</> 
pub type InferenceOptions {
  InferenceOptions(
    tool_choice: option.Option(ToolChoice),
    model: option.Option(String),
  )
}

Constructors

ListChatKitThreadItemsOrder

</> 
pub type ListChatKitThreadItemsOrder {
  ItemsAsc
  ItemsDesc
}

Constructors 

  • ItemsAsc
  • ItemsDesc

ListChatKitThreadItemsQuery

</> 
pub type ListChatKitThreadItemsQuery {
  ListChatKitThreadItemsQuery(
    limit: option.Option(Int),
    order: option.Option(ListChatKitThreadItemsOrder),
    after: option.Option(String),
    before: option.Option(String),
  )
}

Constructors

ListChatKitThreadsOrder

</> 
pub type ListChatKitThreadsOrder {
  ThreadsAsc
  ThreadsDesc
}

Constructors 

  • ThreadsAsc
  • ThreadsDesc

ListChatKitThreadsQuery

</> 
pub type ListChatKitThreadsQuery {
  ListChatKitThreadsQuery(
    limit: option.Option(Int),
    order: option.Option(ListChatKitThreadsOrder),
    after: option.Option(String),
    before: option.Option(String),
    user: option.Option(String),
  )
}

Constructors

RateLimitsParam

</> 
pub type RateLimitsParam {
  RateLimitsParam(max_requests_per_1_minute: option.Option(Int))
}

Constructors

ResponseOutputText

</> 
pub type ResponseOutputText {
  ResponseOutputText(
    output_text_type: String,
    text: String,
    annotations: List(Annotation),
  )
}

Constructors 

  • ResponseOutputText(
  output_text_type: String,
  text: String,
  annotations: List(Annotation),
)

TaskGroupTask

</> 
pub type TaskGroupTask {
  TaskGroupTask(
    task_type: TaskType,
    heading: option.Option(String),
    summary: option.Option(String),
  )
}

Constructors

TaskType

</> 
pub type TaskType {
  TaskCustom
  TaskThought
}

Constructors 

  • TaskCustom
  • TaskThought

ThreadItem

</> 
pub type ThreadItem {
  UserMessageItem(
    id: String,
    object: String,
    created_at: Int,
    thread_id: String,
    content: List(UserMessageContent),
    attachments: List(Attachment),
    inference_options: option.Option(InferenceOptions),
  )
  AssistantMessageItem(
    id: String,
    object: String,
    created_at: Int,
    thread_id: String,
    content: List(ResponseOutputText),
  )
  WidgetMessageItem(
    id: String,
    object: String,
    created_at: Int,
    thread_id: String,
    widget: String,
  )
  ClientToolCallItem(
    id: String,
    object: String,
    created_at: Int,
    thread_id: String,
    status: ClientToolCallStatus,
    call_id: String,
    name: String,
    arguments: String,
    output: option.Option(String),
  )
  TaskItem(
    id: String,
    object: String,
    created_at: Int,
    thread_id: String,
    task_type: TaskType,
    heading: option.Option(String),
    summary: option.Option(String),
  )
  TaskGroupItem(
    id: String,
    object: String,
    created_at: Int,
    thread_id: String,
    tasks: List(TaskGroupTask),
  )
}

Constructors 

  • UserMessageItem(
  id: String,
  object: String,
  created_at: Int,
  thread_id: String,
  content: List(UserMessageContent),
  attachments: List(Attachment),
  inference_options: option.Option(InferenceOptions),
)
  • AssistantMessageItem(
  id: String,
  object: String,
  created_at: Int,
  thread_id: String,
  content: List(ResponseOutputText),
)
  • WidgetMessageItem(
  id: String,
  object: String,
  created_at: Int,
  thread_id: String,
  widget: String,
)
  • ClientToolCallItem(
  id: String,
  object: String,
  created_at: Int,
  thread_id: String,
  status: ClientToolCallStatus,
  call_id: String,
  name: String,
  arguments: String,
  output: option.Option(String),
)
  • TaskItem(
  id: String,
  object: String,
  created_at: Int,
  thread_id: String,
  task_type: TaskType,
  heading: option.Option(String),
  summary: option.Option(String),
)
  • TaskGroupItem(
  id: String,
  object: String,
  created_at: Int,
  thread_id: String,
  tasks: List(TaskGroupTask),
)

ThreadItemListResource

</> 
pub type ThreadItemListResource {
  ThreadItemListResource(
    object: String,
    data: List(ThreadItem),
    first_id: option.Option(String),
    last_id: option.Option(String),
    has_more: Bool,
  )
}

Constructors

ThreadListResource

</> 
pub type ThreadListResource {
  ThreadListResource(
    object: String,
    data: List(ThreadResource),
    first_id: option.Option(String),
    last_id: option.Option(String),
    has_more: Bool,
  )
}

Constructors

ThreadResource

</> 
pub type ThreadResource {
  ThreadResource(
    id: String,
    object: String,
    created_at: Int,
    title: option.Option(String),
    status: ThreadStatus,
    user: String,
    items: option.Option(ThreadItemListResource),
  )
}

Constructors 

  • ThreadResource(
  id: String,
  object: String,
  created_at: Int,
  title: option.Option(String),
  status: ThreadStatus,
  user: String,
  items: option.Option(ThreadItemListResource),
)

    Arguments

    status

    Status discriminator. Wire format flattens these fields onto the thread object (e.g. "type": "active" or "type": "locked", "reason": "...").

ThreadStatus

</>

Status discriminator on a ThreadResource. Note: in the wire format these fields are flattened directly onto the thread object, with type distinguishing the variant.

pub type ThreadStatus {
  ThreadActive
  ThreadLocked(reason: option.Option(String))
  ThreadClosed(reason: option.Option(String))
}

Constructors

ToolChoice

</> 
pub type ToolChoice {
  ToolChoice(id: String)
}

Constructors 

  • ToolChoice(id: String)

UrlAnnotationSource

</> 
pub type UrlAnnotationSource {
  UrlAnnotationSource(url: String)
}

Constructors 

  • UrlAnnotationSource(url: String)

UserMessageContent

</> 
pub type UserMessageContent {
  InputTextContent(text: String)
  QuotedTextContent(text: String)
}

Constructors 

  • InputTextContent(text: String)
  • QuotedTextContent(text: String)

WorkflowParam

</> 
pub type WorkflowParam {
  WorkflowParam(
    id: String,
    version: option.Option(String),
    state_variables: option.Option(
      dict.Dict(String, dynamic.Dynamic),
    ),
    tracing: option.Option(WorkflowTracingParam),
  )
}

Constructors

WorkflowTracingParam

</> 
pub type WorkflowTracingParam {
  WorkflowTracingParam(enabled: option.Option(Bool))
}

Constructors

Values

annotation_decoder

</> 
pub fn annotation_decoder() -> decode.Decoder(Annotation)

automatic_thread_titling_param_to_json

</> 
pub fn automatic_thread_titling_param_to_json(
  param: AutomaticThreadTitlingParam,
) -> json.Json

chat_session_rate_limits_decoder

</> 
pub fn chat_session_rate_limits_decoder() -> decode.Decoder(
  ChatSessionRateLimits,
)

chat_session_resource_decoder

</> 
pub fn chat_session_resource_decoder() -> decode.Decoder(
  ChatSessionResource,
)

chat_session_status_decoder

</> 
pub fn chat_session_status_decoder() -> decode.Decoder(
  ChatSessionStatus,
)

chat_session_status_to_json

</> 
pub fn chat_session_status_to_json(
  status: ChatSessionStatus,
) -> json.Json

chatkit_configuration_param_to_json

</> 
pub fn chatkit_configuration_param_to_json(
  config: ChatkitConfigurationParam,
) -> json.Json

chatkit_workflow_decoder

</> 
pub fn chatkit_workflow_decoder() -> decode.Decoder(
  ChatkitWorkflow,
)

chatkit_workflow_to_json

</> 
pub fn chatkit_workflow_to_json(
  workflow: ChatkitWorkflow,
) -> json.Json

chatkit_workflow_tracing_decoder

</> 
pub fn chatkit_workflow_tracing_decoder() -> decode.Decoder(
  ChatkitWorkflowTracing,
)

chatkit_workflow_tracing_to_json

</> 
pub fn chatkit_workflow_tracing_to_json(
  tracing: ChatkitWorkflowTracing,
) -> json.Json

create_chat_session_body_to_json

</> 
pub fn create_chat_session_body_to_json(
  body: CreateChatSessionBody,
) -> json.Json

empty_list_thread_items_query

</> 
pub fn empty_list_thread_items_query() -> ListChatKitThreadItemsQuery

empty_list_threads_query

</> 
pub fn empty_list_threads_query() -> ListChatKitThreadsQuery

expires_after_param_to_json

</> 
pub fn expires_after_param_to_json(
  expires: ExpiresAfterParam,
) -> json.Json

file_upload_param_to_json

</> 
pub fn file_upload_param_to_json(
  param: FileUploadParam,
) -> json.Json

history_param_to_json

</> 
pub fn history_param_to_json(param: HistoryParam) -> json.Json

new_create_chat_session_body

</> 
pub fn new_create_chat_session_body(
  workflow: WorkflowParam,
  user: String,
) -> CreateChatSessionBody

new_expires_after_param

</> 
pub fn new_expires_after_param(seconds: Int) -> ExpiresAfterParam

Default anchor "created_at".

new_workflow_param

</> 
pub fn new_workflow_param(id: String) -> WorkflowParam

new_workflow_tracing_param

</> 
pub fn new_workflow_tracing_param() -> WorkflowTracingParam

rate_limits_param_to_json

</> 
pub fn rate_limits_param_to_json(
  rate_limits: RateLimitsParam,
) -> json.Json

session_cancel_request

</> 
pub fn session_cancel_request(
  config: config.Config,
  session_id: String,
) -> request.Request(String)

session_cancel_response

</> 
pub fn session_cancel_response(
  response: response.Response(String),
) -> Result(ChatSessionResource, error.GlopenaiError)

session_create_request

</> 
pub fn session_create_request(
  config: config.Config,
  body: CreateChatSessionBody,
) -> request.Request(String)

session_create_response

</> 
pub fn session_create_response(
  response: response.Response(String),
) -> Result(ChatSessionResource, error.GlopenaiError)

thread_delete_request

</> 
pub fn thread_delete_request(
  config: config.Config,
  thread_id: String,
) -> request.Request(String)

thread_delete_response

</> 
pub fn thread_delete_response(
  response: response.Response(String),
) -> Result(DeletedThreadResource, error.GlopenaiError)

thread_item_decoder

</> 
pub fn thread_item_decoder() -> decode.Decoder(ThreadItem)

thread_items_list_request

</> 
pub fn thread_items_list_request(
  config: config.Config,
  thread_id: String,
) -> request.Request(String)

thread_items_list_request_with_query

</> 
pub fn thread_items_list_request_with_query(
  config: config.Config,
  thread_id: String,
  query: ListChatKitThreadItemsQuery,
) -> request.Request(String)

thread_items_list_response

</> 
pub fn thread_items_list_response(
  response: response.Response(String),
) -> Result(ThreadItemListResource, error.GlopenaiError)

thread_list_request

</> 
pub fn thread_list_request(
  config: config.Config,
) -> request.Request(String)

thread_list_request_with_query

</> 
pub fn thread_list_request_with_query(
  config: config.Config,
  query: ListChatKitThreadsQuery,
) -> request.Request(String)

thread_list_response

</> 
pub fn thread_list_response(
  response: response.Response(String),
) -> Result(ThreadListResource, error.GlopenaiError)

thread_resource_decoder

</> 
pub fn thread_resource_decoder() -> decode.Decoder(ThreadResource)

thread_retrieve_request

</> 
pub fn thread_retrieve_request(
  config: config.Config,
  thread_id: String,
) -> request.Request(String)

thread_retrieve_response

</> 
pub fn thread_retrieve_response(
  response: response.Response(String),
) -> Result(ThreadResource, error.GlopenaiError)

thread_status_decoder

</> 
pub fn thread_status_decoder() -> decode.Decoder(ThreadStatus)

with_chatkit_configuration

</> 
pub fn with_chatkit_configuration(
  body: CreateChatSessionBody,
  configuration: ChatkitConfigurationParam,
) -> CreateChatSessionBody

with_expires_after

</> 
pub fn with_expires_after(
  body: CreateChatSessionBody,
  expires_after: ExpiresAfterParam,
) -> CreateChatSessionBody

with_rate_limits

</> 
pub fn with_rate_limits(
  body: CreateChatSessionBody,
  rate_limits: RateLimitsParam,
) -> CreateChatSessionBody

workflow_param_to_json

</> 
pub fn workflow_param_to_json(
  workflow: WorkflowParam,
) -> json.Json

workflow_param_with_state_variables

</> 
pub fn workflow_param_with_state_variables(
  workflow: WorkflowParam,
  state_variables: dict.Dict(String, dynamic.Dynamic),
) -> WorkflowParam

workflow_param_with_tracing

</> 
pub fn workflow_param_with_tracing(
  workflow: WorkflowParam,
  tracing: WorkflowTracingParam,
) -> WorkflowParam

workflow_param_with_version

</> 
pub fn workflow_param_with_version(
  workflow: WorkflowParam,
  version: String,
) -> WorkflowParam

workflow_tracing_param_to_json

</> 
pub fn workflow_tracing_param_to_json(
  tracing: WorkflowTracingParam,
) -> json.Json
✨ Search Document