package ocaml-ai-sdk

  1. Overview
  2. Docs
OCaml AI SDK - Provider abstraction for AI models

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (8)

Authors

  1. A
    Ahrefs

Maintainers

  1. J
    José Nogueira <jose.nogueira@ahrefs.com>

Sources

ocaml-ai-sdk-0.6.tbz
sha256=44e7f6ebef6da2828ec2844dd5b38c8f37284c08e54a29e06f6a8822df6f8e10
sha512=ce31d0868abf28bcaef7b24a0ab09b37dcfc94db3de96b38ff36a03800ae59a19e8009a35314f93191b3c8f178c40f8569630d4389f56ddc2f2cc94fb7bffc3c

doc/ocaml-ai-sdk.ai_provider/Ai_provider/Provider_error/index.html

Module Ai_provider.Provider_errorSource

Errors from provider API calls.

Sourcetype timeout_phase =
  1. | Request_headers
    (*

    Not retryable: the server may already be processing the request.

    *)
  2. | Stream_idle
    (*

    Retryable: the connection has gone silent and is treated as dead.

    *)
Sourcetype error_kind =
  1. | Api_error of {
    1. status : int;
    2. body : string;
    }
  2. | Network_error of {
    1. message : string;
    }
  3. | Deserialization_error of {
    1. message : string;
    2. raw : string;
    }
  4. | Timeout of {
    1. phase : timeout_phase;
    2. elapsed_s : float;
    3. limit_s : float;
    }
Sourcetype t = {
  1. provider : string;
  2. kind : error_kind;
  3. is_retryable : bool;
  4. retry_after_s : float option;
}
Sourceexception Provider_error of t
Sourceval make_api_error : provider:string -> status:int -> body:string -> ?is_retryable:bool -> ?retry_after_s:float -> unit -> t

Construct an API error.

When is_retryable is omitted, defaults to the upstream status-code heuristic: 408, 409, 429, or any 5xx are retryable. Providers may override this when they can parse the error type from the response body.

Sourceval make_timeout : provider:string -> phase:timeout_phase -> elapsed_s:float -> limit_s:float -> t

Construct a timeout error. is_retryable is derived from phase: Request_headers is not retryable (server may already be processing the request; retry risks double-billing); Stream_idle is retryable (stream is dead, safe to start over).

Sourceval to_string : t -> string