API documentation

The Imagine SDK offers clients to interact with the Imagine API using object-oriented programming. See some examples.

The Imagine SDK is also compatible with LangChain.

• Imagine clients
  • Synchronous client
    • ImagineClient
      • ImagineClient.chat()
      • ImagineClient.chat_stream()
      • ImagineClient.completion()
      • ImagineClient.completion_stream()
      • ImagineClient.embeddings()
      • ImagineClient.get_available_models()
      • ImagineClient.get_available_models_by_type()
      • ImagineClient.get_chat_history()
      • ImagineClient.get_completion_history()
      • ImagineClient.get_embedding_history()
      • ImagineClient.get_reranker_history()
      • ImagineClient.health_check()
      • ImagineClient.images_generate()
      • ImagineClient.images_generate_stream()
      • ImagineClient.ping()
      • ImagineClient.reranker()
      • ImagineClient.transcribe()
      • ImagineClient.translate()
      • ImagineClient.usage()
  • Asynchronous client
    • ImagineAsyncClient
      • ImagineAsyncClient.chat()
      • ImagineAsyncClient.chat_stream()
      • ImagineAsyncClient.completion()
      • ImagineAsyncClient.completion_stream()
      • ImagineAsyncClient.embeddings()
      • ImagineAsyncClient.get_available_models()
      • ImagineAsyncClient.get_available_models_by_type()
      • ImagineAsyncClient.get_chat_history()
      • ImagineAsyncClient.get_completion_history()
      • ImagineAsyncClient.get_embedding_history()
      • ImagineAsyncClient.get_reranker_history()
      • ImagineAsyncClient.health_check()
      • ImagineAsyncClient.images_generate()
      • ImagineAsyncClient.images_generate_stream()
      • ImagineAsyncClient.ping()
      • ImagineAsyncClient.reranker()
      • ImagineAsyncClient.transcribe()
      • ImagineAsyncClient.translate()
      • ImagineAsyncClient.usage()
• Data Transfer Objects and exceptions
  • Input Arguments
    • ModelType
    • ReRankerRequest
      • ReRankerRequest.documents
      • ReRankerRequest.model
      • ReRankerRequest.query
      • ReRankerRequest.return_documents
      • ReRankerRequest.top_n
    • ChatMessage
      • ChatMessage.content
      • ChatMessage.name
      • ChatMessage.role
      • ChatMessage.tool_call_id
      • ChatMessage.tool_calls
    • ChatCompletionRequest
      • ChatCompletionRequest.frequency_penalty
      • ChatCompletionRequest.ignore_eos
      • ChatCompletionRequest.max_seconds
      • ChatCompletionRequest.max_tokens
      • ChatCompletionRequest.messages
      • ChatCompletionRequest.model
      • ChatCompletionRequest.presence_penalty
      • ChatCompletionRequest.repetition_penalty
      • ChatCompletionRequest.skip_special_tokens
      • ChatCompletionRequest.stop
      • ChatCompletionRequest.stop_token_ids
      • ChatCompletionRequest.stream
      • ChatCompletionRequest.temperature
      • ChatCompletionRequest.top_k
      • ChatCompletionRequest.top_p
    • EmbeddingRequest
      • EmbeddingRequest.id
      • EmbeddingRequest.input
      • EmbeddingRequest.model
    • CompletionRequest
      • CompletionRequest.frequency_penalty
      • CompletionRequest.ignore_eos
      • CompletionRequest.max_seconds
      • CompletionRequest.max_tokens
      • CompletionRequest.model
      • CompletionRequest.presence_penalty
      • CompletionRequest.prompt
      • CompletionRequest.repetition_penalty
      • CompletionRequest.skip_special_tokens
      • CompletionRequest.stop
      • CompletionRequest.stop_token_ids
      • CompletionRequest.stream
      • CompletionRequest.temperature
      • CompletionRequest.top_k
      • CompletionRequest.top_p
  • Responses
    • EmbeddingResponse
      • EmbeddingResponse.first_embedding
      • EmbeddingResponse.id
      • EmbeddingResponse.model
      • EmbeddingResponse.object
    • TranslateResponse
    • ReRankerResponse
      • ReRankerResponse.data
      • ReRankerResponse.failure
      • ReRankerResponse.id
      • ReRankerResponse.model
      • ReRankerResponse.object
      • ReRankerResponse.usage
    • HealthResponse
      • HealthResponse.models
      • HealthResponse.postgres
      • HealthResponse.redis
    • PingResponse
      • PingResponse.message
      • PingResponse.status
    • UsageResponse
      • UsageResponse.overall
      • UsageResponse.usage
    • CompletionResponse
      • CompletionResponse.choices
      • CompletionResponse.created
      • CompletionResponse.first_text
      • CompletionResponse.generation_time
      • CompletionResponse.id
      • CompletionResponse.model
      • CompletionResponse.object
      • CompletionResponse.usage
    • CompletionStreamResponse
      • CompletionStreamResponse.choices
      • CompletionStreamResponse.created
      • CompletionStreamResponse.first_content
      • CompletionStreamResponse.id
      • CompletionStreamResponse.model
      • CompletionStreamResponse.object
      • CompletionStreamResponse.usage
    • ChatCompletionResponse
      • ChatCompletionResponse.choices
      • ChatCompletionResponse.created
      • ChatCompletionResponse.first_content
      • ChatCompletionResponse.id
      • ChatCompletionResponse.model
      • ChatCompletionResponse.object
      • ChatCompletionResponse.usage
    • ChatCompletionResponseChoice
      • ChatCompletionResponseChoice.finish_reason
      • ChatCompletionResponseChoice.index
      • ChatCompletionResponseChoice.message
    • ChatCompletionStreamResponse
      • ChatCompletionStreamResponse.choices
      • ChatCompletionStreamResponse.created
      • ChatCompletionStreamResponse.first_content
      • ChatCompletionStreamResponse.id
      • ChatCompletionStreamResponse.model
      • ChatCompletionStreamResponse.object
      • ChatCompletionStreamResponse.usage
    • TranscribeResponse
      • TranscribeResponse.generation_time
      • TranscribeResponse.id
      • TranscribeResponse.text
      • TranscribeResponse.ts
    • ImageResponse
      • ImageResponse.created
      • ImageResponse.data
      • ImageResponse.model
      • ImageResponse.object
    • ChatCompletionResponseStreamChoice
      • ChatCompletionResponseStreamChoice.delta
      • ChatCompletionResponseStreamChoice.finish_reason
      • ChatCompletionResponseStreamChoice.index
    • DeltaMessage
      • DeltaMessage.content
      • DeltaMessage.role
    • FinishReason
    • UsageInfo
      • UsageInfo.completion_tokens
      • UsageInfo.prompt_tokens
      • UsageInfo.total_tokens
  • Exceptions
    • ImagineException
    • ImagineAPITooManyRequestsException
• LangChain
  • ImagineChat
    • ImagineChat.get_lc_namespace()
    • ImagineChat.is_lc_serializable()
  • ImagineLLM
  • ImagineEmbeddings
    • ImagineEmbeddings.aembed_documents()
    • ImagineEmbeddings.aembed_query()
    • ImagineEmbeddings.embed_documents()
    • ImagineEmbeddings.embed_query()