From d4167e81d6e45dd0251a8d56b53076406c099299 Mon Sep 17 00:00:00 2001 From: Han Xiao Date: Wed, 12 Feb 2025 16:24:47 +0800 Subject: [PATCH] chore: add client integration guidelines --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b9e00cf..418a4e0 100644 --- a/README.md +++ b/README.md @@ -66,10 +66,10 @@ You can use it with any OpenAI-compatible client. For the authentication Bearer, #### Client integration guidelines If you are building a web/local/mobile client that uses `Jina DeepSearch API`, here are some design guidelines: -- Our API is fully compatible with OpenAI API, this should greatly simplify the integration process. The model name is `jina-deepsearch-v1`. -- DeepSearch API is a reasoning+search grounding LLM, so it's best for questions that require deep reasoning and search. +- Our API is fully compatible with [OpenAI API schema](https://platform.openai.com/docs/api-reference/chat/create), this should greatly simplify the integration process. The model name is `jina-deepsearch-v1`. +- Our DeepSearch API is a reasoning+search grounding LLM, so it's best for questions that require deep reasoning and search. - Two special tokens are introduced `...`, `...`. Please render them with care. -- Guide the user to get a Jina API key from https://jina.ai +- Guide the user to get a Jina API key from https://jina.ai, with 1M free tokens for new API key. - There are rate limits, [between 10RPM to 30RPM depending on the API key tier](https://jina.ai/contact-sales#rate-limit). - [Download Jina AI logo here](https://jina.ai/logo-Jina-1024.zip)