From 04eb6b3087f8b2c4fba0b278ff0f69b9954ff9e0 Mon Sep 17 00:00:00 2001 From: Han Xiao Date: Mon, 13 May 2024 14:32:01 +0200 Subject: [PATCH] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 67847d7..4693839 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Reader converts any URL to an **LLM-friendly** input with a simple prefix `https ## Updates -- **2024-05-08**: Image capion is off by default for better latency. To turn it on, set `x-with-generated-alt` in the request header. +- **2024-05-08**: Image capion is off by default for better latency. To turn it on, set `x-with-generated-alt: true` in the request header. - **2024-05-03**: We finally resolved a DDoS attack since April 29th. Now our API is much more reliable and scalable than ever! - **2024-04-24**: You now have more fine-grained control over Reader API [using headers](#using-request-headers), e.g. forwarding cookies, using HTTP proxy. - **2024-04-15**: Reader now supports image reading! It captions all images at the specified URL and adds `Image [idx]: [caption]` as an alt tag (if they initially lack one). This enables downstream LLMs to interact with the images in reasoning, summarizing etc. [See example here](https://x.com/JinaAI_/status/1780094402071023926). @@ -64,6 +64,7 @@ Note that in terms of completeness: `... > streamContent3 > streamContent2 > str As you have already seen above, one can control the behavior of the Reader API using request headers. Here is a complete list of supported headers. +- You can enable the image caption feature via the `x-with-generated-alt: true` header. - You can ask the Reader API to forward cookies settings via the `x-set-cookie` header. - Note that requests with cookies will not be cached. - You can bypass `readability` filtering via the `x-respond-with` header, specifically: @@ -73,7 +74,7 @@ As you have already seen above, one can control the behavior of the Reader API u - `x-respond-with: screenshot` returns the URL of the webpage's screenshot - You can specify a proxy server via the `x-proxy-url` header. - You can bypass the cached page (lifetime 300s) via the `x-no-cache` header. -- You can enable the image caption feature via the `x-with-generated-alt` header. + ### JSON mode (super early beta)