Merge pull request alexrudall#311 from alexrudall/helicone-streaming-config

alexrudall · web-flow · commit e511ebbd1713 · 2023-08-17T11:08:26.000+01:00
Add note about Helicone streaming
diff --git a/README.md b/README.md
@@ -90,7 +90,8 @@ client = OpenAI::Client.new(
     extra_headers: {
       "X-Proxy-TTL" => "43200", # For https://github.com/6/openai-caching-proxy-worker#specifying-a-cache-ttl
       "X-Proxy-Refresh": "true", # For https://github.com/6/openai-caching-proxy-worker#refreshing-the-cache
-      "Helicone-Auth": "Bearer HELICONE_API_KEY" # For https://docs.helicone.ai/getting-started/integration-method/openai-proxy
+      "Helicone-Auth": "Bearer HELICONE_API_KEY", # For https://docs.helicone.ai/getting-started/integration-method/openai-proxy
+      "helicone-stream-force-format" => "true", # Use this with Helicone otherwise streaming drops chunks # https://github.com/alexrudall/ruby-openai/issues/251
     }
 )
 ```

Original file line number	Diff line number	Diff line change
`@@ -90,7 +90,8 @@ client = OpenAI::Client.new(`
`90`	`90`	`extra_headers: {`
`91`	`91`	`"X-Proxy-TTL" => "43200", # For https://github.com/6/openai-caching-proxy-worker#specifying-a-cache-ttl`
`92`	`92`	`"X-Proxy-Refresh": "true", # For https://github.com/6/openai-caching-proxy-worker#refreshing-the-cache`
`93`		`- "Helicone-Auth": "Bearer HELICONE_API_KEY" # For https://docs.helicone.ai/getting-started/integration-method/openai-proxy`
	`93`	`+ "Helicone-Auth": "Bearer HELICONE_API_KEY", # For https://docs.helicone.ai/getting-started/integration-method/openai-proxy`
	`94`	`+ "helicone-stream-force-format" => "true", # Use this with Helicone otherwise streaming drops chunks # https://github.com/alexrudall/ruby-openai/issues/251`
`94`	`95`	`}`
`95`	`96`	`)`
`96`	`97`	```