update Read me #10
update Read me #10
Conversation
.fernignore
Outdated
| src/Client.ts | ||
| src/core/fetcher/Fetcher.ts | ||
| tests/integration | ||
| src/wrapper | ||
| src/index.ts | ||
| src/api/resources/auth/client/Client.ts | ||
| src/core/fetcher/getRequestBody.ts | ||
| contributing.md |
There was a problem hiding this comment.
Isn't it usually with uppercase: CONTRIBUTING.md?
README.md
Outdated
| citations: { | ||
| style: "none", | ||
| }, | ||
| enableFactualConsistencyScore: false, |
There was a problem hiding this comment.
Why not have this true in the example?
| generation: { | ||
| }; | ||
|
|
||
| const generationParams: GenerationParameters = { |
There was a problem hiding this comment.
IN this example, what would be the default prompt/LLM? perhaps add to the example also that variable to show how it's used and a link to the docs for options to choose from?
README.md
Outdated
|
|
||
| ### Streaming | ||
|
|
||
| The SDK supports streaming responses for both query and chat. When using streaming, the response will be a generator that you can iterate. |
There was a problem hiding this comment.
nit: "... that you can iterate over".
README.md
Outdated
| } | ||
| ``` | ||
|
|
||
| And streaming the chat response: |
There was a problem hiding this comment.
I would rephrase as "And stream with chat:"
| generation: generationParams | ||
| }); | ||
|
|
||
| const responseItems = []; |
There was a problem hiding this comment.
Is there a link in the docs you can refer to that explains the various "types" (chat_info, generation_chunk, etc)? or if not, perhaps explain this a bit.
Also we call this "chunk" in the loop, but it's not really a chunk anymore (chunk to me says part of the text). It's like "item" or "event"?
No description provided.