diff --git a/fern/openapi/chat.yaml b/fern/openapi/chat.yaml deleted file mode 100644 index 7dbe9fdc..00000000 --- a/fern/openapi/chat.yaml +++ /dev/null @@ -1,496 +0,0 @@ -post: - parameters: - - $ref: './types/RequestSource.yaml' - x-fern-audiences: [public] - summary: Chat - operationId: chat - x-fern-streaming: - stream-condition: $request.stream - response: - $ref: './types/NonStreamedChatResponse.yaml' - response-stream: - $ref: './types/StreamedChatResponse.yaml' - x-readme: - samples-languages: - - python - - java - - curl - - node - - go - code-samples: - - language: go - name: Vanilla - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: './snippets/go/chat-post/default/main.go' - - language: go - name: With Documents - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: ./snippets/go/chat-post/documents/main.go - - language: go - name: Streaming - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: ./snippets/go/chat-post/stream/main.go - - language: go - name: With Tools - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: ./snippets/go/chat-post/tools/main.go - - language: node - name: Vanilla - install: npm i cohere-ai - code: - $ref: ./snippets/node/chat-post/default.ts - - language: node - name: With Documents - install: npm i cohere-ai - code: - $ref: ./snippets/node/chat-post/documents.ts - - language: node - name: Streaming - install: npm i cohere-ai - code: - $ref: ./snippets/node/chat-post/stream.ts - - language: node - name: With Tools - install: npm i cohere-ai - code: - $ref: ./snippets/node/chat-post/tools.ts - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/chat-post/default.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/chat-post.py - - language: python - name: With Documents - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/chat-post/documents.py - - language: python - name: Streaming - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/chat-post/stream.py - - language: python - name: With Tools - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/chat-post/tools.py - - language: java - name: With Documents - install: implementation 'com.cohere:cohere-java:1.x.x' - code: - $ref: ./snippets/java/app/src/main/java/chatpost/Documents.java - - language: java - name: Streaming - install: implementation 'com.cohere:cohere-java:1.x.x' - code: - $ref: ./snippets/java/app/src/main/java/chatpost/Stream.java - - language: java - name: With Tools - install: implementation 'com.cohere:cohere-java:1.x.x' - code: - $ref: ./snippets/java/app/src/main/java/chatpost/Tools.java - - language: curl - name: cURL - code: - $ref: ./snippets/curl/chat-post.sh - description: | - Generates a text response to a user message. - To learn how to use the Chat API with Streaming and RAG follow our [Text Generation guides](/docs/chat-api). - requestBody: - content: - application/json: - schema: - type: object - x-fern-audiences: ['public'] - x-examples: - Chat: - value: - message: Can you give me a global market overview of solar panels? - temperature: 0.3 - stream: false - chat_history: - [ - { 'role': 'User', 'message': 'Hi!' }, - { 'role': 'Chatbot', 'message': 'How can I help you today?' }, - ] - prompt_truncation: 'OFF' - Chat with web search: - value: - message: 'Can you give me a global market overview of solar panels?' - temperature: 0.3 - stream: false - chat_history: [] - connectors: - - id: 'web-search' - prompt_truncation: 'AUTO' - Chat with connector: - value: - message: 'How do I expense a meal?' - stream: false - connectors: - - id: 'custom-connector-id' - prompt_truncation: 'AUTO' - required: - - message - properties: - message: - type: string - x-fern-audiences: ['public'] - description: | - Text input for the model to respond to. - Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments - model: - type: string - x-fern-audiences: ['public'] - description: | - Defaults to `command-r-plus`. - - The name of a compatible [Cohere model](/docs/models) or the ID of a [fine-tuned](/docs/chat-fine-tuning) model. - Compatible Deployments: Cohere Platform, Private Deployments - stream: - description: | - Defaults to `false`. - - When `true`, the response will be a JSON stream of events. The final event will contain the complete response, and will have an `event_type` of `"stream-end"`. - - Streaming is beneficial for user interfaces that render the contents of the response piece by piece, as it gets generated. - Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments - type: boolean - x-fern-audiences: ['public'] - preamble: - description: | - When specified, the default Cohere preamble will be replaced with the provided one. Preambles are a part of the prompt used to adjust the model's overall behavior and conversation style, and use the `SYSTEM` role. - - The `SYSTEM` role is also used for the contents of the optional `chat_history=` parameter. When used with the `chat_history=` parameter it adds content throughout a conversation. Conversely, when used with the `preamble=` parameter it adds content at the start of the conversation only. - Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments - type: string - x-fern-audiences: ['public'] - chat_history: - type: array - x-fern-audiences: ['public'] - minItems: 0 - items: - $ref: './types/Message.yaml' - description: | - A list of previous messages between the user and the model, giving the model conversational context for responding to the user's `message`. - - Each item represents a single message in the chat history, excluding the current user turn. It has two properties: `role` and `message`. The `role` identifies the sender (`CHATBOT`, `SYSTEM`, or `USER`), while the `message` contains the text content. - - The chat_history parameter should not be used for `SYSTEM` messages in most cases. Instead, to add a `SYSTEM` role message at the beginning of a conversation, the `preamble` parameter should be used. - Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments - conversation_id: - type: string - x-fern-audiences: ['public'] - description: | - An alternative to `chat_history`. - - Providing a `conversation_id` creates or resumes a persisted conversation with the specified ID. The ID can be any non empty string. - Compatible Deployments: Cohere Platform - prompt_truncation: - type: string - x-fern-audiences: ['public'] - enum: ['OFF', 'AUTO', 'AUTO_PRESERVE_ORDER'] - description: | - Defaults to `AUTO` when `connectors` are specified and `OFF` in all other cases. - - Dictates how the prompt will be constructed. - - With `prompt_truncation` set to "AUTO", some elements from `chat_history` and `documents` will be dropped in an attempt to construct a prompt that fits within the model's context length limit. During this process the order of the documents and chat history will be changed and ranked by relevance. - - With `prompt_truncation` set to "AUTO_PRESERVE_ORDER", some elements from `chat_history` and `documents` will be dropped in an attempt to construct a prompt that fits within the model's context length limit. During this process the order of the documents and chat history will be preserved as they are inputted into the API. - - With `prompt_truncation` set to "OFF", no elements will be dropped. If the sum of the inputs exceeds the model's context length limit, a `TooManyTokens` error will be returned. - Compatible Deployments: Cohere Platform Only AUTO_PRESERVE_ORDER: Azure, AWS Sagemaker, Private Deployments - connectors: - type: array - x-fern-audiences: ['public'] - minItems: 0 - items: - $ref: './types/ChatConnector.yaml' - description: | - Accepts `{"id": "web-search"}`, and/or the `"id"` for a custom [connector](/docs/connectors), if you've [created](/docs/creating-and-deploying-a-connector) one. - - When specified, the model's reply will be enriched with information found by quering each of the connectors (RAG). - Compatible Deployments: Cohere Platform - search_queries_only: - type: boolean - x-fern-audiences: ['public'] - description: | - Defaults to `false`. - - When `true`, the response will only contain a list of generated search queries, but no search will take place, and no reply from the model to the user's `message` will be generated. - Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments - documents: - description: | - A list of relevant documents that the model can cite to generate a more accurate reply. Each document is a string-string dictionary. - - Example: - `[ - { "title": "Tall penguins", "text": "Emperor penguins are the tallest." }, - { "title": "Penguin habitats", "text": "Emperor penguins only live in Antarctica." }, - ]` - - Keys and values from each document will be serialized to a string and passed to the model. The resulting generation will include citations that reference some of these documents. - - Some suggested keys are "text", "author", and "date". For better generation quality, it is recommended to keep the total word count of the strings in the dictionary to under 300 words. - - An `id` field (string) can be optionally supplied to identify the document in the citations. This field will not be passed to the model. - - An `_excludes` field (array of strings) can be optionally supplied to omit some key-value pairs from being shown to the model. The omitted fields will still show up in the citation object. The "_excludes" field will not be passed to the model. - - See ['Document Mode'](/docs/retrieval-augmented-generation-rag#document-mode) in the guide for more information. - Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments - type: array - x-fern-audiences: ['public'] - items: - $ref: './types/ChatDocument.yaml' - citation_quality: - type: string - x-fern-audiences: ['public'] - description: | - Defaults to `"accurate"`. - - Dictates the approach taken to generating citations as part of the RAG flow by allowing the user to specify whether they want `"accurate"` results or `"fast"` results. - Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments - enum: ['fast', 'accurate'] - temperature: - type: number - x-fern-audiences: ['public'] - format: float - minimum: 0 - maximum: 1 - description: | - Defaults to `0.3`. - - A non-negative float that tunes the degree of randomness in generation. Lower temperatures mean less random generations, and higher temperatures mean more random generations. - - Randomness can be further maximized by increasing the value of the `p` parameter. - Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments - max_tokens: - type: integer - x-fern-audiences: ['public'] - description: | - The maximum number of tokens the model will generate as part of the response. Note: Setting a low value may result in incomplete generations. - Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments - writeOnly: true - max_input_tokens: - type: integer - x-fern-audiences: ['public'] - description: | - The maximum number of input tokens to send to the model. If not specified, `max_input_tokens` is the model's context length limit minus a small buffer. - - Input will be truncated according to the `prompt_truncation` parameter. - Compatible Deployments: Cohere Platform - writeOnly: true - k: - type: integer - x-fern-audiences: ['public'] - description: | - Ensures only the top `k` most likely tokens are considered for generation at each step. - Defaults to `0`, min value of `0`, max value of `500`. - Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments - writeOnly: true - default: 0 - minimum: 0 - maximum: 500 - p: - type: number - x-fern-audiences: ['public'] - 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`. - Defaults to `0.75`. min value of `0.01`, max value of `0.99`. - Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments - writeOnly: true - default: 0.75 - minimum: 0.01 - maximum: 0.99 - seed: - x-fern-audiences: ['public'] - minimum: 0 - maximum: 18446744073709551615 - type: integer - description: | - If specified, the backend will make a best effort to sample tokens - deterministically, such that repeated requests with the same - seed and parameters should return the same result. However, - determinism cannot be totally guaranteed. - Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments - stop_sequences: - x-fern-audiences: ['public'] - writeOnly: true - 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. - Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments - connectors_search_options: - x-internal: true - type: object - description: (internal) Sets inference and model options for RAG search query - and tool use generations. Defaults are used when options are not - specified here, meaning that other parameters outside of - connectors_search_options are ignored (such as model= or - temperature=). - properties: - model: - description: The model to use for search query or tool use generations. See - model= description for more details. - temperature: - description: The temperature to use for search query or tool use generations. - See temperature= for more details. - max_tokens: - description: The maximum number of tokens to generate for search query (default - 50) or tool use (default null) generations. - preamble: - description: Overrides the default preamble for search query generation. Has no - effect on tool use generations. - seed: - x-internal: true - x-fern-audiences: ['public'] - minimum: 0 - maximum: 18446744073709551615 - type: integer - description: | - If specified, the backend will make a best effort to sample tokens - deterministically, such that repeated requests with the same - seed and parameters should return the same result. However, - determinism cannot be totally guaranteed. - Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments - frequency_penalty: - type: number - x-fern-audiences: ['public'] - description: | - Defaults to `0.0`, min value of `0.0`, max value of `1.0`. - - Used 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. - Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments - writeOnly: true - presence_penalty: - type: number - x-fern-audiences: ['public'] - description: | - Defaults to `0.0`, min value of `0.0`, max value of `1.0`. - - Used 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. - Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments - writeOnly: true - raw_prompting: - x-internal: true - x-fern-audiences: ['public'] - type: boolean - description: | - When enabled, the user's prompt will be sent to the model without - any pre-processing. - Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments - return_prompt: - # Undocumented but present in the SDK: - x-internal: true - x-fern-audiences: [ 'public' ] - type: boolean - description: The prompt is returned in the `prompt` response field when this is enabled. - tools: - x-fern-audiences: ['public'] - description: | - A list of available tools (functions) that the model may suggest invoking before producing a text response. - - When `tools` is passed (without `tool_results`), the `text` field in the response will be `""` 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. - Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments - type: array - items: - $ref: './types/Tool.yaml' - minItems: 0 - tool_results: - x-fern-audiences: ['public'] - description: | - A list of results from invoking tools recommended by the model in the previous chat turn. Results are used to produce a text response and will be referenced in citations. When using `tool_results`, `tools` must be passed as well. - Each tool_result contains information about how it was invoked, as well as a list of outputs in the form of dictionaries. - - **Note**: `outputs` must be a list of objects. If your tool returns a single object (eg `{"status": 200}`), make sure to wrap it in a list. - ``` - tool_results = [ - { - "call": { - "name": , - "parameters": { - : - } - }, - "outputs": [{ - : - }] - }, - ... - ] - ``` - **Note**: Chat calls with `tool_results` should not be included in the Chat history to avoid duplication of the message text. - Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments - type: array - minItems: 0 - items: - $ref: './types/ToolResult.yaml' - force_single_step: - x-fern-audiences: ['public'] - type: boolean - description: "Forces the chat to be single step. Defaults to `false`." - # response_format: - # # Undocumented but present in the SDK: - # x-internal: true - # x-fern-audiences: ['public'] - # type: object - # description: (not public yet) Guidance parameters for the generation, forcing the model to output json. - # properties: - # type: - # type: string - # enum: ['json_object'] # will have more options in the future - # description: When set to JSON, the output will be parse-able valid JSON (or run out of context). - # schema: - # # We can make `properties` and `type` required here, but not sure if useful. - # description: | - # A JSON schema object that the output will adhere to. Refer to https://json-schema.org/ for reference about schemas. - # Example (required name and age object): - # `{"type": "object", "properties": {"name": {"type": "string"}, "age": {"type": "integer"}}, "required": ["name", "age"]}` - # type: object - - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: 'OK' - content: - application/json: - schema: - oneOf: - - $ref: './types/NonStreamedChatResponse.yaml' - - $ref: './types/StreamedChatResponse.yaml' diff --git a/fern/openapi/check-api-key.yaml b/fern/openapi/check-api-key.yaml deleted file mode 100644 index 2498cba6..00000000 --- a/fern/openapi/check-api-key.yaml +++ /dev/null @@ -1,48 +0,0 @@ -post: - parameters: - - $ref: './types/RequestSource.yaml' - x-fern-audiences: [public] - summary: Check API key - operationId: checkAPIKey - description: | - Checks that the api key in the Authorization header is valid and active - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: 'OK' - content: - application/json: - schema: - type: object - required: - - valid - properties: - valid: - type: boolean - organization_id: - type: string - owner_id: - type: string \ No newline at end of file diff --git a/fern/openapi/classify.yaml b/fern/openapi/classify.yaml deleted file mode 100644 index 01ccb354..00000000 --- a/fern/openapi/classify.yaml +++ /dev/null @@ -1,371 +0,0 @@ -post: - parameters: - - $ref: './types/RequestSource.yaml' - x-fern-audiences: [public] - summary: Classify - operationId: classify - x-readme: - samples-languages: - - python - - java - - curl - - node - - go - code-samples: - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: './snippets/go/classify-post/main.go' - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/classify-post.ts - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/classify-post.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/classify-post.py - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java:1.0.4' - code: - $ref: ./snippets/java/app/src/main/java/ClassifyPost.java - - language: curl - name: cURL - code: - $ref: ./snippets/curl/classify-post.sh - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: OK - content: - application/json: - schema: - type: object - x-fern-audiences: ['public'] - x-examples: - Example: - id: ca245541-8841-456e-b306-293370789a30 - classifications: - - id: c50ab0d9-95d8-44de-ba90-9647a1718744 - input: Confirm your email address - prediction: Not spam - predictions: - - Not spam - confidence: 0.7581943 - confidences: - - 0.7581943 - labels: - Not spam: - confidence: 0.7581943 - Spam: - confidence: 0.24180566 - classification_type: single-label - - id: 8a841de2-027f-49d4-8c91-e88fa1865b89 - input: hey i need u to send some $ - prediction: Spam - predictions: - - Spam - confidence: 0.9965721 - confidences: - - 0.9965721 - labels: - Not spam: - confidence: 0.0034279241 - Spam: - confidence: 0.9965721 - classification_type: single-label - properties: - id: - type: string - x-fern-audiences: ['public'] - readOnly: true - classifications: - type: array - x-fern-audiences: ['public'] - items: - type: object - x-fern-audiences: ['public'] - properties: - id: - type: string - x-fern-audiences: ['public'] - readOnly: true - input: - type: string - x-fern-audiences: ['public'] - description: The input text that was classified - readOnly: true - prediction: - type: string - x-fern-audiences: ['public'] - description: The predicted label for the associated query (only filled for - single-label models) - readOnly: true - deprecated: true # prediction will be removed soon to remove redundancy, use predictions instead which works both for single and multi-label models - predictions: - type: array - x-fern-audiences: ['public'] - items: - type: string - x-fern-audiences: ['public'] - description: An array containing the predicted labels for the associated query - (only filled for single-label classification) - readOnly: true - confidence: - type: number - x-fern-audiences: ['public'] - format: float - description: The confidence score for the top predicted class (only filled for - single-label classification) - readOnly: true - deprecated: true # confidence will be removed soon to remove redundancy, use confidences instead which works both for single and multi-label models - confidences: - type: array - x-fern-audiences: ['public'] - items: - type: number - x-fern-audiences: ['public'] - format: float - description: - An array containing the confidence scores of all the predictions in - the same order - readOnly: true - labels: - type: object - x-fern-audiences: ['public'] - additionalProperties: - type: object - x-fern-audiences: ['public'] - properties: - confidence: - type: number - x-fern-audiences: ['public'] - format: float - readOnly: true - readOnly: true - description: A map containing each label and its confidence score according to - the classifier. All the confidence scores add up to 1 - for single-label classification. For multi-label - classification the label confidences are independent of - each other, so they don't have to sum up to 1. - readOnly: true - classification_type: - type: string - x-fern-audiences: ['public'] - enum: - - single-label - - multi-label - description: The type of classification performed - readOnly: true - required: - - id - - predictions - - confidences - - labels - - classification_type - readOnly: true - readOnly: true - meta: - $ref: './types/ApiMeta.yaml' - x-fern-audiences: ['public'] - required: - - id - - classifications - examples: - Example: - value: - id: ca245541-8841-456e-b306-293370789a30 - classifications: - - id: c50ab0d9-95d8-44de-ba90-9647a1718744 - input: Confirm your email address - prediction: Not spam - predictions: - - Not spam - confidence: 0.7581943 - confidences: - - 0.7581943 - labels: - Not spam: - confidence: 0.7581943 - Spam: - confidence: 0.24180566 - classification_type: single-label - - id: 8a841de2-027f-49d4-8c91-e88fa1865b89 - input: hey i need u to send some $ - prediction: Spam - predictions: - - Spam - confidence: 0.9965721 - confidences: - - 0.9965721 - labels: - Not spam: - confidence: 0.0034279241 - Spam: - confidence: 0.9965721 - classification_type: single-label - meta: - api_version: - version: '1' - headers: - X-API-Warning: - schema: - type: string - x-fern-audiences: ['public'] - description: Warning description for incorrect usage of the API - description: |- - This endpoint makes a prediction about which label fits the specified text inputs best. To make a prediction, Classify uses the provided `examples` of text + label pairs as a reference. - Note: [Fine-tuned models](/docs/classify-fine-tuning) trained on classification examples don't require the `examples` parameter to be passed in explicitly. - requestBody: - content: - application/json: - schema: - type: object - x-fern-audiences: ['public'] - x-examples: - Example: - inputs: - - Confirm your email address - - hey i need u to send some $ - examples: - - text: Dermatologists don't like her! - label: Spam - - text: 'Hello, open to this?' - label: Spam - - text: I need help please wire me $1000 right now - label: Spam - - text: Nice to know you ;) - label: Spam - - text: Please help me? - label: Spam - - text: Your parcel will be delivered today - label: Not spam - - text: Review changes to our Terms and Conditions - label: Not spam - - text: Weekly sync notes - label: Not spam - - text: 'Re: Follow up from today’s meeting' - label: Not spam - - text: Pre-read for tomorrow - label: Not spam - properties: - inputs: - type: array - x-fern-audiences: ['public'] - maxItems: 96 - description: 'A list of up to 96 texts to be classified. Each one must be a non-empty string. - - There is, however, no consistent, universal limit to the length a particular input can be. We perform classification on the first `x` tokens of each input, and `x` varies depending on which underlying model is powering classification. The maximum token length for each model is listed in the "max tokens" column [here](/docs/models). - - Note: by default the `truncate` parameter is set to `END`, so tokens exceeding the limit will be automatically dropped. This behavior can be disabled by setting `truncate` to `NONE`, which will result in validation errors for longer texts.' - items: - type: string - x-fern-audiences: ['public'] - writeOnly: true - writeOnly: true - examples: - type: array - x-fern-audiences: ['public'] - description: |- - An array of examples to provide context to the model. Each example is a text string and its associated label/class. Each unique label requires at least 2 examples associated with it; the maximum number of examples is 2500, and each example has a maximum length of 512 tokens. The values should be structured as `{text: "...",label: "..."}`. - Note: [Fine-tuned Models](/docs/classify-fine-tuning) trained on classification examples don't require the `examples` parameter to be passed in explicitly. - maxItems: 2500 - items: - x-fern-audiences: ['public'] - $ref: './types/ClassifyExample.yaml' - writeOnly: true - model: - type: string - x-fern-audiences: ['public'] - description: 'The identifier of the model. Currently available models are - `embed-multilingual-v2.0`, `embed-english-light-v2.0`, and - `embed-english-v2.0` (default). Smaller "light" models are - faster, while larger models will perform better. [Fine-tuned - models](/docs/fine-tuning) can also be - supplied with their full ID.' - writeOnly: true - preset: - type: string - x-fern-audiences: ['public'] - example: my-preset-a58sbd - description: "The ID of a custom playground preset. You can create presets in - the - [playground](https://dashboard.cohere.com/playground/classify?mo\ - del=large). If you use a preset, all other parameters become - optional, and any included parameters will override the preset's - parameters." - writeOnly: true - truncate: - type: string - x-fern-audiences: ['public'] - default: END - enum: - - NONE - - START - - END - description: |- - One of `NONE|START|END` to specify how the API will handle inputs longer than the maximum token length. - Passing `START` will discard the start of the input. `END` will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. - If `NONE` is selected, when the input exceeds the maximum input token length an error will be returned. - writeOnly: true - required: - - inputs - examples: - Example: - value: - inputs: - - Confirm your email address - - hey i need u to send some $ - examples: - - text: Dermatologists don't like her! - label: Spam - - text: 'Hello, open to this?' - label: Spam - - text: I need help please wire me $1000 right now - label: Spam - - text: Nice to know you ;) - label: Spam - - text: Please help me? - label: Spam - - text: Your parcel will be delivered today - label: Not spam - - text: Review changes to our Terms and Conditions - label: Not spam - - text: Weekly sync notes - label: Not spam - - text: 'Re: Follow up from today’s meeting' - label: Not spam - - text: Pre-read for tomorrow - label: Not spam - description: '' diff --git a/fern/openapi/cluster-jobs-job-id.yaml b/fern/openapi/cluster-jobs-job-id.yaml deleted file mode 100644 index aa101f82..00000000 --- a/fern/openapi/cluster-jobs-job-id.yaml +++ /dev/null @@ -1,102 +0,0 @@ -patch: - summary: Update a Cluster job - operationId: update-cluster-job - parameters: - - name: job-id - in: path - required: true - schema: - type: string - x-fern-audiences: ['public'] - - $ref: './types/RequestSource.yaml' - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: OK - content: - application/json: - schema: - $ref: './types/UpdateClusterJobResponse.yaml' - headers: - X-API-Warning: - schema: - type: string - x-fern-audiences: ['public'] - description: Warning description for incorrect usage of the API - description: This endpoint updates a cluster job. - requestBody: - content: - application/json: - schema: - $ref: './types/UpdateClusterJobRequest.yaml' -get: - summary: Get a Cluster job - operationId: get-cluster-job - parameters: - - name: job-id - in: path - required: true - schema: - type: string - x-fern-audiences: ['public'] - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: OK - content: - application/json: - schema: - $ref: './types/GetClusterJobResponse.yaml' - headers: - X-API-Warning: - schema: - type: string - x-fern-audiences: ['public'] - description: Warning description for incorrect usage of the API - description: This endpoint returns a cluster job. diff --git a/fern/openapi/cluster-jobs.yaml b/fern/openapi/cluster-jobs.yaml deleted file mode 100644 index a889eedc..00000000 --- a/fern/openapi/cluster-jobs.yaml +++ /dev/null @@ -1,91 +0,0 @@ -post: - parameters: - - $ref: './types/RequestSource.yaml' - summary: Create a Cluster Job - operationId: create-cluster-job - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: OK - content: - application/json: - schema: - $ref: './types/CreateClusterJobResponse.yaml' - headers: - X-API-Warning: - schema: - type: string - x-fern-audiences: ['public'] - description: Warning description for incorrect usage of the API - description: This endpoint creates a new cluster job. - requestBody: - content: - application/json: - schema: - $ref: './types/CreateClusterJobRequest.yaml' -get: - parameters: - - $ref: './types/RequestSource.yaml' - summary: List Cluster Jobs - operationId: list-cluster-jobs - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: OK - content: - application/json: - schema: - $ref: './types/ListClusterJobsResponse.yaml' - headers: - X-API-Warning: - schema: - type: string - x-fern-audiences: ['public'] - description: Warning description for incorrect usage of the API - description: This endpoint returns a list of cluster jobs. diff --git a/fern/openapi/cohere.yaml b/fern/openapi/cohere.yaml deleted file mode 100644 index fcfee785..00000000 --- a/fern/openapi/cohere.yaml +++ /dev/null @@ -1,102 +0,0 @@ -openapi: 3.1.0 -info: - title: API Reference - version: '1.0' - description: |- - The Cohere Platform is centered around models. - - Each model has a different amount of power (i.e. parameters), to be used for different tasks. - - Cohere also supports finetuning of baseline models to improve performance on downstream tasks or to teach the model large quantities of information which cannot be extracted with few-shot learning or prompt engineering. - summary: Cohere's API - contact: - name: Cohere Developers - url: 'https://cohere.com/' - email: team@cohere.com - termsOfService: 'https://cohere.com/terms-of-use' - license: - name: proprietary - url: 'https://cohere.com/terms-of-use' -servers: - - url: 'https://api.cohere.com/v1' - description: production -paths: - /chat: - $ref: ./chat.yaml - /generate: - $ref: ./generate.yaml - /embed: - $ref: ./embed.yaml - /embed-jobs: - $ref: ./embed-jobs.yaml - /embed-jobs/{id}: - $ref: ./embed-jobs-id.yaml - /embed-jobs/{id}/cancel: - $ref: ./embed-jobs-cancel.yaml - /rerank: - $ref: ./rerank.yaml - /classify: - $ref: ./classify.yaml - /datasets: - $ref: ./dataset.yaml - /datasets/usage: - $ref: ./dataset-usage.yaml - /datasets/{id}: - $ref: ./dataset-id.yaml - /summarize: - $ref: ./summarize.yaml - /tokenize: - $ref: ./tokenize.yaml - /detokenize: - $ref: ./detokenize.yaml - /connectors: - $ref: ./connectors.yaml - /connectors/{id}: - $ref: ./connectors-id.yaml - /connectors/{id}/oauth/authorize: - $ref: ./connectors-id-oauth-authorize.yaml - /connector_logs: - x-internal: true - $ref: ./connector-logs.yaml - /loglikelihood: - x-internal: true - $ref: ./loglikelihood.yaml - /cluster-jobs: - x-internal: true - $ref: ./cluster-jobs.yaml - /cluster-jobs/{job-id}: - x-internal: true - $ref: ./cluster-jobs-job-id.yaml - /models/{model}: - $ref: ./models-get.yaml - /models: - $ref: ./models-list.yaml - /check-api-key: - $ref: ./check-api-key.yaml - /finetuning/finetuned-models: - $ref: ./finetuning-finetuned-models.yaml - /finetuning/finetuned-models/{id}: - $ref: ./finetuning-finetuned-models-id.yaml - /finetuning/finetuned-models/{finetuned_model_id}/events: - $ref: ./finetuning-finetuned-models-events.yaml - /finetuning/finetuned-models/{finetuned_model_id}/training-step-metrics: - $ref: ./finetuning-finetuned-models-training-step-metrics.yaml -components: - securitySchemes: - bearerAuth: - type: http - x-fern-audiences: ['public'] - scheme: bearer - x-fern-bearer: - env: CO_API_KEY -security: - - bearerAuth: [] -tags: - - name: /datasets - description: 'Datasets API' - - name: /connectors - description: 'Connectors API' - - name: /embed-jobs - description: 'Embed Jobs API' - - name: /finetuning - description: 'Finetuning API (Beta)' diff --git a/fern/openapi/connector-logs.yaml b/fern/openapi/connector-logs.yaml deleted file mode 100644 index 2e5f8d52..00000000 --- a/fern/openapi/connector-logs.yaml +++ /dev/null @@ -1,85 +0,0 @@ -get: - summary: Get Connector Logs - tags: [/connectors] - operationId: get-logs - x-fern-sdk-method-name: get-logs - x-fern-sdk-group-name: connectors - parameters: - - name: limit - in: query - description: Maximum number of connectors to return [0, 100]. - schema: - default: 30 - type: number - - name: offset - in: query - description: Number of connectors to skip before returning results [0, inf]. - schema: - default: 0 - type: number - - name: organizationId - in: query - description: Organization ID to filter by. - schema: - type: string - - name: connectorIds - in: query - description: Connector IDs to filter by. - schema: - type: array - items: - type: string - - name: startTimestamp - in: query - description: Start timestamp to filter by. - schema: - type: string - format: date-time - - name: endTimestamp - in: query - description: End timestamp to filter by. - schema: - type: string - format: date-time - - name: statusCodeFilter.lowerLimit - in: query - description: Lower limit of status code to filter by. - schema: - type: number - - name: statusCodeFilter.upperLimit - in: query - description: Upper limit of status code to filter by. - schema: - type: number - - $ref: './types/RequestSource.yaml' - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: OK - content: - application/json: - schema: - $ref: './types/GetConnectorsLogsResponse.yaml' diff --git a/fern/openapi/connectors-id-oauth-authorize.yaml b/fern/openapi/connectors-id-oauth-authorize.yaml deleted file mode 100644 index 387c3d26..00000000 --- a/fern/openapi/connectors-id-oauth-authorize.yaml +++ /dev/null @@ -1,96 +0,0 @@ -post: - x-fern-audiences: [public] - summary: Authorize with oAuth - tags: [/connectors] - description: Authorize the connector with the given ID for the connector oauth - app. See ['Connector - Authentication'](/docs/connector-authentication) for - more information. - operationId: oAuthAuthorize-connector - x-fern-sdk-method-name: oAuthAuthorize - x-fern-sdk-group-name: connectors - parameters: - - name: id - in: path - required: true - description: The ID of the connector to authorize. - schema: - type: string - x-fern-audiences: ['public'] - - name: after_token_redirect - in: query - description: The URL to redirect to after the connector has been authorized. - schema: - type: string - x-fern-audiences: ['public'] - - $ref: './types/RequestSource.yaml' - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: OK - content: - application/json: - schema: - $ref: './types/OAuthAuthorizeResponse.yaml' - x-readme: - samples-languages: - - python - - java - - python - - java - - node - - curl - - go - code-samples: - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: './snippets/go/connectors-id-oauth-authorize-post/main.go' - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/connectors-id-oauth-authorize-post.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/connectors-id-oauth-authorize-post.py - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java:1.0.4' - code: - $ref: ./snippets/java/app/src/main/java/ConnectorsIdOauthAuthorizePost.java - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/connectors-id-oauth-authorize-post.ts - - language: curl - name: cURL - code: - $ref: ./snippets/curl/connectors-id-oauth-authorize-post.sh diff --git a/fern/openapi/connectors-id.yaml b/fern/openapi/connectors-id.yaml deleted file mode 100644 index 90e15195..00000000 --- a/fern/openapi/connectors-id.yaml +++ /dev/null @@ -1,268 +0,0 @@ -get: - x-fern-audiences: [public] - summary: Get a Connector - tags: [/connectors] - description: Retrieve a connector by ID. See - ['Connectors'](/docs/connectors) for more - information. - operationId: get-connector - x-fern-sdk-method-name: get - x-fern-sdk-group-name: connectors - parameters: - - name: id - in: path - required: true - description: The ID of the connector to retrieve. - schema: - type: string - x-fern-audiences: ['public'] - - $ref: './types/RequestSource.yaml' - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: OK - content: - application/json: - schema: - $ref: './types/GetConnectorResponse.yaml' - x-readme: - samples-languages: - - python - - java - - node - - curl - - go - code-samples: - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: './snippets/go/connector-get/main.go' - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/connector-get.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/connector-get.py - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java:1.0.4' - code: - $ref: ./snippets/java/app/src/main/java/ConnectorGet.java - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/connector-get.ts - - language: curl - name: cURL - code: - $ref: ./snippets/curl/connector-get.sh -patch: - x-fern-audiences: [public] - summary: Update a Connector - tags: [/connectors] - operationId: update-connector - x-fern-sdk-method-name: update - x-fern-sdk-group-name: connectors - description: Update a connector by ID. Omitted fields will not be updated. See - ['Managing your - Connector'](/docs/managing-your-connector) for more - information. - parameters: - - name: id - in: path - required: true - description: The ID of the connector to update. - schema: - type: string - x-fern-audiences: ['public'] - - $ref: './types/RequestSource.yaml' - requestBody: - content: - application/json: - schema: - $ref: './types/UpdateConnectorRequest.yaml' - required: true - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: OK - content: - application/json: - schema: - $ref: './types/UpdateConnectorResponse.yaml' - x-readme: - samples-languages: - - python - - java - - node - - curl - - go - code-samples: - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: './snippets/go/connector-patch/main.go' - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/connector-patch.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/connector-patch.py - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java:1.0.4' - code: - $ref: ./snippets/java/app/src/main/java/ConnectorPatch.java - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/connector-patch.ts - - language: curl - name: Curl - code: - $ref: ./snippets/curl/connector-patch.sh -delete: - x-fern-audiences: [public] - summary: Delete a Connector - tags: [/connectors] - description: Delete a connector by ID. See - ['Connectors'](/docs/connectors) for more - information. - operationId: delete-connector - x-fern-sdk-method-name: delete - x-fern-sdk-group-name: connectors - parameters: - - name: id - description: The ID of the connector to delete. - in: path - required: true - schema: - type: string - x-fern-audiences: ['public'] - - $ref: './types/RequestSource.yaml' - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: OK - content: - application/json: - schema: - $ref: './types/DeleteConnectorResponse.yaml' - x-readme: - samples-languages: - - python - - java - - node - - curl - - go - code-samples: - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: './snippets/go/connector-delete/main.go' - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/connector-delete.ts - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/connector-delete.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/connector-delete.py - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java:1.0.4' - code: - $ref: ./snippets/java/app/src/main/java/ConnectorDelete.java - - language: curl - name: cURL - code: - $ref: ./snippets/curl/connector-delete.sh diff --git a/fern/openapi/connectors.yaml b/fern/openapi/connectors.yaml deleted file mode 100644 index 36dd0342..00000000 --- a/fern/openapi/connectors.yaml +++ /dev/null @@ -1,184 +0,0 @@ -get: - x-fern-audiences: [public] - summary: List Connectors - tags: [/connectors] - operationId: list-connectors - x-fern-sdk-method-name: list - x-fern-sdk-group-name: connectors - description: Returns a list of connectors ordered by descending creation date - (newer first). See ['Managing your - Connector'](/docs/managing-your-connector) for more - information. - parameters: - - name: limit - in: query - description: Maximum number of connectors to return [0, 100]. - schema: - default: 30 - type: number - x-fern-audiences: ['public'] - - name: offset - in: query - description: Number of connectors to skip before returning results [0, inf]. - schema: - default: 0 - type: number - x-fern-audiences: ['public'] - - $ref: './types/RequestSource.yaml' - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: OK - content: - application/json: - schema: - $ref: './types/ListConnectorsResponse.yaml' - x-readme: - samples-languages: - - python - - java - - python - - java - - node - - curl - - go - code-samples: - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: './snippets/go/connectors-list/main.go' - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/connectors-list.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/connectors-list.py - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java:1.0.4' - code: - $ref: ./snippets/java/app/src/main/java/ConnectorsList.java - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/connectors-list.ts - - language: curl - name: cURL - code: - $ref: ./snippets/curl/connectors-list.sh -post: - x-fern-audiences: [public] - summary: Create a Connector - tags: [/connectors] - operationId: create-connector - x-fern-sdk-method-name: create - x-fern-sdk-group-name: connectors - description: |- - Creates a new connector. The connector is tested during registration and will cancel registration when the test is unsuccessful. See ['Creating and Deploying a Connector'](/docs/creating-and-deploying-a-connector) for more information. - parameters: - - $ref: './types/RequestSource.yaml' - requestBody: - content: - application/json: - schema: - $ref: './types/CreateConnectorRequest.yaml' - required: true - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: OK - content: - application/json: - schema: - $ref: './types/CreateConnectorResponse.yaml' - x-readme: - samples-languages: - - python - - java - - python - - java - - node - - curl - - go - code-samples: - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: './snippets/go/connector-create/main.go' - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/connector-create.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/connector-create.py - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java:1.0.4' - code: - $ref: ./snippets/java/app/src/main/java/ConnectorCreate.java - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/connector-create.ts - - language: curl - name: Curl - code: - $ref: ./snippets/curl/connector-create.sh diff --git a/fern/openapi/dataset-id.yaml b/fern/openapi/dataset-id.yaml deleted file mode 100644 index 63092947..00000000 --- a/fern/openapi/dataset-id.yaml +++ /dev/null @@ -1,178 +0,0 @@ -get: - x-fern-audiences: [public] - summary: Get a Dataset - operationId: get-dataset - description: Retrieve a dataset by ID. See - ['Datasets'](/docs/datasets) for more information. - tags: [/datasets] - x-fern-sdk-group-name: datasets - x-fern-sdk-method-name: get - parameters: - - name: id - in: path - required: true - schema: - type: string - x-fern-audiences: ['public'] - pattern: ^(?!usage$).*$ - - $ref: './types/RequestSource.yaml' - x-readme: - samples-languages: - - python - - java - - python - - java - - node - - curl - - go - code-samples: - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: './snippets/go/dataset-get/main.go' - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/dataset-get.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/dataset-get.py - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java:1.0.4' - code: - $ref: ./snippets/java/app/src/main/java/DatasetGet.java - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/dataset-get.ts - - language: curl - name: cURL - code: - $ref: ./snippets/curl/dataset-get.sh - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: A successful response. - content: - application/json: - schema: - type: object - x-fern-audiences: ['public'] - required: - - dataset - properties: - dataset: - $ref: './types/Dataset.yaml' -delete: - x-fern-audiences: [public] - summary: Delete a Dataset - operationId: delete-dataset - description: Delete a dataset by ID. Datasets are automatically deleted after 30 - days, but they can also be deleted manually. - tags: [/datasets] - x-fern-sdk-group-name: datasets - x-fern-sdk-method-name: delete - parameters: - - name: id - in: path - required: true - schema: - type: string - x-fern-audiences: ['public'] - pattern: ^(?!usage$).*$ - - $ref: './types/RequestSource.yaml' - x-readme: - samples-languages: - - python - - java - - python - - java - - node - - curl - - go - code-samples: - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: './snippets/go/dataset-delete/main.go' - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/dataset-delete.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/dataset-delete.py - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java:1.0.4' - code: - $ref: ./snippets/java/app/src/main/java/DatasetDelete.java - - language: curl - name: cURL - code: - $ref: ./snippets/curl/dataset-delete.sh - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: A successful response. - content: - application/json: - schema: - type: object - x-fern-audiences: ['public'] diff --git a/fern/openapi/dataset-usage.yaml b/fern/openapi/dataset-usage.yaml deleted file mode 100644 index 98802860..00000000 --- a/fern/openapi/dataset-usage.yaml +++ /dev/null @@ -1,88 +0,0 @@ -get: - x-fern-audiences: [public] - summary: Get Dataset Usage - operationId: get-dataset-usage - description: View the dataset storage usage for your Organization. Each - Organization can have up to 10GB of storage across all their users. - tags: [/datasets] - parameters: - - $ref: "./types/RequestSource.yaml" - x-fern-sdk-group-name: datasets - x-fern-sdk-method-name: getUsage - x-readme: - samples-languages: - - python - - java - - python - - java - - node - - curl - - go - code-samples: - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: "./snippets/go/dataset-usage-get/main.go" - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/dataset-usage-get.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/dataset-usage-get.py - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java:1.0.4' - code: - $ref: ./snippets/java/app/src/main/java/DatasetUsageGet.java - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/dataset-usage-get.ts - - language: curl - name: cURL - code: - $ref: ./snippets/curl/dataset-usage-get.sh - responses: - "400": - $ref: "./errors/BadRequest.yaml" - "401": - $ref: "./errors/Unauthorized.yaml" - "403": - $ref: "./errors/Forbidden.yaml" - "404": - $ref: "./errors/NotFound.yaml" - "422": - $ref: "./errors/UnprocessableEntity.yaml" - "429": - $ref: "./errors/RateLimit.yaml" - "498": - $ref: "./errors/InvalidToken.yaml" - "499": - $ref: "./errors/RequestCancelled.yaml" - "500": - $ref: "./errors/InternalServerError.yaml" - "501": - $ref: "./errors/NotImplemented.yaml" - "503": - $ref: "./errors/ServiceUnavailable.yaml" - "504": - $ref: "./errors/GatewayTimeout.yaml" - "200": - description: A successful response. - content: - application/json: - schema: - type: object - x-fern-audiences: ["public"] - properties: - organization_usage: - type: number - x-fern-audiences: ["public"] - format: long - description: The total number of bytes used by the organization. diff --git a/fern/openapi/dataset.yaml b/fern/openapi/dataset.yaml deleted file mode 100644 index 3eb480ab..00000000 --- a/fern/openapi/dataset.yaml +++ /dev/null @@ -1,352 +0,0 @@ -post: - x-fern-audiences: [public] - summary: Create a Dataset - operationId: create-dataset - description: Create a dataset by uploading a file. See ['Dataset - Creation'](/docs/datasets#dataset-creation) for more - information. - tags: [/datasets] - x-fern-sdk-group-name: datasets - x-fern-sdk-method-name: create - requestBody: - content: - multipart/form-data: - schema: - type: object - x-fern-audiences: ['public'] - properties: - data: - type: string - x-fern-audiences: ['public'] - format: binary - description: The file to upload - eval_data: - type: string - x-fern-audiences: ['public'] - format: binary - description: An optional evaluation file to upload - required: - - data - parameters: - - in: query - name: name - required: true - schema: - type: string - x-fern-audiences: ['public'] - description: The name of the uploaded dataset. - - in: query - name: type - required: true - schema: - $ref: './types/DatasetType.yaml' - description: The dataset type, which is used to validate the data. Valid types - are `embed-input`, `reranker-finetune-input`, - `single-label-classification-finetune-input`, `chat-finetune-input`, and - `multi-label-classification-finetune-input`. - - in: query - name: keep_original_file - schema: - type: boolean - x-fern-audiences: ['public'] - description: Indicates if the original file should be stored. - - in: query - name: skip_malformed_input - schema: - type: boolean - x-fern-audiences: ['public'] - description: Indicates whether rows with malformed input should be dropped - (instead of failing the validation check). Dropped rows will be returned - in the warnings field. - - in: query - name: keep_fields - schema: - type: array - items: - type: string - x-fern-audiences: ['public'] - description: List of names of fields that will be persisted in the Dataset. By - default the Dataset will retain only the required fields indicated in - the [schema for the corresponding Dataset - type](/docs/datasets#dataset-types). For example, - datasets of type `embed-input` will drop all fields other than the - required `text` field. If any of the fields in `keep_fields` are missing - from the uploaded file, Dataset validation will fail. - - in: query - name: optional_fields - schema: - type: array - items: - type: string - x-fern-audiences: ['public'] - description: List of names of fields that will be persisted in the Dataset. By - default the Dataset will retain only the required fields indicated in - the [schema for the corresponding Dataset - type](/docs/datasets#dataset-types). For example, - Datasets of type `embed-input` will drop all fields other than the - required `text` field. If any of the fields in `optional_fields` are - missing from the uploaded file, Dataset validation will pass. - - in: query - name: text_separator - schema: - type: string - x-fern-audiences: ['public'] - description: Raw .txt uploads will be split into entries using the - text_separator value. - - in: query - name: csv_delimiter - schema: - type: string - x-fern-audiences: ['public'] - description: The delimiter used for .csv uploads. - - in: query - x-internal: true - name: dry_run - schema: - type: boolean - description: flag to enable dry_run mode - - $ref: './types/RequestSource.yaml' - x-readme: - samples-languages: - - python - - java - - python - - java - - node - - curl - - go - code-samples: - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: './snippets/go/dataset-post/main.go' - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/dataset-post.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/dataset-post.py - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java:1.0.4' - code: - $ref: ./snippets/java/app/src/main/java/DatasetPost.java - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/dataset-post.ts - - language: curl - name: cURL - code: - $ref: ./snippets/curl/dataset-post.sh - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: A successful response. - content: - application/json: - schema: - type: object - x-fern-audiences: ['public'] - properties: - id: - type: string - x-fern-audiences: ['public'] - description: The dataset ID - # the following are private fields used by the dry_run flag - validation_status: - x-internal: true - $ref: './types/DatasetValidationStatus.yaml' - validation_errors: - x-internal: true - type: array - items: - type: string - description: Errors found during validation - validation_warnings: - x-internal: true - type: array - items: - type: string - description: Warnings found during validation - schema: - x-internal: true - type: string - description: the avro schema of the dataset - metrics: - x-internal: true - $ref: './types/Metrics.yaml' - dataset_parts: - x-internal: true - type: array - items: - type: object - properties: - name: - type: string - description: the name of the dataset part - num_rows: - type: number - description: the number of rows in the dataset part - samples: - type: array - items: - type: string - description: the first few rows of the dataset part - part_kind: - type: string - description: the kind of dataset part - description: the underlying files that make up the dataset -get: - x-fern-audiences: [public] - summary: List Datasets - operationId: list-datasets - description: List datasets that have been created. - tags: [/datasets] - x-fern-sdk-group-name: datasets - x-fern-sdk-method-name: list - parameters: - - name: datasetType - in: query - description: optional filter by dataset type - schema: - type: string - x-fern-audiences: ['public'] - - name: before - in: query - description: optional filter before a date - schema: - type: string - x-fern-audiences: ['public'] - format: date-time - - name: after - in: query - description: optional filter after a date - schema: - type: string - x-fern-audiences: ['public'] - format: date-time - - name: limit - in: query - description: optional limit to number of results - schema: - type: number - x-fern-audiences: ['public'] - - name: offset - in: query - description: optional offset to start of results - schema: - type: number - x-fern-audiences: ['public'] - - name: validationStatus - in: query - description: optional filter by validation status - schema: - $ref: './types/DatasetValidationStatus.yaml' - - $ref: './types/RequestSource.yaml' - x-readme: - samples-languages: - - python - - java - - python - - java - - node - - curl - - go - code-samples: - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: './snippets/go/dataset-get/main.go' - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/dataset-get.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/dataset-get.py - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java:1.0.4' - code: - $ref: ./snippets/java/app/src/main/java/DatasetGet.java - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/dataset-get.ts - - language: curl - name: cURL - code: - $ref: ./snippets/curl/dataset-get.sh - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: A successful response. - content: - application/json: - schema: - type: object - x-fern-audiences: ['public'] - properties: - datasets: - type: array - x-fern-audiences: ['public'] - items: - $ref: './types/Dataset.yaml' diff --git a/fern/openapi/detect-language.yaml b/fern/openapi/detect-language.yaml deleted file mode 100644 index 561bcb64..00000000 --- a/fern/openapi/detect-language.yaml +++ /dev/null @@ -1,116 +0,0 @@ -post: - x-fern-audiences: [public] - summary: Detect Language - operationId: detect-language - parameters: - - $ref: './types/RequestSource.yaml' - x-readme: - samples-languages: - - python - - curl - - node - code-samples: - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: |- - const { CohereClient } = require("cohere-ai"); - - const cohere = new CohereClient({ - token: "<>", - }); - - (async () => { - const detectLanguage = await cohere.detectLanguage({ - texts: ["Hello world", "Здравствуй, Мир"], - }); - - console.log(detectLanguage); - })(); - - language: python - name: Cohere Python SDK - install: python -m pip install cohere - code: |- - import cohere - co = cohere.Client('<>') - - response = co.detect_language( - texts=['Hello world', "'Здравствуй, Мир'"] - ) - print(response) - responses: - '200': - description: OK - headers: - X-API-Warning: - schema: - type: string - x-fern-audiences: [ "public" ] - description: Warning description for incorrect usage of the API - content: - application/json: - schema: - type: object - x-fern-audiences: [ "public" ] - properties: - results: - type: array - x-fern-audiences: [ "public" ] - description: 'List of languages, one per input text' - items: - type: object - x-fern-audiences: [ "public" ] - properties: - language_name: - type: string - x-fern-audiences: [ "public" ] - language_code: - type: string - x-fern-audiences: [ "public" ] - readOnly: true - meta: - $ref: './types/ApiMeta.yaml' - x-fern-audiences: [ "public" ] - examples: - Example: - description: "This is a sample response for the inputs ['hello world', 'Здравствуй, Мир']" - value: - results: - - language_name: English - language_code: en - - language_name: Russian - language_code: ru - meta: - api_version: - version: '1' - description: This endpoint identifies which language each of the provided texts is written in. - requestBody: - content: - application/json: - schema: - type: object - x-fern-audiences: [ "public" ] - properties: - texts: - type: array - x-fern-audiences: [ "public" ] - description: List of strings to run the detection on. - minItems: 1 - items: - type: string - x-fern-audiences: [ "public" ] - writeOnly: true - model: - type: string - x-fern-audiences: [ "public" ] - description: |- - The identifier of the model to generate with. - writeOnly: true - required: - - texts - examples: - Example: - value: - texts: - - Hello world - - 'Здравствуй, Мир' diff --git a/fern/openapi/detokenize.yaml b/fern/openapi/detokenize.yaml deleted file mode 100644 index 27a2efe9..00000000 --- a/fern/openapi/detokenize.yaml +++ /dev/null @@ -1,141 +0,0 @@ -post: - x-fern-audiences: [public] - summary: Detokenize - operationId: detokenize - parameters: - - $ref: './types/RequestSource.yaml' - x-readme: - samples-languages: - - python - - java - - curl - - node - - go - code-samples: - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: './snippets/go/detokenize-post/main.go' - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/detokenize-post.ts - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/detokenize-post.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/detokenize-post.py - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java:1.0.4' - code: - $ref: ./snippets/java/app/src/main/java/DetokenizePost.java - - language: curl - name: cURL - code: - $ref: ./snippets/curl/detokenize-post.sh - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: OK - headers: - X-API-Warning: - schema: - type: string - x-fern-audiences: ['public'] - description: Warning description for incorrect usage of the API - content: - application/json: - schema: - type: object - x-fern-audiences: ['public'] - properties: - text: - type: string - x-fern-audiences: ['public'] - description: A string representing the list of tokens. - readOnly: true - meta: - $ref: './types/ApiMeta.yaml' - x-fern-audiences: ['public'] - required: - - text - examples: - Example: - value: - text: 'detokenized! :D' - meta: - api_version: - version: '1' - description: 'This endpoint takes tokens using byte-pair encoding and returns - their text representation. To learn more about tokenization and byte pair - encoding, see the tokens page.' - requestBody: - content: - application/json: - schema: - type: object - x-fern-audiences: ['public'] - properties: - tokens: - type: array - x-fern-audiences: ['public'] - description: The list of tokens to be detokenized. - minItems: 1 - maxItems: 65536 - items: - type: integer - x-fern-audiences: ['public'] - writeOnly: true - model: - type: string - x-fern-audiences: ['public'] - description: An optional parameter to provide the model name. This will ensure - that the detokenization is done by the tokenizer used by that - model. - required: - - tokens - - model - examples: - Example: - value: - tokens: - - 10104 - - 12221 - - 1315 - - 34 - - 1420 - - 69 - model: 'command' - description: '' -parameters: [] diff --git a/fern/openapi/embed-jobs-cancel.yaml b/fern/openapi/embed-jobs-cancel.yaml deleted file mode 100644 index 4e3fae7a..00000000 --- a/fern/openapi/embed-jobs-cancel.yaml +++ /dev/null @@ -1,92 +0,0 @@ -post: - x-fern-audiences: [public] - parameters: - - name: id - in: path - required: true - description: The ID of the embed job to cancel. - schema: - type: string - x-fern-audiences: ['public'] - - $ref: './types/RequestSource.yaml' - summary: Cancel an Embed Job - operationId: cancel-embed-job - tags: [/embed-jobs] - x-fern-sdk-group-name: embed-jobs - x-fern-sdk-method-name: cancel - x-readme: - samples-languages: - - python - - java - - python - - java - - node - - curl - - go - code-samples: - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: './snippets/go/embed-jobs-cancel/main.go' - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/embed-jobs-cancel.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/embed-jobs-cancel.py - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java:1.0.4' - code: - $ref: ./snippets/java/app/src/main/java/EmbedJobsCancel.java - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/embed-jobs-cancel.ts - - language: curl - name: cURL - code: - $ref: ./snippets/curl/embed-jobs-cancel.sh - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: OK - headers: - X-API-Warning: - schema: - type: string - x-fern-audiences: ['public'] - description: Warning description for incorrect usage of the API - description: This API allows users to cancel an active embed job. Once invoked, - the embedding process will be terminated, and users will be charged for the - embeddings processed up to the cancellation point. It's important to note - that partial results will not be available to users after cancellation. diff --git a/fern/openapi/embed-jobs-fetch.yaml b/fern/openapi/embed-jobs-fetch.yaml deleted file mode 100644 index b8c3fbdb..00000000 --- a/fern/openapi/embed-jobs-fetch.yaml +++ /dev/null @@ -1,53 +0,0 @@ -get: - x-fern-audiences: [public] - parameters: - - name: id - in: path - required: true - description: The ID of the embed job to retrieve. - schema: - type: string - x-fern-audiences: [ 'public' ] - - $ref: './types/RequestSource.yaml' - summary: Fetch an Embed Job by ID - operationId: get-embed-job - tags: [/embed-jobs] - x-fern-sdk-group-name: embed-jobs - x-fern-sdk-method-name: get - x-readme: - samples-languages: - - python - - curl - code-samples: - - language: python - name: Cohere Python SDK - install: python -m pip install cohere - code: |- - import cohere - co = cohere.Client('<>') - - # get embed job - my_embed_job = co.get_embed_job('job_id') - - print(my_embed_job) - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: './types/EmbedJob.yaml' - headers: - X-API-Warning: - schema: - type: string - x-fern-audiences: [ "public" ] - description: Warning message for potentially incorrect usage of the API - '400': - description: Bad Request - '404': - description: Not Found - '500': - description: Internal Server Error - description: This API retrieves the details about an embed job started by the same user. - diff --git a/fern/openapi/embed-jobs-id.yaml b/fern/openapi/embed-jobs-id.yaml deleted file mode 100644 index ae548779..00000000 --- a/fern/openapi/embed-jobs-id.yaml +++ /dev/null @@ -1,93 +0,0 @@ -get: - x-fern-audiences: [public] - parameters: - - name: id - in: path - required: true - description: The ID of the embed job to retrieve. - schema: - type: string - x-fern-audiences: ['public'] - - $ref: './types/RequestSource.yaml' - summary: Fetch an Embed Job - operationId: get-embed-job - tags: [/embed-jobs] - x-fern-sdk-group-name: embed-jobs - x-fern-sdk-method-name: get - x-readme: - samples-languages: - - python - - java - - python - - java - - node - - curl - - go - code-samples: - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: './snippets/go/emebed-jobs-get/main.go' - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/emebed-jobs-get.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/emebed-jobs-get.py - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java:1.0.4' - code: - $ref: ./snippets/java/app/src/main/java/EmbedJobsGet.java - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/emebed-jobs-get.ts - - language: curl - name: cURL - code: - $ref: ./snippets/curl/emebed-jobs-get.sh - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: OK - content: - application/json: - schema: - $ref: './types/EmbedJob.yaml' - headers: - X-API-Warning: - schema: - type: string - x-fern-audiences: ['public'] - description: Warning message for potentially incorrect usage of the API - description: This API retrieves the details about an embed job started by the same user. diff --git a/fern/openapi/embed-jobs.yaml b/fern/openapi/embed-jobs.yaml deleted file mode 100644 index f456ec64..00000000 --- a/fern/openapi/embed-jobs.yaml +++ /dev/null @@ -1,182 +0,0 @@ -post: - x-fern-audiences: [public] - parameters: - - $ref: './types/RequestSource.yaml' - summary: Create an Embed Job - operationId: create-embed-job - tags: [/embed-jobs] - x-fern-sdk-group-name: embed-jobs - x-fern-sdk-method-name: create - x-readme: - samples-languages: - - python - - java - - python - - java - - node - - curl - - go - code-samples: - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: './snippets/go/embed-jobs-post/main.go' - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/embed-jobs-post.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/embed-jobs-post.py - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java:1.0.4' - code: - $ref: ./snippets/java/app/src/main/java/EmbedJobsPost.java - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/embed-jobs-post.ts - - language: curl - name: cURL - code: - $ref: ./snippets/curl/embed-jobs-post.sh - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: OK - content: - application/json: - schema: - $ref: './types/CreateEmbedJobResponse.yaml' - headers: - X-API-Warning: - schema: - type: string - x-fern-audiences: ['public'] - description: Warning description for incorrect usage of the API - description: This API launches an async Embed job for a - [Dataset](/docs/datasets) of type `embed-input`. The - result of a completed embed job is new Dataset of type `embed-output`, which - contains the original text entries and the corresponding embeddings. - requestBody: - content: - application/json: - schema: - $ref: './types/CreateEmbedJobRequest.yaml' - -get: - x-fern-audiences: [public] - parameters: - - $ref: './types/RequestSource.yaml' - summary: List Embed Jobs - operationId: list-embed-jobs - tags: [/embed-jobs] - x-fern-sdk-group-name: embed-jobs - x-fern-sdk-method-name: list - x-readme: - samples-languages: - - python - - java - - python - - java - - node - - curl - - go - code-samples: - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: './snippets/go/embed-jobs-get/main.go' - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/embed-jobs-get.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/embed-jobs-get.py - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java:1.0.4' - code: - $ref: ./snippets/java/app/src/main/java/EmbedJobsGet.java - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/embed-jobs-get.ts - - language: curl - name: cURL - code: - $ref: ./snippets/curl/embed-jobs-get.sh - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: OK - content: - application/json: - schema: - $ref: './types/ListEmbedJobResponse.yaml' - headers: - X-API-Warning: - schema: - type: string - x-fern-audiences: ['public'] - description: Warning description for incorrect usage of the API - description: The list embed job endpoint allows users to view all embed jobs - history for that specific user. diff --git a/fern/openapi/embed.yaml b/fern/openapi/embed.yaml deleted file mode 100644 index 01e6a762..00000000 --- a/fern/openapi/embed.yaml +++ /dev/null @@ -1,173 +0,0 @@ -post: - x-fern-audiences: [public] - summary: Embed - operationId: embed - parameters: - - $ref: './types/RequestSource.yaml' - x-readme: - samples-languages: - - python - - java - - curl - - node - - go - code-samples: - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: './snippets/go/embed-post/main.go' - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/embed-post.ts - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/embed-post.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/embed-post.py - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java:1.0.4' - code: - $ref: ./snippets/java/app/src/main/java/EmbedPost.java - - language: curl - name: cURL - code: - $ref: ./snippets/curl/embed-post.sh - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: OK - content: - application/json: - schema: - oneOf: - - $ref: './types/EmbedFloatsResponse.yaml' - - $ref: './types/EmbedByTypeResponse.yaml' - discriminator: - propertyName: response_type - mapping: - embeddings_floats: './types/EmbedFloatsResponse.yaml' - embeddings_by_type: './types/EmbedByTypeResponse.yaml' - headers: - X-API-Warning: - schema: - type: string - x-fern-audiences: ['public'] - description: Warning description for incorrect usage of the API - description: |- - This endpoint returns text embeddings. An embedding is a list of floating point numbers that captures semantic information about the text that it represents. - - Embeddings can be used to create text classifiers as well as empower semantic search. To learn more about embeddings, see the embedding page. - - If you want to learn more how to use the embedding model, have a look at the [Semantic Search Guide](/docs/semantic-search). - requestBody: - content: - application/json: - schema: - type: object - x-fern-audiences: ['public'] - properties: - texts: - type: array - x-fern-audiences: ['public'] - minItems: 1 - maxItems: 96 - description: An array of strings for the model to embed. Maximum number of texts - per call is `96`. We recommend reducing the length of each text - to be under `512` tokens for optimal quality. - items: - type: string - x-fern-audiences: ['public'] - writeOnly: true - writeOnly: true - model: - type: string - x-fern-audiences: ['public'] - description: |- - Defaults to embed-english-v2.0 - - The identifier of the model. Smaller "light" models are faster, while larger models will perform better. [Custom models](/docs/training-custom-models) can also be supplied with their full ID. - - Available models and corresponding embedding dimensions: - - * `embed-english-v3.0` 1024 - * `embed-multilingual-v3.0` 1024 - * `embed-english-light-v3.0` 384 - * `embed-multilingual-light-v3.0` 384 - - * `embed-english-v2.0` 4096 - * `embed-english-light-v2.0` 1024 - * `embed-multilingual-v2.0` 768 - writeOnly: true - input_type: - x-fern-audiences: ['public'] - $ref: './types/EmbedInputType.yaml' - embedding_types: - type: array - x-fern-audiences: ['public'] - items: - $ref: './types/EmbeddingType.yaml' - description: |- - Specifies the types of embeddings you want to get back. Not required and default is None, which returns the Embed Floats response type. Can be one or more of the following types. - - * `"float"`: Use this when you want to get back the default float embeddings. Valid for all models. - * `"int8"`: Use this when you want to get back signed int8 embeddings. Valid for only v3 models. - * `"uint8"`: Use this when you want to get back unsigned int8 embeddings. Valid for only v3 models. - * `"binary"`: Use this when you want to get back signed binary embeddings. Valid for only v3 models. - * `"ubinary"`: Use this when you want to get back unsigned binary embeddings. Valid for only v3 models. - writeOnly: true - truncate: - type: string - x-fern-audiences: ['public'] - default: END - enum: - - NONE - - START - - END - description: |- - One of `NONE|START|END` to specify how the API will handle inputs longer than the maximum token length. - - Passing `START` will discard the start of the input. `END` will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. - - If `NONE` is selected, when the input exceeds the maximum input token length an error will be returned. - writeOnly: true - required: - - texts - examples: - Example: - value: - texts: - - hello - - goodbye - description: '' diff --git a/fern/openapi/errors/BadRequest.yaml b/fern/openapi/errors/BadRequest.yaml deleted file mode 100644 index a4c048c3..00000000 --- a/fern/openapi/errors/BadRequest.yaml +++ /dev/null @@ -1,13 +0,0 @@ -description: | - This error is returned when the request is not well formed. This could be because: - - JSON is invalid - - The request is missing required fields - - The request contains an invalid combination of fields -content: - application/json: - schema: - type: object - properties: - data: - type: string - diff --git a/fern/openapi/errors/Forbidden.yaml b/fern/openapi/errors/Forbidden.yaml deleted file mode 100644 index 4c70ea79..00000000 --- a/fern/openapi/errors/Forbidden.yaml +++ /dev/null @@ -1,12 +0,0 @@ -description: | - This error indicates that the operation attempted to be performed is not allowed. This could be because: - - The api token is invalid - - The user does not have the necessary permissions -content: - application/json: - schema: - type: object - properties: - data: - type: string - diff --git a/fern/openapi/errors/GatewayTimeout.yaml b/fern/openapi/errors/GatewayTimeout.yaml deleted file mode 100644 index b79cbfe5..00000000 --- a/fern/openapi/errors/GatewayTimeout.yaml +++ /dev/null @@ -1,11 +0,0 @@ -description: | - This error is returned when a request to the server times out. This could be due to: - - An internal services taking too long to respond -content: - application/json: - schema: - type: object - properties: - data: - type: string - diff --git a/fern/openapi/errors/InternalServerError.yaml b/fern/openapi/errors/InternalServerError.yaml deleted file mode 100644 index 1463e680..00000000 --- a/fern/openapi/errors/InternalServerError.yaml +++ /dev/null @@ -1,10 +0,0 @@ -description: | - This error is returned when an uncategorised internal server error occurs. -content: - application/json: - schema: - type: object - properties: - data: - type: string - diff --git a/fern/openapi/errors/InvalidToken.yaml b/fern/openapi/errors/InvalidToken.yaml deleted file mode 100644 index 1b9cf9a4..00000000 --- a/fern/openapi/errors/InvalidToken.yaml +++ /dev/null @@ -1,10 +0,0 @@ -description: | - This error is returned when a request or response contains a deny-listed token. -content: - application/json: - schema: - type: object - properties: - data: - type: string - diff --git a/fern/openapi/errors/NotFound.yaml b/fern/openapi/errors/NotFound.yaml deleted file mode 100644 index 655ae5e0..00000000 --- a/fern/openapi/errors/NotFound.yaml +++ /dev/null @@ -1,12 +0,0 @@ -description: | - This error is returned when a resource is not found. This could be because: - - The endpoint does not exist - - The resource does not exist eg model id, dataset id -content: - application/json: - schema: - type: object - properties: - data: - type: string - diff --git a/fern/openapi/errors/NotImplemented.yaml b/fern/openapi/errors/NotImplemented.yaml deleted file mode 100644 index 82052ff3..00000000 --- a/fern/openapi/errors/NotImplemented.yaml +++ /dev/null @@ -1,10 +0,0 @@ -description: | - This error is returned when the requested feature is not implemented. -content: - application/json: - schema: - type: object - properties: - data: - type: string - diff --git a/fern/openapi/errors/RateLimit.yaml b/fern/openapi/errors/RateLimit.yaml deleted file mode 100644 index e9603686..00000000 --- a/fern/openapi/errors/RateLimit.yaml +++ /dev/null @@ -1,8 +0,0 @@ -description: 'Too many requests' -content: - application/json: - schema: - type: object - properties: - data: - type: string diff --git a/fern/openapi/errors/RequestCancelled.yaml b/fern/openapi/errors/RequestCancelled.yaml deleted file mode 100644 index 50982c84..00000000 --- a/fern/openapi/errors/RequestCancelled.yaml +++ /dev/null @@ -1,10 +0,0 @@ -description: | - This error is returned when a request is cancelled by the user. -content: - application/json: - schema: - type: object - properties: - data: - type: string - diff --git a/fern/openapi/errors/RequestEntityTooLarge.yaml b/fern/openapi/errors/RequestEntityTooLarge.yaml deleted file mode 100644 index 4a4e0415..00000000 --- a/fern/openapi/errors/RequestEntityTooLarge.yaml +++ /dev/null @@ -1,10 +0,0 @@ -description: | - This error is returned when the request size is too large. -content: - application/json: - schema: - type: object - properties: - data: - type: string - diff --git a/fern/openapi/errors/ServiceUnavailable.yaml b/fern/openapi/errors/ServiceUnavailable.yaml deleted file mode 100644 index fe4cbf99..00000000 --- a/fern/openapi/errors/ServiceUnavailable.yaml +++ /dev/null @@ -1,11 +0,0 @@ -description: | - This error is returned when the service is unavailable. This could be due to: - - Too many users trying to access the service at the same time -content: - application/json: - schema: - type: object - properties: - data: - type: string - diff --git a/fern/openapi/errors/Unauthorized.yaml b/fern/openapi/errors/Unauthorized.yaml deleted file mode 100644 index 4c70ea79..00000000 --- a/fern/openapi/errors/Unauthorized.yaml +++ /dev/null @@ -1,12 +0,0 @@ -description: | - This error indicates that the operation attempted to be performed is not allowed. This could be because: - - The api token is invalid - - The user does not have the necessary permissions -content: - application/json: - schema: - type: object - properties: - data: - type: string - diff --git a/fern/openapi/errors/UnprocessableEntity.yaml b/fern/openapi/errors/UnprocessableEntity.yaml deleted file mode 100644 index a4c048c3..00000000 --- a/fern/openapi/errors/UnprocessableEntity.yaml +++ /dev/null @@ -1,13 +0,0 @@ -description: | - This error is returned when the request is not well formed. This could be because: - - JSON is invalid - - The request is missing required fields - - The request contains an invalid combination of fields -content: - application/json: - schema: - type: object - properties: - data: - type: string - diff --git a/fern/openapi/finetuning-finetuned-models-events.yaml b/fern/openapi/finetuning-finetuned-models-events.yaml deleted file mode 100644 index 88933261..00000000 --- a/fern/openapi/finetuning-finetuned-models-events.yaml +++ /dev/null @@ -1,146 +0,0 @@ -# Generated by `turbo run openapi:finetuning` - DO NOT EDIT. -get: - summary: Retrieves the chronology of statuses the fine-tuned model has been through. - operationId: ListEvents - responses: - "200": - description: A successful response. - content: - application/json: - schema: - $ref: ./types/v1/finetuning/ListEventsResponse.yaml - example: - events: - - user_id: 7a317d97-4d05-427d-9396-f31b9fb92c55 - status: STATUS_QUEUED - created_at: 2024-01-17T20:11:45.267960Z - - user_id: 7a317d97-4d05-427d-9396-f31b9fb92c55 - status: STATUS_FINETUNING - created_at: 2024-01-17T20:11:46.000862Z - - user_id: 7a317d97-4d05-427d-9396-f31b9fb92c55 - status: STATUS_DEPLOYING_API - created_at: 2024-01-17T20:31:05.047066Z - - status: STATUS_READY - created_at: 2024-01-17T20:31:06.988655Z - total_size: 5 - "400": - description: Bad Request - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "401": - description: Unauthorized - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "403": - description: Forbidden - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "404": - description: Not Found - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "500": - description: Internal Server Error - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "503": - description: Status Service Unavailable - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - parameters: - - name: finetuned_model_id - description: The parent fine-tuned model ID. - in: path - required: true - schema: - type: string - - name: page_size - description: >- - Maximum number of results to be returned by the server. If 0, defaults - to - - 50. - in: query - required: false - schema: - type: integer - format: int32 - - name: page_token - description: Request a specific page of the list results. - in: query - required: false - schema: - type: string - - name: order_by - description: >- - Comma separated list of fields. For example: "created_at,name". The - default - - sorting order is ascending. To specify descending order for a field, - append - - " desc" to the field name. For example: "created_at desc,name". - - - Supported sorting fields: - - created_at (default) - in: query - required: false - schema: - type: string - - $ref: ./types/RequestSource.yaml - tags: - - /finetuning - x-readme: - samples-languages: - - python - - java - - go - - node - - curl - code-samples: - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java' - code: - $ref: ./snippets/java/app/src/main/java/finetuning/ListEvents.java - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: ./snippets/go/finetuning/list-events/main.go - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/finetuning/list-events.ts - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/finetuning/list-events.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/finetuning/list-events.py - - language: curl - name: cURL - code: - $ref: ./snippets/curl/finetuning/list-events.sh - x-fern-sdk-group-name: finetuning - x-fern-audiences: - - public - x-fern-request-name: FinetuningListEventsRequest diff --git a/fern/openapi/finetuning-finetuned-models-id.yaml b/fern/openapi/finetuning-finetuned-models-id.yaml deleted file mode 100644 index 9442c1c2..00000000 --- a/fern/openapi/finetuning-finetuned-models-id.yaml +++ /dev/null @@ -1,364 +0,0 @@ -# Generated by `turbo run openapi:finetuning` - DO NOT EDIT. -patch: - summary: Updates a fine-tuned model. - operationId: UpdateFinetunedModel - responses: - "200": - description: A successful response. - content: - application/json: - schema: - $ref: ./types/v1/finetuning/UpdateFinetunedModelResponse.yaml - "400": - description: Bad Request - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "401": - description: Unauthorized - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "403": - description: Forbidden - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "404": - description: Not Found - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "500": - description: Internal Server Error - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "503": - description: Status Service Unavailable - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - parameters: - - name: id - description: FinetunedModel ID. - in: path - required: true - schema: - type: string - - $ref: ./types/RequestSource.yaml - tags: - - /finetuning - requestBody: - description: Information about the fine-tuned model. Must contain name and settings. - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: FinetunedModel name (e.g. `foobar`). - creator_id: - type: string - description: User ID of the creator. - readOnly: true - organization_id: - type: string - description: Organization ID. - readOnly: true - settings: - $ref: ./types/v1/finetuning/Settings.yaml - description: FinetunedModel settings such as dataset, hyperparameters... - status: - $ref: ./types/v1/finetuning/Status.yaml - description: Current stage in the life-cycle of the fine-tuned model. - readOnly: true - created_at: - type: string - format: date-time - description: Creation timestamp. - readOnly: true - updated_at: - type: string - format: date-time - description: Latest update timestamp. - readOnly: true - completed_at: - type: string - format: date-time - description: Timestamp for the completed fine-tuning. - readOnly: true - last_used: - type: string - format: date-time - description: Timestamp for the latest request to this fine-tuned model. - readOnly: true - title: Information about the fine-tuned model. Must contain name and settings. - required: - - name - - settings - required: true - x-readme: - samples-languages: - - python - - java - - go - - node - - curl - code-samples: - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java' - code: - $ref: ./snippets/java/app/src/main/java/finetuning/UpdateFinetunedModel.java - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: ./snippets/go/finetuning/update-finetuned-model/main.go - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/finetuning/update-finetuned-model.ts - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/finetuning/update-finetuned-model.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/finetuning/update-finetuned-model.py - - language: curl - name: cURL - code: - $ref: ./snippets/curl/finetuning/update-finetuned-model.sh - x-fern-sdk-group-name: finetuning - x-fern-audiences: - - public - x-fern-request-name: FinetuningUpdateFinetunedModelRequest -get: - summary: Returns a fine-tuned model by ID. - operationId: GetFinetunedModel - responses: - "200": - description: A successful response. - content: - application/json: - schema: - $ref: ./types/v1/finetuning/GetFinetunedModelResponse.yaml - example: - finetuned_model: - id: fee37446-7fc7-42f9-a026-c6ba2fcc422d - name: prompt-completion-ft - creator_id: 7a317d97-4d05-427d-9396-f31b9fb92c55 - organization_id: 6bdca3d5-3eae-4de0-ac34-786d8063b7ee - settings: - base_model: - name: medium - version: 14.2.0 - base_type: BASE_TYPE_GENERATIVE - strategy: STRATEGY_TFEW - dataset_id: my-dataset-d701tr - hyperparameters: - early_stopping_patience: 6 - early_stopping_threshold: 0.01 - train_batch_size: 16 - train_epochs: 1 - learning_rate: 0.01 - status: STATUS_READY - created_at: 2024-01-17T20:11:42.907112Z - updated_at: 2024-01-17T20:31:06.464015Z - completed_at: 2024-01-17T20:31:05.047066Z - "400": - description: Bad Request - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "401": - description: Unauthorized - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "403": - description: Forbidden - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "404": - description: Not Found - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "500": - description: Internal Server Error - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "503": - description: Status Service Unavailable - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - parameters: - - name: id - description: The fine-tuned model ID. - in: path - required: true - schema: - type: string - - $ref: ./types/RequestSource.yaml - tags: - - /finetuning - x-readme: - samples-languages: - - python - - java - - go - - node - - curl - code-samples: - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java' - code: - $ref: ./snippets/java/app/src/main/java/finetuning/GetFinetunedModel.java - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: ./snippets/go/finetuning/get-finetuned-model/main.go - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/finetuning/get-finetuned-model.ts - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/finetuning/get-finetuned-model.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/finetuning/get-finetuned-model.py - - language: curl - name: cURL - code: - $ref: ./snippets/curl/finetuning/get-finetuned-model.sh - x-fern-sdk-group-name: finetuning - x-fern-audiences: - - public - x-fern-request-name: FinetuningGetFinetunedModelRequest -delete: - summary: Deletes a fine-tuned model. - operationId: DeleteFinetunedModel - responses: - "200": - description: A successful response. - content: - application/json: - schema: - $ref: ./types/v1/finetuning/DeleteFinetunedModelResponse.yaml - "400": - description: Bad Request - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "401": - description: Unauthorized - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "403": - description: Forbidden - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "404": - description: Not Found - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "500": - description: Internal Server Error - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "503": - description: Status Service Unavailable - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - parameters: - - name: id - description: The fine-tuned model ID. - in: path - required: true - schema: - type: string - - $ref: ./types/RequestSource.yaml - tags: - - /finetuning - x-readme: - samples-languages: - - python - - java - - go - - node - - curl - code-samples: - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java' - code: - $ref: ./snippets/java/app/src/main/java/finetuning/DeleteFinetunedModel.java - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: ./snippets/go/finetuning/delete-finetuned-model/main.go - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/finetuning/delete-finetuned-model.ts - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/finetuning/delete-finetuned-model.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/finetuning/delete-finetuned-model.py - - language: curl - name: cURL - code: - $ref: ./snippets/curl/finetuning/delete-finetuned-model.sh - x-fern-sdk-group-name: finetuning - x-fern-audiences: - - public diff --git a/fern/openapi/finetuning-finetuned-models-metrics.yaml b/fern/openapi/finetuning-finetuned-models-metrics.yaml deleted file mode 100644 index aaf1fbe8..00000000 --- a/fern/openapi/finetuning-finetuned-models-metrics.yaml +++ /dev/null @@ -1,127 +0,0 @@ -# Generated by `turbo run openapi:finetuning` - DO NOT EDIT. -get: - summary: Retrieves metrics measured during the training of a fine-tuned model. - operationId: ListTrainingStepMetrics - responses: - "200": - description: A successful response. - content: - application/json: - schema: - $ref: ./types/v1/finetuning/ListTrainingStepMetricsResponse.yaml - example: - step_metrics: - - created_at: 2024-01-17T20:24:26.952802658Z - metrics: - accuracy: 0.4557601809501648 - cross_entropy: 4.264331340789795 - generation_accuracy: 0.4557601809501648 - generation_cross_entropy: 4.264331340789795 - step: 0 - - created_at: 2024-01-17T20:25:19.331940174Z - step_number: 9 - metrics: - accuracy: 0.7393720149993896 - cross_entropy: 0.7702581286430359 - generation_accuracy: 0.7393720149993896 - generation_cross_entropy: 0.7702581286430359 - step: 9 - "400": - description: Bad Request - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "401": - description: Unauthorized - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "403": - description: Forbidden - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "404": - description: Not Found - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "500": - description: Internal Server Error - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "503": - description: Status Service Unavailable - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - parameters: - - name: finetuned_model_id - description: The parent fine-tuned model ID. - in: path - required: true - schema: - type: string - - name: page_size - description: >- - Maximum number of results to be returned by the server. If 0, defaults - to - - 50. - in: query - required: false - schema: - type: integer - format: int32 - - name: page_token - description: Request a specific page of the list results. - in: query - required: false - schema: - type: string - - $ref: ./types/RequestSource.yaml - tags: - - /finetuning - x-readme: - samples-languages: - - python - - java - - go - - node - - curl - code-samples: - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java' - code: - $ref: ./snippets/java/app/src/main/java/finetuning/ListTrainingStepMetrics.java - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: ./snippets/go/finetuning/list-training-step-metrics/main.go - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/finetuning/list-training-step-metrics.ts - - language: python - name: Cohere Python SDK - install: python -m pip install cohere - code: - $ref: ./snippets/python/finetuning/list-training-step-metrics.py - - language: curl - name: cURL - code: - $ref: ./snippets/curl/finetuning/list-training-step-metrics.sh - x-fern-sdk-group-name: finetuning - x-fern-audiences: - - public - x-fern-request-name: FinetuningListTrainingStepMetricsRequest diff --git a/fern/openapi/finetuning-finetuned-models-training-step-metrics.yaml b/fern/openapi/finetuning-finetuned-models-training-step-metrics.yaml deleted file mode 100644 index 29c2165c..00000000 --- a/fern/openapi/finetuning-finetuned-models-training-step-metrics.yaml +++ /dev/null @@ -1,132 +0,0 @@ -# Generated by `turbo run openapi:finetuning` - DO NOT EDIT. -get: - summary: Retrieves metrics measured during the training of a fine-tuned model. - operationId: ListTrainingStepMetrics - responses: - "200": - description: A successful response. - content: - application/json: - schema: - $ref: ./types/v1/finetuning/ListTrainingStepMetricsResponse.yaml - example: - step_metrics: - - created_at: 2024-01-17T20:24:26.952802658Z - metrics: - accuracy: 0.4557601809501648 - cross_entropy: 4.264331340789795 - generation_accuracy: 0.4557601809501648 - generation_cross_entropy: 4.264331340789795 - step: 0 - - created_at: 2024-01-17T20:25:19.331940174Z - step_number: 9 - metrics: - accuracy: 0.7393720149993896 - cross_entropy: 0.7702581286430359 - generation_accuracy: 0.7393720149993896 - generation_cross_entropy: 0.7702581286430359 - step: 9 - "400": - description: Bad Request - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "401": - description: Unauthorized - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "403": - description: Forbidden - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "404": - description: Not Found - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "500": - description: Internal Server Error - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "503": - description: Status Service Unavailable - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - parameters: - - name: finetuned_model_id - description: The parent fine-tuned model ID. - in: path - required: true - schema: - type: string - - name: page_size - description: >- - Maximum number of results to be returned by the server. If 0, defaults - to - - 50. - in: query - required: false - schema: - type: integer - format: int32 - - name: page_token - description: Request a specific page of the list results. - in: query - required: false - schema: - type: string - - $ref: ./types/RequestSource.yaml - tags: - - /finetuning - x-readme: - samples-languages: - - python - - java - - go - - node - - curl - code-samples: - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java' - code: - $ref: ./snippets/java/app/src/main/java/finetuning/ListTrainingStepMetrics.java - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: ./snippets/go/finetuning/list-training-step-metrics/main.go - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/finetuning/list-training-step-metrics.ts - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/finetuning/list-training-step-metrics.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/finetuning/list-training-step-metrics.py - - language: curl - name: cURL - code: - $ref: ./snippets/curl/finetuning/list-training-step-metrics.sh - x-fern-sdk-group-name: finetuning - x-fern-audiences: - - public - x-fern-request-name: FinetuningListTrainingStepMetricsRequest diff --git a/fern/openapi/finetuning-finetuned-models.yaml b/fern/openapi/finetuning-finetuned-models.yaml deleted file mode 100644 index b9f28b60..00000000 --- a/fern/openapi/finetuning-finetuned-models.yaml +++ /dev/null @@ -1,269 +0,0 @@ -# Generated by `turbo run openapi:finetuning` - DO NOT EDIT. -get: - summary: Lists fine-tuned models. - operationId: ListFinetunedModels - responses: - "200": - description: A successful response. - content: - application/json: - schema: - $ref: ./types/v1/finetuning/ListFinetunedModelsResponse.yaml - example: - finetuned_models: - - id: fee37446-7fc7-42f9-a026-c6ba2fcc422d - name: prompt-completion-ft - creator_id: 7a317d97-4d05-427d-9396-f31b9fb92c55 - organization_id: 6bdca3d5-3eae-4de0-ac34-786d8063b7ee - settings: - base_model: - name: medium - version: 14.2.0 - base_type: BASE_TYPE_GENERATIVE - strategy: STRATEGY_TFEW - dataset_id: my-dataset-d701tr - hyperparameters: - early_stopping_patience: 6 - early_stopping_threshold: 0.01 - train_batch_size: 16 - train_epochs: 1 - learning_rate: 0.01 - status: STATUS_READY - created_at: 2024-01-17T20:11:42.907112Z - updated_at: 2024-01-17T20:31:06.464015Z - completed_at: 2024-01-17T20:31:05.047066Z - - id: 9d927c5e-7598-4772-98b7-cdf2014e8874 - name: rerank-ft - creator_id: 7a317d97-4d05-427d-9396-f31b9fb92c55 - organization_id: 6bdca3d5-3eae-4de0-ac34-786d8063b7ee - settings: - base_model: - name: english - version: 2.0.0 - base_type: BASE_TYPE_RERANK - strategy: STRATEGY_VANILLA - dataset_id: rerank-dataset-d820xf - status: STATUS_READY - created_at: 2024-01-17T20:17:16.997608Z - updated_at: 2024-01-17T20:50:11.148769Z - completed_at: 2024-01-17T20:42:55.821051Z - "400": - description: Bad Request - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "401": - description: Unauthorized - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "403": - description: Forbidden - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "404": - description: Not Found - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "500": - description: Internal Server Error - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "503": - description: Status Service Unavailable - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - parameters: - - name: page_size - description: >- - Maximum number of results to be returned by the server. If 0, defaults - to - - 50. - in: query - required: false - schema: - type: integer - format: int32 - - name: page_token - description: Request a specific page of the list results. - in: query - required: false - schema: - type: string - - name: order_by - description: >- - Comma separated list of fields. For example: "created_at,name". The - default - - sorting order is ascending. To specify descending order for a field, - append - - " desc" to the field name. For example: "created_at desc,name". - - - Supported sorting fields: - - created_at (default) - in: query - required: false - schema: - type: string - - $ref: ./types/RequestSource.yaml - tags: - - /finetuning - x-readme: - samples-languages: - - python - - java - - go - - node - - curl - code-samples: - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java' - code: - $ref: ./snippets/java/app/src/main/java/finetuning/ListFinetunedModels.java - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: ./snippets/go/finetuning/list-finetuned-models/main.go - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/finetuning/list-finetuned-models.ts - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/finetuning/list-finetuned-models.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/finetuning/list-finetuned-models.py - - language: curl - name: cURL - code: - $ref: ./snippets/curl/finetuning/list-finetuned-models.sh - x-fern-sdk-group-name: finetuning - x-fern-audiences: - - public - x-fern-request-name: FinetuningListFinetunedModelsRequest -post: - summary: Trains and deploys a fine-tuned model. - operationId: CreateFinetunedModel - responses: - "200": - description: A successful response. - content: - application/json: - schema: - $ref: ./types/v1/finetuning/CreateFinetunedModelResponse.yaml - "400": - description: Bad Request - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "401": - description: Unauthorized - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "403": - description: Forbidden - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "404": - description: Not Found - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "500": - description: Internal Server Error - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - "503": - description: Status Service Unavailable - content: - application/json: - schema: - $ref: ./types/v1/finetuning/Error.yaml - tags: - - /finetuning - requestBody: - description: Information about the fine-tuned model. Must contain name and settings. - content: - application/json: - schema: - $ref: ./types/v1/finetuning/FinetunedModel.yaml - required: - - finetuned_model - example: - name: api-test - settings: - base_model: - base_type: BASE_TYPE_GENERATIVE - dataset_id: my-dataset-id - required: true - parameters: - - $ref: ./types/RequestSource.yaml - x-readme: - samples-languages: - - python - - java - - go - - node - - curl - code-samples: - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java' - code: - $ref: ./snippets/java/app/src/main/java/finetuning/CreateFinetunedModel.java - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: ./snippets/go/finetuning/create-finetuned-model/main.go - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/finetuning/create-finetuned-model.ts - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/finetuning/create-finetuned-model.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/finetuning/create-finetuned-model.py - - language: curl - name: cURL - code: - $ref: ./snippets/curl/finetuning/create-finetuned-model.sh - x-fern-sdk-group-name: finetuning - x-fern-audiences: - - public diff --git a/fern/openapi/generate.yaml b/fern/openapi/generate.yaml deleted file mode 100644 index ee62b05b..00000000 --- a/fern/openapi/generate.yaml +++ /dev/null @@ -1,272 +0,0 @@ -post: - x-fern-audiences: [public] - summary: Generate - operationId: generate - x-fern-streaming: - stream-condition: $request.stream - response: - $ref: './types/Generation.yaml' - response-stream: - $ref: './types/GenerateStreamedResponse.yaml' - parameters: - - $ref: './types/RequestSource.yaml' - x-readme: - samples-languages: - - python - - java - - curl - - node - - go - code-samples: - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: './snippets/go/generate-post/main.go' - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/generate-post.ts - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/generate-post.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/generate-post.py - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java:1.0.4' - code: - $ref: ./snippets/java/app/src/main/java/GeneratePost.java - - language: curl - name: cURL - code: - $ref: ./snippets/curl/generate-post.sh - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: OK - content: - application/json: - schema: - $ref: './types/Generation.yaml' - application/stream+json: - schema: - $ref: './types/GenerateStreamedResponse.yaml' - headers: - X-API-Warning: - schema: - type: string - x-fern-audiences: ['public'] - description: Warning description for incorrect usage of the API - description: | - - This API is marked as "Legacy" and is no longer maintained. Follow the [migration guide](/docs/migrating-from-cogenerate-to-cochat) to start using the Chat API. - - - Generates realistic text conditioned on a given input. - requestBody: - content: - application/json: - schema: - type: object - x-fern-audiences: ['public'] - x-examples: - Example: - prompt: Please explain to me how LLMs work - max_tokens: 50 - temperature: 1 - k: 0 - p: 0.75 - properties: - prompt: - type: string - x-fern-audiences: ['public'] - example: Please explain to me how LLMs work - description: | - The input text that serves as the starting point for generating the response. - Note: The prompt will be pre-processed and modified before reaching the model. - writeOnly: true - model: - type: string - x-fern-audiences: ['public'] - description: |- - The identifier of the model to generate with. Currently available models are `command` (default), `command-nightly` (experimental), `command-light`, and `command-light-nightly` (experimental). - Smaller, "light" models are faster, while larger models will perform better. [Custom models](/docs/training-custom-models) can also be supplied with their full ID. - writeOnly: true - num_generations: - type: integer - x-fern-audiences: ['public'] - description: | - The maximum number of generations that will be returned. Defaults to `1`, min value of `1`, max value of `5`. - writeOnly: true - stream: - type: boolean - x-fern-audiences: ['public'] - description: | - When `true`, the response will be a JSON stream of events. Streaming is beneficial for user interfaces that render the contents of the response piece by piece, as it gets generated. - - The final event will contain the complete response, and will contain an `is_finished` field set to `true`. The event will also contain a `finish_reason`, which can be one of the following: - - `COMPLETE` - the model sent back a finished reply - - `MAX_TOKENS` - the reply was cut off because the model reached the maximum number of tokens for its context length - - `ERROR` - something went wrong when generating the reply - - `ERROR_TOXIC` - the model generated a reply that was deemed toxic - max_tokens: - type: integer - x-fern-audiences: ['public'] - description: | - The maximum number of tokens the model will generate as part of the response. Note: Setting a low value may result in incomplete generations. - - This parameter is off by default, and if it's not specified, the model will continue generating until it emits an EOS completion token. See [BPE Tokens](/bpe-tokens-wiki) for more details. - - Can only be set to `0` if `return_likelihoods` is set to `ALL` to get the likelihood of the prompt. - writeOnly: true - truncate: - type: string - x-fern-audiences: ['public'] - default: END - enum: - - NONE - - START - - END - description: |- - One of `NONE|START|END` to specify how the API will handle inputs longer than the maximum token length. - - Passing `START` will discard the start of the input. `END` will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. - - If `NONE` is selected, when the input exceeds the maximum input token length an error will be returned. - writeOnly: true - temperature: - type: number - x-fern-audiences: ['public'] - description: | - A non-negative float that tunes the degree of randomness in generation. Lower temperatures mean less random generations. See [Temperature](/temperature-wiki) for more details. - Defaults to `0.75`, min value of `0.0`, max value of `5.0`. - writeOnly: true - seed: - x-internal: true - x-fern-audiences: ['public'] - minimum: 0 - maximum: 18446744073709551615 - type: integer - description: | - If specified, the backend will make a best effort to sample tokens - deterministically, such that repeated requests with the same - seed and parameters should return the same result. However, - determinism cannot be totally guaranteed. - Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments - preset: - type: string - x-fern-audiences: ['public'] - example: my-preset-a58sbd - description: | - Identifier of a custom preset. A preset is a combination of parameters, such as prompt, temperature etc. You can create presets in the [playground](https://dashboard.cohere.com/playground/generate). - When a preset is specified, the `prompt` parameter becomes optional, and any included parameters will override the preset's parameters. - writeOnly: true - end_sequences: - type: array - x-fern-audiences: ['public'] - description: The generated text will be cut at the beginning of the earliest - occurrence of an end sequence. The sequence will be excluded - from the text. - items: - type: string - x-fern-audiences: ['public'] - writeOnly: true - stop_sequences: - type: array - x-fern-audiences: ['public'] - description: The generated text will be cut at the end of the earliest - occurrence of a stop sequence. The sequence will be included the - text. - items: - type: string - x-fern-audiences: ['public'] - writeOnly: true - k: - type: integer - x-fern-audiences: ['public'] - description: | - Ensures only the top `k` most likely tokens are considered for generation at each step. - Defaults to `0`, min value of `0`, max value of `500`. - writeOnly: true - p: - type: number - x-fern-audiences: ['public'] - 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`. - Defaults to `0.75`. min value of `0.01`, max value of `0.99`. - writeOnly: true - frequency_penalty: - type: number - x-fern-audiences: ['public'] - description: | - Used 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. - - Using `frequency_penalty` in combination with `presence_penalty` is not supported on newer models. - writeOnly: true - presence_penalty: - type: number - x-fern-audiences: ['public'] - description: | - Defaults to `0.0`, min value of `0.0`, max value of `1.0`. - - Can be used 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. - - Using `frequency_penalty` in combination with `presence_penalty` is not supported on newer models. - writeOnly: true - return_likelihoods: - type: string - x-fern-audiences: ['public'] - description: |- - One of `GENERATION|ALL|NONE` to specify how and if the token likelihoods are returned with the response. Defaults to `NONE`. - - If `GENERATION` is selected, the token likelihoods will only be provided for generated text. - - If `ALL` is selected, the token likelihoods will be provided both for the prompt and the generated text. - enum: - - GENERATION - - ALL - - NONE - default: NONE - raw_prompting: - type: boolean - x-fern-audiences: ['public'] - description: "When enabled, the user's prompt will be sent to the model without - any pre-processing." - required: - - prompt - writeOnly: true - examples: - Example: - value: - prompt: Please explain to me how LLMs work - description: '' diff --git a/fern/openapi/loglikelihood.yaml b/fern/openapi/loglikelihood.yaml deleted file mode 100644 index 69e73254..00000000 --- a/fern/openapi/loglikelihood.yaml +++ /dev/null @@ -1,87 +0,0 @@ -post: - x-internal: true - summary: LogLikelihood - operationId: loglikelihood - parameters: - - $ref: './types/RequestSource.yaml' - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: OK - content: - application/json: - schema: - $ref: './types/LogLikelihoodResponse.yaml' - headers: - X-API-Warning: - schema: - type: string - x-fern-audiences: ['public'] - description: Warning description for incorrect usage of the API - description: Log likelihood tokenizes the input and annotates the tokens with - the models assessment of their probability. - requestBody: - content: - application/json: - schema: - type: object - x-fern-audiences: ['public'] - x-examples: - Prompt and completion: - value: - prompt: Please explain to me how LLMs work - completion: They work by using a large language model to generate text. - Raw prompt: - value: - raw_prompt: What's the colour of the sky? blue - properties: - model: - type: string - x-fern-audiences: ['public'] - description: The identifier of the model to generate with. Currently available - models are `command` (default), `command-nightly` - (experimental), `command-light`, and `command-light-nightly` - (experimental). Smaller, "light" models are faster, while larger - models will perform better. [Custom - models](/docs/training-custom-models) can also be supplied with - their full ID. - prompt: - type: string - x-fern-audiences: ['public'] - description: | - To be used in conjunction with `completion`. This will be interpolated into the user message in the prompt template. - writeOnly: true - completion: - type: string - x-fern-audiences: ['public'] - description: | - To be used in conjunction with `prompt`. This will be interpolated into the chatbot reponse in the prompt template. - raw_prompt: - type: string - x-fern-audiences: ['public'] - description: | - To be used on its own, this allows you to pass a custom prompt to the model that will not be interpolated into a prompt template. - writeOnly: true diff --git a/fern/openapi/models-get.yaml b/fern/openapi/models-get.yaml deleted file mode 100644 index 3d89dcf3..00000000 --- a/fern/openapi/models-get.yaml +++ /dev/null @@ -1,53 +0,0 @@ -get: - summary: Get a Model - tags: [/models] - operationId: get-model - x-fern-sdk-method-name: get - x-fern-sdk-group-name: models - x-fern-audiences: ['public'] - description: Returns the details of a model, provided its name. - parameters: - - name: model - in: path - required: true - schema: - type: string - x-fern-audiences: ['public'] - - $ref: './types/RequestSource.yaml' - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: OK - content: - application/json: - schema: - $ref: './types/GetModelResponse.yaml' - headers: - X-API-Warning: - schema: - type: string - x-fern-audiences: ['public'] - description: Warning description for incorrect usage of the API \ No newline at end of file diff --git a/fern/openapi/models-list.yaml b/fern/openapi/models-list.yaml deleted file mode 100644 index d787d1c7..00000000 --- a/fern/openapi/models-list.yaml +++ /dev/null @@ -1,108 +0,0 @@ -get: - x-fern-audiences: [public] - summary: List Models - tags: [/models] - operationId: list-models - x-fern-sdk-method-name: list - x-fern-sdk-group-name: models - description: Returns a list of models available for use. The list contains - models from Cohere as well as your fine-tuned models. - parameters: - - name: page_size - in: query - description: |- - Maximum number of models to include in a page - Defaults to `20`, min value of `1`, max value of `1000`. - schema: - type: number - x-fern-audiences: ['public'] - - name: page_token - description: Page token provided in the `next_page_token` field of a previous - response. - in: query - schema: - type: string - x-fern-audiences: ['public'] - - name: endpoint - in: query - description: When provided, filters the list of models to only those that are - compatible with the specified endpoint. - schema: - $ref: './types/CompatibleEndpoint.yaml' - x-fern-audiences: ['public'] - - name: default_only - in: query - description: When provided, filters the list of models to only the default model - to the endpoint. This parameter is only valid when `endpoint` is - provided. - schema: - type: boolean - x-fern-audiences: ['public'] - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: OK - content: - application/json: - schema: - $ref: './types/ListModelsResponse.yaml' - x-readme: - samples-languages: - - node - - curl - - python - - java - - go - code-samples: - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/models-list-get.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/models-list-get.py - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java:1.0.4' - code: - $ref: ./snippets/java/app/src/main/java/ModelsListGet.java - - language: curl - name: cURL - code: - $ref: ./snippets/curl/models-list-get.sh - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/models-list-get.ts - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: './snippets/go/models-list-get/main.go' diff --git a/fern/openapi/models-name.yaml b/fern/openapi/models-name.yaml deleted file mode 100644 index ef3c2988..00000000 --- a/fern/openapi/models-name.yaml +++ /dev/null @@ -1,41 +0,0 @@ -get: - summary: Get a Model - tags: [/models] - operationId: get-model - x-fern-sdk-method-name: get - x-fern-sdk-group-name: models - description: Returns the configuration of a model provided an endpoint. If no modelName is provided, the default model's configuration for the endpoint is returned. - parameters: - - name: endpoint - in: path - required: true - schema: - type: string - x-fern-audiences: [ "public" ] - - name: modelName - in: query - description: Override the model to fetch. Instead of the default one for the endpoint. - schema: - type: string - x-fern-audiences: [ "public" ] - - $ref: './types/RequestSource.yaml' - responses: - '429': - $ref: './types/RateLimit.yaml' - '200': - description: OK - content: - application/json: - schema: - $ref: './types/ModelConfig.yaml' - headers: - X-API-Warning: - schema: - type: string - x-fern-audiences: [ "public" ] - description: Warning description for incorrect usage of the API - '400': - description: Bad Request - '500': - description: Internal Server Error - diff --git a/fern/openapi/models.yaml b/fern/openapi/models.yaml deleted file mode 100644 index db922084..00000000 --- a/fern/openapi/models.yaml +++ /dev/null @@ -1,74 +0,0 @@ -get: - x-fern-audiences: [public] - summary: List Models - tags: [/models] - operationId: list-models - x-fern-sdk-method-name: list - x-fern-sdk-group-name: models - description: Returns a list of models available for use. The list contains models from Cohere as well as your fine-tuned models. - parameters: - - name: page_size - in: query - description: |- - Maximum number of models to include in a page - Defaults to `20`, min value of `1`, max value of `1000`. - schema: - type: number - x-fern-audiences: ['public'] - - name: page_token - description: Page token provided in the `next_page_token` field of a previous response. - in: query - schema: - type: string - x-fern-audiences: ['public'] - - name: endpoint - in: query - description: When provided, filters the list of models to only those that are compatible with the specified endpoint. - schema: - $ref: './types/CompatibleEndpoint.yaml' - x-fern-audiences: ['public'] - responses: - '429': - $ref: './types/RateLimit.yaml' - '200': - description: OK - content: - application/json: - schema: - $ref: './types/ListModelsResponse.yaml' - x-readme: - samples-languages: - - node - - curl - # - python - code-samples: -# - language: python -# name: Cohere Python SDK -# install: python -m pip install cohere --upgrade -# code: |- -# import cohere -# co = cohere.Client('<>') -# models = co.list_models() -# print(models) - - language: curl - name: cURL - code: |- - curl --request GET \ - --url https://api.cohere.ai/v1/models \ - --header 'accept: application/json' \ - --header "Authorization: bearer $CO_API_KEY" - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: |- - const { CohereClient } = require("cohere-ai"); - - const cohere = new CohereClient({ - token: "<>", - }); - - (async () => { - const models = await cohere.models.list(); - - console.log(models); - })(); diff --git a/fern/openapi/rerank.yaml b/fern/openapi/rerank.yaml deleted file mode 100644 index 30e732f8..00000000 --- a/fern/openapi/rerank.yaml +++ /dev/null @@ -1,195 +0,0 @@ -post: - x-fern-audiences: [public] - summary: Rerank - operationId: rerank - parameters: - - $ref: './types/RequestSource.yaml' - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: OK - content: - application/json: - schema: - type: object - x-fern-audiences: ['public'] - properties: - id: - type: string - x-fern-audiences: ['public'] - results: - type: array - x-fern-audiences: ['public'] - description: An ordered list of ranked documents - items: - type: object - x-fern-audiences: ['public'] - properties: - document: - type: object - x-fern-audiences: ['public'] - description: If `return_documents` is set as `false` this will return none, if `true` it will return the documents passed in - properties: - text: - type: string - x-fern-audiences: ['public'] - description: The text of the document to rerank - required: - - text - index: - type: integer - x-fern-audiences: ['public'] - description: Corresponds to the index in the original list of documents to which the ranked document belongs. (i.e. if the first value in the `results` object has an `index` value of 3, it means in the list of documents passed in, the document at `index=3` had the highest relevance) - relevance_score: - type: number - x-fern-audiences: ['public'] - format: float - description: Relevance scores are normalized to be in the range `[0, 1]`. Scores close to `1` indicate a high relevance to the query, and scores closer to `0` indicate low relevance. It is not accurate to assume a score of 0.9 means the document is 2x more relevant than a document with a score of 0.45 - readOnly: true - required: - - index - - relevance_score - meta: - $ref: './types/ApiMeta.yaml' - x-fern-audiences: ['public'] - required: - - results - requestBody: - content: - application/json: - schema: - type: object - x-fern-audiences: ['public'] - properties: - model: - type: string - x-fern-audiences: ['public'] - description: 'The identifier of the model to use, one of : - `rerank-english-v3.0`, `rerank-multilingual-v3.0`, - `rerank-english-v2.0`, `rerank-multilingual-v2.0`' - query: - type: string - x-fern-audiences: ['public'] - description: The search query - documents: - type: array - x-fern-audiences: ['public'] - description: |- - A list of document objects or strings to rerank. - If a document is provided the text fields is required and all other fields will be preserved in the response. - - The total max chunks (length of documents * max_chunks_per_doc) must be less than 10000. - - We recommend a maximum of 1,000 documents for optimal endpoint performance. - items: - oneOf: - - type: string - - $ref: "./types/RerankDocument.yaml" - top_n: - type: integer - x-fern-audiences: ['public'] - minimum: 1 - description: 'The number of most relevant documents or indices to return, - defaults to the length of the documents' - rank_fields: - type: array - x-fern-audiences: ['public'] - items: - type: string - x-fern-audiences: ['public'] - description: |- - If a JSON object is provided, you can specify which keys you would like to have considered for reranking. The model will rerank based on order of the fields passed in (i.e. rank_fields=['title','author','text'] will rerank using the values in title, author, text sequentially. If the length of title, author, and text exceeds the context length of the model, the chunking will not re-consider earlier fields). If not provided, the model will use the default text field for ranking. - return_documents: - type: boolean - x-fern-audiences: ['public'] - default: false - description: |- - - If false, returns results without the doc text - the api will return a list of {index, relevance score} where index is inferred from the list passed into the request. - - If true, returns results with the doc text passed in - the api will return an ordered list of {index, text, relevance score} where index + text refers to the list passed into the request. - max_chunks_per_doc: - type: integer - x-fern-audiences: ['public'] - description: The maximum number of chunks to produce internally from a document - default: 10 - required: - - query - - documents - examples: - Example: - value: - model: rerank-english-v3.0 - query: What is the capital of the United States? - documents: - - Carson City is the capital city of the American state of - Nevada. - - The Commonwealth of the Northern Mariana Islands is a group of - islands in the Pacific Ocean. Its capital is Saipan. - - 'Washington, D.C. (also known as simply Washington or D.C., - and officially as the District of Columbia) is the capital of - the United States. It is a federal district.' - - 'Capital punishment (the death penalty) has existed in the - United States since beforethe United States was a country. As - of 2017, capital punishment is legal in 30 of the 50 states.' - description: '' - description: This endpoint takes in a query and a list of texts and produces an - ordered array with each text assigned a relevance score. - x-readme: - samples-languages: - - python - - java - - curl - - node - - go - code-samples: - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: './snippets/go/rerank-post/main.go' - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/rerank-post.ts - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/rerank-post.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/rerank-post.py - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java:1.0.4' - code: - $ref: ./snippets/java/app/src/main/java/RerankPost.java - - language: curl - name: cURL - code: - $ref: ./snippets/curl/rerank-post.sh diff --git a/fern/openapi/summarize.yaml b/fern/openapi/summarize.yaml deleted file mode 100644 index b72e1dc9..00000000 --- a/fern/openapi/summarize.yaml +++ /dev/null @@ -1,216 +0,0 @@ -post: - x-fern-audiences: [public] - summary: Summarize - operationId: summarize - parameters: - - $ref: './types/RequestSource.yaml' - x-readme: - samples-languages: - - python - - java - - curl - - node - - go - code-samples: - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: './snippets/go/summarize-post/main.go' - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/summarize-post.ts - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/summarize-post.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/summarize-post.py - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java:1.0.4' - code: - $ref: ./snippets/java/app/src/main/java/SummarizePost.java - - language: curl - name: cURL - code: - $ref: ./snippets/curl/summarize-post.sh - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: OK - headers: - X-API-Warning: - schema: - type: string - x-fern-audiences: ['public'] - description: Warning description for incorrect usage of the API - content: - application/json: - schema: - type: object - x-fern-audiences: ['public'] - properties: - id: - type: string - x-fern-audiences: ['public'] - description: Generated ID for the summary - summary: - type: string - x-fern-audiences: ['public'] - description: Generated summary for the text - meta: - $ref: './types/ApiMeta.yaml' - x-fern-audiences: ['public'] - description: | - - This API is marked as "Legacy" and is no longer maintained. Follow the [migration guide](/docs/migrating-from-cogenerate-to-cochat) to start using the Chat API. - - - Generates a summary in English for a given text. - requestBody: - content: - application/json: - schema: - type: object - x-fern-audiences: ['public'] - properties: - text: - type: string - x-fern-audiences: ['public'] - description: 'The text to generate a summary for. Can be up to 100,000 - characters long. Currently the only supported language is - English.' - minLength: 250 - maxLength: 50000 - writeOnly: true - length: - type: string - x-fern-audiences: ['public'] - description: 'One of `short`, `medium`, `long`, or `auto` defaults to `auto`. - Indicates the approximate length of the summary. If `auto` is - selected, the best option will be picked based on the input - text.' - default: medium - enum: - - short - - medium - - long - writeOnly: true - format: - type: string - x-fern-audiences: ['public'] - default: paragraph - enum: - - paragraph - - bullets - description: 'One of `paragraph`, `bullets`, or `auto`, defaults to `auto`. - Indicates the style in which the summary will be delivered - in - a free form paragraph or in bullet points. If `auto` is - selected, the best option will be picked based on the input - text.' - writeOnly: true - model: - type: string - x-fern-audiences: ['public'] - description: 'The identifier of the model to generate the summary with. - Currently available models are `command` (default), - `command-nightly` (experimental), `command-light`, and - `command-light-nightly` (experimental). Smaller, "light" models - are faster, while larger models will perform better.' - writeOnly: true - extractiveness: - type: string - x-fern-audiences: ['public'] - description: 'One of `low`, `medium`, `high`, or `auto`, defaults to `auto`. - Controls how close to the original text the summary is. `high` - extractiveness summaries will lean towards reusing sentences - verbatim, while `low` extractiveness summaries will tend to - paraphrase more. If `auto` is selected, the best option will be - picked based on the input text.' - default: low - enum: - - low - - medium - - high - writeOnly: true - temperature: - type: number - x-fern-audiences: ['public'] - description: 'Ranges from 0 to 5. Controls the randomness of the output. Lower - values tend to generate more “predictable” output, while higher - values tend to generate more “creative” output. The sweet spot - is typically between 0 and 1.' - default: 0.3 - minimum: 0 - maximum: 5 - writeOnly: true - additional_command: - type: string - x-fern-audiences: ['public'] - description: A free-form instruction for modifying how the summaries get - generated. Should complete the sentence "Generate a summary _". - Eg. "focusing on the next steps" or "written by Yoda" - writeOnly: true - required: - - text - examples: - Example: - value: - text: "Ice cream is a sweetened frozen food typically eaten as a snack or - dessert. It may be made from milk or cream and is flavoured with - a sweetener, either sugar or an alternative, and a spice, such - as cocoa or vanilla, or with fruit such as strawberries or - peaches. It can also be made by whisking a flavored cream base - and liquid nitrogen together. Food coloring is sometimes added, - in addition to stabilizers. The mixture is cooled below the - freezing point of water and stirred to incorporate air spaces - and to prevent detectable ice crystals from forming. The result - is a smooth, semi-solid foam that is solid at very low - temperatures (below 2 °C or 35 °F). It becomes more malleable as - its temperature increases. - - - The meaning of the name \"ice cream\" varies - from one country to another. In some countries, such as the - United States, \"ice cream\" applies only to a specific variety, - and most governments regulate the commercial use of the various - terms according to the relative quantities of the main - ingredients, notably the amount of cream. Products that do not - meet the criteria to be called ice cream are sometimes labelled - \"frozen dairy dessert\" instead. In other countries, such as - Italy and Argentina, one word is used fo\r all variants. - Analogues made from dairy alternatives, such as goat's or - sheep's milk, or milk substitutes (e.g., soy, cashew, coconut, - almond milk or tofu), are available for those who are lactose - intolerant, allergic to dairy protein or vegan." - description: '' diff --git a/fern/openapi/tokenize.yaml b/fern/openapi/tokenize.yaml deleted file mode 100644 index 6c3980ab..00000000 --- a/fern/openapi/tokenize.yaml +++ /dev/null @@ -1,159 +0,0 @@ -post: - x-fern-audiences: [public] - summary: Tokenize - operationId: tokenize - parameters: - - $ref: './types/RequestSource.yaml' - x-readme: - samples-languages: - - python - - java - - curl - - node - - go - code-samples: - - language: go - name: Cohere Go SDK - install: go get github.com/cohere-ai/cohere-go/v2 - code: - $ref: './snippets/go/tokenize-post/main.go' - - language: node - name: Cohere TypeScript SDK - install: npm i cohere-ai - code: - $ref: ./snippets/node/tokenize-post.ts - - language: python - name: Sync - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python/tokenize-post.py - - language: python - name: Async - install: python -m pip install cohere --upgrade - code: - $ref: ./snippets/python-async/tokenize-post.py - - language: java - name: Cohere java SDK - install: implementation 'com.cohere:cohere-java:1.0.4' - code: - $ref: ./snippets/java/app/src/main/java/TokenizePost.java - - language: node - name: Cohere Node.js SDK - install: npm install cohere-ai - code: - $ref: ./snippets/node/tokenize-post.ts - - language: curl - name: cURL - code: - $ref: ./snippets/curl/tokenize-post.sh - responses: - '400': - $ref: "./errors/BadRequest.yaml" - '401': - $ref: "./errors/Unauthorized.yaml" - '403': - $ref: "./errors/Forbidden.yaml" - '404': - $ref: "./errors/NotFound.yaml" - '422': - $ref: "./errors/UnprocessableEntity.yaml" - '429': - $ref: './errors/RateLimit.yaml' - '498': - $ref: "./errors/InvalidToken.yaml" - '499': - $ref: "./errors/RequestCancelled.yaml" - '500': - $ref: "./errors/InternalServerError.yaml" - '501': - $ref: "./errors/NotImplemented.yaml" - '503': - $ref: "./errors/ServiceUnavailable.yaml" - '504': - $ref: "./errors/GatewayTimeout.yaml" - '200': - description: OK - headers: - X-API-Warning: - schema: - type: string - x-fern-audiences: ['public'] - description: Warning description for incorrect usage of the API - content: - application/json: - schema: - type: object - x-fern-audiences: ['public'] - properties: - tokens: - type: array - x-fern-audiences: ['public'] - description: 'An array of tokens, where each token is an integer.' - items: - type: integer - x-fern-audiences: ['public'] - readOnly: true - readOnly: true - token_strings: - type: array - x-fern-audiences: ['public'] - items: - type: string - x-fern-audiences: ['public'] - meta: - $ref: './types/ApiMeta.yaml' - x-fern-audiences: ['public'] - required: - - tokens - - token_strings - examples: - Example: - value: - tokens: - - 34160 - - 974 - - 514 - - 34 - - 1420 - - 69 - token_strings: - - token - - ize' - - ' me' - - '!' - - ' :' - - D - meta: - api_version: - version: '1' - description: 'This endpoint splits input text into smaller units called tokens - using byte-pair encoding (BPE). To learn more about tokenization and byte - pair encoding, see the tokens page.' - requestBody: - content: - application/json: - schema: - type: object - x-fern-audiences: ['public'] - properties: - text: - type: string - x-fern-audiences: ['public'] - description: 'The string to be tokenized, the minimum text length is 1 - character, and the maximum text length is 65536 characters.' - minLength: 1 - maxLength: 65536 - model: - type: string - x-fern-audiences: ['public'] - description: An optional parameter to provide the model name. This will ensure - that the tokenization uses the tokenizer used by that model. - required: - - text - - model - examples: - Example: - value: - text: 'tokenize me! :D' - model: command - description: '' diff --git a/fern/openapi/types/ApiMeta.yaml b/fern/openapi/types/ApiMeta.yaml deleted file mode 100644 index 10d20f29..00000000 --- a/fern/openapi/types/ApiMeta.yaml +++ /dev/null @@ -1,61 +0,0 @@ -type: object -properties: - api_version: - type: object - x-fern-audiences: ['public'] - properties: - version: - type: string - x-fern-audiences: ['public'] - is_deprecated: - type: boolean - x-fern-audiences: ['public'] - is_experimental: - type: boolean - x-fern-audiences: ['public'] - required: - - version - billed_units: - type: object - x-fern-audiences: ['public'] - properties: - input_tokens: - type: number - x-fern-audiences: ['public'] - description: | - The number of billed input tokens. - output_tokens: - type: number - x-fern-audiences: ['public'] - description: | - The number of billed output tokens. - search_units: - type: number - x-fern-audiences: ['public'] - description: | - The number of billed search units. - classifications: - type: number - x-fern-audiences: ['public'] - description: | - The number of billed classifications units. - tokens: - type: object - x-fern-audiences: ['public'] - properties: - input_tokens: - type: number - x-fern-audiences: ['public'] - description: | - The number of tokens used as input to the model. - output_tokens: - type: number - x-fern-audiences: ['public'] - description: | - The number of tokens produced by the model. - warnings: - type: array - x-fern-audiences: ['public'] - items: - type: string - x-fern-audiences: ['public'] diff --git a/fern/openapi/types/AuthTokenType.yaml b/fern/openapi/types/AuthTokenType.yaml deleted file mode 100644 index 4d73c250..00000000 --- a/fern/openapi/types/AuthTokenType.yaml +++ /dev/null @@ -1,7 +0,0 @@ -type: string -description: The token_type specifies the way the token is passed in the Authorization header. Valid values are "bearer", "basic", and "noscheme". -enum: - - bearer - - basic - - noscheme -default: noscheme diff --git a/fern/openapi/types/ChatCitation.yaml b/fern/openapi/types/ChatCitation.yaml deleted file mode 100644 index d7f63a31..00000000 --- a/fern/openapi/types/ChatCitation.yaml +++ /dev/null @@ -1,33 +0,0 @@ -description: | - A section of the generated reply which cites external knowledge. -required: - - start - - end - - text - - document_ids -properties: - start: - description: | - The index of text that the citation starts at, counting from zero. For example, a generation of `Hello, world!` with a citation on `world` would have a start value of `7`. This is because the citation starts at `w`, which is the seventh character. - type: integer - x-fern-audiences: ['public'] - end: - description: | - The index of text that the citation ends after, counting from zero. For example, a generation of `Hello, world!` with a citation on `world` would have an end value of `11`. This is because the citation ends after `d`, which is the eleventh character. - type: integer - x-fern-audiences: ['public'] - text: - description: | - The text of the citation. For example, a generation of `Hello, world!` with a citation of `world` would have a text value of `world`. - type: string - x-fern-audiences: ['public'] - minLength: 1 - document_ids: - description: | - Identifiers of documents cited by this section of the generated reply. - type: array - x-fern-audiences: ['public'] - items: - type: string - x-fern-audiences: ['public'] - minItems: 1 diff --git a/fern/openapi/types/ChatCitationGenerationEvent.yaml b/fern/openapi/types/ChatCitationGenerationEvent.yaml deleted file mode 100644 index c7872d44..00000000 --- a/fern/openapi/types/ChatCitationGenerationEvent.yaml +++ /dev/null @@ -1,13 +0,0 @@ -allOf: - - $ref: './ChatStreamEvent.yaml' - - type: object - required: - - citations - properties: - citations: - description: | - Citations for the generated reply. - type: array - x-fern-audiences: ['public'] - items: - $ref: './ChatCitation.yaml' diff --git a/fern/openapi/types/ChatConnector.yaml b/fern/openapi/types/ChatConnector.yaml deleted file mode 100644 index 0f0abf7e..00000000 --- a/fern/openapi/types/ChatConnector.yaml +++ /dev/null @@ -1,31 +0,0 @@ -description: | - The connector used for fetching documents. -type: object -required: - - id -properties: - id: - description: | - The identifier of the connector. - type: string - x-fern-audiences: ['public'] - minLength: 1 - user_access_token: - description: | - When specified, this user access token will be passed to the connector in the Authorization header instead of the Cohere generated one. - type: string - x-fern-audiences: ['public'] - continue_on_failure: - description: | - Defaults to `false`. - - When `true`, the request will continue if this connector returned an error. - type: boolean - x-fern-audiences: ['public'] - options: - description: | - Provides the connector with different settings at request time. The key/value pairs of this object are specific to each connector. - - For example, the connector `web-search` supports the `site` option, which limits search results to the specified domain. - type: object - x-fern-audiences: ['public'] diff --git a/fern/openapi/types/ChatDataMetrics.yaml b/fern/openapi/types/ChatDataMetrics.yaml deleted file mode 100644 index 9756f8b7..00000000 --- a/fern/openapi/types/ChatDataMetrics.yaml +++ /dev/null @@ -1,16 +0,0 @@ -type: object -properties: - num_train_turns: - type: number - format: long - description: "The sum of all turns of valid train examples." - x-fern-audiences: ["public"] - num_eval_turns: - type: number - format: long - description: "The sum of all turns of valid eval examples." - x-fern-audiences: ["public"] - preamble: - type: string - description: "The preamble of this dataset." - x-fern-audiences: ["public"] diff --git a/fern/openapi/types/ChatDocument.yaml b/fern/openapi/types/ChatDocument.yaml deleted file mode 100644 index 6aafc985..00000000 --- a/fern/openapi/types/ChatDocument.yaml +++ /dev/null @@ -1,15 +0,0 @@ -description: | - Relevant information that could be used by the model to generate a more accurate reply. - The contents of each document are generally short (under 300 words), and are passed in the form of a - dictionary of strings. Some suggested keys are "text", "author", "date". Both the key name and the value will be - passed to the model. -type: object -properties: - id: - description: Unique identifier for this document. - type: string - x-fern-audiences: ['public'] -additionalProperties: - type: string - x-fern-audiences: ['public'] -x-fern-type: map # for now, fern doesn't support properties + additionalProperties diff --git a/fern/openapi/types/ChatMessage.yaml b/fern/openapi/types/ChatMessage.yaml deleted file mode 100644 index 6e10614a..00000000 --- a/fern/openapi/types/ChatMessage.yaml +++ /dev/null @@ -1,22 +0,0 @@ -description: | - Represents a single message in the chat history, excluding the current user turn. It has two properties: `role` and `message`. The `role` identifies the sender (`CHATBOT`, `SYSTEM`, or `USER`), while the `message` contains the text content. - - The chat_history parameter should not be used for `SYSTEM` messages in most cases. Instead, to add a `SYSTEM` role message at the beginning of a conversation, the `preamble` parameter should be used. -required: - - role - - message -properties: - role: - $ref: './ChatRole.yaml' - x-fern-audiences: ['public'] - message: - type: string - description: | - Contents of the chat message. - minLength: 1 - x-fern-audiences: ['public'] - tool_calls: - x-fern-audiences: ['public'] - type: array - items: - $ref: './ToolCall.yaml' diff --git a/fern/openapi/types/ChatRole.yaml b/fern/openapi/types/ChatRole.yaml deleted file mode 100644 index 04b5936e..00000000 --- a/fern/openapi/types/ChatRole.yaml +++ /dev/null @@ -1,8 +0,0 @@ -type: string -description: | - One of `CHATBOT`, `SYSTEM`, `TOOL` or `USER` to identify who the message is coming from. -enum: - - 'CHATBOT' - - 'SYSTEM' - - 'USER' - - 'TOOL' \ No newline at end of file diff --git a/fern/openapi/types/ChatSearchQueriesGenerationEvent.yaml b/fern/openapi/types/ChatSearchQueriesGenerationEvent.yaml deleted file mode 100644 index b677f275..00000000 --- a/fern/openapi/types/ChatSearchQueriesGenerationEvent.yaml +++ /dev/null @@ -1,12 +0,0 @@ -allOf: - - $ref: './ChatStreamEvent.yaml' - - type: object - required: - - search_queries - properties: - search_queries: - type: array - x-fern-audiences: ['public'] - description: Generated search queries, meant to be used as part of the RAG flow. - items: - $ref: './ChatSearchQuery.yaml' diff --git a/fern/openapi/types/ChatSearchQuery.yaml b/fern/openapi/types/ChatSearchQuery.yaml deleted file mode 100644 index a75e7a56..00000000 --- a/fern/openapi/types/ChatSearchQuery.yaml +++ /dev/null @@ -1,18 +0,0 @@ -description: | - The generated search query. Contains the text of the query and a unique identifier for the query. -type: object -required: - - text - - generation_id -properties: - text: - description: | - The text of the search query. - type: string - x-fern-audiences: ['public'] - generation_id: - description: | - Unique identifier for the generated search query. Useful for submitting feedback. - type: string - x-fern-audiences: ['public'] - format: uuid diff --git a/fern/openapi/types/ChatSearchResult.yaml b/fern/openapi/types/ChatSearchResult.yaml deleted file mode 100644 index 26f9bdcd..00000000 --- a/fern/openapi/types/ChatSearchResult.yaml +++ /dev/null @@ -1,33 +0,0 @@ -type: object -required: - - connector - - document_ids -properties: - search_query: - $ref: './ChatSearchQuery.yaml' - x-fern-audiences: ['public'] - connector: - description: | - The connector from which this result comes from. - $ref: './ChatSearchResultConnector.yaml' - x-fern-audiences: ['public'] - document_ids: - description: | - Identifiers of documents found by this search query. - type: array - x-fern-audiences: ['public'] - minLength: 0 - items: - type: string - x-fern-audiences: ['public'] - minLength: 1 - error_message: - description: | - An error message if the search failed. - type: string - x-fern-audiences: ['public'] - continue_on_failure: - description: | - Whether a chat request should continue or not if the request to this connector fails. - type: boolean - x-fern-audiences: ['public'] diff --git a/fern/openapi/types/ChatSearchResultConnector.yaml b/fern/openapi/types/ChatSearchResultConnector.yaml deleted file mode 100644 index f6f6b32e..00000000 --- a/fern/openapi/types/ChatSearchResultConnector.yaml +++ /dev/null @@ -1,12 +0,0 @@ -description: | - The connector used for fetching documents. -type: object -required: - - id -properties: - id: - description: | - The identifier of the connector. - type: string - x-fern-audiences: ['public'] - minLength: 1 diff --git a/fern/openapi/types/ChatSearchResultsEvent.yaml b/fern/openapi/types/ChatSearchResultsEvent.yaml deleted file mode 100644 index 2fa69e79..00000000 --- a/fern/openapi/types/ChatSearchResultsEvent.yaml +++ /dev/null @@ -1,20 +0,0 @@ -allOf: - - $ref: './ChatStreamEvent.yaml' - - type: object - properties: - search_results: - description: | - Conducted searches and the ids of documents retrieved from each of them. - type: array - x-fern-audiences: ['public'] - minItems: 0 - items: - $ref: './ChatSearchResult.yaml' - documents: - description: | - Documents fetched from searches or provided by the user. - type: array - x-fern-audiences: ['public'] - minItems: 0 - items: - $ref: './ChatDocument.yaml' diff --git a/fern/openapi/types/ChatStreamEndEvent.yaml b/fern/openapi/types/ChatStreamEndEvent.yaml deleted file mode 100644 index b8f2f623..00000000 --- a/fern/openapi/types/ChatStreamEndEvent.yaml +++ /dev/null @@ -1,27 +0,0 @@ -allOf: - - $ref: './ChatStreamEvent.yaml' - - type: object - required: - - finish_reason - - response - properties: - finish_reason: - description: | - - `COMPLETE` - the model sent back a finished reply - - `ERROR_LIMIT` - the reply was cut off because the model reached the maximum number of tokens for its context length - - `MAX_TOKENS` - the reply was cut off because the model reached the maximum number of tokens specified by the max_tokens parameter - - `ERROR` - something went wrong when generating the reply - - `ERROR_TOXIC` - the model generated a reply that was deemed toxic - type: string - x-fern-audiences: ['public'] - enum: - - 'COMPLETE' - - 'ERROR_LIMIT' - - 'MAX_TOKENS' - - 'ERROR' - - 'ERROR_TOXIC' - response: - x-fern-audiences: ['public'] - description: | - The consolidated response from the model. Contains the generated reply and all the other information streamed back in the previous events. - $ref: './NonStreamedChatResponse.yaml' diff --git a/fern/openapi/types/ChatStreamEvent.yaml b/fern/openapi/types/ChatStreamEvent.yaml deleted file mode 100644 index 5b3fd55c..00000000 --- a/fern/openapi/types/ChatStreamEvent.yaml +++ /dev/null @@ -1,13 +0,0 @@ -required: - - event_type -properties: - event_type: - type: string - x-fern-audiences: ['public'] - enum: - - 'stream-start' - - 'search-queries-generation' - - 'search-results' - - 'text-generation' - - 'citation-generation' - - 'stream-end' diff --git a/fern/openapi/types/ChatStreamStartEvent.yaml b/fern/openapi/types/ChatStreamStartEvent.yaml deleted file mode 100644 index 2b5b62b8..00000000 --- a/fern/openapi/types/ChatStreamStartEvent.yaml +++ /dev/null @@ -1,13 +0,0 @@ -allOf: - - $ref: './ChatStreamEvent.yaml' - - type: object - required: - - generation_id - properties: - generation_id: - description: | - Unique identifier for the generated reply. Useful for submitting feedback. - type: string - x-fern-audiences: ['public'] - format: uuid - minLength: 1 diff --git a/fern/openapi/types/ChatTextGenerationEvent.yaml b/fern/openapi/types/ChatTextGenerationEvent.yaml deleted file mode 100644 index ec9d26e3..00000000 --- a/fern/openapi/types/ChatTextGenerationEvent.yaml +++ /dev/null @@ -1,12 +0,0 @@ -allOf: - - $ref: './ChatStreamEvent.yaml' - - type: object - required: - - text - properties: - text: - description: | - The next batch of text generated by the model. - type: string - x-fern-audiences: ['public'] - minLength: 1 diff --git a/fern/openapi/types/ChatToolCallsChunkEvent.yaml b/fern/openapi/types/ChatToolCallsChunkEvent.yaml deleted file mode 100644 index 1940e28e..00000000 --- a/fern/openapi/types/ChatToolCallsChunkEvent.yaml +++ /dev/null @@ -1,9 +0,0 @@ -allOf: - - $ref: './ChatStreamEvent.yaml' - - type: object - required: - - tool_call_delta - properties: - tool_call_delta: - $ref: './ToolCallDelta.yaml' - x-fern-audiences: ['public'] \ No newline at end of file diff --git a/fern/openapi/types/ChatToolCallsGenerationEvent.yaml b/fern/openapi/types/ChatToolCallsGenerationEvent.yaml deleted file mode 100644 index b725e0d0..00000000 --- a/fern/openapi/types/ChatToolCallsGenerationEvent.yaml +++ /dev/null @@ -1,16 +0,0 @@ -allOf: - - $ref: './ChatStreamEvent.yaml' - - type: object - required: - - tool_calls - properties: - text: - description: | - The text generated related to the tool calls generated - type: string - x-fern-audiences: ['public'] - tool_calls: - x-fern-audiences: ['public'] - type: array - items: - $ref: './ToolCall.yaml' diff --git a/fern/openapi/types/ChatToolInputsGenerationEvent.yaml b/fern/openapi/types/ChatToolInputsGenerationEvent.yaml deleted file mode 100644 index 7e2a156e..00000000 --- a/fern/openapi/types/ChatToolInputsGenerationEvent.yaml +++ /dev/null @@ -1,11 +0,0 @@ -x-internal: true -allOf: - - $ref: './ChatStreamEvent.yaml' - - type: object - required: - - tool_calls - properties: - tool_calls: - type: array - items: - $ref: './ToolCall.yaml' diff --git a/fern/openapi/types/ClassifyDataMetrics.yaml b/fern/openapi/types/ClassifyDataMetrics.yaml deleted file mode 100644 index 8eb6613d..00000000 --- a/fern/openapi/types/ClassifyDataMetrics.yaml +++ /dev/null @@ -1,6 +0,0 @@ -type: object -properties: - label_metrics: - type: array - items: - $ref: './LabelMetric.yaml' diff --git a/fern/openapi/types/ClassifyExample.yaml b/fern/openapi/types/ClassifyExample.yaml deleted file mode 100644 index 13bb6db2..00000000 --- a/fern/openapi/types/ClassifyExample.yaml +++ /dev/null @@ -1,11 +0,0 @@ -type: object -properties: - text: - type: string - x-fern-audiences: ['public'] - writeOnly: true - label: - type: string - x-fern-audiences: ['public'] - writeOnly: true -writeOnly: true diff --git a/fern/openapi/types/Cluster.yaml b/fern/openapi/types/Cluster.yaml deleted file mode 100644 index 73c7bbae..00000000 --- a/fern/openapi/types/Cluster.yaml +++ /dev/null @@ -1,23 +0,0 @@ -type: object -properties: - id: - type: string - x-fern-audiences: ['public'] - keywords: - type: array - x-fern-audiences: ['public'] - items: - type: string - x-fern-audiences: ['public'] - description: - type: string - x-fern-audiences: ['public'] - size: - type: integer - x-fern-audiences: ['public'] - sample_elements: - type: array - x-fern-audiences: ['public'] - items: - type: string - x-fern-audiences: ['public'] diff --git a/fern/openapi/types/CompatibleEndpoint.yaml b/fern/openapi/types/CompatibleEndpoint.yaml deleted file mode 100644 index 2e47b49e..00000000 --- a/fern/openapi/types/CompatibleEndpoint.yaml +++ /dev/null @@ -1,10 +0,0 @@ -type: string -description: One of the Cohere API endpoints that the model can be used with. -enum: - - chat - - embed - - classify - - summarize - - rerank - - rate - - generate diff --git a/fern/openapi/types/Connector.yaml b/fern/openapi/types/Connector.yaml deleted file mode 100644 index b5134bfc..00000000 --- a/fern/openapi/types/Connector.yaml +++ /dev/null @@ -1,73 +0,0 @@ -description: |- - A connector allows you to integrate data sources with the '/chat' endpoint to create grounded generations with citations to the data source. - documents to help answer users. -type: object -required: - - id - - name - - created_at - - updated_at -properties: - id: - type: string - x-fern-audiences: ['public'] - description: |- - The unique identifier of the connector (used in both `/connectors` & `/chat` endpoints). - This is automatically created from the name of the connector upon registration. - organization_id: - type: string - x-fern-audiences: ['public'] - description: |- - The organization to which this connector belongs. This is automatically set to - the organization of the user who created the connector. - name: - type: string - x-fern-audiences: ['public'] - description: A human-readable name for the connector. - description: - type: string - x-fern-audiences: ['public'] - description: A description of the connector. - url: - type: string - x-fern-audiences: ['public'] - description: The URL of the connector that will be used to search for documents. - created_at: - type: string - x-fern-audiences: ['public'] - format: date-time - description: The UTC time at which the connector was created. - updated_at: - type: string - x-fern-audiences: ['public'] - format: date-time - description: The UTC time at which the connector was last updated. - excludes: - description: A list of fields to exclude from the prompt (fields remain in the document). - type: array - x-fern-audiences: ['public'] - items: - type: string - x-fern-audiences: ['public'] - auth_type: - description: 'The type of authentication/authorization used by the connector. Possible values: [oauth, service_auth]' - type: string - x-fern-audiences: ['public'] - format: enum - oauth: - $ref: './ConnectorOAuth.yaml' - x-fern-audiences: ['public'] - description: The OAuth 2.0 configuration for the connector. - auth_status: - type: string - x-fern-audiences: ['public'] - enum: [valid, expired] - description: The OAuth status for the user making the request. One of ["valid", "expired", ""]. Empty string (field is omitted) means the user has not authorized the connector yet. - active: - type: boolean - x-fern-audiences: ['public'] - description: Whether the connector is active or not. - continue_on_failure: - type: boolean - x-fern-audiences: ['public'] - description: Whether a chat request should continue or not if the request to this connector fails. diff --git a/fern/openapi/types/ConnectorLog.yaml b/fern/openapi/types/ConnectorLog.yaml deleted file mode 100644 index efde6303..00000000 --- a/fern/openapi/types/ConnectorLog.yaml +++ /dev/null @@ -1,40 +0,0 @@ -type: object -required: - - id - - connector_id - - request_id - - user_id - - organization_id - - created_at - - status_code - - duration_millis -properties: - id: - type: string - description: Unique identifier for the connector log - connector_id: - type: string - description: Unique identifier for the connector - request_id: - type: string - description: Unique identifier for the request - user_id: - type: string - description: Unique identifier for the user - organization_id: - type: string - description: Unique identifier for the organization - created_at: - type: string - description: Time of connector log creation in RFC3339 format - format: date-time - example: '2023-04-28T21:00:56.646257Z' - status_code: - type: integer - description: HTTP status code of the request - duration_millis: - type: integer - description: Duration of the request in milliseconds - error_message: - type: string - description: Error message of the request diff --git a/fern/openapi/types/ConnectorOAuth.yaml b/fern/openapi/types/ConnectorOAuth.yaml deleted file mode 100644 index 1ebcd23e..00000000 --- a/fern/openapi/types/ConnectorOAuth.yaml +++ /dev/null @@ -1,25 +0,0 @@ -type: object -required: - - authorize_url - - token_url -properties: - client_id: - type: string - x-fern-audiences: ['public'] - description: The OAuth 2.0 client ID. This field is encrypted at rest. - client_secret: - type: string - x-fern-audiences: ['public'] - description: The OAuth 2.0 client Secret. This field is encrypted at rest and never returned in a response. - authorize_url: - type: string - x-fern-audiences: ['public'] - description: The OAuth 2.0 /authorize endpoint to use when users authorize the connector. - token_url: - type: string - x-fern-audiences: ['public'] - description: The OAuth 2.0 /token endpoint to use when users authorize the connector. - scope: - type: string - x-fern-audiences: ['public'] - description: The OAuth scopes to request when users authorize the connector. diff --git a/fern/openapi/types/CreateClusterJobRequest.yaml b/fern/openapi/types/CreateClusterJobRequest.yaml deleted file mode 100644 index c6ed5b61..00000000 --- a/fern/openapi/types/CreateClusterJobRequest.yaml +++ /dev/null @@ -1,31 +0,0 @@ -type: object -required: - - embeddings_url -properties: - embeddings_url: - type: string - x-fern-audiences: ['public'] - input_dataset_id: - type: string - x-fern-audiences: ['public'] - min_cluster_size: - type: integer - x-fern-audiences: ['public'] - description: 'Defaults to `10`. Parameter for HDBSCAN. Only clusters with this number of elements will be returned with a positive cluster number.' - default: 10 - minimum: 1 - n_neighbors: - type: integer - x-fern-audiences: ['public'] - description: 'Parameter for UMAP. A scalar governing how to balance global vs local structure in the data.' - minimum: 2 - maximum: 100 - default: 15 - is_deterministic: - type: boolean - x-fern-audiences: ['public'] - description: 'Parameter for UMAP. A boolean governing whether the embeddings from UMAP (that will be clustered with HDBSCAN) are deterministic.' - default: true - generate_descriptions: - type: boolean - x-fern-audiences: ['public'] diff --git a/fern/openapi/types/CreateClusterJobResponse.yaml b/fern/openapi/types/CreateClusterJobResponse.yaml deleted file mode 100644 index 6f7cdb3b..00000000 --- a/fern/openapi/types/CreateClusterJobResponse.yaml +++ /dev/null @@ -1,8 +0,0 @@ -type: object -required: - - job_id -properties: - job_id: - type: string - x-fern-audiences: ['public'] -description: Response for creating a cluster job. diff --git a/fern/openapi/types/CreateConnectorOAuth.yaml b/fern/openapi/types/CreateConnectorOAuth.yaml deleted file mode 100644 index 1d91bb07..00000000 --- a/fern/openapi/types/CreateConnectorOAuth.yaml +++ /dev/null @@ -1,23 +0,0 @@ -required: ['clientId', 'clientSecret', 'authorizeUrl', 'tokenUrl'] -type: object -properties: - client_id: - type: string - x-fern-audiences: ['public'] - description: The OAuth 2.0 client ID. This fields is encrypted at rest. - client_secret: - type: string - x-fern-audiences: ['public'] - description: The OAuth 2.0 client Secret. This field is encrypted at rest and never returned in a response. - authorize_url: - type: string - x-fern-audiences: ['public'] - description: The OAuth 2.0 /authorize endpoint to use when users authorize the connector. - token_url: - type: string - x-fern-audiences: ['public'] - description: The OAuth 2.0 /token endpoint to use when users authorize the connector. - scope: - type: string - x-fern-audiences: ['public'] - description: The OAuth scopes to request when users authorize the connector. diff --git a/fern/openapi/types/CreateConnectorRequest.yaml b/fern/openapi/types/CreateConnectorRequest.yaml deleted file mode 100644 index fb4692e7..00000000 --- a/fern/openapi/types/CreateConnectorRequest.yaml +++ /dev/null @@ -1,42 +0,0 @@ -type: object -required: - - name - - url -properties: - name: - type: string - x-fern-audiences: ['public'] - description: A human-readable name for the connector. - description: - type: string - x-fern-audiences: ['public'] - description: A description of the connector. - url: - type: string - x-fern-audiences: ['public'] - description: The URL of the connector that will be used to search for documents. - excludes: - description: A list of fields to exclude from the prompt (fields remain in the document). - type: array - x-fern-audiences: ['public'] - items: - type: string - x-fern-audiences: ['public'] - oauth: - $ref: './CreateConnectorOAuth.yaml' - x-fern-audiences: ['public'] - description: The OAuth 2.0 configuration for the connector. Cannot be specified if service_auth is specified. - active: - type: boolean - x-fern-audiences: ['public'] - default: true - description: Whether the connector is active or not. - continue_on_failure: - type: boolean - x-fern-audiences: ['public'] - default: false - description: Whether a chat request should continue or not if the request to this connector fails. - service_auth: - x-fern-audiences: ['public'] - $ref: './CreateConnectorServiceAuth.yaml' - description: The service to service authentication configuration for the connector. Cannot be specified if oauth is specified. diff --git a/fern/openapi/types/CreateConnectorResponse.yaml b/fern/openapi/types/CreateConnectorResponse.yaml deleted file mode 100644 index 1103d248..00000000 --- a/fern/openapi/types/CreateConnectorResponse.yaml +++ /dev/null @@ -1,6 +0,0 @@ -type: object -required: - - connector -properties: - connector: - $ref: './Connector.yaml' diff --git a/fern/openapi/types/CreateConnectorServiceAuth.yaml b/fern/openapi/types/CreateConnectorServiceAuth.yaml deleted file mode 100644 index 15f74573..00000000 --- a/fern/openapi/types/CreateConnectorServiceAuth.yaml +++ /dev/null @@ -1,10 +0,0 @@ -required: ['type', 'token'] -type: object -properties: - type: - x-fern-audiences: ['public'] - $ref: './AuthTokenType.yaml' - token: - type: string - x-fern-audiences: ['public'] - description: The token that will be used in the HTTP Authorization header when making requests to the connector. This field is encrypted at rest and never returned in a response. diff --git a/fern/openapi/types/CreateEmbedJobRequest.yaml b/fern/openapi/types/CreateEmbedJobRequest.yaml deleted file mode 100644 index 2e62ff7b..00000000 --- a/fern/openapi/types/CreateEmbedJobRequest.yaml +++ /dev/null @@ -1,54 +0,0 @@ -type: object -required: - - model - - dataset_id - - input_type -properties: - model: - type: string - x-fern-audiences: ['public'] - format: string - description: | - ID of the embedding model. - - Available models and corresponding embedding dimensions: - - - `embed-english-v3.0` : 1024 - - `embed-multilingual-v3.0` : 1024 - - `embed-english-light-v3.0` : 384 - - `embed-multilingual-light-v3.0` : 384 - dataset_id: - type: string - x-fern-audiences: ['public'] - description: ID of a [Dataset](/docs/datasets). The Dataset must be of type `embed-input` and must have a validation status `Validated` - input_type: - x-fern-audiences: ['public'] - $ref: './EmbedInputType.yaml' - name: - type: string - x-fern-audiences: ['public'] - description: The name of the embed job. - embedding_types: - type: array - x-fern-audiences: ['public'] - items: - $ref: './EmbeddingType.yaml' - description: |- - Specifies the types of embeddings you want to get back. Not required and default is None, which returns the Embed Floats response type. Can be one or more of the following types. - - * `"float"`: Use this when you want to get back the default float embeddings. Valid for all models. - * `"int8"`: Use this when you want to get back signed int8 embeddings. Valid for only v3 models. - * `"uint8"`: Use this when you want to get back unsigned int8 embeddings. Valid for only v3 models. - * `"binary"`: Use this when you want to get back signed binary embeddings. Valid for only v3 models. - * `"ubinary"`: Use this when you want to get back unsigned binary embeddings. Valid for only v3 models. - truncate: - type: string - x-fern-audiences: ['public'] - description: | - One of `START|END` to specify how the API will handle inputs longer than the maximum token length. - - Passing `START` will discard the start of the input. `END` will discard the end of the input. In both cases, input is discarded until the remaining input is exactly the maximum input token length for the model. - default: END - enum: - - START - - END diff --git a/fern/openapi/types/CreateEmbedJobResponse.yaml b/fern/openapi/types/CreateEmbedJobResponse.yaml deleted file mode 100644 index b30e3643..00000000 --- a/fern/openapi/types/CreateEmbedJobResponse.yaml +++ /dev/null @@ -1,11 +0,0 @@ -type: object -required: - - job_id -description: Response from creating an embed job. -properties: - job_id: - type: string - x-fern-audiences: ['public'] - meta: - $ref: './ApiMeta.yaml' - x-fern-audiences: ['public'] diff --git a/fern/openapi/types/CreateRequest.yaml b/fern/openapi/types/CreateRequest.yaml deleted file mode 100644 index 8a8f2696..00000000 --- a/fern/openapi/types/CreateRequest.yaml +++ /dev/null @@ -1,41 +0,0 @@ -type: object -required: - - name - - url -properties: - name: - type: string - x-fern-audiences: [ "public" ] - description: A human-readable name for the connector. - description: - type: string - x-fern-audiences: [ "public" ] - description: A description of the connector. - url: - type: string - x-fern-audiences: [ "public" ] - description: The URL of the connector that will be used to search for documents. - excludes: - description: A list of fields to exclude from the prompt (fields remain in the document). - type: array - x-fern-audiences: [ "public" ] - items: - type: string - x-fern-audiences: [ "public" ] - oauth: - $ref: './CreateConnectorOAuth.yaml' - x-fern-audiences: [ "public" ] - description: The OAuth 2.0 configuration for the connector. Cannot be specified if service_auth is specified. - active: - type: boolean - x-fern-audiences: [ "public" ] - default: true - description: Whether the connector is active or not. - continue_on_failure: - type: boolean - x-fern-audiences: [ "public" ] - default: false - description: Whether a chat request should continue or not if the request to this connector fails. - service_auth: - $ref: './CreateConnectorServiceAuth.yaml' - description: The service to service authentication configuration for the connector. Cannot be specified if oauth is specified. diff --git a/fern/openapi/types/CreateResponse.yaml b/fern/openapi/types/CreateResponse.yaml deleted file mode 100644 index dd3745d5..00000000 --- a/fern/openapi/types/CreateResponse.yaml +++ /dev/null @@ -1,6 +0,0 @@ -type: object -required: - - connector -properties: - connector: - $ref: './Connector.yaml' diff --git a/fern/openapi/types/Dataset.yaml b/fern/openapi/types/Dataset.yaml deleted file mode 100644 index 34798519..00000000 --- a/fern/openapi/types/Dataset.yaml +++ /dev/null @@ -1,70 +0,0 @@ -type: object -required: - - id - - name - - created_at - - updated_at - - dataset_type - - validation_status -properties: - id: - type: string - x-fern-audiences: ['public'] - description: The dataset ID - name: - type: string - x-fern-audiences: ['public'] - description: The name of the dataset - created_at: - type: string - x-fern-audiences: ['public'] - format: date-time - description: The creation date - updated_at: - type: string - x-fern-audiences: ['public'] - format: date-time - description: The last update date - dataset_type: - x-fern-audiences: ['public'] - $ref: './DatasetType.yaml' - validation_status: - x-fern-audiences: ['public'] - $ref: './DatasetValidationStatus.yaml' - validation_error: - type: string - x-fern-audiences: ['public'] - description: Errors found during validation - schema: - type: string - x-fern-audiences: ['public'] - description: the avro schema of the dataset - required_fields: - type: array - x-fern-audiences: ['public'] - items: - type: string - x-fern-audiences: ['public'] - preserve_fields: - type: array - x-fern-audiences: ['public'] - items: - type: string - x-fern-audiences: ['public'] - dataset_parts: - type: array - x-fern-audiences: ['public'] - items: - $ref: './DatasetPart.yaml' - description: the underlying files that make up the dataset - validation_warnings: - type: array - x-fern-audiences: ['public'] - items: - type: string - x-fern-audiences: ['public'] - description: warnings found during validation - parse_info: - $ref: './ParseInfo.yaml' - metrics: - $ref: './Metrics.yaml' diff --git a/fern/openapi/types/DatasetPart.yaml b/fern/openapi/types/DatasetPart.yaml deleted file mode 100644 index 4110d5e6..00000000 --- a/fern/openapi/types/DatasetPart.yaml +++ /dev/null @@ -1,43 +0,0 @@ -type: object -required: - - id - - name -properties: - id: - type: string - x-fern-audiences: ['public'] - description: The dataset part ID - name: - type: string - x-fern-audiences: ['public'] - description: The name of the dataset part - url: - type: string - x-fern-audiences: ['public'] - description: The download url of the file - index: - type: integer - x-fern-audiences: ['public'] - format: int32 - description: The index of the file - size_bytes: - type: integer - x-fern-audiences: ['public'] - format: int32 - description: The size of the file in bytes - num_rows: - type: integer - x-fern-audiences: ['public'] - format: int32 - description: The number of rows in the file - original_url: - type: string - x-fern-audiences: ['public'] - description: The download url of the original file - samples: - type: array - x-fern-audiences: ['public'] - items: - type: string - x-fern-audiences: ['public'] - description: The first few rows of the parsed file diff --git a/fern/openapi/types/DatasetType.yaml b/fern/openapi/types/DatasetType.yaml deleted file mode 100644 index 094f90a0..00000000 --- a/fern/openapi/types/DatasetType.yaml +++ /dev/null @@ -1,12 +0,0 @@ -x-fern-audiences: ['public'] -description: The type of the dataset -type: string -enum: - - embed-input - - embed-result - - cluster-result - - cluster-outliers - - reranker-finetune-input - - single-label-classification-finetune-input - - chat-finetune-input - - multi-label-classification-finetune-input diff --git a/fern/openapi/types/DatasetValidationStatus.yaml b/fern/openapi/types/DatasetValidationStatus.yaml deleted file mode 100644 index fc04421d..00000000 --- a/fern/openapi/types/DatasetValidationStatus.yaml +++ /dev/null @@ -1,10 +0,0 @@ -x-fern-audiences: ['public'] -description: The validation status of the dataset -type: string -enum: - - 'unknown' - - 'queued' - - 'processing' - - 'failed' - - 'validated' - - 'skipped' diff --git a/fern/openapi/types/DeleteConnectorResponse.yaml b/fern/openapi/types/DeleteConnectorResponse.yaml deleted file mode 100644 index 91bf3091..00000000 --- a/fern/openapi/types/DeleteConnectorResponse.yaml +++ /dev/null @@ -1 +0,0 @@ -type: object diff --git a/fern/openapi/types/DeleteResponse.yaml b/fern/openapi/types/DeleteResponse.yaml deleted file mode 100644 index 91bf3091..00000000 --- a/fern/openapi/types/DeleteResponse.yaml +++ /dev/null @@ -1 +0,0 @@ -type: object diff --git a/fern/openapi/types/EmbedByTypeResponse.yaml b/fern/openapi/types/EmbedByTypeResponse.yaml deleted file mode 100644 index e13dfcae..00000000 --- a/fern/openapi/types/EmbedByTypeResponse.yaml +++ /dev/null @@ -1,1263 +0,0 @@ -type: object -required: - - id - - embeddings - - texts - - api_version -properties: - response_type: - type: string - x-fern-audiences: ['public'] - enum: - - embeddings_floats - - embeddings_by_type - id: - type: string - x-fern-audiences: ['public'] - embeddings: - type: object - x-fern-audiences: ['public'] - description: 'An object with different embedding types. The length of each embedding type array will be the same as the length of the original `texts` array.' - properties: - float: - type: array - x-fern-audiences: ['public'] - description: 'An array of float embeddings.' - items: - type: array - x-fern-audiences: ['public'] - items: - type: number - x-fern-audiences: ['public'] - readOnly: true - readOnly: true - int8: - type: array - x-fern-audiences: ['public'] - description: 'An array of signed int8 embeddings. Each value is between -128 and 127.' - items: - type: array - x-fern-audiences: ['public'] - items: - type: integer - x-fern-audiences: ['public'] - readOnly: true - readOnly: true - uint8: - type: array - x-fern-audiences: ['public'] - description: 'An array of unsigned int8 embeddings. Each value is between 0 and 255.' - items: - type: array - x-fern-audiences: ['public'] - items: - type: integer - x-fern-audiences: ['public'] - readOnly: true - readOnly: true - binary: - type: array - x-fern-audiences: ['public'] - description: 'An array of packed signed binary embeddings. The length of each binary embedding is 1/8 the length of the float embeddings of the provided model. Each value is between -128 and 127.' - items: - type: array - x-fern-audiences: ['public'] - items: - type: integer - x-fern-audiences: ['public'] - readOnly: true - readOnly: true - ubinary: - type: array - x-fern-audiences: ['public'] - description: 'An array of packed unsigned binary embeddings. The length of each binary embedding is 1/8 the length of the float embeddings of the provided model. Each value is between 0 and 255.' - items: - type: array - x-fern-audiences: ['public'] - items: - type: integer - x-fern-audiences: ['public'] - readOnly: true - items: - type: array - x-fern-audiences: ['public'] - items: - type: number - x-fern-audiences: ['public'] - readOnly: true - readOnly: true - texts: - type: array - x-fern-audiences: ['public'] - description: The text entries for which embeddings were returned. - items: - type: string - x-fern-audiences: ['public'] - meta: - $ref: './ApiMeta.yaml' - x-fern-audiences: ['public'] -x-examples: - Example: - value: - id: bc57846a-3e56-4327-8acc-588ca1a37b8a - texts: - - hello world - embeddings: - float: - - - -0.039520264 - - -0.04574585 - - -0.08807373 - - -0.084106445 - - -0.009742737 - - -0.0090408325 - - -0.048187256 - - 0.07128906 - - 0.010688782 - - 0.016067505 - - -0.02822876 - - 0.036224365 - - 0.037994385 - - -0.041992188 - - 0.052124023 - - -0.027297974 - - 0.048309326 - - 0.017410278 - - 0.004283905 - - -0.0058555603 - - -0.012992859 - - 0.023040771 - - 0.00121212 - - 0.02078247 - - 0.04827881 - - -0.021530151 - - 0.017807007 - - 0.0075531006 - - -0.047912598 - - -0.042633057 - - 0.0016927719 - - 0.04547119 - - 0.0143585205 - - 0.022354126 - - 0.0017910004 - - 0.048614502 - - -0.02609253 - - 0.007850647 - - 0.00907135 - - 0.0035381317 - - 0.015289307 - - -0.008132935 - - 0.016296387 - - -0.02859497 - - -0.023712158 - - 0.008857727 - - -0.04309082 - - -0.025115967 - - 0.032928467 - - -0.029663086 - - 0.00434494 - - -0.022338867 - - -0.004371643 - - -0.0075035095 - - -0.009529114 - - 0.0038223267 - - -0.06048584 - - -0.018127441 - - 0.010131836 - - 0.08380127 - - 0.03652954 - - 0.0030384064 - - 0.006034851 - - -0.006286621 - - 0.016784668 - - -0.00308609 - - 0.01612854 - - 0.011413574 - - 0.022491455 - - 0.02482605 - - 0.0047683716 - - 0.012245178 - - -0.017593384 - - -0.023254395 - - -0.012641907 - - 0.030181885 - - -0.015365601 - - 0.031021118 - - 0.015144348 - - 0.016708374 - - 0.02180481 - - 0.010765076 - - -0.015586853 - - -0.05819702 - - 0.02128601 - - -0.021713257 - - -0.013320923 - - -0.0064849854 - - -0.001657486 - - -0.030715942 - - -0.008666992 - - 0.060668945 - - -0.0011959076 - - -0.032104492 - - -0.057006836 - - -0.015655518 - - -0.014015198 - - 0.036987305 - - 0.011016846 - - 0.037475586 - - -0.015319824 - - -0.016479492 - - 0.0030403137 - - -0.028167725 - - -0.0067825317 - - -0.00894928 - - -0.026107788 - - 0.010231018 - - 0.031707764 - - 0.050354004 - - -0.016220093 - - 0.04345703 - - -0.008888245 - - -0.0037784576 - - -0.034576416 - - 0.002565384 - - -0.0018634796 - - 0.013954163 - - 0.012062073 - - 0.046813965 - - 0.033081055 - - 0.028778076 - - 0.0051231384 - - 0.022094727 - - -0.021881104 - - -0.009788513 - - -0.04647827 - - -0.025482178 - - 0.066833496 - - -0.040863037 - - -0.019714355 - - 0.06866455 - - -0.07519531 - - -0.045532227 - - -0.020507812 - - 0.021331787 - - 0.036376953 - - -0.034210205 - - 0.017669678 - - 0.0155181885 - - 0.047698975 - - -0.010368347 - - 0.010879517 - - 0.016555786 - - -0.028076172 - - 0.03225708 - - -0.0056152344 - - -0.020690918 - - 0.00011438131 - - -0.021011353 - - -0.04425049 - - -0.029922485 - - -0.0014362335 - - 0.013618469 - - 0.011260986 - - 0.017532349 - - -0.043426514 - - 0.012557983 - - 0.026748657 - - 0.039154053 - - -0.030944824 - - 0.024169922 - - 0.06573486 - - -0.03817749 - - -0.025314331 - - -0.039794922 - - -0.050445557 - - -0.0020828247 - - -0.0010194778 - - 0.01725769 - - 0.0017976761 - - 0.029067993 - - 0.0115356445 - - 0.005214691 - - 0.0066604614 - - -0.014801025 - - -0.033172607 - - 0.023956299 - - 0.008865356 - - 0.09539795 - - 0.062286377 - - -0.0076408386 - - -0.035125732 - - 0.09082031 - - -0.015350342 - - -0.015625 - - -0.0090789795 - - -0.01876831 - - 0.05239868 - - -0.010406494 - - 0.05078125 - - -0.013694763 - - -0.07244873 - - 0.018539429 - - -0.016983032 - - -0.03353882 - - 0.01739502 - - 0.004055023 - - -0.010147095 - - -0.0027599335 - - -0.002714157 - - -0.0107040405 - - 0.021438599 - - -0.029525757 - - 0.01902771 - - -0.025909424 - - 0.0008072853 - - 0.026672363 - - 0.0019044876 - - 0.016937256 - - -0.018814087 - - -0.03668213 - - 0.03338623 - - -0.09240723 - - -0.024765015 - - -0.019378662 - - -0.051757812 - - 0.050109863 - - 0.018859863 - - 0.01687622 - - 0.020111084 - - -0.041534424 - - 0.009559631 - - -0.018859863 - - 5.853176e-05 - - 0.032684326 - - -0.04058838 - - 0.015823364 - - -0.038635254 - - 0.0055656433 - - -0.021560669 - - 0.012481689 - - -0.050872803 - - -0.036071777 - - -0.046844482 - - -0.041900635 - - -0.06561279 - - 0.014785767 - - 0.010124207 - - 0.030426025 - - 0.024261475 - - 0.0057411194 - - -0.026275635 - - -0.006919861 - - 0.022750854 - - -0.015167236 - - 0.022964478 - - -0.0033664703 - - 0.02734375 - - 0.03201294 - - 0.025939941 - - 0.019104004 - - 0.028030396 - - -0.014328003 - - -0.01574707 - - 0.06982422 - - -0.008026123 - - 0.006816864 - - -0.0019035339 - - 0.026245117 - - -0.028945923 - - 0.014968872 - - 0.0054244995 - - -0.00028896332 - - -0.02243042 - - -0.0030822754 - - -0.02558899 - - -0.022918701 - - -0.017089844 - - -0.0035190582 - - 0.029953003 - - -0.037078857 - - -0.02507019 - - -0.017303467 - - 0.064331055 - - -0.028533936 - - -0.07287598 - - 0.028839111 - - -0.0029792786 - - -0.02104187 - - -0.01663208 - - -0.016571045 - - -0.015106201 - - 0.0027313232 - - 0.031051636 - - -0.025680542 - - 0.004722595 - - 0.032348633 - - 0.020019531 - - 0.056365967 - - 0.07208252 - - 0.01235199 - - 0.00084495544 - - 0.035369873 - - -0.018569946 - - -0.0063552856 - - 0.03161621 - - 0.064575195 - - -0.02557373 - - -0.007232666 - - -0.017700195 - - -0.003835678 - - 0.007381439 - - -0.0385437 - - -0.0019102097 - - -0.023223877 - - -0.0124435425 - - 0.013343811 - - 0.020996094 - - -0.014022827 - - -0.01939392 - - 0.044128418 - - 0.0052757263 - - -0.00068950653 - - -0.04876709 - - -0.05609131 - - -0.020874023 - - -0.00806427 - - -0.13391113 - - -0.06323242 - - -0.021865845 - - -0.021072388 - - 0.005832672 - - -0.015701294 - - -0.006286621 - - -0.012954712 - - -0.017288208 - - 0.0036773682 - - -0.0084991455 - - -0.03213501 - - 0.021987915 - - -0.010322571 - - -0.029144287 - - 0.003824234 - - 0.02708435 - - 0.0026187897 - - 0.05496216 - - -0.04916382 - - 0.005466461 - - -0.0070648193 - - 0.0793457 - - -0.040863037 - - 0.012641907 - - 0.016448975 - - 0.02041626 - - -0.029006958 - - -0.008491516 - - 0.0023422241 - - 0.043640137 - - 0.0121536255 - - -0.0043525696 - - -0.030899048 - - 0.0062332153 - - -0.013038635 - - 0.007904053 - - -0.03390503 - - -0.034729004 - - -0.0647583 - - -0.0052375793 - - -0.08154297 - - 0.015960693 - - 0.016235352 - - -0.012130737 - - -0.021469116 - - -0.03253174 - - -0.014465332 - - 0.016448975 - - 0.004589081 - - -0.05291748 - - 0.018005371 - - -0.002981186 - - -0.01247406 - - 0.023147583 - - -0.055419922 - - -0.08526611 - - 0.016723633 - - 0.012939453 - - -0.039031982 - - 0.016677856 - - 0.016937256 - - 0.023147583 - - 0.034576416 - - -0.010635376 - - 0.03466797 - - 0.037750244 - - 0.020141602 - - -0.0046539307 - - 0.0059432983 - - 0.05609131 - - 0.027709961 - - 0.01838684 - - 0.015022278 - - -0.039215088 - - -0.0048828125 - - 0.047546387 - - 0.0138549805 - - -0.046203613 - - 0.036193848 - - -0.109680176 - - 0.0019550323 - - -0.03125 - - 0.0084991455 - - -0.0020256042 - - -0.001739502 - - -0.06756592 - - 0.03491211 - - -0.05633545 - - -0.008491516 - - 0.0048446655 - - 0.042663574 - - 0.025054932 - - -0.022247314 - - -0.0044555664 - - 0.0022335052 - - -0.0071907043 - - -0.003982544 - - -0.073913574 - - -0.011253357 - - 0.029220581 - - -0.0047073364 - - -0.04626465 - - 0.05670166 - - -0.041503906 - - 0.014579773 - - -0.016174316 - - 0.021560669 - - -0.019332886 - - 0.01550293 - - 0.02709961 - - 0.010528564 - - 0.012786865 - - -0.023849487 - - -0.016937256 - - -0.04626465 - - -0.04397583 - - 0.026245117 - - -0.017868042 - - 0.021072388 - - -0.02128601 - - -0.012161255 - - -0.004776001 - - -0.0088272095 - - 0.009246826 - - -0.012313843 - - 0.0096206665 - - -0.0047950745 - - -0.0079956055 - - 0.052520752 - - -0.06616211 - - 0.0014686584 - - -0.046081543 - - 0.03289795 - - -0.03656006 - - 0.055389404 - - 0.009773254 - - 0.0013818741 - - 0.043823242 - - 0.034942627 - - 0.055236816 - - -0.011833191 - - -0.024353027 - - 0.011398315 - - -0.051574707 - - -0.019882202 - - 0.0018358231 - - -0.005859375 - - 0.06677246 - - -0.0009851456 - - -0.026809692 - - 0.0075798035 - - -0.021347046 - - -0.01146698 - - 0.03262329 - - 0.031585693 - - -0.006729126 - - 0.008659363 - - -0.025665283 - - 0.02947998 - - -0.03744507 - - 0.02027893 - - -0.026062012 - - 0.018585205 - - -0.004463196 - - -0.036865234 - - -0.043670654 - - 0.021392822 - - -0.062561035 - - -0.080078125 - - 0.011451721 - - 0.06762695 - - 0.039001465 - - -0.016799927 - - 0.049072266 - - 0.041412354 - - -0.03062439 - - 0.011795044 - - -0.016555786 - - 0.046569824 - - 0.010688782 - - -0.01902771 - - -0.031097412 - - -0.023391724 - - -0.01651001 - - 0.009399414 - - 0.049041748 - - -0.025817871 - - -0.018356323 - - 0.02154541 - - -0.0029411316 - - 0.074157715 - - 0.017059326 - - -0.0017595291 - - 0.00390625 - - 0.02645874 - - -0.0010709763 - - 0.040222168 - - -0.034423828 - - 0.0231781 - - -0.016693115 - - -0.022094727 - - 0.004383087 - - 0.007331848 - - 0.018676758 - - 0.023773193 - - -0.0069770813 - - 0.0029773712 - - -0.023712158 - - -0.0051956177 - - -0.011810303 - - -0.0519104 - - 0.07244873 - - 0.032409668 - - 0.016662598 - - 0.015716553 - - -0.03640747 - - 0.03918457 - - -0.046722412 - - -0.0046081543 - - 0.006061554 - - -0.011940002 - - -0.0004878044 - - 0.01260376 - - 0.0073280334 - - 0.0015096664 - - 0.005844116 - - 0.029129028 - - 0.047668457 - - 0.05960083 - - -0.0647583 - - 0.064697266 - - -0.017440796 - - -0.01889038 - - 0.037628174 - - 0.0048065186 - - -0.023101807 - - -0.048675537 - - -0.02508545 - - -0.007965088 - - 0.0015897751 - - 0.06866455 - - -0.0099487305 - - -0.0022964478 - - -0.030014038 - - -0.007713318 - - -0.034362793 - - 0.013931274 - - 0.0026836395 - - -0.0014476776 - - 0.02532959 - - -0.020584106 - - -0.039001465 - - -0.062347412 - - -0.04736328 - - -0.024368286 - - -0.045776367 - - 0.03149414 - - -0.012825012 - - 0.028076172 - - 0.0058784485 - - 0.08062744 - - 0.0104599 - - 0.014579773 - - -0.041137695 - - 0.04244995 - - -0.021011353 - - 0.06390381 - - 0.0010871887 - - 0.04147339 - - -0.0053138733 - - 0.02268982 - - -0.028182983 - - -0.022628784 - - -0.021408081 - - -0.006088257 - - 0.028030396 - - 0.025146484 - - 0.00881958 - - -0.04244995 - - 0.027938843 - - 0.013916016 - - -0.04647827 - - 0.0072288513 - - 0.017745972 - - -0.02381897 - - -0.010147095 - - 0.0096588135 - - -0.04586792 - - -0.014480591 - - -0.0027217865 - - -0.03111267 - - 0.04522705 - - -0.02772522 - - -0.0013189316 - - 0.017807007 - - -0.0135269165 - - -0.014175415 - - -0.00019681454 - - 0.03161621 - - 0.0041007996 - - -0.024871826 - - 0.0039367676 - - -0.026916504 - - 0.03237915 - - 0.007068634 - - 0.029647827 - - -0.0102005005 - - 0.0076675415 - - 0.0051078796 - - -0.008041382 - - -0.0062942505 - - 0.0010309219 - - 0.010543823 - - -0.010101318 - - -0.013496399 - - 0.00920105 - - 0.0546875 - - -0.02784729 - - -0.0056762695 - - -0.08679199 - - -0.050048828 - - 0.03378296 - - 0.010124207 - - 0.019058228 - - -0.037872314 - - -0.0063323975 - - 0.0014324188 - - -0.010002136 - - -0.015731812 - - -0.036071777 - - -0.0028915405 - - -0.0082092285 - - 0.0037841797 - - -0.020629883 - - 0.01725769 - - -0.026000977 - - 0.00012862682 - - 0.021621704 - - 0.07086182 - - -0.008049011 - - -0.012634277 - - -0.064941406 - - -0.0073013306 - - -0.02760315 - - -0.040649414 - - 0.02809143 - - 0.009849548 - - 0.0011720657 - - 0.059936523 - - -0.032806396 - - 0.06311035 - - 0.009536743 - - 0.014801025 - - 0.03390503 - - -0.002620697 - - -0.04650879 - - -0.015365601 - - 0.03741455 - - -0.0067443848 - - -0.008888245 - - -0.0013017654 - - -0.010154724 - - 0.0027217865 - - 0.016052246 - - 0.025100708 - - -0.030532837 - - 0.032318115 - - 0.014564514 - - -0.009109497 - - 0.009628296 - - -0.021438599 - - -0.049926758 - - -0.00088214874 - - -0.019638062 - - -0.020126343 - - 0.055847168 - - -0.006729126 - - -0.044921875 - - -0.01890564 - - -0.0026683807 - - 0.0038547516 - - 0.004600525 - - -0.013977051 - - 0.018341064 - - -0.05178833 - - 0.011054993 - - 0.019927979 - - 0.011436462 - - 0.010391235 - - -0.012680054 - - -0.017669678 - - 0.01928711 - - 0.025115967 - - -0.07757568 - - -0.030960083 - - 0.013137817 - - -0.066467285 - - -0.054473877 - - -0.04244995 - - -0.027526855 - - 0.02973938 - - -0.024017334 - - -0.03918457 - - 0.0154800415 - - -0.036315918 - - 0.015510559 - - -0.020385742 - - -0.0390625 - - -0.00137043 - - 0.0016002655 - - -0.010238647 - - 0.014656067 - - 0.029373169 - - -0.027023315 - - 0.0076141357 - - -0.001917839 - - 0.03451538 - - 0.004814148 - - 0.024887085 - - 0.036315918 - - -0.006500244 - - -0.070495605 - - -0.0071754456 - - 0.025863647 - - 0.022994995 - - 0.007217407 - - 0.032165527 - - 0.016830444 - - 0.02859497 - - -0.011123657 - - 0.020126343 - - -0.0014410019 - - 0.0021781921 - - 0.053619385 - - 0.015625 - - 0.017150879 - - -0.03326416 - - -0.04626465 - - 0.034332275 - - 0.07165527 - - -0.040740967 - - -0.06628418 - - -0.024291992 - - -0.0066871643 - - 0.065979004 - - 0.034851074 - - 0.07678223 - - 0.053009033 - - 0.0317688 - - -0.04019165 - - 0.030288696 - - 0.062347412 - - -0.011734009 - - 0.0024604797 - - 0.006095886 - - -0.0152282715 - - 0.056762695 - - 0.021270752 - - -0.011154175 - - -0.0143966675 - - 0.0057754517 - - -0.0003619194 - - 0.0053367615 - - -0.030639648 - - 0.0024776459 - - -0.031799316 - - -0.012710571 - - 0.048828125 - - 0.029632568 - - 0.013244629 - - 0.087890625 - - -0.01134491 - - 0.028656006 - - -0.014778137 - - 0.06695557 - - 0.026275635 - - -0.016113281 - - 0.018859863 - - -0.008239746 - - 0.024383545 - - -0.039154053 - - -0.006252289 - - 0.049224854 - - -0.04638672 - - 0.0031967163 - - -0.04849243 - - -0.04058838 - - 0.038757324 - - 0.00730896 - - -0.04345703 - - 0.04296875 - - -0.0024299622 - - -0.05670166 - - 0.019119263 - - -0.011802673 - - 0.038970947 - - -0.03366089 - - 0.03591919 - - -0.0009088516 - - 0.013259888 - - -0.07342529 - - 0.004299164 - - 0.0395813 - - 0.013420105 - - -0.004459381 - - -0.0084991455 - - 0.031982422 - - 0.018249512 - - -0.0038604736 - - -0.022323608 - - -0.013031006 - - 0.0513916 - - -0.007068634 - - -0.003545761 - - 0.010292053 - - -0.010322571 - - -0.0037841797 - - 0.043701172 - - -0.012672424 - - 0.013725281 - - 0.021575928 - - -0.03942871 - - -0.0105896 - - -0.01878357 - - -0.017623901 - - -0.03414917 - - 0.02142334 - - 0.026550293 - - -0.022903442 - - 0.008598328 - - 0.03100586 - - 0.049957275 - - 0.021438599 - - 0.016204834 - - -0.014129639 - - 0.0079193115 - - -0.004535675 - - 0.0010051727 - - -0.038208008 - - -0.014923096 - - -0.01436615 - - -0.009666443 - - 0.0006933212 - - 0.0132369995 - - 0.01486969 - - 0.028762817 - - 0.011329651 - - -0.042663574 - - 0.014961243 - - -0.018127441 - - -0.007232666 - - 0.008369446 - - 0.027557373 - - 0.006706238 - - -0.05038452 - - -0.023666382 - - -0.0072898865 - - -0.007865906 - - -0.008926392 - - -0.013137817 - - 0.08886719 - - 0.030929565 - - 0.021255493 - - -0.0020389557 - - -0.08337402 - - -0.020385742 - - 0.03866577 - - -0.020523071 - - 0.021881104 - - 0.005756378 - - 0.022003174 - - 0.021209717 - - -0.06161499 - - -0.020309448 - - -0.0057258606 - - -0.033813477 - - 0.0017337799 - - -0.052612305 - - 0.01461792 - - -0.017944336 - - 0.042816162 - - -0.053710938 - - -0.041259766 - - -0.014549255 - - 0.020843506 - - -0.019760132 - - 0.004890442 - - -0.0007162094 - - -0.009429932 - - -0.01966858 - - -0.014320374 - - 0.041259766 - - 0.00075244904 - - -0.0064430237 - - 0.028961182 - - -0.01876831 - - 0.0027942657 - - -0.051116943 - - 0.00093746185 - - 0.0037384033 - - -0.06982422 - - -0.0107040405 - - 0.030090332 - - -0.019104004 - - -0.016647339 - - -0.037475586 - - 0.0140686035 - - -0.051086426 - - -0.032409668 - - -0.011131287 - - -0.023620605 - - -0.04159546 - - -0.034851074 - - -0.064941406 - - -0.03451538 - - 0.0047416687 - - -0.04510498 - - 0.020477295 - - -0.03024292 - - -0.034179688 - - 0.058410645 - - 0.008514404 - - 0.0049858093 - - 0.02331543 - - 0.03704834 - - -0.017333984 - - 0.014389038 - - 0.013786316 - - 0.008583069 - - -0.009643555 - - 0.020095825 - - 0.013496399 - - -0.01991272 - - -0.0446167 - - 0.0075149536 - - 0.0071029663 - - 0.0446167 - - -0.03933716 - - 0.009902954 - - 0.011077881 - - 0.008781433 - - -0.001701355 - - 0.016235352 - - 0.01802063 - - -0.010765076 - - -0.03427124 - - 0.0112838745 - - -0.023208618 - - -0.009979248 - - -0.010696411 - - -0.023208618 - - -0.026748657 - - -0.02923584 - - 0.013801575 - - -0.050323486 - - -0.0059661865 - - -0.004837036 - - 0.01940918 - - 0.00018620491 - - 0.0016450882 - - 0.019012451 - - -0.048034668 - - 0.034423828 - - -0.033599854 - - 0.020126343 - - -0.04949951 - - 0.071899414 - - -0.06060791 - - -0.043395996 - - 0.012138367 - - 0.022476196 - - 0.029006958 - - 0.04550171 - - -0.03564453 - - -0.015090942 - - 0.055541992 - - 0.014884949 - - 0.020767212 - - -0.01071167 - - 0.046905518 - - 0.033813477 - - -0.04260254 - - -0.00094127655 - - 0.016708374 - - -0.0011367798 - - -0.030426025 - - -0.03427124 - - 0.01763916 - - -0.012634277 - - 0.030517578 - - -0.055480957 - - -0.054992676 - - 0.056274414 - - -0.0007033348 - - -0.058624268 - - 0.0061531067 - - -0.008613586 - - 0.016067505 - - 0.003376007 - - -0.01586914 - - -0.025146484 - - 0.008491516 - - 0.053222656 - - -0.02923584 - - 0.021408081 - ubinary: - - - 1 - - 218 - - 231 - - 179 - - 247 - - 164 - - 161 - - 62 - - 191 - - 23 - - 200 - - 16 - - 114 - - 29 - - 23 - - 240 - - 145 - - 187 - - 72 - - 119 - - 96 - - 126 - - 121 - - 10 - - 76 - - 43 - - 200 - - 122 - - 213 - - 7 - - 202 - - 249 - - 86 - - 2 - - 36 - - 27 - - 252 - - 194 - - 25 - - 128 - - 33 - - 39 - - 171 - - 156 - - 160 - - 195 - - 73 - - 189 - - 223 - - 53 - - 68 - - 228 - - 37 - - 94 - - 20 - - 41 - - 87 - - 228 - - 164 - - 213 - - 68 - - 237 - - 97 - - 150 - - 212 - - 244 - - 61 - - 39 - - 244 - - 195 - - 6 - - 129 - - 125 - - 116 - - 59 - - 100 - - 36 - - 107 - - 179 - - 48 - - 228 - - 21 - - 192 - - 247 - - 136 - - 118 - - 130 - - 26 - - 243 - - 33 - - 40 - - 181 - - 227 - - 245 - - 230 - - 31 - - 109 - - 149 - - 61 - - 106 - - 83 - - 74 - - 174 - - 98 - - 75 - - 6 - - 250 - - 135 - - 211 - - 129 - - 197 - - 225 - - 81 - - 67 - - 86 - - 68 - - 2 - - 159 - - 118 - - 119 - - 100 - - 8 - - 245 - - 79 - - 59 - - 34 - - 146 - - 205 - meta: - api_version: - version: '1' - api_version: 'v2' diff --git a/fern/openapi/types/EmbedFloatsResponse.yaml b/fern/openapi/types/EmbedFloatsResponse.yaml deleted file mode 100644 index 825cf902..00000000 --- a/fern/openapi/types/EmbedFloatsResponse.yaml +++ /dev/null @@ -1,1073 +0,0 @@ -type: object -required: - - id - - embeddings - - texts - - api_version -properties: - response_type: - type: string - x-fern-audiences: ['public'] - enum: - - embeddings_floats - - embeddings_by_type - id: - type: string - x-fern-audiences: ['public'] - embeddings: - type: array - x-fern-audiences: ['public'] - description: 'An array of embeddings, where each embedding is an array of floats. The length of the `embeddings` array will be the same as the length of the original `texts` array.' - items: - type: array - x-fern-audiences: ['public'] - items: - type: number - x-fern-audiences: ['public'] - readOnly: true - readOnly: true - texts: - type: array - x-fern-audiences: ['public'] - description: The text entries for which embeddings were returned. - items: - type: string - x-fern-audiences: ['public'] - meta: - $ref: './ApiMeta.yaml' - x-fern-audiences: ['public'] -x-examples: - Example: - value: - id: bc57846a-3e56-4327-8acc-588ca1a37b8a - texts: - - hello world - embeddings: - - - -0.039520264 - - -0.04574585 - - -0.08807373 - - -0.084106445 - - -0.009742737 - - -0.0090408325 - - -0.048187256 - - 0.07128906 - - 0.010688782 - - 0.016067505 - - -0.02822876 - - 0.036224365 - - 0.037994385 - - -0.041992188 - - 0.052124023 - - -0.027297974 - - 0.048309326 - - 0.017410278 - - 0.004283905 - - -0.0058555603 - - -0.012992859 - - 0.023040771 - - 0.00121212 - - 0.02078247 - - 0.04827881 - - -0.021530151 - - 0.017807007 - - 0.0075531006 - - -0.047912598 - - -0.042633057 - - 0.0016927719 - - 0.04547119 - - 0.0143585205 - - 0.022354126 - - 0.0017910004 - - 0.048614502 - - -0.02609253 - - 0.007850647 - - 0.00907135 - - 0.0035381317 - - 0.015289307 - - -0.008132935 - - 0.016296387 - - -0.02859497 - - -0.023712158 - - 0.008857727 - - -0.04309082 - - -0.025115967 - - 0.032928467 - - -0.029663086 - - 0.00434494 - - -0.022338867 - - -0.004371643 - - -0.0075035095 - - -0.009529114 - - 0.0038223267 - - -0.06048584 - - -0.018127441 - - 0.010131836 - - 0.08380127 - - 0.03652954 - - 0.0030384064 - - 0.006034851 - - -0.006286621 - - 0.016784668 - - -0.00308609 - - 0.01612854 - - 0.011413574 - - 0.022491455 - - 0.02482605 - - 0.0047683716 - - 0.012245178 - - -0.017593384 - - -0.023254395 - - -0.012641907 - - 0.030181885 - - -0.015365601 - - 0.031021118 - - 0.015144348 - - 0.016708374 - - 0.02180481 - - 0.010765076 - - -0.015586853 - - -0.05819702 - - 0.02128601 - - -0.021713257 - - -0.013320923 - - -0.0064849854 - - -0.001657486 - - -0.030715942 - - -0.008666992 - - 0.060668945 - - -0.0011959076 - - -0.032104492 - - -0.057006836 - - -0.015655518 - - -0.014015198 - - 0.036987305 - - 0.011016846 - - 0.037475586 - - -0.015319824 - - -0.016479492 - - 0.0030403137 - - -0.028167725 - - -0.0067825317 - - -0.00894928 - - -0.026107788 - - 0.010231018 - - 0.031707764 - - 0.050354004 - - -0.016220093 - - 0.04345703 - - -0.008888245 - - -0.0037784576 - - -0.034576416 - - 0.002565384 - - -0.0018634796 - - 0.013954163 - - 0.012062073 - - 0.046813965 - - 0.033081055 - - 0.028778076 - - 0.0051231384 - - 0.022094727 - - -0.021881104 - - -0.009788513 - - -0.04647827 - - -0.025482178 - - 0.066833496 - - -0.040863037 - - -0.019714355 - - 0.06866455 - - -0.07519531 - - -0.045532227 - - -0.020507812 - - 0.021331787 - - 0.036376953 - - -0.034210205 - - 0.017669678 - - 0.0155181885 - - 0.047698975 - - -0.010368347 - - 0.010879517 - - 0.016555786 - - -0.028076172 - - 0.03225708 - - -0.0056152344 - - -0.020690918 - - 0.00011438131 - - -0.021011353 - - -0.04425049 - - -0.029922485 - - -0.0014362335 - - 0.013618469 - - 0.011260986 - - 0.017532349 - - -0.043426514 - - 0.012557983 - - 0.026748657 - - 0.039154053 - - -0.030944824 - - 0.024169922 - - 0.06573486 - - -0.03817749 - - -0.025314331 - - -0.039794922 - - -0.050445557 - - -0.0020828247 - - -0.0010194778 - - 0.01725769 - - 0.0017976761 - - 0.029067993 - - 0.0115356445 - - 0.005214691 - - 0.0066604614 - - -0.014801025 - - -0.033172607 - - 0.023956299 - - 0.008865356 - - 0.09539795 - - 0.062286377 - - -0.0076408386 - - -0.035125732 - - 0.09082031 - - -0.015350342 - - -0.015625 - - -0.0090789795 - - -0.01876831 - - 0.05239868 - - -0.010406494 - - 0.05078125 - - -0.013694763 - - -0.07244873 - - 0.018539429 - - -0.016983032 - - -0.03353882 - - 0.01739502 - - 0.004055023 - - -0.010147095 - - -0.0027599335 - - -0.002714157 - - -0.0107040405 - - 0.021438599 - - -0.029525757 - - 0.01902771 - - -0.025909424 - - 0.0008072853 - - 0.026672363 - - 0.0019044876 - - 0.016937256 - - -0.018814087 - - -0.03668213 - - 0.03338623 - - -0.09240723 - - -0.024765015 - - -0.019378662 - - -0.051757812 - - 0.050109863 - - 0.018859863 - - 0.01687622 - - 0.020111084 - - -0.041534424 - - 0.009559631 - - -0.018859863 - - 5.853176e-05 - - 0.032684326 - - -0.04058838 - - 0.015823364 - - -0.038635254 - - 0.0055656433 - - -0.021560669 - - 0.012481689 - - -0.050872803 - - -0.036071777 - - -0.046844482 - - -0.041900635 - - -0.06561279 - - 0.014785767 - - 0.010124207 - - 0.030426025 - - 0.024261475 - - 0.0057411194 - - -0.026275635 - - -0.006919861 - - 0.022750854 - - -0.015167236 - - 0.022964478 - - -0.0033664703 - - 0.02734375 - - 0.03201294 - - 0.025939941 - - 0.019104004 - - 0.028030396 - - -0.014328003 - - -0.01574707 - - 0.06982422 - - -0.008026123 - - 0.006816864 - - -0.0019035339 - - 0.026245117 - - -0.028945923 - - 0.014968872 - - 0.0054244995 - - -0.00028896332 - - -0.02243042 - - -0.0030822754 - - -0.02558899 - - -0.022918701 - - -0.017089844 - - -0.0035190582 - - 0.029953003 - - -0.037078857 - - -0.02507019 - - -0.017303467 - - 0.064331055 - - -0.028533936 - - -0.07287598 - - 0.028839111 - - -0.0029792786 - - -0.02104187 - - -0.01663208 - - -0.016571045 - - -0.015106201 - - 0.0027313232 - - 0.031051636 - - -0.025680542 - - 0.004722595 - - 0.032348633 - - 0.020019531 - - 0.056365967 - - 0.07208252 - - 0.01235199 - - 0.00084495544 - - 0.035369873 - - -0.018569946 - - -0.0063552856 - - 0.03161621 - - 0.064575195 - - -0.02557373 - - -0.007232666 - - -0.017700195 - - -0.003835678 - - 0.007381439 - - -0.0385437 - - -0.0019102097 - - -0.023223877 - - -0.0124435425 - - 0.013343811 - - 0.020996094 - - -0.014022827 - - -0.01939392 - - 0.044128418 - - 0.0052757263 - - -0.00068950653 - - -0.04876709 - - -0.05609131 - - -0.020874023 - - -0.00806427 - - -0.13391113 - - -0.06323242 - - -0.021865845 - - -0.021072388 - - 0.005832672 - - -0.015701294 - - -0.006286621 - - -0.012954712 - - -0.017288208 - - 0.0036773682 - - -0.0084991455 - - -0.03213501 - - 0.021987915 - - -0.010322571 - - -0.029144287 - - 0.003824234 - - 0.02708435 - - 0.0026187897 - - 0.05496216 - - -0.04916382 - - 0.005466461 - - -0.0070648193 - - 0.0793457 - - -0.040863037 - - 0.012641907 - - 0.016448975 - - 0.02041626 - - -0.029006958 - - -0.008491516 - - 0.0023422241 - - 0.043640137 - - 0.0121536255 - - -0.0043525696 - - -0.030899048 - - 0.0062332153 - - -0.013038635 - - 0.007904053 - - -0.03390503 - - -0.034729004 - - -0.0647583 - - -0.0052375793 - - -0.08154297 - - 0.015960693 - - 0.016235352 - - -0.012130737 - - -0.021469116 - - -0.03253174 - - -0.014465332 - - 0.016448975 - - 0.004589081 - - -0.05291748 - - 0.018005371 - - -0.002981186 - - -0.01247406 - - 0.023147583 - - -0.055419922 - - -0.08526611 - - 0.016723633 - - 0.012939453 - - -0.039031982 - - 0.016677856 - - 0.016937256 - - 0.023147583 - - 0.034576416 - - -0.010635376 - - 0.03466797 - - 0.037750244 - - 0.020141602 - - -0.0046539307 - - 0.0059432983 - - 0.05609131 - - 0.027709961 - - 0.01838684 - - 0.015022278 - - -0.039215088 - - -0.0048828125 - - 0.047546387 - - 0.0138549805 - - -0.046203613 - - 0.036193848 - - -0.109680176 - - 0.0019550323 - - -0.03125 - - 0.0084991455 - - -0.0020256042 - - -0.001739502 - - -0.06756592 - - 0.03491211 - - -0.05633545 - - -0.008491516 - - 0.0048446655 - - 0.042663574 - - 0.025054932 - - -0.022247314 - - -0.0044555664 - - 0.0022335052 - - -0.0071907043 - - -0.003982544 - - -0.073913574 - - -0.011253357 - - 0.029220581 - - -0.0047073364 - - -0.04626465 - - 0.05670166 - - -0.041503906 - - 0.014579773 - - -0.016174316 - - 0.021560669 - - -0.019332886 - - 0.01550293 - - 0.02709961 - - 0.010528564 - - 0.012786865 - - -0.023849487 - - -0.016937256 - - -0.04626465 - - -0.04397583 - - 0.026245117 - - -0.017868042 - - 0.021072388 - - -0.02128601 - - -0.012161255 - - -0.004776001 - - -0.0088272095 - - 0.009246826 - - -0.012313843 - - 0.0096206665 - - -0.0047950745 - - -0.0079956055 - - 0.052520752 - - -0.06616211 - - 0.0014686584 - - -0.046081543 - - 0.03289795 - - -0.03656006 - - 0.055389404 - - 0.009773254 - - 0.0013818741 - - 0.043823242 - - 0.034942627 - - 0.055236816 - - -0.011833191 - - -0.024353027 - - 0.011398315 - - -0.051574707 - - -0.019882202 - - 0.0018358231 - - -0.005859375 - - 0.06677246 - - -0.0009851456 - - -0.026809692 - - 0.0075798035 - - -0.021347046 - - -0.01146698 - - 0.03262329 - - 0.031585693 - - -0.006729126 - - 0.008659363 - - -0.025665283 - - 0.02947998 - - -0.03744507 - - 0.02027893 - - -0.026062012 - - 0.018585205 - - -0.004463196 - - -0.036865234 - - -0.043670654 - - 0.021392822 - - -0.062561035 - - -0.080078125 - - 0.011451721 - - 0.06762695 - - 0.039001465 - - -0.016799927 - - 0.049072266 - - 0.041412354 - - -0.03062439 - - 0.011795044 - - -0.016555786 - - 0.046569824 - - 0.010688782 - - -0.01902771 - - -0.031097412 - - -0.023391724 - - -0.01651001 - - 0.009399414 - - 0.049041748 - - -0.025817871 - - -0.018356323 - - 0.02154541 - - -0.0029411316 - - 0.074157715 - - 0.017059326 - - -0.0017595291 - - 0.00390625 - - 0.02645874 - - -0.0010709763 - - 0.040222168 - - -0.034423828 - - 0.0231781 - - -0.016693115 - - -0.022094727 - - 0.004383087 - - 0.007331848 - - 0.018676758 - - 0.023773193 - - -0.0069770813 - - 0.0029773712 - - -0.023712158 - - -0.0051956177 - - -0.011810303 - - -0.0519104 - - 0.07244873 - - 0.032409668 - - 0.016662598 - - 0.015716553 - - -0.03640747 - - 0.03918457 - - -0.046722412 - - -0.0046081543 - - 0.006061554 - - -0.011940002 - - -0.0004878044 - - 0.01260376 - - 0.0073280334 - - 0.0015096664 - - 0.005844116 - - 0.029129028 - - 0.047668457 - - 0.05960083 - - -0.0647583 - - 0.064697266 - - -0.017440796 - - -0.01889038 - - 0.037628174 - - 0.0048065186 - - -0.023101807 - - -0.048675537 - - -0.02508545 - - -0.007965088 - - 0.0015897751 - - 0.06866455 - - -0.0099487305 - - -0.0022964478 - - -0.030014038 - - -0.007713318 - - -0.034362793 - - 0.013931274 - - 0.0026836395 - - -0.0014476776 - - 0.02532959 - - -0.020584106 - - -0.039001465 - - -0.062347412 - - -0.04736328 - - -0.024368286 - - -0.045776367 - - 0.03149414 - - -0.012825012 - - 0.028076172 - - 0.0058784485 - - 0.08062744 - - 0.0104599 - - 0.014579773 - - -0.041137695 - - 0.04244995 - - -0.021011353 - - 0.06390381 - - 0.0010871887 - - 0.04147339 - - -0.0053138733 - - 0.02268982 - - -0.028182983 - - -0.022628784 - - -0.021408081 - - -0.006088257 - - 0.028030396 - - 0.025146484 - - 0.00881958 - - -0.04244995 - - 0.027938843 - - 0.013916016 - - -0.04647827 - - 0.0072288513 - - 0.017745972 - - -0.02381897 - - -0.010147095 - - 0.0096588135 - - -0.04586792 - - -0.014480591 - - -0.0027217865 - - -0.03111267 - - 0.04522705 - - -0.02772522 - - -0.0013189316 - - 0.017807007 - - -0.0135269165 - - -0.014175415 - - -0.00019681454 - - 0.03161621 - - 0.0041007996 - - -0.024871826 - - 0.0039367676 - - -0.026916504 - - 0.03237915 - - 0.007068634 - - 0.029647827 - - -0.0102005005 - - 0.0076675415 - - 0.0051078796 - - -0.008041382 - - -0.0062942505 - - 0.0010309219 - - 0.010543823 - - -0.010101318 - - -0.013496399 - - 0.00920105 - - 0.0546875 - - -0.02784729 - - -0.0056762695 - - -0.08679199 - - -0.050048828 - - 0.03378296 - - 0.010124207 - - 0.019058228 - - -0.037872314 - - -0.0063323975 - - 0.0014324188 - - -0.010002136 - - -0.015731812 - - -0.036071777 - - -0.0028915405 - - -0.0082092285 - - 0.0037841797 - - -0.020629883 - - 0.01725769 - - -0.026000977 - - 0.00012862682 - - 0.021621704 - - 0.07086182 - - -0.008049011 - - -0.012634277 - - -0.064941406 - - -0.0073013306 - - -0.02760315 - - -0.040649414 - - 0.02809143 - - 0.009849548 - - 0.0011720657 - - 0.059936523 - - -0.032806396 - - 0.06311035 - - 0.009536743 - - 0.014801025 - - 0.03390503 - - -0.002620697 - - -0.04650879 - - -0.015365601 - - 0.03741455 - - -0.0067443848 - - -0.008888245 - - -0.0013017654 - - -0.010154724 - - 0.0027217865 - - 0.016052246 - - 0.025100708 - - -0.030532837 - - 0.032318115 - - 0.014564514 - - -0.009109497 - - 0.009628296 - - -0.021438599 - - -0.049926758 - - -0.00088214874 - - -0.019638062 - - -0.020126343 - - 0.055847168 - - -0.006729126 - - -0.044921875 - - -0.01890564 - - -0.0026683807 - - 0.0038547516 - - 0.004600525 - - -0.013977051 - - 0.018341064 - - -0.05178833 - - 0.011054993 - - 0.019927979 - - 0.011436462 - - 0.010391235 - - -0.012680054 - - -0.017669678 - - 0.01928711 - - 0.025115967 - - -0.07757568 - - -0.030960083 - - 0.013137817 - - -0.066467285 - - -0.054473877 - - -0.04244995 - - -0.027526855 - - 0.02973938 - - -0.024017334 - - -0.03918457 - - 0.0154800415 - - -0.036315918 - - 0.015510559 - - -0.020385742 - - -0.0390625 - - -0.00137043 - - 0.0016002655 - - -0.010238647 - - 0.014656067 - - 0.029373169 - - -0.027023315 - - 0.0076141357 - - -0.001917839 - - 0.03451538 - - 0.004814148 - - 0.024887085 - - 0.036315918 - - -0.006500244 - - -0.070495605 - - -0.0071754456 - - 0.025863647 - - 0.022994995 - - 0.007217407 - - 0.032165527 - - 0.016830444 - - 0.02859497 - - -0.011123657 - - 0.020126343 - - -0.0014410019 - - 0.0021781921 - - 0.053619385 - - 0.015625 - - 0.017150879 - - -0.03326416 - - -0.04626465 - - 0.034332275 - - 0.07165527 - - -0.040740967 - - -0.06628418 - - -0.024291992 - - -0.0066871643 - - 0.065979004 - - 0.034851074 - - 0.07678223 - - 0.053009033 - - 0.0317688 - - -0.04019165 - - 0.030288696 - - 0.062347412 - - -0.011734009 - - 0.0024604797 - - 0.006095886 - - -0.0152282715 - - 0.056762695 - - 0.021270752 - - -0.011154175 - - -0.0143966675 - - 0.0057754517 - - -0.0003619194 - - 0.0053367615 - - -0.030639648 - - 0.0024776459 - - -0.031799316 - - -0.012710571 - - 0.048828125 - - 0.029632568 - - 0.013244629 - - 0.087890625 - - -0.01134491 - - 0.028656006 - - -0.014778137 - - 0.06695557 - - 0.026275635 - - -0.016113281 - - 0.018859863 - - -0.008239746 - - 0.024383545 - - -0.039154053 - - -0.006252289 - - 0.049224854 - - -0.04638672 - - 0.0031967163 - - -0.04849243 - - -0.04058838 - - 0.038757324 - - 0.00730896 - - -0.04345703 - - 0.04296875 - - -0.0024299622 - - -0.05670166 - - 0.019119263 - - -0.011802673 - - 0.038970947 - - -0.03366089 - - 0.03591919 - - -0.0009088516 - - 0.013259888 - - -0.07342529 - - 0.004299164 - - 0.0395813 - - 0.013420105 - - -0.004459381 - - -0.0084991455 - - 0.031982422 - - 0.018249512 - - -0.0038604736 - - -0.022323608 - - -0.013031006 - - 0.0513916 - - -0.007068634 - - -0.003545761 - - 0.010292053 - - -0.010322571 - - -0.0037841797 - - 0.043701172 - - -0.012672424 - - 0.013725281 - - 0.021575928 - - -0.03942871 - - -0.0105896 - - -0.01878357 - - -0.017623901 - - -0.03414917 - - 0.02142334 - - 0.026550293 - - -0.022903442 - - 0.008598328 - - 0.03100586 - - 0.049957275 - - 0.021438599 - - 0.016204834 - - -0.014129639 - - 0.0079193115 - - -0.004535675 - - 0.0010051727 - - -0.038208008 - - -0.014923096 - - -0.01436615 - - -0.009666443 - - 0.0006933212 - - 0.0132369995 - - 0.01486969 - - 0.028762817 - - 0.011329651 - - -0.042663574 - - 0.014961243 - - -0.018127441 - - -0.007232666 - - 0.008369446 - - 0.027557373 - - 0.006706238 - - -0.05038452 - - -0.023666382 - - -0.0072898865 - - -0.007865906 - - -0.008926392 - - -0.013137817 - - 0.08886719 - - 0.030929565 - - 0.021255493 - - -0.0020389557 - - -0.08337402 - - -0.020385742 - - 0.03866577 - - -0.020523071 - - 0.021881104 - - 0.005756378 - - 0.022003174 - - 0.021209717 - - -0.06161499 - - -0.020309448 - - -0.0057258606 - - -0.033813477 - - 0.0017337799 - - -0.052612305 - - 0.01461792 - - -0.017944336 - - 0.042816162 - - -0.053710938 - - -0.041259766 - - -0.014549255 - - 0.020843506 - - -0.019760132 - - 0.004890442 - - -0.0007162094 - - -0.009429932 - - -0.01966858 - - -0.014320374 - - 0.041259766 - - 0.00075244904 - - -0.0064430237 - - 0.028961182 - - -0.01876831 - - 0.0027942657 - - -0.051116943 - - 0.00093746185 - - 0.0037384033 - - -0.06982422 - - -0.0107040405 - - 0.030090332 - - -0.019104004 - - -0.016647339 - - -0.037475586 - - 0.0140686035 - - -0.051086426 - - -0.032409668 - - -0.011131287 - - -0.023620605 - - -0.04159546 - - -0.034851074 - - -0.064941406 - - -0.03451538 - - 0.0047416687 - - -0.04510498 - - 0.020477295 - - -0.03024292 - - -0.034179688 - - 0.058410645 - - 0.008514404 - - 0.0049858093 - - 0.02331543 - - 0.03704834 - - -0.017333984 - - 0.014389038 - - 0.013786316 - - 0.008583069 - - -0.009643555 - - 0.020095825 - - 0.013496399 - - -0.01991272 - - -0.0446167 - - 0.0075149536 - - 0.0071029663 - - 0.0446167 - - -0.03933716 - - 0.009902954 - - 0.011077881 - - 0.008781433 - - -0.001701355 - - 0.016235352 - - 0.01802063 - - -0.010765076 - - -0.03427124 - - 0.0112838745 - - -0.023208618 - - -0.009979248 - - -0.010696411 - - -0.023208618 - - -0.026748657 - - -0.02923584 - - 0.013801575 - - -0.050323486 - - -0.0059661865 - - -0.004837036 - - 0.01940918 - - 0.00018620491 - - 0.0016450882 - - 0.019012451 - - -0.048034668 - - 0.034423828 - - -0.033599854 - - 0.020126343 - - -0.04949951 - - 0.071899414 - - -0.06060791 - - -0.043395996 - - 0.012138367 - - 0.022476196 - - 0.029006958 - - 0.04550171 - - -0.03564453 - - -0.015090942 - - 0.055541992 - - 0.014884949 - - 0.020767212 - - -0.01071167 - - 0.046905518 - - 0.033813477 - - -0.04260254 - - -0.00094127655 - - 0.016708374 - - -0.0011367798 - - -0.030426025 - - -0.03427124 - - 0.01763916 - - -0.012634277 - - 0.030517578 - - -0.055480957 - - -0.054992676 - - 0.056274414 - - -0.0007033348 - - -0.058624268 - - 0.0061531067 - - -0.008613586 - - 0.016067505 - - 0.003376007 - - -0.01586914 - - -0.025146484 - - 0.008491516 - - 0.053222656 - - -0.02923584 - - 0.021408081 - meta: - api_version: - version: '1' - api_version: 'v1' diff --git a/fern/openapi/types/EmbedInputType.yaml b/fern/openapi/types/EmbedInputType.yaml deleted file mode 100644 index 1ddeb1a0..00000000 --- a/fern/openapi/types/EmbedInputType.yaml +++ /dev/null @@ -1,13 +0,0 @@ -type: string -enum: - - 'search_document' - - 'search_query' - - 'classification' - - 'clustering' -description: | - Specifies the type of input passed to the model. Required for embedding models v3 and higher. - - - `"search_document"`: Used for embeddings stored in a vector database for search use-cases. - - `"search_query"`: Used for embeddings of search queries run against a vector DB to find relevant documents. - - `"classification"`: Used for embeddings passed through a text classifier. - - `"clustering"`: Used for the embeddings run through a clustering algorithm. diff --git a/fern/openapi/types/EmbedJob.yaml b/fern/openapi/types/EmbedJob.yaml deleted file mode 100644 index fe9ec1ff..00000000 --- a/fern/openapi/types/EmbedJob.yaml +++ /dev/null @@ -1,54 +0,0 @@ -type: object -required: - - job_id - - status - - created_at - - input_dataset_id - - model - - truncate -properties: - job_id: - type: string - x-fern-audiences: ['public'] - description: ID of the embed job - name: - type: string - x-fern-audiences: ['public'] - description: The name of the embed job - status: - type: string - x-fern-audiences: ['public'] - description: The status of the embed job - enum: - - processing - - complete - - cancelling - - cancelled - - failed - created_at: - type: string - x-fern-audiences: ['public'] - description: The creation date of the embed job - format: date-time - input_dataset_id: - type: string - x-fern-audiences: ['public'] - description: ID of the input dataset - output_dataset_id: - type: string - x-fern-audiences: ['public'] - description: ID of the resulting output dataset - model: - type: string - x-fern-audiences: ['public'] - description: ID of the model used to embed - truncate: - type: string - x-fern-audiences: ['public'] - description: The truncation option used - enum: - - START - - END - meta: - $ref: './ApiMeta.yaml' - x-fern-audiences: ['public'] diff --git a/fern/openapi/types/EmbeddingType.yaml b/fern/openapi/types/EmbeddingType.yaml deleted file mode 100644 index 773352ae..00000000 --- a/fern/openapi/types/EmbeddingType.yaml +++ /dev/null @@ -1,9 +0,0 @@ -x-fern-audiences: ['public'] -type: string -writeOnly: true -enum: - - float - - int8 - - uint8 - - binary - - ubinary diff --git a/fern/openapi/types/FinetuneDatasetMetrics.yaml b/fern/openapi/types/FinetuneDatasetMetrics.yaml deleted file mode 100644 index 828e764c..00000000 --- a/fern/openapi/types/FinetuneDatasetMetrics.yaml +++ /dev/null @@ -1,38 +0,0 @@ -type: object -properties: - trainable_token_count: - type: number - format: long - description: "The number of tokens of valid examples that can be used for training." - x-fern-audiences: ["public"] - total_examples: - type: number - format: long - description: "The overall number of examples." - x-fern-audiences: ["public"] - train_examples: - type: number - format: long - description: "The number of training examples." - x-fern-audiences: ["public"] - train_size_bytes: - type: number - format: long - description: "The size in bytes of all training examples." - x-fern-audiences: ["public"] - eval_examples: - type: number - format: long - description: "Number of evaluation examples." - x-fern-audiences: ["public"] - eval_size_bytes: - type: number - format: long - description: "The size in bytes of all eval examples." - x-fern-audiences: ["public"] - reranker_data_metrics: - $ref: "./RerankerDataMetrics.yaml" - chat_data_metrics: - $ref: "./ChatDataMetrics.yaml" - classify_data_metrics: - $ref: "./ClassifyDataMetrics.yaml" diff --git a/fern/openapi/types/FinishReason.yaml b/fern/openapi/types/FinishReason.yaml deleted file mode 100644 index 62ee1636..00000000 --- a/fern/openapi/types/FinishReason.yaml +++ /dev/null @@ -1,9 +0,0 @@ -type: string -enum: - - COMPLETE - - STOP_SEQUENCE - - ERROR - - ERROR_TOXIC - - ERROR_LIMIT - - USER_CANCEL - - MAX_TOKENS diff --git a/fern/openapi/types/GenerateStreamEnd.yaml b/fern/openapi/types/GenerateStreamEnd.yaml deleted file mode 100644 index baba8d11..00000000 --- a/fern/openapi/types/GenerateStreamEnd.yaml +++ /dev/null @@ -1,31 +0,0 @@ -allOf: - - $ref: './GenerateStreamEvent.yaml' - - type: object - required: - - is_finished - - finish_response - - response - properties: - is_finished: - x-fern-audiences: ['public'] - type: boolean - finish_reason: - x-fern-audiences: ['public'] - $ref: './FinishReason.yaml' - response: - type: object - x-fern-audiences: ['public'] - required: - - id - properties: - id: - x-fern-audiences: ['public'] - type: string - prompt: - x-fern-audiences: ['public'] - type: string - generations: - x-fern-audiences: ['public'] - type: array - items: - $ref: './SingleGenerationInStream.yaml' diff --git a/fern/openapi/types/GenerateStreamError.yaml b/fern/openapi/types/GenerateStreamError.yaml deleted file mode 100644 index 32748371..00000000 --- a/fern/openapi/types/GenerateStreamError.yaml +++ /dev/null @@ -1,22 +0,0 @@ -allOf: - - $ref: './GenerateStreamEvent.yaml' - - type: object - required: - - is_finished - - finish_reason - - err - properties: - index: - x-fern-audiences: ['public'] - type: integer - description: Refers to the nth generation. Only present when `num_generations` is greater than zero. - is_finished: - x-fern-audiences: ['public'] - type: boolean - finish_reason: - x-fern-audiences: ['public'] - $ref: './FinishReason.yaml' - err: - x-fern-audiences: ['public'] - type: string - description: Error message diff --git a/fern/openapi/types/GenerateStreamEvent.yaml b/fern/openapi/types/GenerateStreamEvent.yaml deleted file mode 100644 index 0abe07cc..00000000 --- a/fern/openapi/types/GenerateStreamEvent.yaml +++ /dev/null @@ -1,9 +0,0 @@ -required: - - event_type -properties: - event_type: - type: string - enum: - - 'text-generation' - - 'stream-end' - - 'stream-error' diff --git a/fern/openapi/types/GenerateStreamText.yaml b/fern/openapi/types/GenerateStreamText.yaml deleted file mode 100644 index c28c5c12..00000000 --- a/fern/openapi/types/GenerateStreamText.yaml +++ /dev/null @@ -1,15 +0,0 @@ -allOf: - - $ref: './GenerateStreamEvent.yaml' - - type: object - required: - - is_finished - - text - properties: - text: - type: string - description: A segment of text of the generation. - index: - type: integer - description: Refers to the nth generation. Only present when `num_generations` is greater than zero, and only when text responses are being streamed. - is_finished: - type: boolean diff --git a/fern/openapi/types/GenerateStreamedResponse.yaml b/fern/openapi/types/GenerateStreamedResponse.yaml deleted file mode 100644 index 20d430b1..00000000 --- a/fern/openapi/types/GenerateStreamedResponse.yaml +++ /dev/null @@ -1,11 +0,0 @@ -description: Response in content type stream when `stream` is `true` in the request parameters. Generation tokens are streamed with the GenerationStream response. The final response is of type GenerationFinalResponse. -oneOf: - - $ref: './GenerateStreamText.yaml' - - $ref: './GenerateStreamEnd.yaml' - - $ref: './GenerateStreamError.yaml' -discriminator: - propertyName: event_type - mapping: - 'text-generation': './GenerateStreamText.yaml' - 'stream-end': './GenerateStreamEnd.yaml' - 'stream-error': './GenerateStreamError.yaml' diff --git a/fern/openapi/types/Generation.yaml b/fern/openapi/types/Generation.yaml deleted file mode 100644 index f23cc986..00000000 --- a/fern/openapi/types/Generation.yaml +++ /dev/null @@ -1,23 +0,0 @@ -type: object -required: - - id - - generations -properties: - id: - type: string - x-fern-audiences: ['public'] - prompt: - type: string - x-fern-audiences: ['public'] - description: Prompt used for generations. - generations: - type: array - x-fern-audiences: ['public'] - description: List of generated results - items: - type: object - x-fern-audiences: ['public'] - $ref: './SingleGeneration.yaml' - meta: - $ref: './ApiMeta.yaml' - x-fern-audiences: ['public'] diff --git a/fern/openapi/types/GenerationFinalResponse.yaml b/fern/openapi/types/GenerationFinalResponse.yaml deleted file mode 100644 index 1adf9365..00000000 --- a/fern/openapi/types/GenerationFinalResponse.yaml +++ /dev/null @@ -1,21 +0,0 @@ -required: - - is_finished - - finish_response - - response -properties: - is_finished: - type: boolean - x-fern-audiences: [ "public" ] - finish_reason: - $ref: './FinishReason.yaml' - response: - type: object - x-fern-audiences: [ "public" ] - required: - - id - properties: - id: - type: string - x-fern-audiences: [ "public" ] - generations: - $ref: './SingleGenerationInStream.yaml' diff --git a/fern/openapi/types/GenerationStream.yaml b/fern/openapi/types/GenerationStream.yaml deleted file mode 100644 index 4ce3982d..00000000 --- a/fern/openapi/types/GenerationStream.yaml +++ /dev/null @@ -1,15 +0,0 @@ -required: - - is_finished - - text -properties: - text: - type: string - x-fern-audiences: [ "public" ] - description: A segment of text of the generation. - index: - type: integer - x-fern-audiences: [ "public" ] - description: Refers to the nth generation. Only present when `num_generations` is greater than zero, and only when text responses are being streamed. - is_finished: - type: boolean - x-fern-audiences: [ "public" ] diff --git a/fern/openapi/types/GetClusterJobResponse.yaml b/fern/openapi/types/GetClusterJobResponse.yaml deleted file mode 100644 index 3eeab937..00000000 --- a/fern/openapi/types/GetClusterJobResponse.yaml +++ /dev/null @@ -1,77 +0,0 @@ -type: object -required: - - job_id -properties: - job_id: - type: string - x-fern-audiences: ['public'] - created_at: - type: string - x-fern-audiences: ['public'] - description: Time of job creation in RFC3339 format - format: date-time - example: '2023-04-28T21:00:56.646257Z' - readOnly: true - embeddings_url: - type: string - x-fern-audiences: ['public'] - description: The input file URL used for the job - readOnly: true - input_dataset_id: - type: string - x-fern-audiences: ['public'] - description: The input dataset ID used for the job - readOnly: true - min_cluster_size: - type: integer - x-fern-audiences: ['public'] - description: The parameter used in the job creation. Please refer to the job creation endpoint for more details - readOnly: true - n_neighbors: - type: integer - x-fern-audiences: ['public'] - description: The parameter used in the job creation. Please refer to the job creation endpoint for more details - readOnly: true - is_deterministic: - type: boolean - x-fern-audiences: ['public'] - description: The parameter used in the job creation. Please refer to the job creation endpoint for more details - readOnly: true - status: - type: string - x-fern-audiences: ['public'] - enum: - - 'unknown' - - 'processing' - - 'failed' - - 'complete' - - 'queued' - is_final_state: - type: boolean - x-fern-audiences: ['public'] - description: A boolean indicating whether the job is in a final state, whether completed or failed - readOnly: true - output_clusters_url: - type: string - x-fern-audiences: ['public'] - description: The output file URL for the clusters (signed url that expires) - readOnly: true - output_outliers_url: - type: string - x-fern-audiences: ['public'] - description: The output file URL for the outliers (signed url that expires) - readOnly: true - clusters: - type: array - x-fern-audiences: ['public'] - description: The list of cluster summaries for the job - readOnly: true - items: - $ref: './Cluster.yaml' - error: - type: string - x-fern-audiences: ['public'] - meta: - $ref: './ApiMeta.yaml' - x-fern-audiences: ['public'] -description: Response for getting a cluster job. diff --git a/fern/openapi/types/GetConnectorResponse.yaml b/fern/openapi/types/GetConnectorResponse.yaml deleted file mode 100644 index 1103d248..00000000 --- a/fern/openapi/types/GetConnectorResponse.yaml +++ /dev/null @@ -1,6 +0,0 @@ -type: object -required: - - connector -properties: - connector: - $ref: './Connector.yaml' diff --git a/fern/openapi/types/GetConnectorsLogsResponse.yaml b/fern/openapi/types/GetConnectorsLogsResponse.yaml deleted file mode 100644 index 3b7b0a11..00000000 --- a/fern/openapi/types/GetConnectorsLogsResponse.yaml +++ /dev/null @@ -1,13 +0,0 @@ -type: object -required: - - connector_logs - - total -properties: - connector_logs: - type: array - items: - $ref: './ConnectorLog.yaml' - total: - type: number - description: Total number of connector logs - readOnly: true diff --git a/fern/openapi/types/GetModelResponse.yaml b/fern/openapi/types/GetModelResponse.yaml deleted file mode 100644 index 288b67b5..00000000 --- a/fern/openapi/types/GetModelResponse.yaml +++ /dev/null @@ -1,45 +0,0 @@ -description: |- - Contains information about the model and which API endpoints it can be used with. -type: object -properties: - name: - type: string - x-fern-audiences: ['public'] - description: |- - Specify this name in the `model` parameter of API requests to use your chosen model. - endpoints: - type: array - x-fern-audiences: ['public'] - items: - $ref: './CompatibleEndpoint.yaml' - description: |- - The API endpoints that the model is compatible with. - finetuned: - type: boolean - x-fern-audiences: ['public'] - description: |- - Whether the model has been fine-tuned or not. - context_length: - type: number - x-fern-audiences: ['public'] - description: |- - The maximum number of tokens that the model can process in a single request. Note that not all of these tokens are always available due to special tokens and preambles that Cohere has added by default. - tokenizer_url: - type: string - x-fern-audiences: ['public'] - description: |- - Public URL to the tokenizer's configuration file. - default_endpoints: - type: array - x-fern-audiences: ['public'] - items: - $ref: './CompatibleEndpoint.yaml' - description: |- - The API endpoints that the model is default to. - - # The following field should only be available to cohere users. The type is generated currently by fern but not used, which is not ideal (this is private). - # config: - # $ref: './ModelConfig.yaml' - # x-fern-audiences: [ "private" ] - # description: |- - # Internal model config information. This field is only available to users with the `admin` role. diff --git a/fern/openapi/types/GetResponse.yaml b/fern/openapi/types/GetResponse.yaml deleted file mode 100644 index dd3745d5..00000000 --- a/fern/openapi/types/GetResponse.yaml +++ /dev/null @@ -1,6 +0,0 @@ -type: object -required: - - connector -properties: - connector: - $ref: './Connector.yaml' diff --git a/fern/openapi/types/LabelMetric.yaml b/fern/openapi/types/LabelMetric.yaml deleted file mode 100644 index a30fb2c0..00000000 --- a/fern/openapi/types/LabelMetric.yaml +++ /dev/null @@ -1,17 +0,0 @@ -type: object -properties: - total_examples: - type: number - format: long - description: "Total number of examples for this label" - x-fern-audiences: ["public"] - label: - type: string - description: "value of the label" - x-fern-audiences: ["public"] - samples: - type: array - items: - type: string - description: "samples for this label" - x-fern-audiences: ["public"] diff --git a/fern/openapi/types/ListClusterJobsResponse.yaml b/fern/openapi/types/ListClusterJobsResponse.yaml deleted file mode 100644 index 074f28e7..00000000 --- a/fern/openapi/types/ListClusterJobsResponse.yaml +++ /dev/null @@ -1,15 +0,0 @@ -type: object -required: - - jobs -properties: - jobs: - type: array - x-fern-audiences: ['public'] - items: - $ref: './GetClusterJobResponse.yaml' - total_count: - type: integer - x-fern-audiences: ['public'] - meta: - $ref: './ApiMeta.yaml' - x-fern-audiences: ['public'] diff --git a/fern/openapi/types/ListConnectorsResponse.yaml b/fern/openapi/types/ListConnectorsResponse.yaml deleted file mode 100644 index b592dbf3..00000000 --- a/fern/openapi/types/ListConnectorsResponse.yaml +++ /dev/null @@ -1,14 +0,0 @@ -type: object -required: - - connectors -properties: - connectors: - type: array - x-fern-audiences: ['public'] - items: - $ref: './Connector.yaml' - total_count: - type: number - x-fern-audiences: ['public'] - description: Total number of connectors. - readOnly: true diff --git a/fern/openapi/types/ListEmbedJobResponse.yaml b/fern/openapi/types/ListEmbedJobResponse.yaml deleted file mode 100644 index 79a2c4dd..00000000 --- a/fern/openapi/types/ListEmbedJobResponse.yaml +++ /dev/null @@ -1,7 +0,0 @@ -type: object -properties: - embed_jobs: - type: array - items: - $ref: './EmbedJob.yaml' - x-fern-audiences: ['public'] diff --git a/fern/openapi/types/ListModelsResponse.yaml b/fern/openapi/types/ListModelsResponse.yaml deleted file mode 100644 index 830c4370..00000000 --- a/fern/openapi/types/ListModelsResponse.yaml +++ /dev/null @@ -1,13 +0,0 @@ -type: object -required: - - models -properties: - models: - type: array - x-fern-audiences: ['public'] - items: - $ref: './GetModelResponse.yaml' - next_page_token: - type: string - x-fern-audiences: ['public'] - description: A token to retrieve the next page of results. Provide in the page_token parameter of the next request. diff --git a/fern/openapi/types/ListResponse.yaml b/fern/openapi/types/ListResponse.yaml deleted file mode 100644 index 309dd6ac..00000000 --- a/fern/openapi/types/ListResponse.yaml +++ /dev/null @@ -1,9 +0,0 @@ -type: object -required: - - connectors -properties: - connectors: - type: array - x-fern-audiences: [ "public" ] - items: - $ref: './Connector.yaml' diff --git a/fern/openapi/types/LogLikelihoodResponse.yaml b/fern/openapi/types/LogLikelihoodResponse.yaml deleted file mode 100644 index d1b0161a..00000000 --- a/fern/openapi/types/LogLikelihoodResponse.yaml +++ /dev/null @@ -1,31 +0,0 @@ -type: object -required: - - id - - prompt_tokens - - completion_tokens - - raw_prompt_tokens -properties: - id: - type: string - x-fern-audiences: ['public'] - prompt_tokens: - description: Probabilities for tokens in the request prompt - type: array - x-fern-audiences: ['public'] - items: - $ref: './TokenLikelihood.yaml' - completion_tokens: - description: Probabilities for tokens in the request completion - type: array - x-fern-audiences: ['public'] - items: - $ref: './TokenLikelihood.yaml' - raw_prompt_tokens: - description: Probabilities for tokens in the request raw_prompt - type: array - x-fern-audiences: ['public'] - items: - $ref: './TokenLikelihood.yaml' - meta: - $ref: './ApiMeta.yaml' - x-fern-audiences: ['public'] diff --git a/fern/openapi/types/Message.yaml b/fern/openapi/types/Message.yaml deleted file mode 100644 index d3c1159a..00000000 --- a/fern/openapi/types/Message.yaml +++ /dev/null @@ -1,10 +0,0 @@ -oneOf: - - $ref: './ChatMessage.yaml' - - $ref: './ToolMessage.yaml' -discriminator: - propertyName: role - mapping: - CHATBOT: './ChatMessage.yaml' - SYSTEM: './ChatMessage.yaml' - USER: './ChatMessage.yaml' - TOOL: './ToolMessage.yaml' \ No newline at end of file diff --git a/fern/openapi/types/Metrics.yaml b/fern/openapi/types/Metrics.yaml deleted file mode 100644 index 0604bb3e..00000000 --- a/fern/openapi/types/Metrics.yaml +++ /dev/null @@ -1,24 +0,0 @@ -type: object -properties: - finetune_dataset_metrics: - $ref: './FinetuneDatasetMetrics.yaml' - embed_data: - x-internal: true - type: object - properties: - fields: - description: the fields in the dataset - x-internal: true - type: array - items: - x-internal: true - type: object - properties: - name: - description: the name of the field - x-internal: true - type: string - count: - description: the number of times the field appears in the dataset - x-internal: true - type: number diff --git a/fern/openapi/types/Model.yaml b/fern/openapi/types/Model.yaml deleted file mode 100644 index 8eb0198e..00000000 --- a/fern/openapi/types/Model.yaml +++ /dev/null @@ -1,36 +0,0 @@ -description: |- - Contains information about the model and which API endpoints it can be used with. -type: object -properties: - name: - type: string - x-fern-audiences: [ "public" ] - description: |- - Specify this name in the `model` parameter of API requests to use your chosen model. - endpoints: - type: array - x-fern-audiences: [ "public" ] - items: - $ref: './CompatibleEndpoint.yaml' - description: |- - The API endpoints that the model is compatible with. - finetuned: - type: boolean - x-fern-audiences: [ "public" ] - description: |- - Whether the model has been fine-tuned or not. - context_length: - type: number - x-fern-audiences: [ "public" ] - description: |- - The maximum number of tokens that the model can process in a single request. Note that not all of these tokens are always available due to special tokens and preambles that Cohere has added by default. - tokenizer: - type: string - x-fern-audiences: [ "public" ] - description: |- - The name of the tokenizer used for the model. - tokenizer_url: - type: string - x-fern-audiences: [ "public" ] - description: |- - Public URL to the tokenizer's configuration file. diff --git a/fern/openapi/types/ModelConfig.yaml b/fern/openapi/types/ModelConfig.yaml deleted file mode 100644 index 76a14be4..00000000 --- a/fern/openapi/types/ModelConfig.yaml +++ /dev/null @@ -1,100 +0,0 @@ -required: - - route - - name -properties: - route: - type: string - x-fern-audiences: ['public'] - name: - type: string - x-fern-audiences: ['public'] - billing_tag: - type: string - x-fern-audiences: ['public'] - model_id: - type: string - x-fern-audiences: ['public'] - model_size: - type: string - x-fern-audiences: ['public'] - finetune_id: - type: string - x-fern-audiences: ['public'] - endpoint_type: - type: string - x-fern-audiences: ['public'] - model_type: - type: string - x-fern-audiences: ['public'] - nemo_model_id: - type: string - x-fern-audiences: ['public'] - model_url: - type: string - x-fern-audiences: ['public'] - context_length: - type: integer - x-fern-audiences: ['public'] - serving_framework: - type: string - x-fern-audiences: ['public'] - serving_entrypoint: - type: string - x-fern-audiences: ['public'] - compatible_endpoints: - type: array - x-fern-audiences: ['public'] - items: - type: string - x-fern-audiences: ['public'] - prompt_templates: - type: object - x-fern-audiences: ['public'] - additionalProperties: - type: string - x-fern-audiences: ['public'] - compression_values: - type: object - x-fern-audiences: ['public'] - additionalProperties: - type: number - x-fern-audiences: ['public'] - compatibility_version: - type: integer - x-fern-audiences: ['public'] - default_language: - type: string - x-fern-audiences: ['public'] - additional_languages: - type: string - x-fern-audiences: ['public'] - labels: - type: array - x-fern-audiences: ['public'] - items: - type: string - x-fern-audiences: ['public'] - multi_label: - type: boolean - x-fern-audiences: ['public'] - baseline_model: - type: string - x-fern-audiences: ['public'] - is_baseline: - type: boolean - x-fern-audiences: ['public'] - tokenizer_id: - type: string - x-fern-audiences: ['public'] - end_of_sequence_string: - type: string - x-fern-audiences: ['public'] - streaming: - type: boolean - x-fern-audiences: ['public'] - group: - type: string - x-fern-audiences: ['public'] - model_version: - type: string - x-fern-audiences: ['public'] diff --git a/fern/openapi/types/NonStreamedChatResponse.yaml b/fern/openapi/types/NonStreamedChatResponse.yaml deleted file mode 100644 index 1760338b..00000000 --- a/fern/openapi/types/NonStreamedChatResponse.yaml +++ /dev/null @@ -1,70 +0,0 @@ -required: - - text -properties: - text: - type: string - x-fern-audiences: ['public'] - minLength: 1 - description: Contents of the reply generated by the model. - generation_id: - type: string - x-fern-audiences: ['public'] - format: uuid - description: Unique identifier for the generated reply. Useful for submitting feedback. - citations: - type: array - x-fern-audiences: ['public'] - minItems: 0 - description: Inline citations for the generated reply. - items: - $ref: './ChatCitation.yaml' - documents: - type: array - x-fern-audiences: ['public'] - minItems: 0 - description: Documents seen by the model when generating the reply. - items: - $ref: './ChatDocument.yaml' - is_search_required: - type: boolean - x-fern-audiences: ['public'] - description: Denotes that a search for documents is required during the RAG flow. - search_queries: - type: array - x-fern-audiences: ['public'] - description: Generated search queries, meant to be used as part of the RAG flow. - items: - $ref: './ChatSearchQuery.yaml' - search_results: - type: array - x-fern-audiences: ['public'] - minItems: 0 - description: Documents retrieved from each of the conducted searches. - items: - $ref: './ChatSearchResult.yaml' - finish_reason: - x-fern-audiences: ['public'] - $ref: './FinishReason.yaml' - tool_calls: - x-fern-audiences: ['public'] - type: array - items: - $ref: './ToolCall.yaml' - chat_history: - type: array - x-fern-audiences: ['public'] - minItems: 0 - items: - $ref: './Message.yaml' - description: | - A list of previous messages between the user and the model, meant to give the model conversational context for responding to the user's `message`. - prompt: - # Undocumented but present in the SDK: - x-internal: true - x-fern-audiences: ['public'] - type: string - description: The prompt that was used. Only present when `return_prompt` in the request is set to true. - - meta: - $ref: './ApiMeta.yaml' - x-fern-audiences: ['public'] diff --git a/fern/openapi/types/OAuthAuthorizeResponse.yaml b/fern/openapi/types/OAuthAuthorizeResponse.yaml deleted file mode 100644 index 2e919f39..00000000 --- a/fern/openapi/types/OAuthAuthorizeResponse.yaml +++ /dev/null @@ -1,6 +0,0 @@ -type: object -properties: - redirect_url: - type: string - x-fern-audiences: ['public'] - description: The OAuth 2.0 redirect url. Redirect the user to this url to authorize the connector. diff --git a/fern/openapi/types/ParseInfo.yaml b/fern/openapi/types/ParseInfo.yaml deleted file mode 100644 index 7b6cd157..00000000 --- a/fern/openapi/types/ParseInfo.yaml +++ /dev/null @@ -1,11 +0,0 @@ -type: object -properties: - separator: - type: string - x-fern-audiences: ['public'] - writeOnly: true - delimiter: - type: string - x-fern-audiences: ['public'] - writeOnly: true -writeOnly: true diff --git a/fern/openapi/types/RateLimit.yaml b/fern/openapi/types/RateLimit.yaml deleted file mode 100644 index e9603686..00000000 --- a/fern/openapi/types/RateLimit.yaml +++ /dev/null @@ -1,8 +0,0 @@ -description: 'Too many requests' -content: - application/json: - schema: - type: object - properties: - data: - type: string diff --git a/fern/openapi/types/RequestSource.yaml b/fern/openapi/types/RequestSource.yaml deleted file mode 100644 index 210aa6dd..00000000 --- a/fern/openapi/types/RequestSource.yaml +++ /dev/null @@ -1,9 +0,0 @@ -name: X-Client-Name -description: | - The name of the project that is making the request. -x-fern-audiences: ['public'] -schema: - type: string -in: header -required: false -example: 'my-cool-project' diff --git a/fern/openapi/types/RerankDocument.yaml b/fern/openapi/types/RerankDocument.yaml deleted file mode 100644 index bfbd2889..00000000 --- a/fern/openapi/types/RerankDocument.yaml +++ /dev/null @@ -1,9 +0,0 @@ -type: object -x-fern-type: map # for now, fern doesn't support properties + additionalProperties -properties: - text: - type: string - x-fern-audiences: ['public'] - description: The text of the document to rerank. -required: - - text diff --git a/fern/openapi/types/RerankerDataMetrics.yaml b/fern/openapi/types/RerankerDataMetrics.yaml deleted file mode 100644 index 418dbfad..00000000 --- a/fern/openapi/types/RerankerDataMetrics.yaml +++ /dev/null @@ -1,32 +0,0 @@ -type: object -properties: - num_train_queries: - type: number - format: long - description: "The number of training queries." - x-fern-audiences: ["public"] - num_train_relevant_passages: - type: number - format: long - description: "The sum of all relevant passages of valid training examples." - x-fern-audiences: ["public"] - num_train_hard_negatives: - type: number - format: long - description: "The sum of all hard negatives of valid training examples." - x-fern-audiences: ["public"] - num_eval_queries: - type: number - format: long - description: "The number of evaluation queries." - x-fern-audiences: ["public"] - num_eval_relevant_passages: - type: number - format: long - description: "The sum of all relevant passages of valid eval examples." - x-fern-audiences: ["public"] - num_eval_hard_negatives: - type: number - format: long - description: "The sum of all hard negatives of valid eval examples." - x-fern-audiences: ["public"] diff --git a/fern/openapi/types/SearchQueriesOnlyResponse.yaml b/fern/openapi/types/SearchQueriesOnlyResponse.yaml deleted file mode 100644 index 15986734..00000000 --- a/fern/openapi/types/SearchQueriesOnlyResponse.yaml +++ /dev/null @@ -1,9 +0,0 @@ -required: - - search_queries -properties: - search_queries: - type: array - x-fern-audiences: [ "public" ] - description: Generated search queries, meant to be used as part of the RAG flow. - items: - $ref: './ChatSearchQuery.yaml' diff --git a/fern/openapi/types/SingleGeneration.yaml b/fern/openapi/types/SingleGeneration.yaml deleted file mode 100644 index 15ef71a6..00000000 --- a/fern/openapi/types/SingleGeneration.yaml +++ /dev/null @@ -1,36 +0,0 @@ -type: object -properties: - id: - type: string - x-fern-audiences: ['public'] - text: - type: string - x-fern-audiences: ['public'] - index: - type: integer - x-fern-audiences: ['public'] - description: Refers to the nth generation. Only present when `num_generations` is greater than zero. - likelihood: - type: number - x-fern-audiences: ['public'] - token_likelihoods: - type: array - x-fern-audiences: ['public'] - description: "Only returned if `return_likelihoods` is set to `GENERATION` or `ALL`. The likelihood refers to the average log-likelihood of the entire specified string, which is useful for [evaluating the performance of your model](likelihood-eval), especially if you've created a [custom model](/docs/training-custom-models). Individual token likelihoods provide the log-likelihood of each token. The first token will not have a likelihood." - items: - type: object - x-fern-audiences: ['public'] - properties: - token: - type: string - x-fern-audiences: ['public'] - likelihood: - type: number - x-fern-audiences: ['public'] - required: - - id - - token - - likelihood -required: - - text - - id diff --git a/fern/openapi/types/SingleGenerationInStream.yaml b/fern/openapi/types/SingleGenerationInStream.yaml deleted file mode 100644 index fa3d8277..00000000 --- a/fern/openapi/types/SingleGenerationInStream.yaml +++ /dev/null @@ -1,20 +0,0 @@ -type: object -properties: - id: - type: string - x-fern-audiences: ['public'] - text: - type: string - x-fern-audiences: ['public'] - description: Full text of the generation. - index: - type: integer - x-fern-audiences: ['public'] - description: Refers to the nth generation. Only present when `num_generations` is greater than zero. - finish_reason: - x-fern-audiences: ['public'] - $ref: './FinishReason.yaml' -required: - - text - - id - - finish_reason diff --git a/fern/openapi/types/StreamedChatResponse.yaml b/fern/openapi/types/StreamedChatResponse.yaml deleted file mode 100644 index a4c34d22..00000000 --- a/fern/openapi/types/StreamedChatResponse.yaml +++ /dev/null @@ -1,21 +0,0 @@ -description: StreamedChatResponse is returned in streaming mode (specified with `stream=True` in the request). -oneOf: - - $ref: './ChatStreamStartEvent.yaml' - - $ref: './ChatSearchQueriesGenerationEvent.yaml' - - $ref: './ChatSearchResultsEvent.yaml' - - $ref: './ChatTextGenerationEvent.yaml' - - $ref: './ChatCitationGenerationEvent.yaml' - - $ref: './ChatToolCallsGenerationEvent.yaml' - - $ref: './ChatStreamEndEvent.yaml' - - $ref: './ChatToolCallsChunkEvent.yaml' -discriminator: - propertyName: event_type - mapping: - 'stream-start': './ChatStreamStartEvent.yaml' - 'search-queries-generation': './ChatSearchQueriesGenerationEvent.yaml' - 'search-results': './ChatSearchResultsEvent.yaml' - 'text-generation': './ChatTextGenerationEvent.yaml' - 'citation-generation': './ChatCitationGenerationEvent.yaml' - 'tool-calls-generation': './ChatToolCallsGenerationEvent.yaml' - 'stream-end': './ChatStreamEndEvent.yaml' - 'tool-calls-chunk': './ChatToolCallsChunkEvent.yaml' diff --git a/fern/openapi/types/StreamedGeneration.yaml b/fern/openapi/types/StreamedGeneration.yaml deleted file mode 100644 index 16c75029..00000000 --- a/fern/openapi/types/StreamedGeneration.yaml +++ /dev/null @@ -1,6 +0,0 @@ -description: Response in content type stream when `stream` is `true` in the request parameters. Generation tokens are streamed with the GenerationStream response. The final response is of type GenerationFinalResponse. -type: array -items: - oneOf: - - $ref: './GenerationStream.yaml' - - $ref: './GenerationFinalResponse.yaml' diff --git a/fern/openapi/types/TokenLikelihood.yaml b/fern/openapi/types/TokenLikelihood.yaml deleted file mode 100644 index c862c225..00000000 --- a/fern/openapi/types/TokenLikelihood.yaml +++ /dev/null @@ -1,14 +0,0 @@ -type: object -properties: - encoded: - description: Tokenized text - type: integer - x-fern-audiences: ['public'] - decoded: - description: Detokenized text - type: string - x-fern-audiences: ['public'] - log_likelihood: - description: Non normalized probability of the token - type: number - x-fern-audiences: ['public'] diff --git a/fern/openapi/types/Tool.yaml b/fern/openapi/types/Tool.yaml deleted file mode 100644 index d4774c6b..00000000 --- a/fern/openapi/types/Tool.yaml +++ /dev/null @@ -1,44 +0,0 @@ -type: object -required: - - name - - description -properties: - name: - type: string - description: | - The name of the tool to be called. Valid names contain only the characters `a-z`, `A-Z`, `0-9`, `_` and must not begin with a digit. - description: - description: | - The description of what the tool does, the model uses the description to choose when and how to call the function. - type: string - parameter_definitions: - description: | - The input parameters of the tool. Accepts a dictionary where the key is the name of the parameter and the value is the parameter spec. Valid parameter names contain only the characters `a-z`, `A-Z`, `0-9`, `_` and must not begin with a digit. - ``` - { - "my_param": { - "description": , - "type": , // any python data type, such as 'str', 'bool' - "required": - } - } - ``` - type: object - additionalProperties: - type: object - required: - - type - properties: - description: - description: | - The description of the parameter. - type: string - type: - description: | - The type of the parameter. Must be a valid Python type. - type: string - required: - description: | - Denotes whether the parameter is always present (required) or not. Defaults to not required. - type: boolean - default: false diff --git a/fern/openapi/types/ToolCall.yaml b/fern/openapi/types/ToolCall.yaml deleted file mode 100644 index 61c1272a..00000000 --- a/fern/openapi/types/ToolCall.yaml +++ /dev/null @@ -1,16 +0,0 @@ -description: | - Contains the tool calls generated by the model. Use it to invoke your tools. -type: object -required: - - name - - parameters -properties: - name: - x-fern-audiences: ['public'] - description: Name of the tool to call. - type: string - parameters: - x-fern-audiences: ['public'] - description: The name and value of the parameters to use when invoking a tool. - type: object - additionalProperties: true diff --git a/fern/openapi/types/ToolCallDelta.yaml b/fern/openapi/types/ToolCallDelta.yaml deleted file mode 100644 index b546503c..00000000 --- a/fern/openapi/types/ToolCallDelta.yaml +++ /dev/null @@ -1,24 +0,0 @@ -description: | - Contains the chunk of the tool call generation in the stream. -type: object -properties: - name: - description: | - Name of the tool call - type: string - x-fern-audiences: ['public'] - index: - description: | - Index of the tool call generated - type: number - x-fern-audiences: ['public'] - parameters: - description: | - Chunk of the tool parameters - type: string - x-fern-audiences: ['public'] - text: - description: | - Chunk of the tool plan text - type: string - x-fern-audiences: ['public'] diff --git a/fern/openapi/types/ToolInput.yaml b/fern/openapi/types/ToolInput.yaml deleted file mode 100644 index af9f08e3..00000000 --- a/fern/openapi/types/ToolInput.yaml +++ /dev/null @@ -1,14 +0,0 @@ -x-internal: true -type: object -required: - - tool_name - - parameters - - generation_id -properties: - tool_name: - type: string - parameters: - type: object - additionalProperties: true - generation_id: - type: string diff --git a/fern/openapi/types/ToolMessage.yaml b/fern/openapi/types/ToolMessage.yaml deleted file mode 100644 index 51beb4fb..00000000 --- a/fern/openapi/types/ToolMessage.yaml +++ /dev/null @@ -1,11 +0,0 @@ -description: | - Represents tool result in the chat history. -required: - - role -properties: - role: - $ref: './ChatRole.yaml' - tool_results: - type: array - items: - $ref: './ToolResult.yaml' diff --git a/fern/openapi/types/ToolResult.yaml b/fern/openapi/types/ToolResult.yaml deleted file mode 100644 index 63518cd4..00000000 --- a/fern/openapi/types/ToolResult.yaml +++ /dev/null @@ -1,13 +0,0 @@ -type: object -required: - - call - - outputs -properties: - call: - $ref: './ToolCall.yaml' - outputs: - type: array - minItems: 0 - items: - type: object - additionalProperties: true diff --git a/fern/openapi/types/UpdateClusterJobRequest.yaml b/fern/openapi/types/UpdateClusterJobRequest.yaml deleted file mode 100644 index 3c058f15..00000000 --- a/fern/openapi/types/UpdateClusterJobRequest.yaml +++ /dev/null @@ -1,31 +0,0 @@ -type: object -properties: - status: - type: string - x-fern-audiences: ['public'] - enum: - - 'unknown' - - 'processing' - - 'failed' - - 'complete' - - 'queued' - clusters: - type: array - x-fern-audiences: ['public'] - items: - $ref: './Cluster.yaml' - output_clusters_gs_path: - type: string - x-fern-audiences: ['public'] - output_outliers_gs_path: - type: string - x-fern-audiences: ['public'] - error: - type: string - x-fern-audiences: ['public'] - input_tracking_metrics: - type: object - x-fern-audiences: ['public'] - output_tracking_metrics: - type: object - x-fern-audiences: ['public'] diff --git a/fern/openapi/types/UpdateClusterJobResponse.yaml b/fern/openapi/types/UpdateClusterJobResponse.yaml deleted file mode 100644 index 13ed0810..00000000 --- a/fern/openapi/types/UpdateClusterJobResponse.yaml +++ /dev/null @@ -1,8 +0,0 @@ -type: object -required: - - job_id -properties: - job_id: - type: string - x-fern-audiences: ['public'] -description: Response for updating a cluster job. diff --git a/fern/openapi/types/UpdateConnectorOAuth.yaml b/fern/openapi/types/UpdateConnectorOAuth.yaml deleted file mode 100644 index 82991e9f..00000000 --- a/fern/openapi/types/UpdateConnectorOAuth.yaml +++ /dev/null @@ -1,22 +0,0 @@ -type: object -properties: - client_id: - type: string - x-fern-audiences: ['public'] - description: The OAuth 2.0 client ID. This fields is encrypted at rest. - client_secret: - type: string - x-fern-audiences: ['public'] - description: The OAuth 2.0 client Secret. This field is encrypted at rest and never returned in a response. - authorize_url: - type: string - x-fern-audiences: ['public'] - description: The OAuth 2.0 /authorize endpoint to use when users authorize the connector. - token_url: - type: string - x-fern-audiences: ['public'] - description: The OAuth 2.0 /token endpoint to use when users authorize the connector. - scope: - type: string - x-fern-audiences: ['public'] - description: The OAuth scopes to request when users authorize the connector. diff --git a/fern/openapi/types/UpdateConnectorRequest.yaml b/fern/openapi/types/UpdateConnectorRequest.yaml deleted file mode 100644 index dbe8a41b..00000000 --- a/fern/openapi/types/UpdateConnectorRequest.yaml +++ /dev/null @@ -1,33 +0,0 @@ -type: object -properties: - name: - type: string - x-fern-audiences: ['public'] - description: A human-readable name for the connector. - url: - type: string - x-fern-audiences: ['public'] - description: The URL of the connector that will be used to search for documents. - excludes: - description: A list of fields to exclude from the prompt (fields remain in the document). - type: array - x-fern-audiences: ['public'] - items: - type: string - x-fern-audiences: ['public'] - oauth: - $ref: './CreateConnectorOAuth.yaml' - x-fern-audiences: ['public'] - description: The OAuth 2.0 configuration for the connector. Cannot be specified if service_auth is specified. - active: - type: boolean - x-fern-audiences: ['public'] - default: true - continue_on_failure: - type: boolean - x-fern-audiences: ['public'] - default: false - service_auth: - x-fern-audiences: ['public'] - $ref: './CreateConnectorServiceAuth.yaml' - description: The service to service authentication configuration for the connector. Cannot be specified if oauth is specified. diff --git a/fern/openapi/types/UpdateConnectorResponse.yaml b/fern/openapi/types/UpdateConnectorResponse.yaml deleted file mode 100644 index 1103d248..00000000 --- a/fern/openapi/types/UpdateConnectorResponse.yaml +++ /dev/null @@ -1,6 +0,0 @@ -type: object -required: - - connector -properties: - connector: - $ref: './Connector.yaml' diff --git a/fern/openapi/types/UpdateConnectorServiceAuth.yaml b/fern/openapi/types/UpdateConnectorServiceAuth.yaml deleted file mode 100644 index 2467f0e5..00000000 --- a/fern/openapi/types/UpdateConnectorServiceAuth.yaml +++ /dev/null @@ -1,9 +0,0 @@ -type: object -properties: - type: - x-fern-audiences: ['public'] - $ref: './AuthTokenType.yaml' - token: - type: string - x-fern-audiences: ['public'] - description: The token that will be used in the HTTP Authorization header when making requests to the connector. This field is encrypted at rest and never returned in a response. diff --git a/fern/openapi/types/UpdateRequest.yaml b/fern/openapi/types/UpdateRequest.yaml deleted file mode 100644 index 7e0fc981..00000000 --- a/fern/openapi/types/UpdateRequest.yaml +++ /dev/null @@ -1,32 +0,0 @@ -type: object -properties: - name: - type: string - x-fern-audiences: [ "public" ] - description: A human-readable name for the connector. - url: - type: string - x-fern-audiences: [ "public" ] - description: The URL of the connector that will be used to search for documents. - excludes: - description: A list of fields to exclude from the prompt (fields remain in the document). - type: array - x-fern-audiences: [ "public" ] - items: - type: string - x-fern-audiences: [ "public" ] - oauth: - $ref: './CreateConnectorOAuth.yaml' - x-fern-audiences: [ "public" ] - description: The OAuth 2.0 configuration for the connector. Cannot be specified if service_auth is specified. - active: - type: boolean - x-fern-audiences: [ "public" ] - default: true - continue_on_failure: - type: boolean - x-fern-audiences: [ "public" ] - default: false - service_auth: - $ref: './CreateConnectorServiceAuth.yaml' - description: The service to service authentication configuration for the connector. Cannot be specified if oauth is specified. diff --git a/fern/openapi/types/UpdateResponse.yaml b/fern/openapi/types/UpdateResponse.yaml deleted file mode 100644 index dd3745d5..00000000 --- a/fern/openapi/types/UpdateResponse.yaml +++ /dev/null @@ -1,6 +0,0 @@ -type: object -required: - - connector -properties: - connector: - $ref: './Connector.yaml' diff --git a/fern/openapi/types/v1/finetuning/BaseModel.yaml b/fern/openapi/types/v1/finetuning/BaseModel.yaml deleted file mode 100644 index 279a2cb9..00000000 --- a/fern/openapi/types/v1/finetuning/BaseModel.yaml +++ /dev/null @@ -1,22 +0,0 @@ -# Generated by `turbo run openapi:finetuning` - DO NOT EDIT. -type: object -properties: - name: - type: string - description: The name of the base model. - version: - type: string - description: read-only. The version of the base model. - readOnly: true - base_type: - $ref: ./BaseType.yaml - description: The type of the base model. - strategy: - $ref: ./Strategy.yaml - description: The fine-tuning strategy. -description: The base model used for fine-tuning. -required: - - base_type -x-fern-sdk-group-name: - - finetuning - - finetuning diff --git a/fern/openapi/types/v1/finetuning/BaseType.yaml b/fern/openapi/types/v1/finetuning/BaseType.yaml deleted file mode 100644 index c75e7023..00000000 --- a/fern/openapi/types/v1/finetuning/BaseType.yaml +++ /dev/null @@ -1,20 +0,0 @@ -# Generated by `turbo run openapi:finetuning` - DO NOT EDIT. -type: string -enum: - - BASE_TYPE_UNSPECIFIED - - BASE_TYPE_GENERATIVE - - BASE_TYPE_CLASSIFICATION - - BASE_TYPE_RERANK - - BASE_TYPE_CHAT -default: BASE_TYPE_UNSPECIFIED -description: |- - The possible types of fine-tuned models. - - - BASE_TYPE_UNSPECIFIED: Unspecified model. - - BASE_TYPE_GENERATIVE: Generative model. - - BASE_TYPE_CLASSIFICATION: Classification model. - - BASE_TYPE_RERANK: Rerank model. - - BASE_TYPE_CHAT: Chat model. -x-fern-sdk-group-name: - - finetuning - - finetuning diff --git a/fern/openapi/types/v1/finetuning/CreateFinetunedModelResponse.yaml b/fern/openapi/types/v1/finetuning/CreateFinetunedModelResponse.yaml deleted file mode 100644 index 60567d8c..00000000 --- a/fern/openapi/types/v1/finetuning/CreateFinetunedModelResponse.yaml +++ /dev/null @@ -1,10 +0,0 @@ -# Generated by `turbo run openapi:finetuning` - DO NOT EDIT. -type: object -properties: - finetuned_model: - $ref: ./FinetunedModel.yaml - description: Information about the fine-tuned model. -description: Response to request to create a fine-tuned model. -x-fern-sdk-group-name: - - finetuning - - finetuning diff --git a/fern/openapi/types/v1/finetuning/DeleteFinetunedModelResponse.yaml b/fern/openapi/types/v1/finetuning/DeleteFinetunedModelResponse.yaml deleted file mode 100644 index 17ccd92e..00000000 --- a/fern/openapi/types/v1/finetuning/DeleteFinetunedModelResponse.yaml +++ /dev/null @@ -1,6 +0,0 @@ -# Generated by `turbo run openapi:finetuning` - DO NOT EDIT. -type: object -description: Response to request to delete a fine-tuned model. -x-fern-sdk-group-name: - - finetuning - - finetuning diff --git a/fern/openapi/types/v1/finetuning/Error.yaml b/fern/openapi/types/v1/finetuning/Error.yaml deleted file mode 100644 index 2fa19728..00000000 --- a/fern/openapi/types/v1/finetuning/Error.yaml +++ /dev/null @@ -1,10 +0,0 @@ -# Generated by `turbo run openapi:finetuning` - DO NOT EDIT. -type: object -properties: - message: - type: string - description: A developer-facing error message. -description: Error is the response for any unsuccessful event. -x-fern-sdk-group-name: - - finetuning - - finetuning diff --git a/fern/openapi/types/v1/finetuning/Event.yaml b/fern/openapi/types/v1/finetuning/Event.yaml deleted file mode 100644 index 142f9ad9..00000000 --- a/fern/openapi/types/v1/finetuning/Event.yaml +++ /dev/null @@ -1,17 +0,0 @@ -# Generated by `turbo run openapi:finetuning` - DO NOT EDIT. -type: object -properties: - user_id: - type: string - description: ID of the user who initiated the event. Empty if initiated by the system. - status: - $ref: ./Status.yaml - description: Status of the fine-tuned model. - created_at: - type: string - format: date-time - description: Timestamp when the event happened. -description: A change in status of a fine-tuned model. -x-fern-sdk-group-name: - - finetuning - - finetuning diff --git a/fern/openapi/types/v1/finetuning/FinetunedModel.yaml b/fern/openapi/types/v1/finetuning/FinetunedModel.yaml deleted file mode 100644 index 9ca9c121..00000000 --- a/fern/openapi/types/v1/finetuning/FinetunedModel.yaml +++ /dev/null @@ -1,52 +0,0 @@ -# Generated by `turbo run openapi:finetuning` - DO NOT EDIT. -type: object -properties: - id: - type: string - description: read-only. FinetunedModel ID. - readOnly: true - name: - type: string - description: FinetunedModel name (e.g. `foobar`). - creator_id: - type: string - description: read-only. User ID of the creator. - readOnly: true - organization_id: - type: string - description: read-only. Organization ID. - readOnly: true - settings: - $ref: ./Settings.yaml - description: FinetunedModel settings such as dataset, hyperparameters... - status: - $ref: ./Status.yaml - description: read-only. Current stage in the life-cycle of the fine-tuned model. - readOnly: true - created_at: - type: string - format: date-time - description: read-only. Creation timestamp. - readOnly: true - updated_at: - type: string - format: date-time - description: read-only. Latest update timestamp. - readOnly: true - completed_at: - type: string - format: date-time - description: read-only. Timestamp for the completed fine-tuning. - readOnly: true - last_used: - type: string - format: date-time - description: read-only. Timestamp for the latest request to this fine-tuned model. - readOnly: true -description: This resource represents a fine-tuned model. -required: - - name - - settings -x-fern-sdk-group-name: - - finetuning - - finetuning diff --git a/fern/openapi/types/v1/finetuning/GetFinetunedModelResponse.yaml b/fern/openapi/types/v1/finetuning/GetFinetunedModelResponse.yaml deleted file mode 100644 index cdbfc478..00000000 --- a/fern/openapi/types/v1/finetuning/GetFinetunedModelResponse.yaml +++ /dev/null @@ -1,10 +0,0 @@ -# Generated by `turbo run openapi:finetuning` - DO NOT EDIT. -type: object -properties: - finetuned_model: - $ref: ./FinetunedModel.yaml - description: Information about the fine-tuned model. -description: Response to a request to get a fine-tuned model. -x-fern-sdk-group-name: - - finetuning - - finetuning diff --git a/fern/openapi/types/v1/finetuning/Hyperparameters.yaml b/fern/openapi/types/v1/finetuning/Hyperparameters.yaml deleted file mode 100644 index e801fbfc..00000000 --- a/fern/openapi/types/v1/finetuning/Hyperparameters.yaml +++ /dev/null @@ -1,31 +0,0 @@ -# Generated by `turbo run openapi:finetuning` - DO NOT EDIT. -type: object -properties: - early_stopping_patience: - type: integer - format: int32 - description: |- - Stops training if the loss metric does not improve beyond the value of - `early_stopping_threshold` after this many times of evaluation. - early_stopping_threshold: - type: number - format: double - description: How much the loss must improve to prevent early stopping. - train_batch_size: - type: integer - format: int32 - description: |- - The batch size is the number of training examples included in a single - training pass. - train_epochs: - type: integer - format: int32 - description: The number of epochs to train for. - learning_rate: - type: number - format: double - description: The learning rate to be used during training. -description: The fine-tuning hyperparameters. -x-fern-sdk-group-name: - - finetuning - - finetuning diff --git a/fern/openapi/types/v1/finetuning/ListEventsResponse.yaml b/fern/openapi/types/v1/finetuning/ListEventsResponse.yaml deleted file mode 100644 index 75aab9d8..00000000 --- a/fern/openapi/types/v1/finetuning/ListEventsResponse.yaml +++ /dev/null @@ -1,22 +0,0 @@ -# Generated by `turbo run openapi:finetuning` - DO NOT EDIT. -type: object -properties: - events: - type: array - items: - type: object - $ref: ./Event.yaml - description: List of events for the fine-tuned model. - next_page_token: - type: string - description: |- - Pagination token to retrieve the next page of results. If the value is "", - it means no further results for the request. - total_size: - type: integer - format: int32 - description: Total count of results. -description: Response to a request to list events of a fine-tuned model. -x-fern-sdk-group-name: - - finetuning - - finetuning diff --git a/fern/openapi/types/v1/finetuning/ListFinetunedModelsResponse.yaml b/fern/openapi/types/v1/finetuning/ListFinetunedModelsResponse.yaml deleted file mode 100644 index cefe2ec1..00000000 --- a/fern/openapi/types/v1/finetuning/ListFinetunedModelsResponse.yaml +++ /dev/null @@ -1,22 +0,0 @@ -# Generated by `turbo run openapi:finetuning` - DO NOT EDIT. -type: object -properties: - finetuned_models: - type: array - items: - type: object - $ref: ./FinetunedModel.yaml - description: List of fine-tuned models matching the request. - next_page_token: - type: string - description: |- - Pagination token to retrieve the next page of results. If the value is "", - it means no further results for the request. - total_size: - type: integer - format: int32 - description: Total count of results. -description: Response to a request to list fine-tuned models. -x-fern-sdk-group-name: - - finetuning - - finetuning diff --git a/fern/openapi/types/v1/finetuning/ListTrainingStepMetricsResponse.yaml b/fern/openapi/types/v1/finetuning/ListTrainingStepMetricsResponse.yaml deleted file mode 100644 index 333abcd7..00000000 --- a/fern/openapi/types/v1/finetuning/ListTrainingStepMetricsResponse.yaml +++ /dev/null @@ -1,18 +0,0 @@ -# Generated by `turbo run openapi:finetuning` - DO NOT EDIT. -type: object -properties: - step_metrics: - type: array - items: - type: object - $ref: ./TrainingStepMetrics.yaml - description: The metrics for each step the evaluation was run on. - next_page_token: - type: string - description: |- - Pagination token to retrieve the next page of results. If the value is "", - it means no further results for the request. -description: Response to a request to list training-step metrics of a fine-tuned model. -x-fern-sdk-group-name: - - finetuning - - finetuning diff --git a/fern/openapi/types/v1/finetuning/Settings.yaml b/fern/openapi/types/v1/finetuning/Settings.yaml deleted file mode 100644 index 1bc4638d..00000000 --- a/fern/openapi/types/v1/finetuning/Settings.yaml +++ /dev/null @@ -1,24 +0,0 @@ -# Generated by `turbo run openapi:finetuning` - DO NOT EDIT. -type: object -properties: - base_model: - $ref: ./BaseModel.yaml - description: The base model to fine-tune. - dataset_id: - type: string - description: The data used for training and evaluating the fine-tuned model. - hyperparameters: - $ref: ./Hyperparameters.yaml - description: Fine-tuning hyper-parameters. - multi_label: - type: boolean - description: read-only. Whether the model is single-label or multi-label (only - for classification). - readOnly: true -description: The configuration used for fine-tuning. -required: - - base_model - - dataset_id -x-fern-sdk-group-name: - - finetuning - - finetuning diff --git a/fern/openapi/types/v1/finetuning/Status.yaml b/fern/openapi/types/v1/finetuning/Status.yaml deleted file mode 100644 index a7f0aa2d..00000000 --- a/fern/openapi/types/v1/finetuning/Status.yaml +++ /dev/null @@ -1,28 +0,0 @@ -# Generated by `turbo run openapi:finetuning` - DO NOT EDIT. -type: string -enum: - - STATUS_UNSPECIFIED - - STATUS_FINETUNING - - STATUS_DEPLOYING_API - - STATUS_READY - - STATUS_FAILED - - STATUS_DELETED - - STATUS_TEMPORARILY_OFFLINE - - STATUS_PAUSED - - STATUS_QUEUED -default: STATUS_UNSPECIFIED -description: >- - The possible stages of a fine-tuned model life-cycle. - - - STATUS_UNSPECIFIED: Unspecified status. - - STATUS_FINETUNING: The fine-tuned model is being fine-tuned. - - STATUS_DEPLOYING_API: The fine-tuned model is being deployed. - - STATUS_READY: The fine-tuned model is ready to receive requests. - - STATUS_FAILED: The fine-tuned model failed. - - STATUS_DELETED: The fine-tuned model was deleted. - - STATUS_TEMPORARILY_OFFLINE: The fine-tuned model is temporarily unavailable. - - STATUS_PAUSED: The fine-tuned model is paused (Vanilla only). - - STATUS_QUEUED: The fine-tuned model is queued for training. -x-fern-sdk-group-name: - - finetuning - - finetuning diff --git a/fern/openapi/types/v1/finetuning/Strategy.yaml b/fern/openapi/types/v1/finetuning/Strategy.yaml deleted file mode 100644 index 5974ff0c..00000000 --- a/fern/openapi/types/v1/finetuning/Strategy.yaml +++ /dev/null @@ -1,16 +0,0 @@ -# Generated by `turbo run openapi:finetuning` - DO NOT EDIT. -type: string -enum: - - STRATEGY_UNSPECIFIED - - STRATEGY_VANILLA - - STRATEGY_TFEW -default: STRATEGY_UNSPECIFIED -description: |- - The possible strategy used to serve a fine-tuned models. - - - STRATEGY_UNSPECIFIED: Unspecified strategy. - - STRATEGY_VANILLA: Serve the fine-tuned model on a dedicated GPU. - - STRATEGY_TFEW: Serve the fine-tuned model on a shared GPU. -x-fern-sdk-group-name: - - finetuning - - finetuning diff --git a/fern/openapi/types/v1/finetuning/TrainingStepMetrics.yaml b/fern/openapi/types/v1/finetuning/TrainingStepMetrics.yaml deleted file mode 100644 index 89c13b29..00000000 --- a/fern/openapi/types/v1/finetuning/TrainingStepMetrics.yaml +++ /dev/null @@ -1,21 +0,0 @@ -# Generated by `turbo run openapi:finetuning` - DO NOT EDIT. -type: object -properties: - created_at: - type: string - format: date-time - description: Creation timestamp. - step_number: - type: integer - format: int32 - description: Step number. - metrics: - type: object - additionalProperties: - type: number - format: double - description: Map of names and values for each evaluation metrics. -description: The evaluation metrics at a given step of the training of a fine-tuned model. -x-fern-sdk-group-name: - - finetuning - - finetuning diff --git a/fern/openapi/types/v1/finetuning/UpdateFinetunedModelResponse.yaml b/fern/openapi/types/v1/finetuning/UpdateFinetunedModelResponse.yaml deleted file mode 100644 index 25d76957..00000000 --- a/fern/openapi/types/v1/finetuning/UpdateFinetunedModelResponse.yaml +++ /dev/null @@ -1,10 +0,0 @@ -# Generated by `turbo run openapi:finetuning` - DO NOT EDIT. -type: object -properties: - finetuned_model: - $ref: ./FinetunedModel.yaml - description: Information about the fine-tuned model. -description: Response to a request to update a fine-tuned model. -x-fern-sdk-group-name: - - finetuning - - finetuning