From 5885ec2f6e4cbc9c93806928bf069ced09456936 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 27 Nov 2024 15:21:40 +0000 Subject: [PATCH] feat: Updated OpenAPI spec --- src/libs/Cohere/openapi.yaml | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/src/libs/Cohere/openapi.yaml b/src/libs/Cohere/openapi.yaml index b11e869..09b2b06 100644 --- a/src/libs/Cohere/openapi.yaml +++ b/src/libs/Cohere/openapi.yaml @@ -762,6 +762,8 @@ paths: model: type: string description: 'The name of a compatible [Cohere model](https://docs.cohere.com/v2/docs/models) (such as command-r or command-r-plus) or the ID of a [fine-tuned](https://docs.cohere.com/v2/docs/chat-fine-tuning) model.' + x-fern-audiences: + - public messages: $ref: '#/components/schemas/ChatMessages' tools: @@ -769,6 +771,8 @@ paths: items: $ref: '#/components/schemas/ToolV2' description: "A list of available tools (functions) that the model may suggest invoking before producing a text response.\n\nWhen `tools` is passed (without `tool_results`), the `text` content in the response will be empty and the `tool_calls` field in the response will be populated with a list of tool calls that need to be made. If no calls need to be made, the `tool_calls` array will be empty.\n" + x-fern-audiences: + - public strict_tools: type: boolean description: "When set to `true`, tool calls in the Assistant message will be forced to follow the tool definition strictly. Learn more in the [Strict Tools guide](https://docs.cohere.com/docs/structured-outputs-json#structured-outputs-tools).\n\n**Note**: The first few requests with a new set of tools will take longer to process.\n" @@ -782,6 +786,8 @@ paths: - type: string - $ref: '#/components/schemas/Document' description: "A list of relevant documents that the model can cite to generate a more accurate reply. Each document is either a string or document object with content and metadata.\n" + x-fern-audiences: + - public citation_options: $ref: '#/components/schemas/CitationOptions' response_format: @@ -792,33 +798,47 @@ paths: - STRICT - OFF description: "Used to select the [safety instruction](https://docs.cohere.com/v2/docs/safety-modes) inserted into the prompt. Defaults to `CONTEXTUAL`.\nWhen `OFF` is specified, the safety instruction will be omitted.\n\nSafety modes are not yet configurable in combination with `tools`, `tool_results` and `documents` parameters.\n\n**Note**: This parameter is only compatible with models [Command R 08-2024](https://docs.cohere.com/v2/docs/command-r#august-2024-release), [Command R+ 08-2024](https://docs.cohere.com/v2/docs/command-r-plus#august-2024-release) and newer.\n" + x-fern-audiences: + - public max_tokens: type: integer description: "The maximum number of tokens the model will generate as part of the response.\n\n**Note**: Setting a low value may result in incomplete generations.\n" + x-fern-audiences: + - public stop_sequences: type: array items: type: string description: "A list of up to 5 strings that the model will use to stop generation. If the model generates a string that matches any of the strings in the list, it will stop generating tokens and return the generated text up to that point not including the stop sequence.\n" + x-fern-audiences: + - public temperature: maximum: 1 minimum: 0 type: number description: "Defaults to `0.3`.\n\nA non-negative float that tunes the degree of randomness in generation. Lower temperatures mean less random generations, and higher temperatures mean more random generations.\n\nRandomness can be further maximized by increasing the value of the `p` parameter.\n" format: float + x-fern-audiences: + - public seed: maximum: 18446744073709552000 minimum: 0 type: integer description: "If specified, the backend will make a best effort to sample tokens\ndeterministically, such that repeated requests with the same\nseed and parameters should return the same result. However,\ndeterminism cannot be totally guaranteed.\n" + x-fern-audiences: + - public frequency_penalty: type: number description: "Defaults to `0.0`, min value of `0.0`, max value of `1.0`.\nUsed to reduce repetitiveness of generated tokens. The higher the value, the stronger a penalty is applied to previously present tokens, proportional to how many times they have already appeared in the prompt or prior generation.\n" format: float + x-fern-audiences: + - public presence_penalty: type: number description: "Defaults to `0.0`, min value of `0.0`, max value of `1.0`.\nUsed to reduce repetitiveness of generated tokens. Similar to `frequency_penalty`, except that this penalty is applied equally to all tokens that have already appeared, regardless of their exact frequencies.\n" format: float + x-fern-audiences: + - public k: maximum: 500 minimum: 0 @@ -826,6 +846,8 @@ paths: description: "Ensures that only the top `k` most likely tokens are considered for generation at each step. When `k` is set to `0`, k-sampling is disabled.\nDefaults to `0`, min value of `0`, max value of `500`.\n" format: float default: 0 + x-fern-audiences: + - public p: maximum: 0.99 minimum: 0.01 @@ -833,9 +855,13 @@ paths: description: "Ensures that only the most likely tokens, with total probability mass of `p`, are considered for generation at each step. If both `k` and `p` are enabled, `p` acts after `k`.\nDefaults to `0.75`. min value of `0.01`, max value of `0.99`.\n" format: float default: 0.75 + x-fern-audiences: + - public logprobs: type: boolean description: "Defaults to `false`. When set to `true`, the log probabilities of the generated tokens will be included in the response.\n" + x-fern-audiences: + - public responses: '200': description: OK