docs: sync llms.txt with audio input support and agent.embed() - #113
Open
LeonSGP43 wants to merge 1 commit into
Open
docs: sync llms.txt with audio input support and agent.embed()#113LeonSGP43 wants to merge 1 commit into
LeonSGP43 wants to merge 1 commit into
Conversation
Project Xander (b5e2943) added audio input to agent.run/agent.complete and a public agent.embed() on the Needle 3 retrieval head, and updated doc/apis.md accordingly, but llms.txt still listed the old signatures and omitted agent.embed entirely - while promising readers that it is enough to write correct Needle code without inventing API. - agent.run/agent.complete: document the new text="" default and the audio/audio_format/sample_rate/channels argument group (Needle 3 only) - add the missing agent.embed() entry with its Needle-3-only constraint - add a short audio input note (WAV path/bytes, raw PCM16/float32 with positive sample_rate/channels) mirroring doc/apis.md Signed-off-by: LeonSGP43 <cine.dreamer.one@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Project Xander (b5e2943) added audio input to
agent.run/agent.completeand a publicagent.embed()on the Needle 3 retrieval head, and updateddoc/apis.mdaccordingly — butllms.txtstill listed the old signatures and omittedagent.embed()entirely, while promising readers that it is enough to write correct Needle code without inventing API.This PR syncs
llms.txtwith the shipped code:agent.run/agent.complete: document the newtext=""default and theaudio/audio_format="wav"/sample_rate=0/channels=1argument group (Needle 3 models only)agent.embed(text="", audio=None, audio_format="wav", sample_rate=0, channels=1) -> list[float]entry, including the Needle-3-only constraint (raisesValueErroron a Needle 2 model)audio_formatplus positivesample_rate/channels), mirroringdoc/apis.mdVerification
needle/__init__.pyon main (completeL215,runL273,embedL254;_prepare_audioL92 accepts wav/pcm16/float32, PCM requires positive rate/channels;generation < 3raises for audio and embeddings)doc/apis.mdtable updated in b5e2943extractline and the CLI section; this PR touches therun/completelines, adds theembedentry, and appends an audio note after the extraction bullet — no overlapping hunksFollows the precedent of #99 (llms.txt documentation sync).