From 5e70943ed0fdf80e45e9f9405a230b0494a0cfdd Mon Sep 17 00:00:00 2001 From: Hugo Larcher Date: Mon, 15 Jul 2024 18:16:22 +0200 Subject: [PATCH] doc: Add API reference --- docs/source/_toctree.yml | 2 ++ docs/source/reference/api_reference.md | 5 +++++ 2 files changed, 7 insertions(+) create mode 100644 docs/source/reference/api_reference.md diff --git a/docs/source/_toctree.yml b/docs/source/_toctree.yml index 3acfbc89..f891bc0e 100644 --- a/docs/source/_toctree.yml +++ b/docs/source/_toctree.yml @@ -55,6 +55,8 @@ title: Messages API - local: reference/metrics title: Exported Metrics + - local: reference/api_reference + title: API Reference title: Reference - sections: - local: conceptual/streaming diff --git a/docs/source/reference/api_reference.md b/docs/source/reference/api_reference.md new file mode 100644 index 00000000..fd6c7f3b --- /dev/null +++ b/docs/source/reference/api_reference.md @@ -0,0 +1,5 @@ +# HTTP API Reference + +The HTTP API is a RESTful API that allows you to interact with the text-generation-inference component. Two endpoints are available: +* Text Generation Inference [custom API](https://huggingface.github.io/text-generation-inference/) +* OpenAI's [Messages API](https://huggingface.co/docs/text-generation-inference/messages_api)