glopenai - v1.0.0

glopenai/response

Types

Annotation

</>

Tagged by “type”.

pub type Annotation {
  AnnotationFileCitation(FileCitationBody)
  AnnotationUrlCitation(UrlCitationBody)
  AnnotationContainerFileCitation(ContainerFileCitationBody)
  AnnotationFilePath(FilePathAnnotation)
}

Constructors

ApplyPatchCallOutputStatusParam

</> 
pub type ApplyPatchCallOutputStatusParam {
  ApplyPatchOutputCompleted
  ApplyPatchOutputFailed
}

Constructors 

  • ApplyPatchOutputCompleted
  • ApplyPatchOutputFailed

ApplyPatchCallStatusParam

</> 
pub type ApplyPatchCallStatusParam {
  ApplyPatchInProgress
  ApplyPatchCompleted
}

Constructors 

  • ApplyPatchInProgress
  • ApplyPatchCompleted

ApplyPatchCreateFileOperation

</> 
pub type ApplyPatchCreateFileOperation {
  ApplyPatchCreateFileOperation(path: String, diff: String)
}

Constructors 

  • ApplyPatchCreateFileOperation(path: String, diff: String)

ApplyPatchCreateFileOperationParam

</> 
pub type ApplyPatchCreateFileOperationParam {
  ApplyPatchCreateFileOperationParam(path: String, diff: String)
}

Constructors 

  • ApplyPatchCreateFileOperationParam(path: String, diff: String)

ApplyPatchDeleteFileOperation

</> 
pub type ApplyPatchDeleteFileOperation {
  ApplyPatchDeleteFileOperation(path: String)
}

Constructors 

  • ApplyPatchDeleteFileOperation(path: String)

ApplyPatchDeleteFileOperationParam

</> 
pub type ApplyPatchDeleteFileOperationParam {
  ApplyPatchDeleteFileOperationParam(path: String)
}

Constructors 

  • ApplyPatchDeleteFileOperationParam(path: String)

ApplyPatchOperation

</>

Tagged by “type”.

pub type ApplyPatchOperation {
  ApplyPatchCreateFile(ApplyPatchCreateFileOperation)
  ApplyPatchDeleteFile(ApplyPatchDeleteFileOperation)
  ApplyPatchUpdateFile(ApplyPatchUpdateFileOperation)
}

Constructors

ApplyPatchOperationParam

</>

Tagged by “type”.

pub type ApplyPatchOperationParam {
  ApplyPatchOpCreateFile(ApplyPatchCreateFileOperationParam)
  ApplyPatchOpDeleteFile(ApplyPatchDeleteFileOperationParam)
  ApplyPatchOpUpdateFile(ApplyPatchUpdateFileOperationParam)
}

Constructors

ApplyPatchToolCall

</> 
pub type ApplyPatchToolCall {
  ApplyPatchToolCall(
    id: String,
    call_id: String,
    status: ApplyPatchCallStatusParam,
    operation: ApplyPatchOperation,
    created_by: option.Option(String),
  )
}

Constructors

ApplyPatchToolCallItemParam

</> 
pub type ApplyPatchToolCallItemParam {
  ApplyPatchToolCallItemParam(
    id: option.Option(String),
    call_id: String,
    status: ApplyPatchCallStatusParam,
    operation: ApplyPatchOperationParam,
  )
}

Constructors

ApplyPatchToolCallOutput

</> 
pub type ApplyPatchToolCallOutput {
  ApplyPatchToolCallOutput(
    id: String,
    call_id: String,
    status: ApplyPatchCallOutputStatusParam,
    output: option.Option(String),
    created_by: option.Option(String),
  )
}

Constructors

ApplyPatchToolCallOutputItemParam

</> 
pub type ApplyPatchToolCallOutputItemParam {
  ApplyPatchToolCallOutputItemParam(
    id: option.Option(String),
    call_id: String,
    status: ApplyPatchCallOutputStatusParam,
    output: option.Option(String),
  )
}

Constructors

ApplyPatchUpdateFileOperation

</> 
pub type ApplyPatchUpdateFileOperation {
  ApplyPatchUpdateFileOperation(path: String, diff: String)
}

Constructors 

  • ApplyPatchUpdateFileOperation(path: String, diff: String)

ApplyPatchUpdateFileOperationParam

</> 
pub type ApplyPatchUpdateFileOperationParam {
  ApplyPatchUpdateFileOperationParam(path: String, diff: String)
}

Constructors 

  • ApplyPatchUpdateFileOperationParam(path: String, diff: String)

Billing

</> 
pub type Billing {
  Billing(payer: String)
}

Constructors 

  • Billing(payer: String)

ClickButtonType

</> 
pub type ClickButtonType {
  ClickLeft
  ClickRight
  ClickWheel
  ClickBack
  ClickForward
}

Constructors 

  • ClickLeft
  • ClickRight
  • ClickWheel
  • ClickBack
  • ClickForward

ClickParam

</> 
pub type ClickParam {
  ClickParam(button: ClickButtonType, x: Int, y: Int)
}

Constructors

CodeInterpreterContainerAuto

</> 
pub type CodeInterpreterContainerAuto {
  CodeInterpreterContainerAuto(
    file_ids: option.Option(List(String)),
    memory_limit: option.Option(Int),
  )
}

Constructors

CodeInterpreterOutputImage

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

Constructors 

  • CodeInterpreterOutputImage(url: String)

CodeInterpreterOutputLogs

</> 
pub type CodeInterpreterOutputLogs {
  CodeInterpreterOutputLogs(logs: String)
}

Constructors 

  • CodeInterpreterOutputLogs(logs: String)

CodeInterpreterTool

</> 
pub type CodeInterpreterTool {
  CodeInterpreterTool(container: CodeInterpreterToolContainer)
}

Constructors

CodeInterpreterToolCall

</> 
pub type CodeInterpreterToolCall {
  CodeInterpreterToolCall(
    code: option.Option(String),
    container_id: String,
    id: String,
    outputs: option.Option(List(CodeInterpreterToolCallOutput)),
    status: CodeInterpreterToolCallStatus,
  )
}

Constructors

CodeInterpreterToolCallOutput

</>

Tagged by “type”.

pub type CodeInterpreterToolCallOutput {
  CodeInterpOutputLogs(CodeInterpreterOutputLogs)
  CodeInterpOutputImage(CodeInterpreterOutputImage)
}

Constructors

CodeInterpreterToolCallStatus

</> 
pub type CodeInterpreterToolCallStatus {
  CodeInterpInProgress
  CodeInterpCompleted
  CodeInterpIncomplete
  CodeInterpInterpreting
  CodeInterpFailed
}

Constructors 

  • CodeInterpInProgress
  • CodeInterpCompleted
  • CodeInterpIncomplete
  • CodeInterpInterpreting
  • CodeInterpFailed

CodeInterpreterToolContainer

</>

Tagged by “type”, with ContainerID as untagged fallback.

pub type CodeInterpreterToolContainer {
  CodeInterpContainerAuto(CodeInterpreterContainerAuto)
  CodeInterpContainerId(String)
}

Constructors

CompactResource

</> 
pub type CompactResource {
  CompactResource(
    id: String,
    object: String,
    output: List(OutputItem),
    created_at: Int,
    usage: shared.ResponseUsage,
  )
}

Constructors

CompactionBody

</> 
pub type CompactionBody {
  CompactionBody(
    id: String,
    encrypted_content: String,
    created_by: option.Option(String),
  )
}

Constructors 

  • CompactionBody(
  id: String,
  encrypted_content: String,
  created_by: option.Option(String),
)

CompactionSummaryItemParam

</> 
pub type CompactionSummaryItemParam {
  CompactionSummaryItemParam(
    id: option.Option(String),
    encrypted_content: String,
  )
}

Constructors 

  • CompactionSummaryItemParam(
  id: option.Option(String),
  encrypted_content: String,
)

ComputerAction

</>

Tagged by “type”.

pub type ComputerAction {
  ComputerClick(ClickParam)
  ComputerDoubleClick(DoubleClickAction)
  ComputerDrag(DragParam)
  ComputerKeypress(KeyPressAction)
  ComputerMove(MoveParam)
  ComputerScreenshot
  ComputerScroll(ScrollParam)
  ComputerType(TypeActionParam)
  ComputerWait
}

Constructors

ComputerCallOutputItemParam

</> 
pub type ComputerCallOutputItemParam {
  ComputerCallOutputItemParam(
    call_id: String,
    output: ComputerScreenshotImage,
    acknowledged_safety_checks: option.Option(
      List(ComputerCallSafetyCheckParam),
    ),
    id: option.Option(String),
    status: option.Option(OutputStatus),
  )
}

Constructors

ComputerCallSafetyCheckParam

</> 
pub type ComputerCallSafetyCheckParam {
  ComputerCallSafetyCheckParam(
    id: String,
    code: option.Option(String),
    message: option.Option(String),
  )
}

Constructors

ComputerEnvironment

</> 
pub type ComputerEnvironment {
  EnvironmentWindows
  EnvironmentMac
  EnvironmentLinux
  EnvironmentUbuntu
  EnvironmentBrowser
}

Constructors 

  • EnvironmentWindows
  • EnvironmentMac
  • EnvironmentLinux
  • EnvironmentUbuntu
  • EnvironmentBrowser

ComputerScreenshotImage

</> 
pub type ComputerScreenshotImage {
  ComputerScreenshotImage(
    file_id: option.Option(String),
    image_url: option.Option(String),
  )
}

Constructors

ComputerToolCall

</> 
pub type ComputerToolCall {
  ComputerToolCall(
    action: option.Option(ComputerAction),
    actions: option.Option(List(ComputerAction)),
    call_id: String,
    id: String,
    pending_safety_checks: List(ComputerCallSafetyCheckParam),
    status: OutputStatus,
  )
}

Constructors

ComputerUsePreviewTool

</> 
pub type ComputerUsePreviewTool {
  ComputerUsePreviewTool(
    environment: ComputerEnvironment,
    display_width: Int,
    display_height: Int,
  )
}

Constructors 

  • ComputerUsePreviewTool(
  environment: ComputerEnvironment,
  display_width: Int,
  display_height: Int,
)

ContainerAutoParam

</> 
pub type ContainerAutoParam {
  ContainerAutoParam(
    file_ids: option.Option(List(String)),
    network_policy: option.Option(dynamic.Dynamic),
    skills: option.Option(dynamic.Dynamic),
  )
}

Constructors

ContainerFileCitationBody

</> 
pub type ContainerFileCitationBody {
  ContainerFileCitationBody(
    container_id: String,
    end_index: Int,
    file_id: String,
    filename: String,
    start_index: Int,
  )
}

Constructors 

  • ContainerFileCitationBody(
  container_id: String,
  end_index: Int,
  file_id: String,
  filename: String,
  start_index: Int,
)

ContainerReferenceParam

</> 
pub type ContainerReferenceParam {
  ContainerReferenceParam(container_id: String)
}

Constructors 

  • ContainerReferenceParam(container_id: String)

ContainerReferenceResource

</> 
pub type ContainerReferenceResource {
  ContainerReferenceResource(container_id: String)
}

Constructors 

  • ContainerReferenceResource(container_id: String)

Conversation

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

Constructors 

  • Conversation(id: String)

ConversationParam

</>

Untagged: string ID or object.

pub type ConversationParam {
  ConversationId(String)
  ConversationObject(Conversation)
}

Constructors

CoordParam

</> 
pub type CoordParam {
  CoordParam(x: Int, y: Int)
}

Constructors 

  • CoordParam(x: Int, y: Int)

CreateResponse

</> 
pub type CreateResponse {
  CreateResponse(
    background: option.Option(Bool),
    conversation: option.Option(ConversationParam),
    include: option.Option(List(IncludeEnum)),
    input: InputParam,
    instructions: option.Option(String),
    max_output_tokens: option.Option(Int),
    max_tool_calls: option.Option(Int),
    metadata: option.Option(dict.Dict(String, String)),
    model: option.Option(String),
    parallel_tool_calls: option.Option(Bool),
    previous_response_id: option.Option(String),
    prompt: option.Option(Prompt),
    prompt_cache_key: option.Option(String),
    prompt_cache_retention: option.Option(PromptCacheRetention),
    reasoning: option.Option(Reasoning),
    safety_identifier: option.Option(String),
    service_tier: option.Option(ServiceTier),
    store: option.Option(Bool),
    stream: option.Option(Bool),
    stream_options: option.Option(ResponseStreamOptions),
    temperature: option.Option(Float),
    text: option.Option(ResponseTextParam),
    tool_choice: option.Option(ToolChoiceParam),
    tools: option.Option(List(Tool)),
    top_logprobs: option.Option(Int),
    top_p: option.Option(Float),
    truncation: option.Option(Truncation),
  )
}

Constructors

CustomToolCall

</> 
pub type CustomToolCall {
  CustomToolCall(
    call_id: String,
    namespace: option.Option(String),
    input: String,
    name: String,
    id: String,
  )
}

Constructors 

  • CustomToolCall(
  call_id: String,
  namespace: option.Option(String),
  input: String,
  name: String,
  id: String,
)

CustomToolCallOutput

</> 
pub type CustomToolCallOutput {
  CustomToolCallOutput(
    call_id: String,
    output: CustomToolCallOutputOutput,
    id: option.Option(String),
  )
}

Constructors

CustomToolCallOutputOutput

</> 
pub type CustomToolCallOutputOutput {
  CustomToolCallOutputText(String)
  CustomToolCallOutputList(List(InputContent))
}

Constructors 

  • CustomToolCallOutputText(String)
  • CustomToolCallOutputList(List(InputContent))

CustomToolParam

</> 
pub type CustomToolParam {
  CustomToolParam(
    name: String,
    description: option.Option(String),
    format: CustomToolParamFormat,
    defer_loading: option.Option(Bool),
  )
}

Constructors

CustomToolParamFormat

</> 
pub type CustomToolParamFormat {
  CustomFormatText
  CustomFormatGrammar(dynamic.Dynamic)
}

Constructors

DeleteResponse

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

Constructors 

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

DoubleClickAction

</> 
pub type DoubleClickAction {
  DoubleClickAction(x: Int, y: Int)
}

Constructors 

  • DoubleClickAction(x: Int, y: Int)

DragParam

</> 
pub type DragParam {
  DragParam(path: List(CoordParam))
}

Constructors

EasyInputContent

</>

Untagged: content can be string or list.

pub type EasyInputContent {
  EasyContentText(String)
  EasyContentList(List(InputContent))
}

Constructors 

  • EasyContentText(String)
  • EasyContentList(List(InputContent))

EasyInputMessage

</> 
pub type EasyInputMessage {
  EasyInputMessage(
    role: Role,
    content: EasyInputContent,
    phase: option.Option(MessagePhase),
  )
}

Constructors

ErrorObject

</> 
pub type ErrorObject {
  ErrorObject(code: String, message: String)
}

Constructors 

  • ErrorObject(code: String, message: String)

FileCitationBody

</> 
pub type FileCitationBody {
  FileCitationBody(file_id: String, filename: String, index: Int)
}

Constructors 

  • FileCitationBody(file_id: String, filename: String, index: Int)

FilePathAnnotation

</> 
pub type FilePathAnnotation {
  FilePathAnnotation(file_id: String, index: Int)
}

Constructors 

  • FilePathAnnotation(file_id: String, index: Int)

FileSearchTool

</> 
pub type FileSearchTool {
  FileSearchTool(
    vector_store_ids: List(String),
    max_num_results: option.Option(Int),
    filters: option.Option(dynamic.Dynamic),
    ranking_options: option.Option(RankingOptions),
  )
}

Constructors

FileSearchToolCall

</> 
pub type FileSearchToolCall {
  FileSearchToolCall(
    id: String,
    queries: List(String),
    status: FileSearchToolCallStatus,
    results: option.Option(List(FileSearchToolCallResult)),
  )
}

Constructors

FileSearchToolCallResult

</> 
pub type FileSearchToolCallResult {
  FileSearchToolCallResult(
    attributes: dynamic.Dynamic,
    file_id: String,
    filename: String,
    score: Float,
    text: String,
  )
}

Constructors 

  • FileSearchToolCallResult(
  attributes: dynamic.Dynamic,
  file_id: String,
  filename: String,
  score: Float,
  text: String,
)

FileSearchToolCallStatus

</> 
pub type FileSearchToolCallStatus {
  FileSearchInProgress
  FileSearchSearching
  FileSearchIncomplete
  FileSearchFailed
  FileSearchCompleted
}

Constructors 

  • FileSearchInProgress
  • FileSearchSearching
  • FileSearchIncomplete
  • FileSearchFailed
  • FileSearchCompleted

FunctionCallOutput

</>

Untagged: string or content list.

pub type FunctionCallOutput {
  FunctionCallOutputText(String)
  FunctionCallOutputContent(List(InputContent))
}

Constructors 

  • FunctionCallOutputText(String)
  • FunctionCallOutputContent(List(InputContent))

FunctionCallOutputItemParam

</> 
pub type FunctionCallOutputItemParam {
  FunctionCallOutputItemParam(
    call_id: String,
    output: FunctionCallOutput,
    id: option.Option(String),
    status: option.Option(OutputStatus),
  )
}

Constructors

FunctionCallStatus

</> 
pub type FunctionCallStatus {
  FunctionCallInProgress
  FunctionCallCompleted
  FunctionCallIncomplete
}

Constructors 

  • FunctionCallInProgress
  • FunctionCallCompleted
  • FunctionCallIncomplete

FunctionShellAction

</> 
pub type FunctionShellAction {
  FunctionShellAction(
    commands: List(String),
    timeout_ms: option.Option(Int),
    max_output_length: option.Option(Int),
  )
}

Constructors

FunctionShellActionParam

</> 
pub type FunctionShellActionParam {
  FunctionShellActionParam(
    commands: List(String),
    timeout_ms: option.Option(Int),
    max_output_length: option.Option(Int),
  )
}

Constructors

FunctionShellCall

</> 
pub type FunctionShellCall {
  FunctionShellCall(
    id: String,
    call_id: String,
    action: FunctionShellAction,
    status: FunctionShellCallItemStatus,
    environment: option.Option(FunctionShellCallEnvironment),
    created_by: option.Option(String),
  )
}

Constructors

FunctionShellCallEnvironment

</>

Tagged by “type”.

pub type FunctionShellCallEnvironment {
  ShellCallEnvLocal
  ShellCallEnvContainerReference(ContainerReferenceResource)
}

Constructors

FunctionShellCallItemEnvironment

</>

Tagged by “type”.

pub type FunctionShellCallItemEnvironment {
  ShellEnvLocal(LocalEnvironmentParam)
  ShellEnvContainerReference(ContainerReferenceParam)
}

Constructors

FunctionShellCallItemParam

</> 
pub type FunctionShellCallItemParam {
  FunctionShellCallItemParam(
    id: option.Option(String),
    call_id: String,
    action: FunctionShellActionParam,
    status: option.Option(FunctionShellCallItemStatus),
    environment: option.Option(FunctionShellCallItemEnvironment),
  )
}

Constructors

FunctionShellCallItemStatus

</> 
pub type FunctionShellCallItemStatus {
  ShellItemInProgress
  ShellItemCompleted
  ShellItemIncomplete
}

Constructors 

  • ShellItemInProgress
  • ShellItemCompleted
  • ShellItemIncomplete

FunctionShellCallOutput

</> 
pub type FunctionShellCallOutput {
  FunctionShellCallOutput(
    id: String,
    call_id: String,
    output: List(FunctionShellCallOutputContent),
    max_output_length: option.Option(Int),
    created_by: option.Option(String),
  )
}

Constructors

FunctionShellCallOutputContent

</> 
pub type FunctionShellCallOutputContent {
  FunctionShellCallOutputContent(
    stdout: String,
    stderr: String,
    outcome: FunctionShellCallOutputOutcome,
    created_by: option.Option(String),
  )
}

Constructors

FunctionShellCallOutputContentParam

</> 
pub type FunctionShellCallOutputContentParam {
  FunctionShellCallOutputContentParam(
    stdout: String,
    stderr: String,
    outcome: FunctionShellCallOutputOutcomeParam,
  )
}

Constructors

FunctionShellCallOutputExitOutcome

</> 
pub type FunctionShellCallOutputExitOutcome {
  FunctionShellCallOutputExitOutcome(exit_code: Int)
}

Constructors 

  • FunctionShellCallOutputExitOutcome(exit_code: Int)

FunctionShellCallOutputExitOutcomeParam

</> 
pub type FunctionShellCallOutputExitOutcomeParam {
  FunctionShellCallOutputExitOutcomeParam(exit_code: Int)
}

Constructors 

  • FunctionShellCallOutputExitOutcomeParam(exit_code: Int)

FunctionShellCallOutputItemParam

</> 
pub type FunctionShellCallOutputItemParam {
  FunctionShellCallOutputItemParam(
    id: option.Option(String),
    call_id: String,
    output: List(FunctionShellCallOutputContentParam),
    max_output_length: option.Option(Int),
  )
}

Constructors

FunctionShellCallOutputOutcome

</>

Tagged by “type”.

pub type FunctionShellCallOutputOutcome {
  ShellCallOutcomeTimeout
  ShellCallOutcomeExit(FunctionShellCallOutputExitOutcome)
}

Constructors

FunctionShellCallOutputOutcomeParam

</>

Tagged by “type”.

pub type FunctionShellCallOutputOutcomeParam {
  ShellOutcomeTimeout
  ShellOutcomeExit(FunctionShellCallOutputExitOutcomeParam)
}

Constructors

FunctionShellEnvironment

</> 
pub type FunctionShellEnvironment {
  FunctionShellEnvContainerAuto(ContainerAutoParam)
  FunctionShellEnvLocal(LocalEnvironmentParam)
  FunctionShellEnvContainerReference(ContainerReferenceParam)
}

Constructors

FunctionShellToolParam

</> 
pub type FunctionShellToolParam {
  FunctionShellToolParam(
    environment: option.Option(FunctionShellEnvironment),
  )
}

Constructors

FunctionTool

</> 
pub type FunctionTool {
  FunctionTool(
    name: String,
    parameters: option.Option(dynamic.Dynamic),
    strict: option.Option(Bool),
    description: option.Option(String),
    defer_loading: option.Option(Bool),
  )
}

Constructors

FunctionToolCall

</> 
pub type FunctionToolCall {
  FunctionToolCall(
    arguments: String,
    call_id: String,
    namespace: option.Option(String),
    name: String,
    id: option.Option(String),
    status: option.Option(OutputStatus),
  )
}

Constructors

FunctionToolParam

</> 
pub type FunctionToolParam {
  FunctionToolParam(
    name: String,
    description: option.Option(String),
    parameters: option.Option(dynamic.Dynamic),
    strict: option.Option(Bool),
    defer_loading: option.Option(Bool),
  )
}

Constructors

HybridSearch

</> 
pub type HybridSearch {
  HybridSearch(embedding_weight: Float, text_weight: Float)
}

Constructors 

  • HybridSearch(embedding_weight: Float, text_weight: Float)

ImageGenActionEnum

</> 
pub type ImageGenActionEnum {
  ImageGenGenerate
  ImageGenEdit
  ImageGenActionAuto
}

Constructors 

  • ImageGenGenerate
  • ImageGenEdit
  • ImageGenActionAuto

ImageGenTool

</> 
pub type ImageGenTool {
  ImageGenTool(
    background: option.Option(ImageGenToolBackground),
    input_fidelity: option.Option(InputFidelity),
    input_image_mask: option.Option(ImageGenToolInputImageMask),
    model: option.Option(String),
    moderation: option.Option(ImageGenToolModeration),
    output_compression: option.Option(Int),
    output_format: option.Option(ImageGenToolOutputFormat),
    partial_images: option.Option(Int),
    quality: option.Option(ImageGenToolQuality),
    size: option.Option(ImageGenToolSize),
    action: option.Option(ImageGenActionEnum),
  )
}

Constructors

ImageGenToolBackground

</> 
pub type ImageGenToolBackground {
  ImageGenBgTransparent
  ImageGenBgOpaque
  ImageGenBgAuto
}

Constructors 

  • ImageGenBgTransparent
  • ImageGenBgOpaque
  • ImageGenBgAuto

ImageGenToolCall

</> 
pub type ImageGenToolCall {
  ImageGenToolCall(
    id: String,
    result: option.Option(String),
    status: ImageGenToolCallStatus,
  )
}

Constructors

ImageGenToolCallStatus

</> 
pub type ImageGenToolCallStatus {
  ImageGenCallInProgress
  ImageGenCallCompleted
  ImageGenCallGenerating
  ImageGenCallFailed
}

Constructors 

  • ImageGenCallInProgress
  • ImageGenCallCompleted
  • ImageGenCallGenerating
  • ImageGenCallFailed

ImageGenToolInputImageMask

</> 
pub type ImageGenToolInputImageMask {
  ImageGenToolInputImageMask(
    image_url: option.Option(String),
    file_id: option.Option(String),
  )
}

Constructors

ImageGenToolModeration

</> 
pub type ImageGenToolModeration {
  ImageGenModerationAuto
  ImageGenModerationLow
}

Constructors 

  • ImageGenModerationAuto
  • ImageGenModerationLow

ImageGenToolOutputFormat

</> 
pub type ImageGenToolOutputFormat {
  ImageGenFmtPng
  ImageGenFmtWebp
  ImageGenFmtJpeg
}

Constructors 

  • ImageGenFmtPng
  • ImageGenFmtWebp
  • ImageGenFmtJpeg

ImageGenToolQuality

</> 
pub type ImageGenToolQuality {
  ImageGenQualityLow
  ImageGenQualityMedium
  ImageGenQualityHigh
  ImageGenQualityAuto
}

Constructors 

  • ImageGenQualityLow
  • ImageGenQualityMedium
  • ImageGenQualityHigh
  • ImageGenQualityAuto

ImageGenToolSize

</> 
pub type ImageGenToolSize {
  ImageGenSizeAuto
  ImageGenSize1024x1024
  ImageGenSize1024x1536
  ImageGenSize1536x1024
}

Constructors 

  • ImageGenSizeAuto
  • ImageGenSize1024x1024
  • ImageGenSize1024x1536
  • ImageGenSize1536x1024

IncludeEnum

</>

Which data to include in the response.

pub type IncludeEnum {
  IncludeFileSearchCallResults
  IncludeWebSearchCallResults
  IncludeWebSearchCallActionSources
  IncludeMessageInputImageImageUrl
  IncludeComputerCallOutputOutputImageUrl
  IncludeCodeInterpreterCallOutputs
  IncludeReasoningEncryptedContent
  IncludeMessageOutputTextLogprobs
}

Constructors 

  • IncludeFileSearchCallResults
  • IncludeWebSearchCallResults
  • IncludeWebSearchCallActionSources
  • IncludeMessageInputImageImageUrl
  • IncludeComputerCallOutputOutputImageUrl
  • IncludeCodeInterpreterCallOutputs
  • IncludeReasoningEncryptedContent
  • IncludeMessageOutputTextLogprobs

IncompleteDetails

</> 
pub type IncompleteDetails {
  IncompleteDetails(reason: String)
}

Constructors 

  • IncompleteDetails(reason: String)

InputContent

</>

Parts of a message: text, image, or file. Tagged by “type”.

pub type InputContent {
  ContentInputText(InputTextContent)
  ContentInputImage(InputImageContent)
  ContentInputFile(InputFileContent)
}

Constructors

InputFidelity

</> 
pub type InputFidelity {
  FidelityHigh
  FidelityLow
}

Constructors 

  • FidelityHigh
  • FidelityLow

InputFileContent

</> 
pub type InputFileContent {
  InputFileContent(
    file_data: option.Option(String),
    file_id: option.Option(String),
    file_url: option.Option(String),
    filename: option.Option(String),
  )
}

Constructors

InputImageContent

</> 
pub type InputImageContent {
  InputImageContent(
    detail: shared.ImageDetail,
    file_id: option.Option(String),
    image_url: option.Option(String),
  )
}

Constructors

InputItem

</>

Untagged: ItemReference, Item, or EasyMessage.

pub type InputItem {
  InputItemReference(ItemReference)
  InputItemItem(Item)
  InputItemEasyMessage(EasyInputMessage)
}

Constructors

InputMessage

</> 
pub type InputMessage {
  InputMessage(
    content: List(InputContent),
    role: InputRole,
    status: option.Option(OutputStatus),
  )
}

Constructors

InputParam

</>

Untagged: text string or list of items.

pub type InputParam {
  InputText(String)
  InputItems(List(InputItem))
}

Constructors 

  • InputText(String)
  • InputItems(List(InputItem))

InputRole

</> 
pub type InputRole {
  InputRoleUser
  InputRoleSystem
  InputRoleDeveloper
}

Constructors 

  • InputRoleUser
  • InputRoleSystem
  • InputRoleDeveloper

InputTextContent

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

Constructors 

  • InputTextContent(text: String)

Instructions

</>

Untagged: text string or item array.

pub type Instructions {
  InstructionsText(String)
  InstructionsArray(List(InputItem))
}

Constructors 

  • InstructionsText(String)
  • InstructionsArray(List(InputItem))

Item

</>

Content item used to generate a response. Tagged by “type”.

pub type Item {
  ItemMessage(MessageItem)
  ItemFileSearchCall(FileSearchToolCall)
  ItemComputerCall(ComputerToolCall)
  ItemComputerCallOutput(ComputerCallOutputItemParam)
  ItemWebSearchCall(WebSearchToolCall)
  ItemFunctionCall(FunctionToolCall)
  ItemFunctionCallOutput(FunctionCallOutputItemParam)
  ItemToolSearchCall(ToolSearchCallItemParam)
  ItemToolSearchOutput(ToolSearchOutputItemParam)
  ItemReasoning(ReasoningItem)
  ItemCompaction(CompactionSummaryItemParam)
  ItemImageGenerationCall(ImageGenToolCall)
  ItemCodeInterpreterCall(CodeInterpreterToolCall)
  ItemLocalShellCall(LocalShellToolCall)
  ItemLocalShellCallOutput(LocalShellToolCallOutput)
  ItemShellCall(FunctionShellCallItemParam)
  ItemShellCallOutput(FunctionShellCallOutputItemParam)
  ItemApplyPatchCall(ApplyPatchToolCallItemParam)
  ItemApplyPatchCallOutput(ApplyPatchToolCallOutputItemParam)
  ItemMcpListTools(McpListTools)
  ItemMcpApprovalRequest(McpApprovalRequest)
  ItemMcpApprovalResponse(McpApprovalResponse)
  ItemMcpCall(McpToolCall)
  ItemCustomToolCallOutput(CustomToolCallOutput)
  ItemCustomToolCall(CustomToolCall)
}

Constructors

ItemReference

</> 
pub type ItemReference {
  ItemReference(item_type: option.Option(String), id: String)
}

Constructors

KeyPressAction

</> 
pub type KeyPressAction {
  KeyPressAction(keys: List(String))
}

Constructors 

  • KeyPressAction(keys: List(String))

LocalEnvironmentParam

</> 
pub type LocalEnvironmentParam {
  LocalEnvironmentParam(skills: option.Option(dynamic.Dynamic))
}

Constructors

LocalShellExecAction

</> 
pub type LocalShellExecAction {
  LocalShellExecAction(
    command: List(String),
    env: dict.Dict(String, String),
    timeout_ms: option.Option(Int),
    user: option.Option(String),
    working_directory: option.Option(String),
  )
}

Constructors

LocalShellToolCall

</> 
pub type LocalShellToolCall {
  LocalShellToolCall(
    action: LocalShellExecAction,
    call_id: String,
    id: String,
    status: OutputStatus,
  )
}

Constructors

LocalShellToolCallOutput

</> 
pub type LocalShellToolCallOutput {
  LocalShellToolCallOutput(
    id: String,
    output: String,
    status: option.Option(OutputStatus),
  )
}

Constructors

McpApprovalRequest

</> 
pub type McpApprovalRequest {
  McpApprovalRequest(
    arguments: String,
    id: String,
    name: String,
    server_label: String,
  )
}

Constructors 

  • McpApprovalRequest(
  arguments: String,
  id: String,
  name: String,
  server_label: String,
)

McpApprovalResponse

</> 
pub type McpApprovalResponse {
  McpApprovalResponse(
    approval_request_id: String,
    approve: Bool,
    id: option.Option(String),
    reason: option.Option(String),
  )
}

Constructors

McpListTools

</> 
pub type McpListTools {
  McpListTools(
    id: String,
    server_label: String,
    tools: dynamic.Dynamic,
    error: option.Option(String),
  )
}

Constructors

McpToolCall

</> 
pub type McpToolCall {
  McpToolCall(
    arguments: String,
    id: String,
    name: String,
    server_label: String,
    approval_request_id: option.Option(String),
    error: option.Option(String),
    output: option.Option(String),
    status: option.Option(McpToolCallStatus),
  )
}

Constructors

McpToolCallStatus

</> 
pub type McpToolCallStatus {
  McpCallInProgress
  McpCallCompleted
  McpCallIncomplete
  McpCallCalling
  McpCallFailed
}

Constructors 

  • McpCallInProgress
  • McpCallCompleted
  • McpCallIncomplete
  • McpCallCalling
  • McpCallFailed

MessageItem

</>

Untagged: OutputMessage or InputMessage.

pub type MessageItem {
  MessageItemOutput(OutputMessage)
  MessageItemInput(InputMessage)
}

Constructors

MessagePhase

</> 
pub type MessagePhase {
  Commentary
  FinalAnswer
}

Constructors 

  • Commentary
  • FinalAnswer

MoveParam

</> 
pub type MoveParam {
  MoveParam(x: Int, y: Int)
}

Constructors 

  • MoveParam(x: Int, y: Int)

NamespaceToolParam

</> 
pub type NamespaceToolParam {
  NamespaceToolParam(
    name: String,
    description: String,
    tools: List(NamespaceToolParamTool),
  )
}

Constructors

NamespaceToolParamTool

</> 
pub type NamespaceToolParamTool {
  NamespaceFunction(FunctionToolParam)
  NamespaceCustom(CustomToolParam)
}

Constructors

OutputContent

</>

Tagged by “type”.

pub type OutputContent {
  OutputContentOutputText(OutputTextContent)
  OutputContentRefusal(RefusalContent)
  OutputContentReasoningText(ReasoningTextContent)
}

Constructors

OutputItem

</>

Output item from the model. Tagged by “type”.

pub type OutputItem {
  OutputItemMessage(OutputMessage)
  OutputItemFileSearchCall(FileSearchToolCall)
  OutputItemFunctionCall(FunctionToolCall)
  OutputItemWebSearchCall(WebSearchToolCall)
  OutputItemComputerCall(ComputerToolCall)
  OutputItemReasoning(ReasoningItem)
  OutputItemCompaction(CompactionBody)
  OutputItemImageGenerationCall(ImageGenToolCall)
  OutputItemCodeInterpreterCall(CodeInterpreterToolCall)
  OutputItemLocalShellCall(LocalShellToolCall)
  OutputItemShellCall(FunctionShellCall)
  OutputItemShellCallOutput(FunctionShellCallOutput)
  OutputItemApplyPatchCall(ApplyPatchToolCall)
  OutputItemApplyPatchCallOutput(ApplyPatchToolCallOutput)
  OutputItemMcpCall(McpToolCall)
  OutputItemMcpListTools(McpListTools)
  OutputItemMcpApprovalRequest(McpApprovalRequest)
  OutputItemCustomToolCall(CustomToolCall)
  OutputItemToolSearchCall(ToolSearchCall)
  OutputItemToolSearchOutput(ToolSearchOutput)
}

Constructors

OutputMessage

</> 
pub type OutputMessage {
  OutputMessage(
    content: List(OutputMessageContent),
    id: String,
    role: Role,
    phase: option.Option(MessagePhase),
    status: OutputStatus,
  )
}

Constructors

OutputMessageContent

</>

Tagged by “type”.

pub type OutputMessageContent {
  OutputMessageOutputText(OutputTextContent)
  OutputMessageRefusal(RefusalContent)
}

Constructors

OutputStatus

</> 
pub type OutputStatus {
  OutputInProgress
  OutputCompleted
  OutputIncomplete
}

Constructors 

  • OutputInProgress
  • OutputCompleted
  • OutputIncomplete

OutputTextContent

</> 
pub type OutputTextContent {
  OutputTextContent(
    annotations: List(Annotation),
    logprobs: option.Option(List(ResponseLogProb)),
    text: String,
  )
}

Constructors

Prompt

</> 
pub type Prompt {
  Prompt(
    id: String,
    version: option.Option(String),
    variables: option.Option(dynamic.Dynamic),
  )
}

Constructors

PromptCacheRetention

</> 
pub type PromptCacheRetention {
  PromptCacheInMemory
  PromptCacheHours24
}

Constructors 

  • PromptCacheInMemory
  • PromptCacheHours24

RankVersionType

</> 
pub type RankVersionType {
  RankAuto
  RankDefault20241115
}

Constructors 

  • RankAuto
  • RankDefault20241115

RankingOptions

</> 
pub type RankingOptions {
  RankingOptions(
    hybrid_search: option.Option(HybridSearch),
    ranker: RankVersionType,
    score_threshold: option.Option(Float),
  )
}

Constructors

Reasoning

</> 
pub type Reasoning {
  Reasoning(
    effort: option.Option(shared.ReasoningEffort),
    summary: option.Option(ReasoningSummary),
  )
}

Constructors

ReasoningItem

</> 
pub type ReasoningItem {
  ReasoningItem(
    id: String,
    summary: List(SummaryPart),
    content: option.Option(List(ReasoningTextContent)),
    encrypted_content: option.Option(String),
    status: option.Option(OutputStatus),
  )
}

Constructors

ReasoningSummary

</> 
pub type ReasoningSummary {
  ReasoningSummaryAuto
  ReasoningSummaryConcise
  ReasoningSummaryDetailed
}

Constructors 

  • ReasoningSummaryAuto
  • ReasoningSummaryConcise
  • ReasoningSummaryDetailed

ReasoningTextContent

</> 
pub type ReasoningTextContent {
  ReasoningTextContent(text: String)
}

Constructors 

  • ReasoningTextContent(text: String)

RefusalContent

</> 
pub type RefusalContent {
  RefusalContent(refusal: String)
}

Constructors 

  • RefusalContent(refusal: String)

Response

</> 
pub type Response {
  Response(
    background: option.Option(Bool),
    billing: option.Option(Billing),
    conversation: option.Option(Conversation),
    created_at: Int,
    completed_at: option.Option(Int),
    error: option.Option(ErrorObject),
    id: String,
    incomplete_details: option.Option(IncompleteDetails),
    instructions: option.Option(Instructions),
    max_output_tokens: option.Option(Int),
    metadata: option.Option(dict.Dict(String, String)),
    model: String,
    object: String,
    output: List(OutputItem),
    parallel_tool_calls: option.Option(Bool),
    previous_response_id: option.Option(String),
    prompt: option.Option(Prompt),
    prompt_cache_key: option.Option(String),
    prompt_cache_retention: option.Option(PromptCacheRetention),
    reasoning: option.Option(Reasoning),
    safety_identifier: option.Option(String),
    service_tier: option.Option(ServiceTier),
    status: ResponseStatus,
    temperature: option.Option(Float),
    text: option.Option(ResponseTextParam),
    tool_choice: option.Option(ToolChoiceParam),
    tools: option.Option(List(Tool)),
    top_logprobs: option.Option(Int),
    top_p: option.Option(Float),
    truncation: option.Option(Truncation),
    usage: option.Option(shared.ResponseUsage),
  )
}

Constructors

ResponseItemList

</> 
pub type ResponseItemList {
  ResponseItemList(
    object: String,
    first_id: option.Option(String),
    last_id: option.Option(String),
    has_more: Bool,
    data: dynamic.Dynamic,
  )
}

Constructors

ResponseLogProb

</> 
pub type ResponseLogProb {
  ResponseLogProb(
    logprob: Float,
    token: String,
    top_logprobs: List(ResponseTopLogProb),
  )
}

Constructors 

  • ResponseLogProb(
  logprob: Float,
  token: String,
  top_logprobs: List(ResponseTopLogProb),
)

ResponseStatus

</> 
pub type ResponseStatus {
  StatusCompleted
  StatusFailed
  StatusInProgress
  StatusCancelled
  StatusQueued
  StatusIncomplete
}

Constructors 

  • StatusCompleted
  • StatusFailed
  • StatusInProgress
  • StatusCancelled
  • StatusQueued
  • StatusIncomplete

ResponseStreamEvent

</>

All 48 streaming event types. Tagged by “type” with dotted names like “response.created”, “response.output_text.delta”, etc.

pub type ResponseStreamEvent {
  EventResponseCreated(sequence_number: Int, response: Response)
  EventResponseInProgress(
    sequence_number: Int,
    response: Response,
  )
  EventResponseCompleted(
    sequence_number: Int,
    response: Response,
  )
  EventResponseFailed(sequence_number: Int, response: Response)
  EventResponseIncomplete(
    sequence_number: Int,
    response: Response,
  )
  EventResponseQueued(sequence_number: Int, response: Response)
  EventResponseOutputItemAdded(
    sequence_number: Int,
    output_index: Int,
    item: OutputItem,
  )
  EventResponseOutputItemDone(
    sequence_number: Int,
    output_index: Int,
    item: OutputItem,
  )
  EventResponseContentPartAdded(
    sequence_number: Int,
    item_id: String,
    output_index: Int,
    content_index: Int,
    part: OutputContent,
  )
  EventResponseContentPartDone(
    sequence_number: Int,
    item_id: String,
    output_index: Int,
    content_index: Int,
    part: OutputContent,
  )
  EventResponseOutputTextDelta(
    sequence_number: Int,
    item_id: String,
    output_index: Int,
    content_index: Int,
    delta: String,
    logprobs: option.Option(List(ResponseLogProb)),
  )
  EventResponseOutputTextDone(
    sequence_number: Int,
    item_id: String,
    output_index: Int,
    content_index: Int,
    text: String,
    logprobs: option.Option(List(ResponseLogProb)),
  )
  EventResponseRefusalDelta(
    sequence_number: Int,
    item_id: String,
    output_index: Int,
    content_index: Int,
    delta: String,
  )
  EventResponseRefusalDone(
    sequence_number: Int,
    item_id: String,
    output_index: Int,
    content_index: Int,
    refusal: String,
  )
  EventResponseFunctionCallArgumentsDelta(
    sequence_number: Int,
    item_id: String,
    output_index: Int,
    delta: String,
  )
  EventResponseFunctionCallArgumentsDone(
    name: option.Option(String),
    sequence_number: Int,
    item_id: String,
    output_index: Int,
    arguments: String,
  )
  EventResponseFileSearchCallInProgress(
    sequence_number: Int,
    output_index: Int,
    item_id: String,
  )
  EventResponseFileSearchCallSearching(
    sequence_number: Int,
    output_index: Int,
    item_id: String,
  )
  EventResponseFileSearchCallCompleted(
    sequence_number: Int,
    output_index: Int,
    item_id: String,
  )
  EventResponseWebSearchCallInProgress(
    sequence_number: Int,
    output_index: Int,
    item_id: String,
  )
  EventResponseWebSearchCallSearching(
    sequence_number: Int,
    output_index: Int,
    item_id: String,
  )
  EventResponseWebSearchCallCompleted(
    sequence_number: Int,
    output_index: Int,
    item_id: String,
  )
  EventResponseReasoningSummaryPartAdded(
    sequence_number: Int,
    item_id: String,
    output_index: Int,
    summary_index: Int,
    part: SummaryPart,
  )
  EventResponseReasoningSummaryPartDone(
    sequence_number: Int,
    item_id: String,
    output_index: Int,
    summary_index: Int,
    part: SummaryPart,
  )
  EventResponseReasoningSummaryTextDelta(
    sequence_number: Int,
    item_id: String,
    output_index: Int,
    summary_index: Int,
    delta: String,
  )
  EventResponseReasoningSummaryTextDone(
    sequence_number: Int,
    item_id: String,
    output_index: Int,
    summary_index: Int,
    text: String,
  )
  EventResponseReasoningTextDelta(
    sequence_number: Int,
    item_id: String,
    output_index: Int,
    content_index: Int,
    delta: String,
  )
  EventResponseReasoningTextDone(
    sequence_number: Int,
    item_id: String,
    output_index: Int,
    content_index: Int,
    text: String,
  )
  EventResponseImageGenCallCompleted(
    sequence_number: Int,
    output_index: Int,
    item_id: String,
  )
  EventResponseImageGenCallGenerating(
    sequence_number: Int,
    output_index: Int,
    item_id: String,
  )
  EventResponseImageGenCallInProgress(
    sequence_number: Int,
    output_index: Int,
    item_id: String,
  )
  EventResponseImageGenCallPartialImage(
    sequence_number: Int,
    output_index: Int,
    item_id: String,
    partial_image_index: Int,
    partial_image_b64: String,
  )
  EventResponseMcpCallArgumentsDelta(
    sequence_number: Int,
    output_index: Int,
    item_id: String,
    delta: String,
  )
  EventResponseMcpCallArgumentsDone(
    sequence_number: Int,
    output_index: Int,
    item_id: String,
    arguments: String,
  )
  EventResponseMcpCallCompleted(
    sequence_number: Int,
    output_index: Int,
    item_id: String,
  )
  EventResponseMcpCallFailed(
    sequence_number: Int,
    output_index: Int,
    item_id: String,
  )
  EventResponseMcpCallInProgress(
    sequence_number: Int,
    output_index: Int,
    item_id: String,
  )
  EventResponseMcpListToolsCompleted(
    sequence_number: Int,
    output_index: Int,
    item_id: String,
  )
  EventResponseMcpListToolsFailed(
    sequence_number: Int,
    output_index: Int,
    item_id: String,
  )
  EventResponseMcpListToolsInProgress(
    sequence_number: Int,
    output_index: Int,
    item_id: String,
  )
  EventResponseCodeInterpreterCallInProgress(
    sequence_number: Int,
    output_index: Int,
    item_id: String,
  )
  EventResponseCodeInterpreterCallInterpreting(
    sequence_number: Int,
    output_index: Int,
    item_id: String,
  )
  EventResponseCodeInterpreterCallCompleted(
    sequence_number: Int,
    output_index: Int,
    item_id: String,
  )
  EventResponseCodeInterpreterCallCodeDelta(
    sequence_number: Int,
    output_index: Int,
    item_id: String,
    delta: String,
  )
  EventResponseCodeInterpreterCallCodeDone(
    sequence_number: Int,
    output_index: Int,
    item_id: String,
    code: String,
  )
  EventResponseOutputTextAnnotationAdded(
    sequence_number: Int,
    output_index: Int,
    content_index: Int,
    annotation_index: Int,
    item_id: String,
    annotation: dynamic.Dynamic,
  )
  EventResponseCustomToolCallInputDelta(
    sequence_number: Int,
    output_index: Int,
    item_id: String,
    delta: String,
  )
  EventResponseCustomToolCallInputDone(
    sequence_number: Int,
    output_index: Int,
    item_id: String,
    input: String,
  )
  EventResponseError(
    sequence_number: Int,
    code: option.Option(String),
    message: String,
    param: option.Option(String),
  )
}

Constructors 

  • EventResponseCreated(sequence_number: Int, response: Response)
  • EventResponseInProgress(sequence_number: Int, response: Response)
  • EventResponseCompleted(sequence_number: Int, response: Response)
  • EventResponseFailed(sequence_number: Int, response: Response)
  • EventResponseIncomplete(sequence_number: Int, response: Response)
  • EventResponseQueued(sequence_number: Int, response: Response)
  • EventResponseOutputItemAdded(
  sequence_number: Int,
  output_index: Int,
  item: OutputItem,
)
  • EventResponseOutputItemDone(
  sequence_number: Int,
  output_index: Int,
  item: OutputItem,
)
  • EventResponseContentPartAdded(
  sequence_number: Int,
  item_id: String,
  output_index: Int,
  content_index: Int,
  part: OutputContent,
)
  • EventResponseContentPartDone(
  sequence_number: Int,
  item_id: String,
  output_index: Int,
  content_index: Int,
  part: OutputContent,
)
  • EventResponseOutputTextDelta(
  sequence_number: Int,
  item_id: String,
  output_index: Int,
  content_index: Int,
  delta: String,
  logprobs: option.Option(List(ResponseLogProb)),
)
  • EventResponseOutputTextDone(
  sequence_number: Int,
  item_id: String,
  output_index: Int,
  content_index: Int,
  text: String,
  logprobs: option.Option(List(ResponseLogProb)),
)
  • EventResponseRefusalDelta(
  sequence_number: Int,
  item_id: String,
  output_index: Int,
  content_index: Int,
  delta: String,
)
  • EventResponseRefusalDone(
  sequence_number: Int,
  item_id: String,
  output_index: Int,
  content_index: Int,
  refusal: String,
)
  • EventResponseFunctionCallArgumentsDelta(
  sequence_number: Int,
  item_id: String,
  output_index: Int,
  delta: String,
)
  • EventResponseFunctionCallArgumentsDone(
  name: option.Option(String),
  sequence_number: Int,
  item_id: String,
  output_index: Int,
  arguments: String,
)
  • EventResponseFileSearchCallInProgress(
  sequence_number: Int,
  output_index: Int,
  item_id: String,
)
  • EventResponseFileSearchCallSearching(
  sequence_number: Int,
  output_index: Int,
  item_id: String,
)
  • EventResponseFileSearchCallCompleted(
  sequence_number: Int,
  output_index: Int,
  item_id: String,
)
  • EventResponseWebSearchCallInProgress(
  sequence_number: Int,
  output_index: Int,
  item_id: String,
)
  • EventResponseWebSearchCallSearching(
  sequence_number: Int,
  output_index: Int,
  item_id: String,
)
  • EventResponseWebSearchCallCompleted(
  sequence_number: Int,
  output_index: Int,
  item_id: String,
)
  • EventResponseReasoningSummaryPartAdded(
  sequence_number: Int,
  item_id: String,
  output_index: Int,
  summary_index: Int,
  part: SummaryPart,
)
  • EventResponseReasoningSummaryPartDone(
  sequence_number: Int,
  item_id: String,
  output_index: Int,
  summary_index: Int,
  part: SummaryPart,
)
  • EventResponseReasoningSummaryTextDelta(
  sequence_number: Int,
  item_id: String,
  output_index: Int,
  summary_index: Int,
  delta: String,
)
  • EventResponseReasoningSummaryTextDone(
  sequence_number: Int,
  item_id: String,
  output_index: Int,
  summary_index: Int,
  text: String,
)
  • EventResponseReasoningTextDelta(
  sequence_number: Int,
  item_id: String,
  output_index: Int,
  content_index: Int,
  delta: String,
)
  • EventResponseReasoningTextDone(
  sequence_number: Int,
  item_id: String,
  output_index: Int,
  content_index: Int,
  text: String,
)
  • EventResponseImageGenCallCompleted(
  sequence_number: Int,
  output_index: Int,
  item_id: String,
)
  • EventResponseImageGenCallGenerating(
  sequence_number: Int,
  output_index: Int,
  item_id: String,
)
  • EventResponseImageGenCallInProgress(
  sequence_number: Int,
  output_index: Int,
  item_id: String,
)
  • EventResponseImageGenCallPartialImage(
  sequence_number: Int,
  output_index: Int,
  item_id: String,
  partial_image_index: Int,
  partial_image_b64: String,
)
  • EventResponseMcpCallArgumentsDelta(
  sequence_number: Int,
  output_index: Int,
  item_id: String,
  delta: String,
)
  • EventResponseMcpCallArgumentsDone(
  sequence_number: Int,
  output_index: Int,
  item_id: String,
  arguments: String,
)
  • EventResponseMcpCallCompleted(
  sequence_number: Int,
  output_index: Int,
  item_id: String,
)
  • EventResponseMcpCallFailed(
  sequence_number: Int,
  output_index: Int,
  item_id: String,
)
  • EventResponseMcpCallInProgress(
  sequence_number: Int,
  output_index: Int,
  item_id: String,
)
  • EventResponseMcpListToolsCompleted(
  sequence_number: Int,
  output_index: Int,
  item_id: String,
)
  • EventResponseMcpListToolsFailed(
  sequence_number: Int,
  output_index: Int,
  item_id: String,
)
  • EventResponseMcpListToolsInProgress(
  sequence_number: Int,
  output_index: Int,
  item_id: String,
)
  • EventResponseCodeInterpreterCallInProgress(
  sequence_number: Int,
  output_index: Int,
  item_id: String,
)
  • EventResponseCodeInterpreterCallInterpreting(
  sequence_number: Int,
  output_index: Int,
  item_id: String,
)
  • EventResponseCodeInterpreterCallCompleted(
  sequence_number: Int,
  output_index: Int,
  item_id: String,
)
  • EventResponseCodeInterpreterCallCodeDelta(
  sequence_number: Int,
  output_index: Int,
  item_id: String,
  delta: String,
)
  • EventResponseCodeInterpreterCallCodeDone(
  sequence_number: Int,
  output_index: Int,
  item_id: String,
  code: String,
)
  • EventResponseOutputTextAnnotationAdded(
  sequence_number: Int,
  output_index: Int,
  content_index: Int,
  annotation_index: Int,
  item_id: String,
  annotation: dynamic.Dynamic,
)
  • EventResponseCustomToolCallInputDelta(
  sequence_number: Int,
  output_index: Int,
  item_id: String,
  delta: String,
)
  • EventResponseCustomToolCallInputDone(
  sequence_number: Int,
  output_index: Int,
  item_id: String,
  input: String,
)
  • EventResponseError(
  sequence_number: Int,
  code: option.Option(String),
  message: String,
  param: option.Option(String),
)

ResponseStreamOptions

</> 
pub type ResponseStreamOptions {
  ResponseStreamOptions(include_obfuscation: option.Option(Bool))
}

Constructors 

  • ResponseStreamOptions(include_obfuscation: option.Option(Bool))

ResponseTextParam

</> 
pub type ResponseTextParam {
  ResponseTextParam(
    format: TextResponseFormatConfiguration,
    verbosity: option.Option(Verbosity),
  )
}

Constructors

ResponseTopLogProb

</> 
pub type ResponseTopLogProb {
  ResponseTopLogProb(logprob: Float, token: String)
}

Constructors 

  • ResponseTopLogProb(logprob: Float, token: String)

Role

</> 
pub type Role {
  RoleUser
  RoleAssistant
  RoleSystem
  RoleDeveloper
}

Constructors 

  • RoleUser
  • RoleAssistant
  • RoleSystem
  • RoleDeveloper

ScrollParam

</> 
pub type ScrollParam {
  ScrollParam(scroll_x: Int, scroll_y: Int, x: Int, y: Int)
}

Constructors 

  • ScrollParam(scroll_x: Int, scroll_y: Int, x: Int, y: Int)

SearchContentType

</> 
pub type SearchContentType {
  SearchText
  SearchImage
}

Constructors 

  • SearchText
  • SearchImage

ServiceTier

</> 
pub type ServiceTier {
  ServiceTierAuto
  ServiceTierDefault
  ServiceTierFlex
  ServiceTierScale
  ServiceTierPriority
}

Constructors 

  • ServiceTierAuto
  • ServiceTierDefault
  • ServiceTierFlex
  • ServiceTierScale
  • ServiceTierPriority

SummaryPart

</>

Tagged by “type”.

pub type SummaryPart {
  SummaryPartSummaryText(SummaryTextContent)
}

Constructors

SummaryTextContent

</> 
pub type SummaryTextContent {
  SummaryTextContent(text: String)
}

Constructors 

  • SummaryTextContent(text: String)

TextResponseFormatConfiguration

</>

Tagged by “type”.

pub type TextResponseFormatConfiguration {
  TextFormatText
  TextFormatJsonObject
  TextFormatJsonSchema(shared.ResponseFormatJsonSchema)
}

Constructors

TokenCountsResource

</> 
pub type TokenCountsResource {
  TokenCountsResource(object: String, input_tokens: Int)
}

Constructors 

  • TokenCountsResource(object: String, input_tokens: Int)

Tool

</>

All tool definitions. Tagged by “type”.

pub type Tool {
  ToolFunction(FunctionTool)
  ToolFileSearch(FileSearchTool)
  ToolComputerUsePreview(ComputerUsePreviewTool)
  ToolWebSearch(WebSearchTool)
  ToolWebSearch20250826(WebSearchTool)
  ToolMcp(dynamic.Dynamic)
  ToolCodeInterpreter(CodeInterpreterTool)
  ToolImageGeneration(ImageGenTool)
  ToolLocalShell
  ToolShell(FunctionShellToolParam)
  ToolCustom(CustomToolParam)
  ToolComputer
  ToolNamespace(NamespaceToolParam)
  ToolToolSearch(ToolSearchToolParam)
  ToolWebSearchPreview(WebSearchTool)
  ToolWebSearchPreview20250311(WebSearchTool)
  ToolApplyPatch
}

Constructors

ToolChoiceAllowed

</> 
pub type ToolChoiceAllowed {
  ToolChoiceAllowed(
    mode: ToolChoiceAllowedMode,
    tools: dynamic.Dynamic,
  )
}

Constructors

ToolChoiceAllowedMode

</> 
pub type ToolChoiceAllowedMode {
  AllowedModeAuto
  AllowedModeRequired
}

Constructors 

  • AllowedModeAuto
  • AllowedModeRequired

ToolChoiceCustom

</> 
pub type ToolChoiceCustom {
  ToolChoiceCustom(name: String)
}

Constructors 

  • ToolChoiceCustom(name: String)

ToolChoiceFunction

</> 
pub type ToolChoiceFunction {
  ToolChoiceFunction(name: String)
}

Constructors 

  • ToolChoiceFunction(name: String)

ToolChoiceMcp

</> 
pub type ToolChoiceMcp {
  ToolChoiceMcp(name: String, server_label: String)
}

Constructors 

  • ToolChoiceMcp(name: String, server_label: String)

ToolChoiceOptions

</> 
pub type ToolChoiceOptions {
  ToolChoiceNone
  ToolChoiceAuto
  ToolChoiceRequired
}

Constructors 

  • ToolChoiceNone
  • ToolChoiceAuto
  • ToolChoiceRequired

ToolChoiceParam

</>

How the model should select which tool to use. Complex union: tagged variants + untagged fallbacks for Mode and Hosted.

pub type ToolChoiceParam {
  ToolChoiceParamAllowedTools(ToolChoiceAllowed)
  ToolChoiceParamFunction(ToolChoiceFunction)
  ToolChoiceParamMcp(ToolChoiceMcp)
  ToolChoiceParamCustom(ToolChoiceCustom)
  ToolChoiceParamApplyPatch
  ToolChoiceParamShell
  ToolChoiceParamHosted(ToolChoiceTypes)
  ToolChoiceParamMode(ToolChoiceOptions)
}

Constructors

ToolChoiceTypes

</>

Tagged by “type”.

pub type ToolChoiceTypes {
  ToolChoiceFileSearch
  ToolChoiceWebSearchPreview
  ToolChoiceComputer
  ToolChoiceComputerUsePreview
  ToolChoiceComputerUse
  ToolChoiceWebSearchPreview20250311
  ToolChoiceCodeInterpreter
  ToolChoiceImageGeneration
}

Constructors 

  • ToolChoiceFileSearch
  • ToolChoiceWebSearchPreview
  • ToolChoiceComputer
  • ToolChoiceComputerUsePreview
  • ToolChoiceComputerUse
  • ToolChoiceWebSearchPreview20250311
  • ToolChoiceCodeInterpreter
  • ToolChoiceImageGeneration

ToolSearchCall

</> 
pub type ToolSearchCall {
  ToolSearchCall(
    id: String,
    call_id: option.Option(String),
    execution: ToolSearchExecutionType,
    arguments: dynamic.Dynamic,
    status: FunctionCallStatus,
    created_by: option.Option(String),
  )
}

Constructors

ToolSearchCallItemParam

</> 
pub type ToolSearchCallItemParam {
  ToolSearchCallItemParam(
    id: option.Option(String),
    call_id: option.Option(String),
    execution: option.Option(ToolSearchExecutionType),
    arguments: dynamic.Dynamic,
    status: option.Option(OutputStatus),
  )
}

Constructors

ToolSearchExecutionType

</> 
pub type ToolSearchExecutionType {
  ExecutionServer
  ExecutionClient
}

Constructors 

  • ExecutionServer
  • ExecutionClient

ToolSearchOutput

</> 
pub type ToolSearchOutput {
  ToolSearchOutput(
    id: String,
    call_id: option.Option(String),
    execution: ToolSearchExecutionType,
    tools: dynamic.Dynamic,
    status: FunctionCallStatus,
    created_by: option.Option(String),
  )
}

Constructors

ToolSearchOutputItemParam

</> 
pub type ToolSearchOutputItemParam {
  ToolSearchOutputItemParam(
    id: option.Option(String),
    call_id: option.Option(String),
    execution: option.Option(ToolSearchExecutionType),
    tools: dynamic.Dynamic,
    status: option.Option(OutputStatus),
  )
}

Constructors

ToolSearchToolParam

</> 
pub type ToolSearchToolParam {
  ToolSearchToolParam(
    execution: option.Option(ToolSearchExecutionType),
    description: option.Option(String),
    parameters: option.Option(dynamic.Dynamic),
  )
}

Constructors

Truncation

</> 
pub type Truncation {
  TruncationAuto
  TruncationDisabled
}

Constructors 

  • TruncationAuto
  • TruncationDisabled

TypeActionParam

</> 
pub type TypeActionParam {
  TypeActionParam(text: String)
}

Constructors 

  • TypeActionParam(text: String)

UrlCitationBody

</> 
pub type UrlCitationBody {
  UrlCitationBody(
    end_index: Int,
    start_index: Int,
    title: String,
    url: String,
  )
}

Constructors 

  • UrlCitationBody(
  end_index: Int,
  start_index: Int,
  title: String,
  url: String,
)

Verbosity

</> 
pub type Verbosity {
  VerbosityLow
  VerbosityMedium
  VerbosityHigh
}

Constructors 

  • VerbosityLow
  • VerbosityMedium
  • VerbosityHigh

WebSearchActionFind

</> 
pub type WebSearchActionFind {
  WebSearchActionFind(url: String, pattern: String)
}

Constructors 

  • WebSearchActionFind(url: String, pattern: String)

WebSearchActionOpenPage

</> 
pub type WebSearchActionOpenPage {
  WebSearchActionOpenPage(url: option.Option(String))
}

Constructors

WebSearchActionSearch

</> 
pub type WebSearchActionSearch {
  WebSearchActionSearch(
    query: String,
    sources: option.Option(List(WebSearchActionSearchSource)),
  )
}

Constructors

WebSearchActionSearchSource

</> 
pub type WebSearchActionSearchSource {
  WebSearchActionSearchSource(source_type: String, url: String)
}

Constructors 

  • WebSearchActionSearchSource(source_type: String, url: String)

WebSearchApproximateLocation

</> 
pub type WebSearchApproximateLocation {
  WebSearchApproximateLocation(
    city: option.Option(String),
    country: option.Option(String),
    region: option.Option(String),
    timezone: option.Option(String),
  )
}

Constructors

WebSearchTool

</> 
pub type WebSearchTool {
  WebSearchTool(
    filters: option.Option(WebSearchToolFilters),
    user_location: option.Option(WebSearchApproximateLocation),
    search_context_size: option.Option(
      WebSearchToolSearchContextSize,
    ),
    search_content_types: option.Option(List(SearchContentType)),
  )
}

Constructors

WebSearchToolCall

</> 
pub type WebSearchToolCall {
  WebSearchToolCall(
    action: WebSearchToolCallAction,
    id: String,
    status: WebSearchToolCallStatus,
  )
}

Constructors

WebSearchToolCallAction

</>

Tagged by “type”.

pub type WebSearchToolCallAction {
  WebSearchActionSearchVariant(WebSearchActionSearch)
  WebSearchActionOpenPageVariant(WebSearchActionOpenPage)
  WebSearchActionFindVariant(WebSearchActionFind)
  WebSearchActionFindInPageVariant(WebSearchActionFind)
}

Constructors

WebSearchToolCallStatus

</> 
pub type WebSearchToolCallStatus {
  WebSearchInProgress
  WebSearchSearching
  WebSearchCompleted
  WebSearchFailed
}

Constructors 

  • WebSearchInProgress
  • WebSearchSearching
  • WebSearchCompleted
  • WebSearchFailed

WebSearchToolFilters

</> 
pub type WebSearchToolFilters {
  WebSearchToolFilters(
    allowed_domains: option.Option(List(String)),
  )
}

Constructors 

  • WebSearchToolFilters(
  allowed_domains: option.Option(List(String)),
)

WebSearchToolSearchContextSize

</> 
pub type WebSearchToolSearchContextSize {
  WebSearchContextLow
  WebSearchContextMedium
  WebSearchContextHigh
}

Constructors 

  • WebSearchContextLow
  • WebSearchContextMedium
  • WebSearchContextHigh

Values

annotation_decoder

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

cancel_request

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

Build a request to cancel a background response.

cancel_response

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

Parse the response from cancelling a response.

compact_request

</> 
pub fn compact_request(
  config: config.Config,
  body: json.Json,
) -> request.Request(String)

Build a request to compact a conversation.

compact_response

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

Parse the response from compacting a conversation.

compaction_body_decoder

</> 
pub fn compaction_body_decoder() -> decode.Decoder(CompactionBody)

conversation_decoder

</> 
pub fn conversation_decoder() -> decode.Decoder(Conversation)

conversation_param_to_json

</> 
pub fn conversation_param_to_json(
  c: ConversationParam,
) -> json.Json

create_request

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

Build a request to create a response.

create_response_response

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

Parse the response from creating a response.

create_response_to_json

</> 
pub fn create_response_to_json(
  request: CreateResponse,
) -> json.Json

custom_tool_call_decoder

</> 
pub fn custom_tool_call_decoder() -> decode.Decoder(
  CustomToolCall,
)

delete_request

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

Build a request to delete a response by ID.

delete_response

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

Parse the response from deleting a response.

easy_input_content_to_json

</> 
pub fn easy_input_content_to_json(
  c: EasyInputContent,
) -> json.Json

easy_input_message_to_json

</> 
pub fn easy_input_message_to_json(
  m: EasyInputMessage,
) -> json.Json

error_object_decoder

</> 
pub fn error_object_decoder() -> decode.Decoder(ErrorObject)

file_search_tool_call_decoder

</> 
pub fn file_search_tool_call_decoder() -> decode.Decoder(
  FileSearchToolCall,
)

function_tool_call_decoder

</> 
pub fn function_tool_call_decoder() -> decode.Decoder(
  FunctionToolCall,
)

function_tool_to_json

</> 
pub fn function_tool_to_json(tool: FunctionTool) -> json.Json

get_input_token_counts_request

</> 
pub fn get_input_token_counts_request(
  config: config.Config,
  body: json.Json,
) -> request.Request(String)

Build a request to count input tokens.

get_input_token_counts_response

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

Parse the response from counting input tokens.

image_gen_action_to_json

</> 
pub fn image_gen_action_to_json(
  a: ImageGenActionEnum,
) -> json.Json

image_gen_bg_to_json

</> 
pub fn image_gen_bg_to_json(
  b: ImageGenToolBackground,
) -> json.Json

image_gen_fmt_to_json

</> 
pub fn image_gen_fmt_to_json(
  f: ImageGenToolOutputFormat,
) -> json.Json

image_gen_moderation_to_json

</> 
pub fn image_gen_moderation_to_json(
  m: ImageGenToolModeration,
) -> json.Json

image_gen_quality_to_json

</> 
pub fn image_gen_quality_to_json(
  q: ImageGenToolQuality,
) -> json.Json

image_gen_size_to_json

</> 
pub fn image_gen_size_to_json(s: ImageGenToolSize) -> json.Json

image_gen_tool_call_decoder

</> 
pub fn image_gen_tool_call_decoder() -> decode.Decoder(
  ImageGenToolCall,
)

image_gen_tool_to_json

</> 
pub fn image_gen_tool_to_json(tool: ImageGenTool) -> json.Json

include_enum_to_json

</> 
pub fn include_enum_to_json(i: IncludeEnum) -> json.Json

input_content_to_json

</> 
pub fn input_content_to_json(content: InputContent) -> json.Json

input_fidelity_to_json

</> 
pub fn input_fidelity_to_json(f: InputFidelity) -> json.Json

input_item_to_json

</> 
pub fn input_item_to_json(item: InputItem) -> json.Json

input_param_to_json

</> 
pub fn input_param_to_json(input: InputParam) -> json.Json

input_role_decoder

</> 
pub fn input_role_decoder() -> decode.Decoder(InputRole)

input_role_to_json

</> 
pub fn input_role_to_json(r: InputRole) -> json.Json

item_to_json

</> 
pub fn item_to_json(item: Item) -> json.Json

Encode the item tagged union. Since this has many variants, we encode just the type tag + the inner struct’s fields.

list_input_items_request

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

Build a request to list input items for a response.

list_input_items_response

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

Parse the response from listing input items.

mcp_tool_call_decoder

</> 
pub fn mcp_tool_call_decoder() -> decode.Decoder(McpToolCall)

message_phase_decoder

</> 
pub fn message_phase_decoder() -> decode.Decoder(MessagePhase)

message_phase_to_json

</> 
pub fn message_phase_to_json(phase: MessagePhase) -> json.Json

new_create_response

</> 
pub fn new_create_response(
  input input: InputParam,
) -> CreateResponse

Create a new response request with required input.

output_content_decoder

</> 
pub fn output_content_decoder() -> decode.Decoder(OutputContent)

output_item_decoder

</> 
pub fn output_item_decoder() -> decode.Decoder(OutputItem)

output_message_content_decoder

</> 
pub fn output_message_content_decoder() -> decode.Decoder(
  OutputMessageContent,
)

output_message_decoder

</> 
pub fn output_message_decoder() -> decode.Decoder(OutputMessage)

output_status_decoder

</> 
pub fn output_status_decoder() -> decode.Decoder(OutputStatus)

output_status_to_json

</> 
pub fn output_status_to_json(s: OutputStatus) -> json.Json

output_text_content_decoder

</> 
pub fn output_text_content_decoder() -> decode.Decoder(
  OutputTextContent,
)

parse_stream_event

</> 
pub fn parse_stream_event(
  data: String,
) -> Result(
  option.Option(ResponseStreamEvent),
  error.GlopenaiError,
)

Parse a single SSE data line from the Responses API streaming endpoint. Returns Ok(Some(event)) for data, Ok(None) for the [DONE] sentinel.

prompt_cache_retention_decoder

</> 
pub fn prompt_cache_retention_decoder() -> decode.Decoder(
  PromptCacheRetention,
)

prompt_cache_retention_to_json

</> 
pub fn prompt_cache_retention_to_json(
  r: PromptCacheRetention,
) -> json.Json

prompt_decoder

</> 
pub fn prompt_decoder() -> decode.Decoder(Prompt)

prompt_to_json

</> 
pub fn prompt_to_json(p: Prompt) -> json.Json

rank_version_type_to_json

</> 
pub fn rank_version_type_to_json(r: RankVersionType) -> json.Json

reasoning_decoder

</> 
pub fn reasoning_decoder() -> decode.Decoder(Reasoning)

reasoning_item_decoder

</> 
pub fn reasoning_item_decoder() -> decode.Decoder(ReasoningItem)

reasoning_summary_decoder

</> 
pub fn reasoning_summary_decoder() -> decode.Decoder(
  ReasoningSummary,
)

reasoning_summary_to_json

</> 
pub fn reasoning_summary_to_json(
  s: ReasoningSummary,
) -> json.Json

reasoning_to_json

</> 
pub fn reasoning_to_json(r: Reasoning) -> json.Json

response_decoder

</> 
pub fn response_decoder() -> decode.Decoder(Response)

response_log_prob_decoder

</> 
pub fn response_log_prob_decoder() -> decode.Decoder(
  ResponseLogProb,
)

response_status_decoder

</> 
pub fn response_status_decoder() -> decode.Decoder(ResponseStatus)

response_status_to_json

</> 
pub fn response_status_to_json(s: ResponseStatus) -> json.Json

response_stream_event_decoder

</> 
pub fn response_stream_event_decoder() -> decode.Decoder(
  ResponseStreamEvent,
)

response_stream_options_to_json

</> 
pub fn response_stream_options_to_json(
  o: ResponseStreamOptions,
) -> json.Json

response_text_param_decoder

</> 
pub fn response_text_param_decoder() -> decode.Decoder(
  ResponseTextParam,
)

response_text_param_to_json

</> 
pub fn response_text_param_to_json(
  p: ResponseTextParam,
) -> json.Json

retrieve_request

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

Build a request to retrieve a response by ID.

retrieve_response

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

Parse the response from retrieving a response.

role_decoder

</> 
pub fn role_decoder() -> decode.Decoder(Role)

role_to_json

</> 
pub fn role_to_json(r: Role) -> json.Json

search_content_type_to_json

</> 
pub fn search_content_type_to_json(
  t: SearchContentType,
) -> json.Json

service_tier_decoder

</> 
pub fn service_tier_decoder() -> decode.Decoder(ServiceTier)

service_tier_to_json

</> 
pub fn service_tier_to_json(t: ServiceTier) -> json.Json

summary_part_decoder

</> 
pub fn summary_part_decoder() -> decode.Decoder(SummaryPart)

text_response_format_decoder

</> 
pub fn text_response_format_decoder() -> decode.Decoder(
  TextResponseFormatConfiguration,
)

text_response_format_to_json

</> 
pub fn text_response_format_to_json(
  f: TextResponseFormatConfiguration,
) -> json.Json

tool_choice_options_to_json

</> 
pub fn tool_choice_options_to_json(
  o: ToolChoiceOptions,
) -> json.Json

tool_choice_param_to_json

</> 
pub fn tool_choice_param_to_json(
  tc: ToolChoiceParam,
) -> json.Json

tool_search_execution_type_to_json

</> 
pub fn tool_search_execution_type_to_json(
  t: ToolSearchExecutionType,
) -> json.Json

tool_to_json

</> 
pub fn tool_to_json(tool: Tool) -> json.Json

truncation_decoder

</> 
pub fn truncation_decoder() -> decode.Decoder(Truncation)

truncation_to_json

</> 
pub fn truncation_to_json(t: Truncation) -> json.Json

verbosity_decoder

</> 
pub fn verbosity_decoder() -> decode.Decoder(Verbosity)

verbosity_to_json

</> 
pub fn verbosity_to_json(v: Verbosity) -> json.Json

web_search_context_size_to_json

</> 
pub fn web_search_context_size_to_json(
  s: WebSearchToolSearchContextSize,
) -> json.Json

web_search_tool_call_decoder

</> 
pub fn web_search_tool_call_decoder() -> decode.Decoder(
  WebSearchToolCall,
)

web_search_tool_to_json

</> 
pub fn web_search_tool_to_json(tool: WebSearchTool) -> json.Json

with_background

</> 
pub fn with_background(
  request: CreateResponse,
  background: Bool,
) -> CreateResponse

with_conversation

</> 
pub fn with_conversation(
  request: CreateResponse,
  conversation: ConversationParam,
) -> CreateResponse

with_include

</> 
pub fn with_include(
  request: CreateResponse,
  include: List(IncludeEnum),
) -> CreateResponse

with_instructions

</> 
pub fn with_instructions(
  request: CreateResponse,
  instructions: String,
) -> CreateResponse

with_max_output_tokens

</> 
pub fn with_max_output_tokens(
  request: CreateResponse,
  max_output_tokens: Int,
) -> CreateResponse

with_metadata

</> 
pub fn with_metadata(
  request: CreateResponse,
  metadata: dict.Dict(String, String),
) -> CreateResponse

with_model

</> 
pub fn with_model(
  request: CreateResponse,
  model: String,
) -> CreateResponse

with_previous_response_id

</> 
pub fn with_previous_response_id(
  request: CreateResponse,
  previous_response_id: String,
) -> CreateResponse

with_reasoning

</> 
pub fn with_reasoning(
  request: CreateResponse,
  reasoning: Reasoning,
) -> CreateResponse

with_service_tier

</> 
pub fn with_service_tier(
  request: CreateResponse,
  tier: ServiceTier,
) -> CreateResponse

with_store

</> 
pub fn with_store(
  request: CreateResponse,
  store: Bool,
) -> CreateResponse

with_stream

</> 
pub fn with_stream(
  request: CreateResponse,
  stream: Bool,
) -> CreateResponse

with_temperature

</> 
pub fn with_temperature(
  request: CreateResponse,
  temperature: Float,
) -> CreateResponse

with_text

</> 
pub fn with_text(
  request: CreateResponse,
  text: ResponseTextParam,
) -> CreateResponse

with_tool_choice

</> 
pub fn with_tool_choice(
  request: CreateResponse,
  tool_choice: ToolChoiceParam,
) -> CreateResponse

with_tools

</> 
pub fn with_tools(
  request: CreateResponse,
  tools: List(Tool),
) -> CreateResponse

with_top_p

</> 
pub fn with_top_p(
  request: CreateResponse,
  top_p: Float,
) -> CreateResponse

with_truncation

</> 
pub fn with_truncation(
  request: CreateResponse,
  truncation: Truncation,
) -> CreateResponse
✨ Search Document