@@ -9,19 +9,14 @@ This repository contains a generic HTTP client which can be adapted to provide:
99* Debugging capabilities to see the request and response data
1010* Streaming text and JSON events
1111
12- API Documentation: https://pkg.go.dev/github.com/mutablelogic/go-client
12+ API Documentation: < https://pkg.go.dev/github.com/mutablelogic/go-client >
1313
1414There are also some example clients which use this library:
1515
16- * [ Anthropic API Client] ( https://github.com/mutablelogic/go-client/tree/main/pkg/anthropic ) for Claude LLM
1716* [ Bitwarden API Client] ( https://github.com/mutablelogic/go-client/tree/main/pkg/bitwarden )
18- * [ Elevenlabs API Client] ( https://github.com/mutablelogic/go-client/tree/main/pkg/elevenlabs ) for Text-to-Speech
1917* [ Home Assistant API Client] ( https://github.com/mutablelogic/go-client/tree/main/pkg/homeassistant )
2018* [ IPify Client] ( https://github.com/mutablelogic/go-client/tree/main/pkg/ipify )
21- * [ Mistral API Client] ( https://github.com/mutablelogic/go-client/tree/main/pkg/mistral ) for Mistral LLM
2219* [ NewsAPI client] ( https://github.com/mutablelogic/go-client/tree/main/pkg/newsapi )
23- * [ Ollama API client] ( https://github.com/mutablelogic/go-client/tree/main/pkg/ollama ) for locally-hosted LLM's
24- * [ OpenAI API client] ( https://github.com/mutablelogic/go-client/tree/main/pkg/openai ) for OpenAI LLM's
2520* [ WeatherAPI client] ( https://github.com/mutablelogic/go-client/tree/main/pkg/weatherapi )
2621
2722Aiming to have compatibility with go version 1.21 and above.
@@ -81,7 +76,7 @@ You can create a payload using the following methods:
8176 a JSON payload which defaults to POST.
8277* ` client.NewMultipartRequest(payload any, accept string) ` returns a new request with
8378 a Multipart Form data payload which defaults to POST.
84- * ` client.NewFormRequest(payload any, accept string) ` returns a new request with a
79+ * ` client.NewFormRequest(payload any, accept string) ` returns a new request with a
8580 Form data payload which defaults to POST.
8681
8782For example,
@@ -147,7 +142,7 @@ type Client interface {
147142```
148143
149144If you pass a context to the ` DoWithContext ` method, then the request can be
150- cancelled using the context in addition to the timeout. Various options can be passed to
145+ cancelled using the context in addition to the timeout. Various options can be passed to
151146modify each individual request when using the ` Do ` method:
152147
153148* ` OptReqEndpoint(value string) ` sets the endpoint for the request
@@ -273,7 +268,7 @@ func Callback(event client.TextStreamEvent) error {
273268}
274269```
275270
276- The ` TextStreamEvent ` object has the following
271+ The ` TextStreamEvent ` object has the following
277272
278273If you return an error of type ` io.EOF ` from the callback, then the stream will be closed.
279274Similarly, if you return any other error the stream will be closed and the error returned.
0 commit comments