Skip to main content
Ctrl+K
artkit  documentation - Home
  • Home
  • User Guide
  • Examples
  • API Reference
  • Contributor Guide
    • FAQ
    • Release Notes
  • GitHub
  • Home
  • User Guide
  • Examples
  • API Reference
  • Contributor Guide
  • FAQ
  • Release Notes
  • GitHub

Section Navigation

  • API Reference
  • artkit.api
    • artkit.api
  • artkit.flow
  • artkit.model
  • artkit.util
  • API Reference
  • artkit.api

artkit.api#

Convenience module to import all classes and functions using single package alias.

Recommended usage is to import this module as ak.

Example:

import artkit.api as ak

ak.run(
    ak.step("add", lambda x: dict(x=x + 1)),
    input=[dict(x=1), dict(x=10)],
)

Below is a list of all symbols exposed through artkit.api:

  • artkit.flow

    • chain

    • parallel

    • passthrough

    • run

    • RunResult

    • step

  • artkit.model.diffusion

    • CachedDiffusionModel

  • artkit.model.diffusion.base

    • DiffusionModel

  • artkit.model.diffusion.bedrock

    • TitanBedrockDiffusionModel

  • artkit.model.diffusion.openai

    • OpenAIDiffusion

  • artkit.model.llm

    • CachedChatModel

    • TextGenerator

    • HistorizedChatModel

    • CachedCompletionModel

    • ChatFromCompletionModel

  • artkit.model.llm.anthropic

    • AnthropicChat

  • artkit.model.llm.base

    • CompletionModel

    • ChatModel

  • artkit.model.llm.bedrock

    • TitanBedrockChat

  • artkit.model.llm.gemini

    • GeminiChat

  • artkit.model.llm.groq

    • GroqChat

  • artkit.model.llm.huggingface

    • HuggingfaceChatLocal

    • HuggingfaceCompletionLocal

    • HuggingfaceCompletion

    • HuggingfaceChat

    • HuggingfaceURLChat

  • artkit.model.llm.multi_turn

    • multi_turn

  • artkit.model.llm.openai

    • OpenAIChat

  • artkit.model.llm.util

    • parse_json_autofix

  • artkit.model.llm.vertexai

    • VertexAIChat

  • artkit.model.vision

    • CachedVisionModel

  • artkit.model.vision.base

    • VisionModel

  • artkit.model.vision.openai

    • OpenAIVision

  • artkit.util

    • LogThrottlingHandler

    • Image

© Copyright 2024, Boston Consulting Group (BCG).

Created using Sphinx 7.4.7.

Built with the PyData Sphinx Theme 0.15.4.