You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guides/qiskit-code-assistant-openai-api.mdx
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,33 +12,34 @@ description: Learn how to integrate Qiskit Code Assistant with other application
12
12
13
13
# Qiskit Code Assistant - OpenAI API compatibility
14
14
15
-
Qiskit Code Assistant offers compatibility with a subset of the OpenAI API specification, specifically with the [completions API endpoints](https://platform.openai.com/docs/api-reference/completions). The goal of this compatibility is to allow third-party packages to connect to Qiskit Code Assistant seamlessly by using well-known AI-related libraries and methods such as [OpenAI](https://github.com/openai/openai-python), [LiteLLM](https://github.com/BerriAI/litellm), or others.
15
+
Qiskit Code Assistant offers compatibility with a subset of the OpenAI API specification. The goal of this compatibility is to allow third-party packages to connect to Qiskit Code Assistant seamlessly by using well-known AI-related libraries and methods such as [OpenAI](https://github.com/openai/openai-python), [LiteLLM](https://github.com/BerriAI/litellm), or others.
16
16
17
17
## OpenAI API endpoints supported
18
18
19
19
| Method | Path | Comment |
20
20
|--|--|---|
21
21
|**GET**|`/v1/models`| List all models |
22
-
|**GET**|`/v1/model/{model}`| Get model detail |
22
+
|**GET**|`/v1/models/{model}`| Get model detail |
23
23
|**POST**|`/v1/completions`| Send prompt to model for completion |
24
+
|**POST**|`/v1/chat/completions`| Send messages to model for completion |
24
25
25
26
<Admonitiontype="note">
26
-
The `/v1/completions`endpoint fails with a `403` error if the model disclaimer has been accepted. See the following for how to view and accept the model disclaimer.
27
+
The `/v1/completions`and `/v1/chat/completions` endpoints fails with a `403` error if the model disclaimer has been accepted. See the following for how to view and accept the model disclaimer.
27
28
</Admonition>
28
29
29
30
Additional endpoints (not part of OpenAI schema, provided for convenience) include:
30
31
31
32
| Method | Path | Comment |
32
33
|--|--|---|
33
-
|**GET**|`/v1/model/{model}/disclaimer`| Get model's disclaimer |
0 commit comments