Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add serviceinfo endpoint #807

Merged
merged 2 commits into from
Nov 4, 2024
Merged

feat: add serviceinfo endpoint #807

merged 2 commits into from
Nov 4, 2024

Conversation

AlpinDale
Copy link
Member

As discussed offline with @db0 and @LostRuins, we want to establish a well-known URI for LLM inference APIs. The URI will be named serviceinfo, and will be accessible at the /.well-known/serviceinfo route on the RESTful API server.

The overall structure looks like this:

{
  "version": 1.0,
  "software": {
    "name": "string",
    "version": "string",
    "repository": "url",
    "homepage": "url",
    "logo": "url"
  },
  "api": {
    "api_name_1": {
      "name": "string",
      "base_url": "url",
      "documentation": "url",
      "version": 0
    },
    "api_name_2": {
      "name": "string", 
      "base_url": "url",
      "documentation": "url",
      "version": 0
    }
  }
}

The current standard for this serviceinfo if 1.0. Software information will go in the software part, and individual support API schemes will go into the api part. An example for Aphrodite Engine looks like this:

{
  "version": 0.1,
  "software": {
    "name": "Aphrodite Engine",
    "version": "0.6.3.post1",
    "repository": "https://github.com/PygmalionAI/aphrodite-engine",
    "homepage": "https://aphrodite.pygmalion.chat",
    "logo": "https://pygmalion.chat/icons/favicon.ico"
  },
  "api": {
    "openai": {
      "name": "OpenAI API",
      "base_url": "http://localhost:2242/v1",
      "documentation": "http://localhost:2243/redoc",
      "version": 1
    },
    "koboldai": {
      "name": "KoboldAI API",
      "base_url": "http://localhost:2242/api",
      "documentation": "http://localhost:2243/redoc",
      "version": 1
    }
  }
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant