chore: update README.md - #14
Conversation
Updated the README to reflect the new project name and improved structure. Removed outdated sections and added new usage examples.
Added a capabilities section to outline various use cases and their corresponding entry points.
There was a problem hiding this comment.
- don't say internal tool, we don't use that wording. Use the same wording as the docs. don't say extras, it's our sdk, you can just say, something like provided additional metadata or remove this and just show it in the examples
| @@ -1,4 +1,4 @@ | |||
| # interfaze-js | |||
| # interfaze | |||
There was a problem hiding this comment.
Change to: # Interfaze Typescript and Javascript SDK
| @@ -8,22 +8,7 @@ The official [Interfaze](https://interfaze.ai) SDK for TypeScript/JavaScript | |||
| console.log("cache hit:", res.vcache); // typed Interfaze extra | ||
|
|
||
| res.choices[0]?.message.content; | ||
| res.vcache; // semantic-cache hit |
There was a problem hiding this comment.
this is not important, precontext is still not logged. look at the docs intro code: https://interfaze.ai/docs#make-your-first-request
There was a problem hiding this comment.
add a better example like OCR with structured output, more relevant to us
| properties: { city: { type: "string" }, temp_c: { type: "number" } }, | ||
| required: ["city", "temp_c"], | ||
| }), | ||
| }); |
There was a problem hiding this comment.
bad example, give something related to us
| await interfaze.tasks.objectDetection("https://example.com/photo.jpg"); | ||
| await interfaze.tasks.guiDetection("https://example.com/screenshot.png"); | ||
| await interfaze.tasks.forecast("https://example.com/timeseries.csv", { periods: 30 }); | ||
| const stream = interfaze.chat.completions.stream({ |
|
|
||
| From base64 / raw bytes URI: | ||
|
|
||
| ```ts |
There was a problem hiding this comment.
this is great but also add the traditional method of adding the files inline, that's very common too
|
|
||
| ## Tasks | ||
|
|
||
| Each helper forces one specialized tool - [faster and cheaper](https://interfaze.ai/docs/run-tasks) than a completion. All return `unknown`, so validate before use. |
There was a problem hiding this comment.
add the downside too, that it doesn't run the full model so it's only one task and it's a fixed structure
| URLs and base64 both work; `image/gif` and `image/avif` are rejected client-side. | ||
| A match returns the plain string `unsafe S1` as the content. See the exported `GUARD_CODES` / `GUARD_LABELS`. | ||
|
|
||
| ## Interfaze extras |
There was a problem hiding this comment.
why extras?
precontext is such an important part of interfaze, it should be right at the top after the intro code
| messages: [{ role: "user", content: "Extract the total from this receipt." }], | ||
| }); | ||
|
|
||
| res.vcache; // boolean - the semantic cache served this |
There was a problem hiding this comment.
vcache and reasoning is extra but just put them in their own section instead of saying extra
|
@yoeven updated the readme to now better reflect uses and our own documentation style |
2 participants
Updated the README to reflect the new improved structure. Removed outdated sections and added new usage examples.