Skip to content

API Reference

TiinyDevice (tiiny.client.TiinyDevice)

The TiinyDevice class manages the physical connection and administrative tasks for the Tiiny device.

  • options:
    • members:
      • init
      • is_connected
      • get_api_key
      • get_npu_status
      • get_models
      • start_model
      • stop_model
      • get_url

TiinyClient (tiiny.client.TiinyClient)

The TiinyClient (aliased as OpenAI) is the main interface for AI inference tasks. It is designed to be compatible with the OpenAI Python SDK.

  • options:
    • members:
      • init
      • chat
      • embeddings
      • rerank
      • images
      • audio

Chat (tiiny.client.TiinyClient.create)

Accessed via client.chat.completions.

  • options:
    • heading_level: 4

Embeddings (tiiny.client.EmbeddingsRequest)

Accessed via client.embeddings.

  • options:
    • members:
      • create

Rerank (tiiny.client.RerankRequest)

Accessed via client.rerank.

  • options:
    • members:
      • create

Images (tiiny.client.ImagesRequest)

Accessed via client.images.

  • options:
    • members:
      • generate

Audio (tiiny.client.TranscriptionsRequest)

Accessed via client.audio.

The client.audio property exposes the TranscriptionsRequest via client.audio.transcriptions.

  • options:
    • members:
      • create