# Qualcomm AI Inference Suite SDK API reference (client classes)

The Qualcomm AI Inference Suite SDK provides synchronous and asynchronous  [client](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html) classes to interact with the Imagine service using object-oriented programming. This section documents the SDK’s public classes and methods. For code snippets that demonstrate typical use cases, see the [example code](https://docs.qualcomm.com/doc/80-88545-1/topic/index_tutorials.html). The SDK also offers optional [LangChain](https://www.langchain.com/) integration to enable LangChain-based workflows.

- [Imagine clients](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html)
    - [Synchronous client](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#synchronous-client)
        - [`ImagineClient`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineClient)
            - [`ImagineClient.chat()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineClient.chat)
            - [`ImagineClient.chat_stream()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineClient.chat_stream)
            - [`ImagineClient.completion()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineClient.completion)
            - [`ImagineClient.completion_stream()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineClient.completion_stream)
            - [`ImagineClient.embeddings()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineClient.embeddings)
            - [`ImagineClient.get_available_models()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineClient.get_available_models)
            - [`ImagineClient.get_available_models_by_type()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineClient.get_available_models_by_type)
            - [`ImagineClient.get_chat_history()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineClient.get_chat_history)
            - [`ImagineClient.get_completion_history()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineClient.get_completion_history)
            - [`ImagineClient.get_embedding_history()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineClient.get_embedding_history)
            - [`ImagineClient.get_reranker_history()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineClient.get_reranker_history)
            - [`ImagineClient.health_check()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineClient.health_check)
            - [`ImagineClient.images_generate()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineClient.images_generate)
            - [`ImagineClient.images_generate_stream()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineClient.images_generate_stream)
            - [`ImagineClient.ping()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineClient.ping)
            - [`ImagineClient.reranker()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineClient.reranker)
            - [`ImagineClient.transcribe()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineClient.transcribe)
            - [`ImagineClient.translate()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineClient.translate)
            - [`ImagineClient.usage()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineClient.usage)
    - [Asynchronous client](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#asynchronous-client)
        - [`ImagineAsyncClient`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineAsyncClient)
            - [`ImagineAsyncClient.chat()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineAsyncClient.chat)
            - [`ImagineAsyncClient.chat_stream()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineAsyncClient.chat_stream)
            - [`ImagineAsyncClient.completion()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineAsyncClient.completion)
            - [`ImagineAsyncClient.completion_stream()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineAsyncClient.completion_stream)
            - [`ImagineAsyncClient.embeddings()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineAsyncClient.embeddings)
            - [`ImagineAsyncClient.get_available_models()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineAsyncClient.get_available_models)
            - [`ImagineAsyncClient.get_available_models_by_type()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineAsyncClient.get_available_models_by_type)
            - [`ImagineAsyncClient.get_chat_history()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineAsyncClient.get_chat_history)
            - [`ImagineAsyncClient.get_completion_history()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineAsyncClient.get_completion_history)
            - [`ImagineAsyncClient.get_embedding_history()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineAsyncClient.get_embedding_history)
            - [`ImagineAsyncClient.get_reranker_history()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineAsyncClient.get_reranker_history)
            - [`ImagineAsyncClient.health_check()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineAsyncClient.health_check)
            - [`ImagineAsyncClient.images_generate()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineAsyncClient.images_generate)
            - [`ImagineAsyncClient.images_generate_stream()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineAsyncClient.images_generate_stream)
            - [`ImagineAsyncClient.ping()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineAsyncClient.ping)
            - [`ImagineAsyncClient.reranker()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineAsyncClient.reranker)
            - [`ImagineAsyncClient.transcribe()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineAsyncClient.transcribe)
            - [`ImagineAsyncClient.translate()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineAsyncClient.translate)
            - [`ImagineAsyncClient.usage()`](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html#imagine.ImagineAsyncClient.usage)
- [Data transfer objects and exceptions](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html)
    - [Input arguments](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#input-arguments)
        - [`ModelType`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ModelType)
        - [`ReRankerRequest`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ReRankerRequest)
            - [`ReRankerRequest.documents`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ReRankerRequest.documents)
            - [`ReRankerRequest.model`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ReRankerRequest.model)
            - [`ReRankerRequest.query`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ReRankerRequest.query)
            - [`ReRankerRequest.return_documents`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ReRankerRequest.return_documents)
            - [`ReRankerRequest.top_n`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ReRankerRequest.top_n)
        - [`ChatMessage`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatMessage)
            - [`ChatMessage.content`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatMessage.content)
            - [`ChatMessage.name`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatMessage.name)
            - [`ChatMessage.role`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatMessage.role)
            - [`ChatMessage.tool_call_id`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatMessage.tool_call_id)
            - [`ChatMessage.tool_calls`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatMessage.tool_calls)
        - [`ChatCompletionRequest`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionRequest)
            - [`ChatCompletionRequest.frequency_penalty`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionRequest.frequency_penalty)
            - [`ChatCompletionRequest.ignore_eos`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionRequest.ignore_eos)
            - [`ChatCompletionRequest.max_seconds`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionRequest.max_seconds)
            - [`ChatCompletionRequest.max_tokens`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionRequest.max_tokens)
            - [`ChatCompletionRequest.messages`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionRequest.messages)
            - [`ChatCompletionRequest.model`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionRequest.model)
            - [`ChatCompletionRequest.presence_penalty`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionRequest.presence_penalty)
            - [`ChatCompletionRequest.repetition_penalty`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionRequest.repetition_penalty)
            - [`ChatCompletionRequest.skip_special_tokens`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionRequest.skip_special_tokens)
            - [`ChatCompletionRequest.stop`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionRequest.stop)
            - [`ChatCompletionRequest.stop_token_ids`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionRequest.stop_token_ids)
            - [`ChatCompletionRequest.stream`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionRequest.stream)
            - [`ChatCompletionRequest.stream_options`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionRequest.stream_options)
            - [`ChatCompletionRequest.temperature`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionRequest.temperature)
            - [`ChatCompletionRequest.top_k`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionRequest.top_k)
            - [`ChatCompletionRequest.top_p`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionRequest.top_p)
        - [`EmbeddingRequest`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.EmbeddingRequest)
            - [`EmbeddingRequest.id`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.EmbeddingRequest.id)
            - [`EmbeddingRequest.input`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.EmbeddingRequest.input)
            - [`EmbeddingRequest.model`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.EmbeddingRequest.model)
        - [`CompletionRequest`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionRequest)
            - [`CompletionRequest.frequency_penalty`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionRequest.frequency_penalty)
            - [`CompletionRequest.ignore_eos`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionRequest.ignore_eos)
            - [`CompletionRequest.max_seconds`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionRequest.max_seconds)
            - [`CompletionRequest.max_tokens`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionRequest.max_tokens)
            - [`CompletionRequest.model`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionRequest.model)
            - [`CompletionRequest.presence_penalty`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionRequest.presence_penalty)
            - [`CompletionRequest.prompt`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionRequest.prompt)
            - [`CompletionRequest.repetition_penalty`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionRequest.repetition_penalty)
            - [`CompletionRequest.skip_special_tokens`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionRequest.skip_special_tokens)
            - [`CompletionRequest.stop`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionRequest.stop)
            - [`CompletionRequest.stop_token_ids`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionRequest.stop_token_ids)
            - [`CompletionRequest.stream`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionRequest.stream)
            - [`CompletionRequest.stream_options`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionRequest.stream_options)
            - [`CompletionRequest.temperature`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionRequest.temperature)
            - [`CompletionRequest.top_k`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionRequest.top_k)
            - [`CompletionRequest.top_p`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionRequest.top_p)
    - [Responses](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#responses)
        - [`EmbeddingResponse`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.EmbeddingResponse)
            - [`EmbeddingResponse.first_embedding`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.EmbeddingResponse.first_embedding)
            - [`EmbeddingResponse.id`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.EmbeddingResponse.id)
            - [`EmbeddingResponse.model`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.EmbeddingResponse.model)
            - [`EmbeddingResponse.object`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.EmbeddingResponse.object)
        - [`TranslateResponse`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.TranslateResponse)
        - [`ReRankerResponse`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ReRankerResponse)
            - [`ReRankerResponse.data`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ReRankerResponse.data)
            - [`ReRankerResponse.failure`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ReRankerResponse.failure)
            - [`ReRankerResponse.id`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ReRankerResponse.id)
            - [`ReRankerResponse.model`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ReRankerResponse.model)
            - [`ReRankerResponse.object`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ReRankerResponse.object)
            - [`ReRankerResponse.usage`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ReRankerResponse.usage)
        - [`HealthResponse`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.HealthResponse)
            - [`HealthResponse.models`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.HealthResponse.models)
            - [`HealthResponse.postgres`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.HealthResponse.postgres)
            - [`HealthResponse.redis`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.HealthResponse.redis)
        - [`PingResponse`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.PingResponse)
            - [`PingResponse.message`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.PingResponse.message)
            - [`PingResponse.status`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.PingResponse.status)
        - [`UsageResponse`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.UsageResponse)
            - [`UsageResponse.overall`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.UsageResponse.overall)
            - [`UsageResponse.usage`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.UsageResponse.usage)
        - [`CompletionResponse`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionResponse)
            - [`CompletionResponse.choices`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionResponse.choices)
            - [`CompletionResponse.created`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionResponse.created)
            - [`CompletionResponse.first_text`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionResponse.first_text)
            - [`CompletionResponse.generation_time`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionResponse.generation_time)
            - [`CompletionResponse.id`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionResponse.id)
            - [`CompletionResponse.model`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionResponse.model)
            - [`CompletionResponse.object`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionResponse.object)
            - [`CompletionResponse.usage`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionResponse.usage)
        - [`CompletionStreamResponse`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionStreamResponse)
            - [`CompletionStreamResponse.choices`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionStreamResponse.choices)
            - [`CompletionStreamResponse.created`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionStreamResponse.created)
            - [`CompletionStreamResponse.first_content`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionStreamResponse.first_content)
            - [`CompletionStreamResponse.id`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionStreamResponse.id)
            - [`CompletionStreamResponse.model`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionStreamResponse.model)
            - [`CompletionStreamResponse.object`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionStreamResponse.object)
            - [`CompletionStreamResponse.usage`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.CompletionStreamResponse.usage)
        - [`ChatCompletionResponse`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionResponse)
            - [`ChatCompletionResponse.choices`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionResponse.choices)
            - [`ChatCompletionResponse.created`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionResponse.created)
            - [`ChatCompletionResponse.first_content`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionResponse.first_content)
            - [`ChatCompletionResponse.id`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionResponse.id)
            - [`ChatCompletionResponse.model`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionResponse.model)
            - [`ChatCompletionResponse.object`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionResponse.object)
            - [`ChatCompletionResponse.usage`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionResponse.usage)
        - [`ChatCompletionResponseChoice`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionResponseChoice)
            - [`ChatCompletionResponseChoice.finish_reason`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionResponseChoice.finish_reason)
            - [`ChatCompletionResponseChoice.index`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionResponseChoice.index)
            - [`ChatCompletionResponseChoice.message`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionResponseChoice.message)
        - [`ChatCompletionStreamResponse`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionStreamResponse)
            - [`ChatCompletionStreamResponse.choices`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionStreamResponse.choices)
            - [`ChatCompletionStreamResponse.created`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionStreamResponse.created)
            - [`ChatCompletionStreamResponse.first_content`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionStreamResponse.first_content)
            - [`ChatCompletionStreamResponse.id`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionStreamResponse.id)
            - [`ChatCompletionStreamResponse.model`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionStreamResponse.model)
            - [`ChatCompletionStreamResponse.object`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionStreamResponse.object)
            - [`ChatCompletionStreamResponse.usage`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionStreamResponse.usage)
        - [`TranscribeResponse`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.TranscribeResponse)
            - [`TranscribeResponse.generation_time`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.TranscribeResponse.generation_time)
            - [`TranscribeResponse.id`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.TranscribeResponse.id)
            - [`TranscribeResponse.text`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.TranscribeResponse.text)
            - [`TranscribeResponse.ts`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.TranscribeResponse.ts)
        - [`ImageResponse`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ImageResponse)
            - [`ImageResponse.created`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ImageResponse.created)
            - [`ImageResponse.data`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ImageResponse.data)
            - [`ImageResponse.model`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ImageResponse.model)
            - [`ImageResponse.object`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ImageResponse.object)
        - [`ChatCompletionResponseStreamChoice`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionResponseStreamChoice)
            - [`ChatCompletionResponseStreamChoice.delta`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionResponseStreamChoice.delta)
            - [`ChatCompletionResponseStreamChoice.finish_reason`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionResponseStreamChoice.finish_reason)
            - [`ChatCompletionResponseStreamChoice.index`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ChatCompletionResponseStreamChoice.index)
        - [`DeltaMessage`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.DeltaMessage)
            - [`DeltaMessage.content`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.DeltaMessage.content)
            - [`DeltaMessage.role`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.DeltaMessage.role)
        - [`FinishReason`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.FinishReason)
        - [`UsageInfo`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.UsageInfo)
            - [`UsageInfo.completion_tokens`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.UsageInfo.completion_tokens)
            - [`UsageInfo.prompt_tokens`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.UsageInfo.prompt_tokens)
            - [`UsageInfo.total_tokens`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.UsageInfo.total_tokens)
    - [Exceptions](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#exceptions)
        - [`ImagineException`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ImagineException)
        - [`ImagineAPITooManyRequestsException`](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html#imagine.ImagineAPITooManyRequestsException)
- [LangChain](https://docs.qualcomm.com/doc/80-88545-1/topic/langchain.html)
    - [`ImagineChat`](https://docs.qualcomm.com/doc/80-88545-1/topic/langchain.html#imagine.langchain.ImagineChat)
        - [`ImagineChat.get_lc_namespace()`](https://docs.qualcomm.com/doc/80-88545-1/topic/langchain.html#imagine.langchain.ImagineChat.get_lc_namespace)
        - [`ImagineChat.is_lc_serializable()`](https://docs.qualcomm.com/doc/80-88545-1/topic/langchain.html#imagine.langchain.ImagineChat.is_lc_serializable)
    - [`ImagineLLM`](https://docs.qualcomm.com/doc/80-88545-1/topic/langchain.html#imagine.langchain.ImagineLLM)
    - [`ImagineEmbeddings`](https://docs.qualcomm.com/doc/80-88545-1/topic/langchain.html#imagine.langchain.ImagineEmbeddings)
        - [`ImagineEmbeddings.aembed_documents()`](https://docs.qualcomm.com/doc/80-88545-1/topic/langchain.html#imagine.langchain.ImagineEmbeddings.aembed_documents)
        - [`ImagineEmbeddings.aembed_query()`](https://docs.qualcomm.com/doc/80-88545-1/topic/langchain.html#imagine.langchain.ImagineEmbeddings.aembed_query)
        - [`ImagineEmbeddings.embed_documents()`](https://docs.qualcomm.com/doc/80-88545-1/topic/langchain.html#imagine.langchain.ImagineEmbeddings.embed_documents)
        - [`ImagineEmbeddings.embed_query()`](https://docs.qualcomm.com/doc/80-88545-1/topic/langchain.html#imagine.langchain.ImagineEmbeddings.embed_query)

## Next steps

- Review the classes, method, and parameters for [Imagine clients](https://docs.qualcomm.com/doc/80-88545-1/topic/imagine_clients.html).
- Review the classes that work as [data transfer objects (DTOs)](https://docs.qualcomm.com/doc/80-88545-1/topic/dtos.html).
- Review the classes to use with [LangChain](https://docs.qualcomm.com/doc/80-88545-1/topic/langchain.html).

Last Published: Apr 17, 2026

[Previous Topic
Configure logging to debug applications](https://docs.qualcomm.com/bundle/publicresource/80-88545-1/topics/6_0_logging.md) [Next Topic
Imagine clients](https://docs.qualcomm.com/bundle/publicresource/80-88545-1/topics/imagine_clients.md)