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
ImagineClientImagineClient.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
ImagineAsyncClientImagineAsyncClient.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()
- Synchronous client
- Data Transfer Objects and exceptions
- Input Arguments
ModelTypeReRankerRequestChatMessageChatCompletionRequestChatCompletionRequest.frequency_penaltyChatCompletionRequest.ignore_eosChatCompletionRequest.max_secondsChatCompletionRequest.max_tokensChatCompletionRequest.messagesChatCompletionRequest.modelChatCompletionRequest.presence_penaltyChatCompletionRequest.repetition_penaltyChatCompletionRequest.skip_special_tokensChatCompletionRequest.stopChatCompletionRequest.stop_token_idsChatCompletionRequest.streamChatCompletionRequest.temperatureChatCompletionRequest.top_kChatCompletionRequest.top_p
EmbeddingRequestCompletionRequestCompletionRequest.frequency_penaltyCompletionRequest.ignore_eosCompletionRequest.max_secondsCompletionRequest.max_tokensCompletionRequest.modelCompletionRequest.presence_penaltyCompletionRequest.promptCompletionRequest.repetition_penaltyCompletionRequest.skip_special_tokensCompletionRequest.stopCompletionRequest.stop_token_idsCompletionRequest.streamCompletionRequest.temperatureCompletionRequest.top_kCompletionRequest.top_p
- Responses
EmbeddingResponseTranslateResponseReRankerResponseHealthResponsePingResponseUsageResponseCompletionResponseCompletionStreamResponseChatCompletionResponseChatCompletionResponseChoiceChatCompletionStreamResponseTranscribeResponseImageResponseChatCompletionResponseStreamChoiceDeltaMessageFinishReasonUsageInfo
- Exceptions
- Input Arguments
- LangChain