Skip to content

Commit

Permalink
Adding description and also adding enumerations page link in api section
Browse files Browse the repository at this point in the history
Adding description and also adding enumerations page link in api section
  • Loading branch information
edmcquinn committed Oct 17, 2024
1 parent 5f28be2 commit 3de2ad3
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 17 deletions.
4 changes: 4 additions & 0 deletions fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,10 @@ navigation:
layout:
- api: API Reference
display-errors: true
- section: Valid Inputs
contents:
- page: Enumerations for API
path: ./docs/pages/options/enumerations.mdx
- section: SDK Reference
contents:
- page: Chat
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,22 +43,22 @@ paths:
description: The chat model to use for generating completions.
messages:
oneOf:
- type: string
description: A string of the message used for generating completions.
- type: array
description: An array of messages used for generating completions.
items:
required:
- role
- content
type: object
properties:
role:
type: string
description: The role of the sender (user or assistant).
content:
type: string
description: The content of the message.
- type: string
description: A string of the message used for generating completions.
- type: array
description: An array of messages used for generating completions.
items:
required:
- role
- content
type: object
properties:
role:
type: string
description: The role of the sender (user or assistant).
content:
type: string
description: The content of the message.
max_tokens:
type: integer
description: The maximum number of tokens in the generated completion.
Expand Down Expand Up @@ -124,7 +124,7 @@ paths:
type: string
description: Description of the error.
example:
error: "api understands the request but refuses to authorize it"
error: "api understands the request but refuses to authorize it"
"400":
description: General error response.
content:
Expand Down Expand Up @@ -760,6 +760,7 @@ paths:
- type: string
description: A string of text to be embedded.
- type: object
description: Use this option for multimodal input.
properties:
text:
type: string
Expand Down

0 comments on commit 3de2ad3

Please sign in to comment.