Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

V2 docs #93

Merged
merged 67 commits into from
Sep 26, 2024
Merged

V2 docs #93

merged 67 commits into from
Sep 26, 2024

Conversation

mrmer1
Copy link
Contributor

@mrmer1 mrmer1 commented Sep 3, 2024

  • Create docs for v2 API - text generation section
    • Update existing docs - chat, rag, tool use
    • Add new docs - migrating guide from v1 to v2
    • Update getting started tutorials
  • Remove some docs for v2
    • RAG connectors section
    • prompt-truncation
    • single-step-vs-multi-step
  • To add later
    • parameter-types-in-tool-use

@mrmer1 mrmer1 marked this pull request as ready for review September 3, 2024 13:21
@mrmer1 mrmer1 requested review from a team as code owners September 3, 2024 13:21
@mrmer1 mrmer1 requested a review from abdullahkady September 3, 2024 13:21
Copy link

github-actions bot commented Sep 4, 2024

Copy link

github-actions bot commented Sep 5, 2024

Copy link

github-actions bot commented Sep 9, 2024

Copy link

github-actions bot commented Sep 9, 2024

Copy link

github-actions bot commented Sep 9, 2024

Copy link

Copy link

Copy link

Copy link

Copy link

Copy link

Copy link

Copy link

@mrmer1 mrmer1 removed the request for review from abdullahkady September 26, 2024 02:12
@billytrend-cohere billytrend-cohere changed the base branch from main to v2-final September 26, 2024 09:46
@billytrend-cohere billytrend-cohere merged commit 5a419f4 into v2-final Sep 26, 2024
2 checks passed
@billytrend-cohere billytrend-cohere deleted the v2-docs branch September 26, 2024 09:46
billytrend-cohere added a commit that referenced this pull request Sep 26, 2024
* V2 specs (#145)

* V2 specs

* v2

* v2

* Update v2.yml

Signed-off-by: billytrend-cohere <[email protected]>

---------

Signed-off-by: billytrend-cohere <[email protected]>

* release notes for API v2 (#142)

* release notes for API v2

* Rename 2024-09-18-api-v2 to 2024-09-18-api-v2.mdx

Signed-off-by: billytrend-cohere <[email protected]>

* what's new details

---------

Signed-off-by: billytrend-cohere <[email protected]>
Co-authored-by: billytrend-cohere <[email protected]>

* V2 docs (#93)

* add v2 docs - first batch

* add v2 docs

* update image paths

* temp remove param types docs

* misc updates

* add models section and update yml

* multi step tool use updates

* Update fern/pages/fine-tuning/chat-fine-tuning/chat-starting-the-training.mdx

Co-authored-by: Michael <[email protected]>
Signed-off-by: Meor Amer <[email protected]>

* Update fern/pages/fine-tuning/chat-fine-tuning/chat-starting-the-training.mdx

Co-authored-by: Michael <[email protected]>
Signed-off-by: Meor Amer <[email protected]>

* Update fern/pages/v2/models/the-command-family-of-models/command-r.mdx

Co-authored-by: Michael <[email protected]>
Signed-off-by: Meor Amer <[email protected]>

* Update fern/pages/v2/text-generation/chat-api.mdx

Co-authored-by: Michael <[email protected]>
Signed-off-by: Meor Amer <[email protected]>

* Update fern/pages/v2/text-generation/migrating-v1-to-v2.mdx

Co-authored-by: Michael <[email protected]>
Signed-off-by: Meor Amer <[email protected]>

* Update fern/pages/v2/text-generation/migrating-v1-to-v2.mdx

Co-authored-by: Michael <[email protected]>
Signed-off-by: Meor Amer <[email protected]>

* clean up migration guide

* update text gen docs

* update command model to latest

* add tool use param types docs

* ft updates

* update tool content to accept string

* update agent getting started nb

* safety mode

* update fern

* upd search query gen and web search for v2

* change RAG documents to top level param

* remove gen->chat migration, misc updates

* embedding types required

* update rag query generation

* chg term - preamble to system message

* update client to use v2 for misc endpoints

* multi step updates

* update getting started tutorials

* update migration guide title

* update migration guide

* Update preview-docs.yml (#143)

Signed-off-by: billytrend-cohere <[email protected]>

* update chat

* Revert "Update preview-docs.yml (#143)" (#144)

This reverts commit abfd2bd.

* update links

* Apply suggestions from code review

Co-authored-by: Michael <[email protected]>
Signed-off-by: Meor Amer <[email protected]>

* Apply suggestions from code review

Co-authored-by: Michael <[email protected]>
Signed-off-by: Meor Amer <[email protected]>

* chat api updates

* update web search and search query gen migration guide

* fix formatting

* search query gen upd

* add 2 missing pages

* v2 slug change

* Apply suggestions from code review

Co-authored-by: Michael <[email protected]>
Signed-off-by: Meor Amer <[email protected]>

* migration guide - simplify chat history

* update links to point to v2

* update RAG responses

* update streaming docs

* update deployment options and misc

* deployment options edits

* v1 usage notes

* fix formatting

* update meta desc

* update meta desc

* updates on tool use structure and migration guide, + misc

* make v2 default

* fix links

---------

Signed-off-by: Michael <[email protected]>
Signed-off-by: Meor Amer <[email protected]>
Signed-off-by: billytrend-cohere <[email protected]>
Co-authored-by: Michael <[email protected]>
Co-authored-by: billytrend-cohere <[email protected]>

* Update 2024-09-18-api-v2.mdx

Signed-off-by: billytrend-cohere <[email protected]>

* Update snippets to v2 (#152)

* make v1 default

Signed-off-by: Michael <[email protected]>

* Update 2024-09-18-api-v2.mdx

Signed-off-by: Michael <[email protected]>

* Update 2024-09-18-api-v2.mdx

Signed-off-by: Michael <[email protected]>

---------

Signed-off-by: billytrend-cohere <[email protected]>
Signed-off-by: Michael <[email protected]>
Signed-off-by: Meor Amer <[email protected]>
Co-authored-by: Elaine <[email protected]>
Co-authored-by: Meor Amer <[email protected]>
Co-authored-by: Michael <[email protected]>
billytrend-cohere pushed a commit that referenced this pull request Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants