Skip to content
Snippets Groups Projects
Unverified Commit d896b3a3 authored by Shorthills AI's avatar Shorthills AI Committed by GitHub
Browse files

FIx Doc links and other documentation issue (#9632)


* Update CHANGELOG.md

* Update agents.md

* Updated understanding.md (#51)

* Grammatical_error in docs/api_reference/query.rst

* Grammatical error in docs/end_to_end_tutorials/dev_practices/e2e_evaluation.md

* Changed word from unstructed to unstructured

* Corrected the spelling of performing

* Update evaluating.md

Corrected the spelling of "guidelines"

* Update evaluation.md

Changed " things are working will together" to " things are working well together"

* Update usage_pattern.md (#2)

* Update usage_pattern.md

Corrected the spellings of measure.

* Update basic_strategies.md

* Update (#8)

* Introduce Google Generative Language Semantic Retriever (#9440)

* Add a Gemini models for text and multi-modal. (#9452)

* Add a Gemini models for text and multi-modal.

Includes each of {text, mm} x {completion, chat} x {stream, one-shot}
x {sync, async} for Gemini's Developer API.

And two notebooks - regular text & multi-modal.

* add gemini into doc and rename MM example file

* Add version constraints to pip install

And remove noisy output.

* Enrich Gemini Example

* cr

* Use gemini-pro instead of ultra

* cr

* cr

* cr

---------

Co-authored-by: default avatarHaotian Zhang <socool.king@gmail.com>

* [version] bump to v0.9.15 (#9485)

* use persist dir in faiss (#9486)

* Gemini Embedding (#9476)

* Gemini Embedding

* cr

* Merge Gemini Same Role Chat Message (#9498)

* Fix Gemini Same Role Chat Msg

* cr

* cr

* cr

* cr

* Teeny stray link causing weirdness (#9501)

* Fixing CHANGELOG for wrong PR ID (#9505)

* Overhauling indexing to emphasize VectorStoreIndex and SEO

* Expanding use-cases docs: Q&A and chatbots

* Fix small bug in string method of NodeWithScore (#9494)

Update schema.py

Avoid exception in __str__ method of NodeWithScore when the optional member variable self.score is None.

* Added missing `default=None` to `LLM.system_prompt` (#9504)

* Adding default=None to system_prompt to fix type errors

* Added CHANGELOG entry

* Update PDFReader (#9508)

Add to PDFReader so that a user can specify if they want the PDF read in as one whole Document, or each page as a Document.

* Updating Spelling Mistakes (#9513)

* Grammatical_error in docs/api_reference/query.rst

* Grammatical error in docs/end_to_end_tutorials/dev_practices/e2e_evaluation.md

* Changed word from unstructed to unstructured

* Corrected the spelling of performing

---------

Co-authored-by: default avatarKamalSharmaShorthillsAI <kamal@shorthills.ai>
Co-authored-by: default avatarHaotian Zhang <socool.king@gmail.com>
Co-authored-by: default avatarUpneetShorthillsAI <144228282+UpneetShorthillsAI@users.noreply.github.com>

* FIxing Grammatical issues in docs (#9514)

* Fixing Docs (#9515)

* Allowing `LOCALAI_DEFAULTS` to work with `__ror__` (#9502)

---------

Co-authored-by: default avatarLawrence Tsang <pikalaw@gmail.com>
Co-authored-by: default avatarMark McDonald <macd@google.com>
Co-authored-by: default avatarHaotian Zhang <socool.king@gmail.com>
Co-authored-by: default avatarLogan <logan.markewich@live.com>
Co-authored-by: default avatarLaurie Voss <github@seldo.com>
Co-authored-by: default avatarJames Braza <jamesbraza@gmail.com>
Co-authored-by: default avatarMax <150716622+maximannrcp@users.noreply.github.com>
Co-authored-by: default avatarAlex McGraw <60911060+JAlexMcGraw@users.noreply.github.com>
Co-authored-by: default avatarKamalSharmaShorthillsAI <kamal@shorthills.ai>
Co-authored-by: default avatarUpneetShorthillsAI <144228282+UpneetShorthillsAI@users.noreply.github.com>

* Update train_questions.txt (#5)

removed a from a developing

* updated basic_strategies.md and building_rag_from_scratch.md files (#6)

* Update basic_strategies.md

* Update building_rag_from_scratch.md

* Update deprecated_terms.md , changed "THe" to "The"

* Update graph_stores.md

* Update guidance.md

* Update vector_stores.md

* This PR addresses grammatical and clarity enhancements. (#7)

* Update structured_outputs.md

 Grammatical Improvements

* Update query_transformations.md

Changed followup to follow-up.

* Update structured_outputs.md

---------

Co-authored-by: default avatarShorthills AI <141953346+ShorthillsAI@users.noreply.github.com>

* made a grammatical correction (#10)

* Update train_questions.txt

removed a from a developing

* Update agents.md

removed a from a more information

* Update gatsby_license.txt (#11)

* Update gatsby_license.txt

grammar and tense correction: "read, understand, agree to and accept all the terms" to "read, understood, and agreed to accept all the terms", "do not agree" to "disagree", "agreement for keeping" to "agreement to keep", "unlink or detach or remove" to "unlink, detach or remove", "statements concerning tax" to "statements concerning the tax"

* Update concepts.md

grammar and tense correction: "or retrieved data" to "or retrieve data", "data which is" to "data that is", "class, are responsible" to "class, is responsible"," that allow you to ask question" to "that allows you to ask questions".

* Update discover_llamaindex.md (#15)

* Update llms.md (#9)

Corrected spellings of 'results'.

* Update llms.md (#13)

Corrected spelling of results.

* Update CHANGELOG.md (#14)

fixed the spelling mistake of  the evaluation

* Update deprecated_terms.md

Links Urls in Deprecated_terms is not working.
1. Configuring settings in the Service Context Link updated.
2. Parsing Documents into Nodes Link updated.
3. LLMs in LlamaIndex Link updated.
4. Setting LLMs in the ServiceContext updated

* Update deprecated_terms.md

Links Updated in Deprecated_terms mentioned below:
1. Index Usage Pattern link updated.
2. Vector Store Guide link updated
3. Vector Store Integrations link updated.
4. Index Usage Pattern link updated.
5. Vector Store Guide link updated.
6. Vector Store Integrations link updated.

* Update deprecated_terms.md

GPTVectorStoreIndex "Index Usage Pattern" Link updated.

* Update chatbots.md

Improve clarity and consistency in the Chatbots section of the documentation:
1. Corrected the term 'LLM's' to 'LLMs' for consistency.
2. Modified 'Here's some relevant resources' to 'Here are some relevant resources' for grammatical correctness.

* Update chatbots.md with spelling : chatbots

Previous : chat  bots
Corrected : chatbots

* Update multimodal.md

removed an extra word : "out" for consistency and clarity

* Update chatbots.md

* Update agents.md

* Update embeddings.md

* Update understanding.md

* Update extraction.md

---------

Co-authored-by: default avatarKamalSharmaShorthillsAI <kamal@shorthills.ai>
Co-authored-by: default avatarShorthills AI <141953346+ShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarHaotian Zhang <socool.king@gmail.com>
Co-authored-by: default avatarUpneetShorthillsAI <144228282+UpneetShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarManpreetShorthillsAI <142380984+ManpreetShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarSakshiShorthillsAI <144228183+SakshiShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarLawrence Tsang <pikalaw@gmail.com>
Co-authored-by: default avatarMark McDonald <macd@google.com>
Co-authored-by: default avatarLogan <logan.markewich@live.com>
Co-authored-by: default avatarLaurie Voss <github@seldo.com>
Co-authored-by: default avatarJames Braza <jamesbraza@gmail.com>
Co-authored-by: default avatarMax <150716622+maximannrcp@users.noreply.github.com>
Co-authored-by: default avatarAlex McGraw <60911060+JAlexMcGraw@users.noreply.github.com>
Co-authored-by: default avatarAayush <142384656+AayushShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarSaransh Sharma <142397365+SaranshSharmaShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarAbhishekYadavShorthillsAI <142393903+AbhishekYadavShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarAryamanJaiswalShorthillsAI <142397527+AryamanJaiswalShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarSanskar Tanwar <142409040+SanskarTanwarShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarShreeramKumawatShorthillsAI <142401684+ShreeramKumawatShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarVishal <141389263+VishalYadavShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarAashutoshPathakShorthillsAI <142410372+AashutoshPathakShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarRajneesh Singh <68937839+rajneeshRepo@users.noreply.github.com>
Co-authored-by: default avatarVagishaMisraShorthillsAI <143705558+VagishaMisraShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarPankajKumarShorthillsAI <142473460+PankajKumarShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarAdarsh Shrivastav <142413097+AdarshKumarShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarPuneet Dhiman <142409038+PuneetDhimanShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarAmitSinghShorthillsAI <142410046+AmitSinghShorthillsAI@users.noreply.github.com>

* Update embeddings.md

* Update embeddings.md

* Update embeddings.md

* Update embeddings.md

---------

Co-authored-by: default avatarChetnaGuptaShorthillsAI <142381084+ChetnaGuptaShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarPuneet Dhiman <142409038+PuneetDhimanShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarAdityaKalraShorthillsAI <143726711+AdityaKalraShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarKamalSharmaShorthillsAI <kamal@shorthills.ai>
Co-authored-by: default avatarHaotian Zhang <socool.king@gmail.com>
Co-authored-by: default avatarUpneetShorthillsAI <144228282+UpneetShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarManpreetShorthillsAI <142380984+ManpreetShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarSakshiShorthillsAI <144228183+SakshiShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarLawrence Tsang <pikalaw@gmail.com>
Co-authored-by: default avatarMark McDonald <macd@google.com>
Co-authored-by: default avatarLogan <logan.markewich@live.com>
Co-authored-by: default avatarLaurie Voss <github@seldo.com>
Co-authored-by: default avatarJames Braza <jamesbraza@gmail.com>
Co-authored-by: default avatarMax <150716622+maximannrcp@users.noreply.github.com>
Co-authored-by: default avatarAlex McGraw <60911060+JAlexMcGraw@users.noreply.github.com>
Co-authored-by: default avatarAayush <142384656+AayushShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarSaransh Sharma <142397365+SaranshSharmaShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarAbhishekYadavShorthillsAI <142393903+AbhishekYadavShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarAryamanJaiswalShorthillsAI <142397527+AryamanJaiswalShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarSanskar Tanwar <142409040+SanskarTanwarShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarShreeramKumawatShorthillsAI <142401684+ShreeramKumawatShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarVishal <141389263+VishalYadavShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarAashutoshPathakShorthillsAI <142410372+AashutoshPathakShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarRajneesh Singh <68937839+rajneeshRepo@users.noreply.github.com>
Co-authored-by: default avatarVagishaMisraShorthillsAI <143705558+VagishaMisraShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarPankajKumarShorthillsAI <142473460+PankajKumarShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarAdarsh Shrivastav <142413097+AdarshKumarShorthillsAI@users.noreply.github.com>
Co-authored-by: default avatarAmitSinghShorthillsAI <142410046+AmitSinghShorthillsAI@users.noreply.github.com>
parent d465b3e0
Loading
Loading
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment