proposed docs

[mkozakov]

This pull request introduces several changes to the cohere-openapi.yaml file, primarily focusing on refining the descriptions and parameters for the ReRank API. The updates aim to provide clearer guidance and improve the user experience when interacting with the API.

• Description Updates:
  • The description field for the model identifier has been enhanced to include a list of supported models (rerank-english-v3.0, rerank-multilingual-v3.0, rerank-english-v2.0, and rerank-multilingual-v2.0).
  • The query description now specifies that the search query is used to rerank documents, with a maximum length of 500 tokens. It also provides a link to a tokenization guide for reference.
  • The documents description has been modified to clarify that it accepts a list of strings for reranking against the search query. It mentions automatic truncation for long documents and recommends a limit of 1,000 documents for optimal performance.
• Parameter Adjustments:
  • The max_chunks_per_doc parameter has been replaced with max_document_length, which truncates documents exceeding the specified length. The default value has been increased from 10 to 4096.
  • The rank_fields, return_documents, and max_chunks_per_doc parameters have been removed.

[github-actions]

🌿 Preview your docs: https://cohere-preview-4da4ed69-d152-475f-ab70-66bf14ae5209.docs.buildwithfern.com