Skip to content
This repository has been archived by the owner on Oct 14, 2024. It is now read-only.

docs: Page *Any OpenAI-compatible API* reads confusing #308

Open
ZeroAurora opened this issue Aug 26, 2024 · 0 comments
Open

docs: Page *Any OpenAI-compatible API* reads confusing #308

ZeroAurora opened this issue Aug 26, 2024 · 0 comments
Labels
type: documentation Improvements or additions to documentation

Comments

@ZeroAurora
Copy link

ZeroAurora commented Aug 26, 2024

Pages

Info

The first paragraph reads:

This guide outlines the process for configuring Jan as a client for both remote and local API servers, using the mistral-ins-7b-q4 model for illustration. We'll show how to connect to Jan's API-hosting servers.

But later images are showing users how to change the endpoint and connect to Azure-like OpenAI proxy servers. The model in documentation is still GPTs. Not something about mistral-ins-7b-q4 or any other custom model APIs accepting OpenAI-like requests.

Are we using Any OpenAI-compatible API or OpenAI Proxying API? For me the former one means to specify endpoint, apikey, and most importantly the model to use. The latter, on the contrast, means to use an another endpoint with completely same layout as OpenAI's.

This is confusing and should be fixed.

@ZeroAurora ZeroAurora added the type: documentation Improvements or additions to documentation label Aug 26, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type: documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants
@ZeroAurora and others