mirror of
https://github.com/LukeHagar/log10py.git
synced 2025-12-06 04:20:12 +00:00
Initial commit
This commit is contained in:
Niklas Nielsen
3
Makefile
Normal file
3
Makefile
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
download_specs:
|
||||||
|
wget -q https://raw.githubusercontent.com/log10-io/openapi/main/openapi.yaml -O openapi.yaml
|
||||||
|
wget -q https://raw.githubusercontent.com/log10-io/openapi/main/openai.yaml -O openai.yaml
|
||||||
354
README.md
Normal file
354
README.md
Normal file
@@ -0,0 +1,354 @@
|
|||||||
|
# log10py
|
||||||
|
|
||||||
|
<div align="left">
|
||||||
|
<a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
|
||||||
|
<a href="https://opensource.org/licenses/MIT">
|
||||||
|
<img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
## 🏗 **Welcome to your new SDK!** 🏗
|
||||||
|
|
||||||
|
It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:
|
||||||
|
- [ ] 🛠 Make your SDK feel handcrafted by [customizing it](https://www.speakeasyapi.dev/docs/customize-sdks)
|
||||||
|
- [ ] ♻️ Refine your SDK quickly by iterating locally with the [Speakeasy CLI](https://github.com/speakeasy-api/speakeasy)
|
||||||
|
- [ ] 🎁 Publish your SDK to package managers by [configuring automatic publishing](https://www.speakeasyapi.dev/docs/advanced-setup/publish-sdks)
|
||||||
|
- [ ] ✨ When ready to productionize, delete this section from the README
|
||||||
|
|
||||||
|
<!-- Start SDK Installation [installation] -->
|
||||||
|
## SDK Installation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install git+<UNSET>.git
|
||||||
|
```
|
||||||
|
<!-- End SDK Installation [installation] -->
|
||||||
|
|
||||||
|
<!-- Start SDK Example Usage [usage] -->
|
||||||
|
## SDK Example Usage
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
```python
|
||||||
|
import log10
|
||||||
|
|
||||||
|
s = log10.Log10(
|
||||||
|
log10_token="<YOUR_API_KEY_HERE>",
|
||||||
|
x_log10_organization='<value>',
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
res = s.sessions.create(x_log10_organization='<value>')
|
||||||
|
|
||||||
|
if res.object is not None:
|
||||||
|
# handle response
|
||||||
|
pass
|
||||||
|
|
||||||
|
```
|
||||||
|
<!-- End SDK Example Usage [usage] -->
|
||||||
|
|
||||||
|
<!-- Start Available Resources and Operations [operations] -->
|
||||||
|
## Available Resources and Operations
|
||||||
|
|
||||||
|
### [completions](docs/sdks/completions/README.md)
|
||||||
|
|
||||||
|
* [create](docs/sdks/completions/README.md#create) - Create a completion
|
||||||
|
* [update](docs/sdks/completions/README.md#update) - Update completion by id.
|
||||||
|
* [list_ungraded](docs/sdks/completions/README.md#list_ungraded) - List ungraded completions i.e. completions that have not been associated with feedback but matches task selector.
|
||||||
|
|
||||||
|
### [sessions](docs/sdks/sessions/README.md)
|
||||||
|
|
||||||
|
* [create](docs/sdks/sessions/README.md#create) - Create a session
|
||||||
|
|
||||||
|
### [feedback](docs/sdks/feedback/README.md)
|
||||||
|
|
||||||
|
* [get](docs/sdks/feedback/README.md#get) - Fetch feedback by id.
|
||||||
|
* [list](docs/sdks/feedback/README.md#list) - List feedback
|
||||||
|
* [upload](docs/sdks/feedback/README.md#upload) - Upload a piece of feedback
|
||||||
|
|
||||||
|
### [feedback_tasks](docs/sdks/feedbacktasks/README.md)
|
||||||
|
|
||||||
|
* [list](docs/sdks/feedbacktasks/README.md#list) - List feedback tasks.
|
||||||
|
* [create](docs/sdks/feedbacktasks/README.md#create) - Create a new task.
|
||||||
|
* [get](docs/sdks/feedbacktasks/README.md#get) - Retrieves feedback task `taskId`.
|
||||||
|
<!-- End Available Resources and Operations [operations] -->
|
||||||
|
|
||||||
|
<!-- Start Global Parameters [global-parameters] -->
|
||||||
|
## Global Parameters
|
||||||
|
|
||||||
|
A parameter is configured globally. This parameter must be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
|
||||||
|
|
||||||
|
For example, you can set `X-Log10-Organization` to `'<value>'` at SDK initialization and then you do not have to pass the same value on calls to operations like `update`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
|
||||||
|
|
||||||
|
|
||||||
|
### Available Globals
|
||||||
|
|
||||||
|
The following global parameter is available. The required parameter must be set when you initialize the SDK client.
|
||||||
|
|
||||||
|
| Name | Type | Required | Description |
|
||||||
|
| ---- | ---- |:--------:| ----------- |
|
||||||
|
| x_log10_organization | str | ✔️ | The x_log10_organization parameter. |
|
||||||
|
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
```python
|
||||||
|
import log10
|
||||||
|
from log10.models import components
|
||||||
|
|
||||||
|
s = log10.Log10(
|
||||||
|
log10_token="<YOUR_API_KEY_HERE>",
|
||||||
|
x_log10_organization='<value>',
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
res = s.completions.update(completion_id='<value>', completion=components.Completion(
|
||||||
|
organization_id='<value>',
|
||||||
|
request=components.CreateChatCompletionRequest(
|
||||||
|
messages=[
|
||||||
|
components.ChatCompletionRequestFunctionMessage(
|
||||||
|
role=components.ChatCompletionRequestFunctionMessageRole.FUNCTION,
|
||||||
|
content='<value>',
|
||||||
|
name='<value>',
|
||||||
|
),
|
||||||
|
],
|
||||||
|
model=components.Two.GPT_4_TURBO,
|
||||||
|
n=1,
|
||||||
|
response_format=components.ResponseFormat(
|
||||||
|
type=components.CreateChatCompletionRequestType.JSON_OBJECT,
|
||||||
|
),
|
||||||
|
temperature=1,
|
||||||
|
top_p=1,
|
||||||
|
user='user-1234',
|
||||||
|
),
|
||||||
|
), x_log10_organization='<value>')
|
||||||
|
|
||||||
|
if res.completion is not None:
|
||||||
|
# handle response
|
||||||
|
pass
|
||||||
|
|
||||||
|
```
|
||||||
|
<!-- End Global Parameters [global-parameters] -->
|
||||||
|
|
||||||
|
<!-- Start Error Handling [errors] -->
|
||||||
|
## Error Handling
|
||||||
|
|
||||||
|
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
|
||||||
|
|
||||||
|
| Error Object | Status Code | Content Type |
|
||||||
|
| --------------- | --------------- | --------------- |
|
||||||
|
| errors.SDKError | 4xx-5xx | */* |
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
```python
|
||||||
|
import log10
|
||||||
|
from log10.models import components, errors
|
||||||
|
|
||||||
|
s = log10.Log10(
|
||||||
|
log10_token="<YOUR_API_KEY_HERE>",
|
||||||
|
x_log10_organization='<value>',
|
||||||
|
)
|
||||||
|
|
||||||
|
res = None
|
||||||
|
try:
|
||||||
|
res = s.completions.create(completion=components.Completion(
|
||||||
|
organization_id='<value>',
|
||||||
|
request=components.CreateChatCompletionRequest(
|
||||||
|
messages=[
|
||||||
|
components.ChatCompletionRequestAssistantMessage(
|
||||||
|
role=components.ChatCompletionRequestAssistantMessageRole.ASSISTANT,
|
||||||
|
),
|
||||||
|
],
|
||||||
|
model=components.Two.GPT_4_TURBO,
|
||||||
|
n=1,
|
||||||
|
response_format=components.ResponseFormat(
|
||||||
|
type=components.CreateChatCompletionRequestType.JSON_OBJECT,
|
||||||
|
),
|
||||||
|
temperature=1,
|
||||||
|
top_p=1,
|
||||||
|
user='user-1234',
|
||||||
|
),
|
||||||
|
), x_log10_organization='<value>')
|
||||||
|
|
||||||
|
except errors.SDKError as e:
|
||||||
|
# handle exception
|
||||||
|
raise(e)
|
||||||
|
|
||||||
|
if res.any is not None:
|
||||||
|
# handle response
|
||||||
|
pass
|
||||||
|
|
||||||
|
```
|
||||||
|
<!-- End Error Handling [errors] -->
|
||||||
|
|
||||||
|
<!-- Start Server Selection [server] -->
|
||||||
|
## Server Selection
|
||||||
|
|
||||||
|
### Select Server by Index
|
||||||
|
|
||||||
|
You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
|
||||||
|
|
||||||
|
| # | Server | Variables |
|
||||||
|
| - | ------ | --------- |
|
||||||
|
| 0 | `https://log10.io` | None |
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
|
||||||
|
```python
|
||||||
|
import log10
|
||||||
|
from log10.models import components
|
||||||
|
|
||||||
|
s = log10.Log10(
|
||||||
|
server_idx=0,
|
||||||
|
log10_token="<YOUR_API_KEY_HERE>",
|
||||||
|
x_log10_organization='<value>',
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
res = s.completions.create(completion=components.Completion(
|
||||||
|
organization_id='<value>',
|
||||||
|
request=components.CreateChatCompletionRequest(
|
||||||
|
messages=[
|
||||||
|
components.ChatCompletionRequestAssistantMessage(
|
||||||
|
role=components.ChatCompletionRequestAssistantMessageRole.ASSISTANT,
|
||||||
|
),
|
||||||
|
],
|
||||||
|
model=components.Two.GPT_4_TURBO,
|
||||||
|
n=1,
|
||||||
|
response_format=components.ResponseFormat(
|
||||||
|
type=components.CreateChatCompletionRequestType.JSON_OBJECT,
|
||||||
|
),
|
||||||
|
temperature=1,
|
||||||
|
top_p=1,
|
||||||
|
user='user-1234',
|
||||||
|
),
|
||||||
|
), x_log10_organization='<value>')
|
||||||
|
|
||||||
|
if res.any is not None:
|
||||||
|
# handle response
|
||||||
|
pass
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### Override Server URL Per-Client
|
||||||
|
|
||||||
|
The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
|
||||||
|
```python
|
||||||
|
import log10
|
||||||
|
from log10.models import components
|
||||||
|
|
||||||
|
s = log10.Log10(
|
||||||
|
server_url="https://log10.io",
|
||||||
|
log10_token="<YOUR_API_KEY_HERE>",
|
||||||
|
x_log10_organization='<value>',
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
res = s.completions.create(completion=components.Completion(
|
||||||
|
organization_id='<value>',
|
||||||
|
request=components.CreateChatCompletionRequest(
|
||||||
|
messages=[
|
||||||
|
components.ChatCompletionRequestAssistantMessage(
|
||||||
|
role=components.ChatCompletionRequestAssistantMessageRole.ASSISTANT,
|
||||||
|
),
|
||||||
|
],
|
||||||
|
model=components.Two.GPT_4_TURBO,
|
||||||
|
n=1,
|
||||||
|
response_format=components.ResponseFormat(
|
||||||
|
type=components.CreateChatCompletionRequestType.JSON_OBJECT,
|
||||||
|
),
|
||||||
|
temperature=1,
|
||||||
|
top_p=1,
|
||||||
|
user='user-1234',
|
||||||
|
),
|
||||||
|
), x_log10_organization='<value>')
|
||||||
|
|
||||||
|
if res.any is not None:
|
||||||
|
# handle response
|
||||||
|
pass
|
||||||
|
|
||||||
|
```
|
||||||
|
<!-- End Server Selection [server] -->
|
||||||
|
|
||||||
|
<!-- Start Custom HTTP Client [http-client] -->
|
||||||
|
## Custom HTTP Client
|
||||||
|
|
||||||
|
The Python SDK makes API calls using the [requests](https://pypi.org/project/requests/) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object.
|
||||||
|
|
||||||
|
For example, you could specify a header for every request that this sdk makes as follows:
|
||||||
|
```python
|
||||||
|
import log10
|
||||||
|
import requests
|
||||||
|
|
||||||
|
http_client = requests.Session()
|
||||||
|
http_client.headers.update({'x-custom-header': 'someValue'})
|
||||||
|
s = log10.Log10(client=http_client)
|
||||||
|
```
|
||||||
|
<!-- End Custom HTTP Client [http-client] -->
|
||||||
|
|
||||||
|
<!-- Start Authentication [security] -->
|
||||||
|
## Authentication
|
||||||
|
|
||||||
|
### Per-Client Security Schemes
|
||||||
|
|
||||||
|
This SDK supports the following security scheme globally:
|
||||||
|
|
||||||
|
| Name | Type | Scheme |
|
||||||
|
| ------------- | ------------- | ------------- |
|
||||||
|
| `log10_token` | apiKey | API key |
|
||||||
|
|
||||||
|
To authenticate with the API the `log10_token` parameter must be set when initializing the SDK client instance. For example:
|
||||||
|
```python
|
||||||
|
import log10
|
||||||
|
from log10.models import components
|
||||||
|
|
||||||
|
s = log10.Log10(
|
||||||
|
log10_token="<YOUR_API_KEY_HERE>",
|
||||||
|
x_log10_organization='<value>',
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
res = s.completions.create(completion=components.Completion(
|
||||||
|
organization_id='<value>',
|
||||||
|
request=components.CreateChatCompletionRequest(
|
||||||
|
messages=[
|
||||||
|
components.ChatCompletionRequestAssistantMessage(
|
||||||
|
role=components.ChatCompletionRequestAssistantMessageRole.ASSISTANT,
|
||||||
|
),
|
||||||
|
],
|
||||||
|
model=components.Two.GPT_4_TURBO,
|
||||||
|
n=1,
|
||||||
|
response_format=components.ResponseFormat(
|
||||||
|
type=components.CreateChatCompletionRequestType.JSON_OBJECT,
|
||||||
|
),
|
||||||
|
temperature=1,
|
||||||
|
top_p=1,
|
||||||
|
user='user-1234',
|
||||||
|
),
|
||||||
|
), x_log10_organization='<value>')
|
||||||
|
|
||||||
|
if res.any is not None:
|
||||||
|
# handle response
|
||||||
|
pass
|
||||||
|
|
||||||
|
```
|
||||||
|
<!-- End Authentication [security] -->
|
||||||
|
|
||||||
|
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
||||||
|
|
||||||
|
# Development
|
||||||
|
|
||||||
|
## Maturity
|
||||||
|
|
||||||
|
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
|
||||||
|
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
|
||||||
|
looking for the latest version.
|
||||||
|
|
||||||
|
## Contributions
|
||||||
|
|
||||||
|
While we value open-source contributions to this SDK, this library is generated programmatically.
|
||||||
|
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
|
||||||
|
|
||||||
|
### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
|
||||||
18
USAGE.md
Normal file
18
USAGE.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
<!-- Start SDK Example Usage [usage] -->
|
||||||
|
```python
|
||||||
|
import log10
|
||||||
|
|
||||||
|
s = log10.Log10(
|
||||||
|
log10_token="<YOUR_API_KEY_HERE>",
|
||||||
|
x_log10_organization='<value>',
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
res = s.sessions.create(x_log10_organization='<value>')
|
||||||
|
|
||||||
|
if res.object is not None:
|
||||||
|
# handle response
|
||||||
|
pass
|
||||||
|
|
||||||
|
```
|
||||||
|
<!-- End SDK Example Usage [usage] -->
|
||||||
11
docs/models/components/chatcompletionfunctioncalloption.md
Normal file
11
docs/models/components/chatcompletionfunctioncalloption.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# ChatCompletionFunctionCallOption
|
||||||
|
|
||||||
|
Specifying a particular function via `{"name": "my_function"}` forces the model to call that function.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
|
||||||
|
| `name` | *str* | :heavy_check_mark: | The name of the function to call. |
|
||||||
12
docs/models/components/chatcompletionfunctions.md
Normal file
12
docs/models/components/chatcompletionfunctions.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# ~~ChatCompletionFunctions~~
|
||||||
|
|
||||||
|
> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `name` | *str* | :heavy_check_mark: | The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. |
|
||||||
|
| `description` | *Optional[str]* | :heavy_minus_sign: | A description of what the function does, used by the model to choose when and how to call the function. |
|
||||||
|
| `parameters` | Dict[str, *Any*] | :heavy_minus_sign: | The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/text-generation/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. <br/><br/>Omitting `parameters` defines a function with an empty parameter list. |
|
||||||
10
docs/models/components/chatcompletionmessagetoolcall.md
Normal file
10
docs/models/components/chatcompletionmessagetoolcall.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# ChatCompletionMessageToolCall
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `id` | *str* | :heavy_check_mark: | The ID of the tool call. |
|
||||||
|
| `type` | [components.ChatCompletionMessageToolCallType](../../models/components/chatcompletionmessagetoolcalltype.md) | :heavy_check_mark: | The type of the tool. Currently, only `function` is supported. |
|
||||||
|
| `function` | [components.Function](../../models/components/function.md) | :heavy_check_mark: | The function that the model called. |
|
||||||
10
docs/models/components/chatcompletionmessagetoolcalltype.md
Normal file
10
docs/models/components/chatcompletionmessagetoolcalltype.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# ChatCompletionMessageToolCallType
|
||||||
|
|
||||||
|
The type of the tool. Currently, only `function` is supported.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------- | ---------- |
|
||||||
|
| `FUNCTION` | function |
|
||||||
11
docs/models/components/chatcompletionnamedtoolchoice.md
Normal file
11
docs/models/components/chatcompletionnamedtoolchoice.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# ChatCompletionNamedToolChoice
|
||||||
|
|
||||||
|
Specifies a tool the model should use. Use to force the model to call a specific function.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `type` | [components.ChatCompletionNamedToolChoiceType](../../models/components/chatcompletionnamedtoolchoicetype.md) | :heavy_check_mark: | The type of the tool. Currently, only `function` is supported. |
|
||||||
|
| `function` | [components.ChatCompletionNamedToolChoiceFunction](../../models/components/chatcompletionnamedtoolchoicefunction.md) | :heavy_check_mark: | N/A |
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
# ChatCompletionNamedToolChoiceFunction
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
|
||||||
|
| `name` | *str* | :heavy_check_mark: | The name of the function to call. |
|
||||||
10
docs/models/components/chatcompletionnamedtoolchoicetype.md
Normal file
10
docs/models/components/chatcompletionnamedtoolchoicetype.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# ChatCompletionNamedToolChoiceType
|
||||||
|
|
||||||
|
The type of the tool. Currently, only `function` is supported.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------- | ---------- |
|
||||||
|
| `FUNCTION` | function |
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# ChatCompletionRequestAssistantMessage
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `role` | [components.ChatCompletionRequestAssistantMessageRole](../../models/components/chatcompletionrequestassistantmessagerole.md) | :heavy_check_mark: | The role of the messages author, in this case `assistant`. |
|
||||||
|
| `content` | *Optional[str]* | :heavy_minus_sign: | The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.<br/> |
|
||||||
|
| `name` | *Optional[str]* | :heavy_minus_sign: | An optional name for the participant. Provides the model information to differentiate between participants of the same role. |
|
||||||
|
| `tool_calls` | List[[components.ChatCompletionMessageToolCall](../../models/components/chatcompletionmessagetoolcall.md)] | :heavy_minus_sign: | The tool calls generated by the model, such as function calls. |
|
||||||
|
| ~~`function_call`~~ | [Optional[components.FunctionCall]](../../models/components/functioncall.md) | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model. |
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# ChatCompletionRequestAssistantMessageRole
|
||||||
|
|
||||||
|
The role of the messages author, in this case `assistant`.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `ASSISTANT` | assistant |
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# ~~ChatCompletionRequestFunctionMessage~~
|
||||||
|
|
||||||
|
> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `role` | [components.ChatCompletionRequestFunctionMessageRole](../../models/components/chatcompletionrequestfunctionmessagerole.md) | :heavy_check_mark: | The role of the messages author, in this case `function`. |
|
||||||
|
| `content` | *Optional[str]* | :heavy_check_mark: | The contents of the function message. |
|
||||||
|
| `name` | *str* | :heavy_check_mark: | The name of the function to call. |
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# ChatCompletionRequestFunctionMessageRole
|
||||||
|
|
||||||
|
The role of the messages author, in this case `function`.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------- | ---------- |
|
||||||
|
| `FUNCTION` | function |
|
||||||
35
docs/models/components/chatcompletionrequestmessage.md
Normal file
35
docs/models/components/chatcompletionrequestmessage.md
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
# ChatCompletionRequestMessage
|
||||||
|
|
||||||
|
|
||||||
|
## Supported Types
|
||||||
|
|
||||||
|
### ChatCompletionRequestSystemMessage
|
||||||
|
|
||||||
|
```python
|
||||||
|
chatCompletionRequestMessage: components.ChatCompletionRequestSystemMessage = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### ChatCompletionRequestUserMessage
|
||||||
|
|
||||||
|
```python
|
||||||
|
chatCompletionRequestMessage: components.ChatCompletionRequestUserMessage = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### ChatCompletionRequestAssistantMessage
|
||||||
|
|
||||||
|
```python
|
||||||
|
chatCompletionRequestMessage: components.ChatCompletionRequestAssistantMessage = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### ChatCompletionRequestToolMessage
|
||||||
|
|
||||||
|
```python
|
||||||
|
chatCompletionRequestMessage: components.ChatCompletionRequestToolMessage = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### ChatCompletionRequestFunctionMessage
|
||||||
|
|
||||||
|
```python
|
||||||
|
chatCompletionRequestMessage: components.ChatCompletionRequestFunctionMessage = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
# ChatCompletionRequestMessageContentPart
|
||||||
|
|
||||||
|
|
||||||
|
## Supported Types
|
||||||
|
|
||||||
|
### ChatCompletionRequestMessageContentPartText
|
||||||
|
|
||||||
|
```python
|
||||||
|
chatCompletionRequestMessageContentPart: components.ChatCompletionRequestMessageContentPartText = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### ChatCompletionRequestMessageContentPartImage
|
||||||
|
|
||||||
|
```python
|
||||||
|
chatCompletionRequestMessageContentPart: components.ChatCompletionRequestMessageContentPartImage = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# ChatCompletionRequestMessageContentPartImage
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `type` | [components.ChatCompletionRequestMessageContentPartImageType](../../models/components/chatcompletionrequestmessagecontentpartimagetype.md) | :heavy_check_mark: | The type of the content part. |
|
||||||
|
| `image_url` | [components.ImageURL](../../models/components/imageurl.md) | :heavy_check_mark: | N/A |
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# ChatCompletionRequestMessageContentPartImageType
|
||||||
|
|
||||||
|
The type of the content part.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `IMAGE_URL` | image_url |
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# ChatCompletionRequestMessageContentPartText
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
|
||||||
|
| `type` | [components.Type](../../models/components/type.md) | :heavy_check_mark: | The type of the content part. |
|
||||||
|
| `text` | *str* | :heavy_check_mark: | The text content. |
|
||||||
10
docs/models/components/chatcompletionrequestsystemmessage.md
Normal file
10
docs/models/components/chatcompletionrequestsystemmessage.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# ChatCompletionRequestSystemMessage
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `content` | *str* | :heavy_check_mark: | The contents of the system message. |
|
||||||
|
| `role` | [components.Role](../../models/components/role.md) | :heavy_check_mark: | The role of the messages author, in this case `system`. |
|
||||||
|
| `name` | *Optional[str]* | :heavy_minus_sign: | An optional name for the participant. Provides the model information to differentiate between participants of the same role. |
|
||||||
10
docs/models/components/chatcompletionrequesttoolmessage.md
Normal file
10
docs/models/components/chatcompletionrequesttoolmessage.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# ChatCompletionRequestToolMessage
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `role` | [components.ChatCompletionRequestToolMessageRole](../../models/components/chatcompletionrequesttoolmessagerole.md) | :heavy_check_mark: | The role of the messages author, in this case `tool`. |
|
||||||
|
| `content` | *str* | :heavy_check_mark: | The contents of the tool message. |
|
||||||
|
| `tool_call_id` | *str* | :heavy_check_mark: | Tool call that this message is responding to. |
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# ChatCompletionRequestToolMessageRole
|
||||||
|
|
||||||
|
The role of the messages author, in this case `tool`.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------ | ------ |
|
||||||
|
| `TOOL` | tool |
|
||||||
10
docs/models/components/chatcompletionrequestusermessage.md
Normal file
10
docs/models/components/chatcompletionrequestusermessage.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# ChatCompletionRequestUserMessage
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `content` | [components.Content](../../models/components/content.md) | :heavy_check_mark: | The contents of the user message.<br/> |
|
||||||
|
| `role` | [components.ChatCompletionRequestUserMessageRole](../../models/components/chatcompletionrequestusermessagerole.md) | :heavy_check_mark: | The role of the messages author, in this case `user`. |
|
||||||
|
| `name` | *Optional[str]* | :heavy_minus_sign: | An optional name for the participant. Provides the model information to differentiate between participants of the same role. |
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# ChatCompletionRequestUserMessageRole
|
||||||
|
|
||||||
|
The role of the messages author, in this case `user`.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------ | ------ |
|
||||||
|
| `USER` | user |
|
||||||
13
docs/models/components/chatcompletionresponsemessage.md
Normal file
13
docs/models/components/chatcompletionresponsemessage.md
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# ChatCompletionResponseMessage
|
||||||
|
|
||||||
|
A chat completion message generated by the model.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `content` | *Optional[str]* | :heavy_check_mark: | The contents of the message. |
|
||||||
|
| `role` | [components.ChatCompletionResponseMessageRole](../../models/components/chatcompletionresponsemessagerole.md) | :heavy_check_mark: | The role of the author of this message. |
|
||||||
|
| `tool_calls` | List[[components.ChatCompletionMessageToolCall](../../models/components/chatcompletionmessagetoolcall.md)] | :heavy_minus_sign: | The tool calls generated by the model, such as function calls. |
|
||||||
|
| ~~`function_call`~~ | [Optional[components.ChatCompletionResponseMessageFunctionCall]](../../models/components/chatcompletionresponsemessagefunctioncall.md) | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model. |
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
# ~~ChatCompletionResponseMessageFunctionCall~~
|
||||||
|
|
||||||
|
Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.
|
||||||
|
|
||||||
|
> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `arguments` | *str* | :heavy_check_mark: | The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. |
|
||||||
|
| `name` | *str* | :heavy_check_mark: | The name of the function to call. |
|
||||||
10
docs/models/components/chatcompletionresponsemessagerole.md
Normal file
10
docs/models/components/chatcompletionresponsemessagerole.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# ChatCompletionResponseMessageRole
|
||||||
|
|
||||||
|
The role of the author of this message.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ----------- | ----------- |
|
||||||
|
| `ASSISTANT` | assistant |
|
||||||
11
docs/models/components/chatcompletionstreamoptions.md
Normal file
11
docs/models/components/chatcompletionstreamoptions.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# ChatCompletionStreamOptions
|
||||||
|
|
||||||
|
Options for streaming response. Only set this when you set `stream: true`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `include_usage` | *Optional[bool]* | :heavy_minus_sign: | If set, an additional chunk will be streamed before the `data: [DONE]` message. The `usage` field on this chunk shows the token usage statistics for the entire request, and the `choices` field will always be an empty array. All other chunks will also include a `usage` field, but with a null value.<br/> |
|
||||||
11
docs/models/components/chatcompletiontokenlogprob.md
Normal file
11
docs/models/components/chatcompletiontokenlogprob.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# ChatCompletionTokenLogprob
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `token` | *str* | :heavy_check_mark: | The token. |
|
||||||
|
| `logprob` | *float* | :heavy_check_mark: | The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely. |
|
||||||
|
| `bytes` | List[*int*] | :heavy_check_mark: | A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. |
|
||||||
|
| `top_logprobs` | List[[components.TopLogprobs](../../models/components/toplogprobs.md)] | :heavy_check_mark: | List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned. |
|
||||||
9
docs/models/components/chatcompletiontool.md
Normal file
9
docs/models/components/chatcompletiontool.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# ChatCompletionTool
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||||
|
| `type` | [components.ChatCompletionToolType](../../models/components/chatcompletiontooltype.md) | :heavy_check_mark: | The type of the tool. Currently, only `function` is supported. |
|
||||||
|
| `function` | [components.FunctionObject](../../models/components/functionobject.md) | :heavy_check_mark: | N/A |
|
||||||
26
docs/models/components/chatcompletiontoolchoiceoption.md
Normal file
26
docs/models/components/chatcompletiontoolchoiceoption.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# ChatCompletionToolChoiceOption
|
||||||
|
|
||||||
|
Controls which (if any) tool is called by the model.
|
||||||
|
`none` means the model will not call any tool and instead generates a message.
|
||||||
|
`auto` means the model can pick between generating a message or calling one or more tools.
|
||||||
|
`required` means the model must call one or more tools.
|
||||||
|
Specifying a particular tool via `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool.
|
||||||
|
|
||||||
|
`none` is the default when no tools are present. `auto` is the default if tools are present.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Supported Types
|
||||||
|
|
||||||
|
### ChatCompletionToolChoiceOption1
|
||||||
|
|
||||||
|
```python
|
||||||
|
chatCompletionToolChoiceOption: components.ChatCompletionToolChoiceOption1 = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### ChatCompletionNamedToolChoice
|
||||||
|
|
||||||
|
```python
|
||||||
|
chatCompletionToolChoiceOption: components.ChatCompletionNamedToolChoice = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
13
docs/models/components/chatcompletiontoolchoiceoption1.md
Normal file
13
docs/models/components/chatcompletiontoolchoiceoption1.md
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# ChatCompletionToolChoiceOption1
|
||||||
|
|
||||||
|
`none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------- | ---------- |
|
||||||
|
| `NONE` | none |
|
||||||
|
| `AUTO` | auto |
|
||||||
|
| `REQUIRED` | required |
|
||||||
10
docs/models/components/chatcompletiontooltype.md
Normal file
10
docs/models/components/chatcompletiontooltype.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# ChatCompletionToolType
|
||||||
|
|
||||||
|
The type of the tool. Currently, only `function` is supported.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------- | ---------- |
|
||||||
|
| `FUNCTION` | function |
|
||||||
11
docs/models/components/choices.md
Normal file
11
docs/models/components/choices.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# Choices
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `finish_reason` | [components.FinishReason](../../models/components/finishreason.md) | :heavy_check_mark: | The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,<br/>`length` if the maximum number of tokens specified in the request was reached,<br/>`content_filter` if content was omitted due to a flag from our content filters,<br/>`tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.<br/> |
|
||||||
|
| `index` | *int* | :heavy_check_mark: | The index of the choice in the list of choices. |
|
||||||
|
| `message` | [components.ChatCompletionResponseMessage](../../models/components/chatcompletionresponsemessage.md) | :heavy_check_mark: | A chat completion message generated by the model. |
|
||||||
|
| `logprobs` | [Optional[components.Logprobs]](../../models/components/logprobs.md) | :heavy_check_mark: | Log probability information for the choice. |
|
||||||
19
docs/models/components/completion.md
Normal file
19
docs/models/components/completion.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# Completion
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `organization_id` | *str* | :heavy_check_mark: | The unique identifier for the organization. |
|
||||||
|
| `id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for this task. |
|
||||||
|
| `kind` | [Optional[components.Kind]](../../models/components/kind.md) | :heavy_minus_sign: | The kind of completion i.e. chat messages or prompt |
|
||||||
|
| `status` | [Optional[components.Status]](../../models/components/status.md) | :heavy_minus_sign: | The status of this completion. |
|
||||||
|
| `tags` | List[*str*] | :heavy_minus_sign: | The tags for this completion. |
|
||||||
|
| `request` | [Optional[components.CreateChatCompletionRequest]](../../models/components/createchatcompletionrequest.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `response` | [Optional[components.CreateChatCompletionResponse]](../../models/components/createchatcompletionresponse.md) | :heavy_minus_sign: | Represents a chat completion response returned by model, based on the provided input. |
|
||||||
|
| `stacktrace` | List[[components.Stacktrace](../../models/components/stacktrace.md)] | :heavy_minus_sign: | The stacktrace for this completion. |
|
||||||
|
| `session_id` | *Optional[str]* | :heavy_minus_sign: | The session id for this completion. |
|
||||||
|
| `duration` | *Optional[float]* | :heavy_minus_sign: | The duration of this completion in seconds. |
|
||||||
|
| `failure_kind` | *Optional[str]* | :heavy_minus_sign: | The failure kind of this completion. |
|
||||||
|
| `failure_reason` | *Optional[str]* | :heavy_minus_sign: | The failure reason of this completion. |
|
||||||
9
docs/models/components/completiontagsselector.md
Normal file
9
docs/models/components/completiontagsselector.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# CompletionTagsSelector
|
||||||
|
|
||||||
|
The completion tag matching with this task i.e. surfaced as needing feedback.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------- | ----------- | ----------- | ----------- |
|
||||||
12
docs/models/components/completionusage.md
Normal file
12
docs/models/components/completionusage.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# CompletionUsage
|
||||||
|
|
||||||
|
Usage statistics for the completion request.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||||
|
| `completion_tokens` | *int* | :heavy_check_mark: | Number of tokens in the generated completion. |
|
||||||
|
| `prompt_tokens` | *int* | :heavy_check_mark: | Number of tokens in the prompt. |
|
||||||
|
| `total_tokens` | *int* | :heavy_check_mark: | Total number of tokens used in the request (prompt + completion). |
|
||||||
20
docs/models/components/content.md
Normal file
20
docs/models/components/content.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# Content
|
||||||
|
|
||||||
|
The contents of the user message.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Supported Types
|
||||||
|
|
||||||
|
###
|
||||||
|
|
||||||
|
```python
|
||||||
|
content: str = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
###
|
||||||
|
|
||||||
|
```python
|
||||||
|
content: List[components.ChatCompletionRequestMessageContentPart] = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
28
docs/models/components/createchatcompletionrequest.md
Normal file
28
docs/models/components/createchatcompletionrequest.md
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
# CreateChatCompletionRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `messages` | List[[components.ChatCompletionRequestMessage](../../models/components/chatcompletionrequestmessage.md)] | :heavy_check_mark: | A list of messages comprising the conversation so far. [Example Python code](https://cookbook.openai.com/examples/how_to_format_inputs_to_chatgpt_models). | |
|
||||||
|
| `model` | [components.Model](../../models/components/model.md) | :heavy_check_mark: | ID of the model to use. See the [model endpoint compatibility](/docs/models/model-endpoint-compatibility) table for details on which models work with the Chat API. | gpt-4-turbo |
|
||||||
|
| `frequency_penalty` | *Optional[float]* | :heavy_minus_sign: | Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.<br/><br/>[See more information about frequency and presence penalties.](/docs/guides/text-generation/parameter-details)<br/> | |
|
||||||
|
| `logit_bias` | Dict[str, *int*] | :heavy_minus_sign: | Modify the likelihood of specified tokens appearing in the completion.<br/><br/>Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.<br/> | |
|
||||||
|
| `logprobs` | *Optional[bool]* | :heavy_minus_sign: | Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`. | |
|
||||||
|
| `top_logprobs` | *Optional[int]* | :heavy_minus_sign: | An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used. | |
|
||||||
|
| `max_tokens` | *Optional[int]* | :heavy_minus_sign: | The maximum number of [tokens](/tokenizer) that can be generated in the chat completion.<br/><br/>The total length of input tokens and generated tokens is limited by the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens.<br/> | |
|
||||||
|
| `n` | *Optional[int]* | :heavy_minus_sign: | How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep `n` as `1` to minimize costs. | 1 |
|
||||||
|
| `presence_penalty` | *Optional[float]* | :heavy_minus_sign: | Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.<br/><br/>[See more information about frequency and presence penalties.](/docs/guides/text-generation/parameter-details)<br/> | |
|
||||||
|
| `response_format` | [Optional[components.ResponseFormat]](../../models/components/responseformat.md) | :heavy_minus_sign: | An object specifying the format that the model must output. Compatible with [GPT-4 Turbo](/docs/models/gpt-4-and-gpt-4-turbo) and all GPT-3.5 Turbo models newer than `gpt-3.5-turbo-1106`.<br/><br/>Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is valid JSON.<br/><br/>**Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.<br/> | |
|
||||||
|
| `seed` | *Optional[int]* | :heavy_minus_sign: | This feature is in Beta.<br/>If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.<br/>Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.<br/> | |
|
||||||
|
| `stop` | [Optional[components.Stop]](../../models/components/stop.md) | :heavy_minus_sign: | Up to 4 sequences where the API will stop generating further tokens.<br/> | |
|
||||||
|
| `stream` | *Optional[bool]* | :heavy_minus_sign: | If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).<br/> | |
|
||||||
|
| `stream_options` | [Optional[components.ChatCompletionStreamOptions]](../../models/components/chatcompletionstreamoptions.md) | :heavy_minus_sign: | Options for streaming response. Only set this when you set `stream: true`.<br/> | |
|
||||||
|
| `temperature` | *Optional[float]* | :heavy_minus_sign: | What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.<br/><br/>We generally recommend altering this or `top_p` but not both.<br/> | 1 |
|
||||||
|
| `top_p` | *Optional[float]* | :heavy_minus_sign: | An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.<br/><br/>We generally recommend altering this or `temperature` but not both.<br/> | 1 |
|
||||||
|
| `tools` | List[[components.ChatCompletionTool](../../models/components/chatcompletiontool.md)] | :heavy_minus_sign: | A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported.<br/> | |
|
||||||
|
| `tool_choice` | [Optional[components.ChatCompletionToolChoiceOption]](../../models/components/chatcompletiontoolchoiceoption.md) | :heavy_minus_sign: | Controls which (if any) tool is called by the model.<br/>`none` means the model will not call any tool and instead generates a message.<br/>`auto` means the model can pick between generating a message or calling one or more tools.<br/>`required` means the model must call one or more tools.<br/>Specifying a particular tool via `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool.<br/><br/>`none` is the default when no tools are present. `auto` is the default if tools are present.<br/> | |
|
||||||
|
| `user` | *Optional[str]* | :heavy_minus_sign: | A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).<br/> | user-1234 |
|
||||||
|
| ~~`function_call`~~ | [Optional[components.CreateChatCompletionRequestFunctionCall]](../../models/components/createchatcompletionrequestfunctioncall.md) | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>Deprecated in favor of `tool_choice`.<br/><br/>Controls which (if any) function is called by the model.<br/>`none` means the model will not call a function and instead generates a message.<br/>`auto` means the model can pick between generating a message or calling a function.<br/>Specifying a particular function via `{"name": "my_function"}` forces the model to call that function.<br/><br/>`none` is the default when no functions are present. `auto` is the default if functions are present.<br/> | |
|
||||||
|
| ~~`functions`~~ | List[[components.ChatCompletionFunctions](../../models/components/chatcompletionfunctions.md)] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>Deprecated in favor of `tools`.<br/><br/>A list of functions the model may generate JSON inputs for.<br/> | |
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
# ~~CreateChatCompletionRequestFunctionCall~~
|
||||||
|
|
||||||
|
Deprecated in favor of `tool_choice`.
|
||||||
|
|
||||||
|
Controls which (if any) function is called by the model.
|
||||||
|
`none` means the model will not call a function and instead generates a message.
|
||||||
|
`auto` means the model can pick between generating a message or calling a function.
|
||||||
|
Specifying a particular function via `{"name": "my_function"}` forces the model to call that function.
|
||||||
|
|
||||||
|
`none` is the default when no functions are present. `auto` is the default if functions are present.
|
||||||
|
|
||||||
|
|
||||||
|
> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
|
||||||
|
|
||||||
|
|
||||||
|
## Supported Types
|
||||||
|
|
||||||
|
### One
|
||||||
|
|
||||||
|
```python
|
||||||
|
createChatCompletionRequestFunctionCall: components.One = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### ChatCompletionFunctionCallOption
|
||||||
|
|
||||||
|
```python
|
||||||
|
createChatCompletionRequestFunctionCall: components.ChatCompletionFunctionCallOption = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
11
docs/models/components/createchatcompletionrequesttype.md
Normal file
11
docs/models/components/createchatcompletionrequesttype.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# CreateChatCompletionRequestType
|
||||||
|
|
||||||
|
Must be one of `text` or `json_object`.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------- | ------------- |
|
||||||
|
| `TEXT` | text |
|
||||||
|
| `JSON_OBJECT` | json_object |
|
||||||
16
docs/models/components/createchatcompletionresponse.md
Normal file
16
docs/models/components/createchatcompletionresponse.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# CreateChatCompletionResponse
|
||||||
|
|
||||||
|
Represents a chat completion response returned by model, based on the provided input.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *str* | :heavy_check_mark: | A unique identifier for the chat completion. |
|
||||||
|
| `choices` | List[[components.Choices](../../models/components/choices.md)] | :heavy_check_mark: | A list of chat completion choices. Can be more than one if `n` is greater than 1. |
|
||||||
|
| `created` | *int* | :heavy_check_mark: | The Unix timestamp (in seconds) of when the chat completion was created. |
|
||||||
|
| `model` | *str* | :heavy_check_mark: | The model used for the chat completion. |
|
||||||
|
| `object` | [components.Object](../../models/components/object.md) | :heavy_check_mark: | The object type, which is always `chat.completion`. |
|
||||||
|
| `system_fingerprint` | *Optional[str]* | :heavy_minus_sign: | This fingerprint represents the backend configuration that the model runs with.<br/><br/>Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.<br/> |
|
||||||
|
| `usage` | [Optional[components.CompletionUsage]](../../models/components/completionusage.md) | :heavy_minus_sign: | Usage statistics for the completion request. |
|
||||||
12
docs/models/components/detail.md
Normal file
12
docs/models/components/detail.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# Detail
|
||||||
|
|
||||||
|
Specifies the detail level of the image. Learn more in the [Vision guide](/docs/guides/vision/low-or-high-fidelity-image-understanding).
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------ | ------ |
|
||||||
|
| `AUTO` | auto |
|
||||||
|
| `LOW` | low |
|
||||||
|
| `HIGH` | high |
|
||||||
14
docs/models/components/feedback.md
Normal file
14
docs/models/components/feedback.md
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
# Feedback
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||||
|
| `task_id` | *str* | :heavy_check_mark: | The unique identifier for the task associated with this feedback. |
|
||||||
|
| `json_values` | [components.JSONValues](../../models/components/jsonvalues.md) | :heavy_check_mark: | The values of the feedback. Must be valid JSON according to the task schema. |
|
||||||
|
| `matched_completion_ids` | List[*str*] | :heavy_check_mark: | The matched completion ids associated with this feedback. |
|
||||||
|
| `comment` | *str* | :heavy_check_mark: | The comment associated with this feedback. |
|
||||||
|
| `id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for this feedback. |
|
||||||
|
| `created_at_ms` | *Optional[float]* | :heavy_minus_sign: | The epoch this schema was created. |
|
||||||
|
| `completions_summary` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
||||||
18
docs/models/components/finishreason.md
Normal file
18
docs/models/components/finishreason.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# FinishReason
|
||||||
|
|
||||||
|
The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,
|
||||||
|
`length` if the maximum number of tokens specified in the request was reached,
|
||||||
|
`content_filter` if content was omitted due to a flag from our content filters,
|
||||||
|
`tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------------- | ---------------- |
|
||||||
|
| `STOP` | stop |
|
||||||
|
| `LENGTH` | length |
|
||||||
|
| `TOOL_CALLS` | tool_calls |
|
||||||
|
| `CONTENT_FILTER` | content_filter |
|
||||||
|
| `FUNCTION_CALL` | function_call |
|
||||||
11
docs/models/components/function.md
Normal file
11
docs/models/components/function.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# Function
|
||||||
|
|
||||||
|
The function that the model called.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `name` | *str* | :heavy_check_mark: | The name of the function to call. |
|
||||||
|
| `arguments` | *str* | :heavy_check_mark: | The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. |
|
||||||
13
docs/models/components/functioncall.md
Normal file
13
docs/models/components/functioncall.md
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# ~~FunctionCall~~
|
||||||
|
|
||||||
|
Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.
|
||||||
|
|
||||||
|
> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `arguments` | *str* | :heavy_check_mark: | The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. |
|
||||||
|
| `name` | *str* | :heavy_check_mark: | The name of the function to call. |
|
||||||
10
docs/models/components/functionobject.md
Normal file
10
docs/models/components/functionobject.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# FunctionObject
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `name` | *str* | :heavy_check_mark: | The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. |
|
||||||
|
| `description` | *Optional[str]* | :heavy_minus_sign: | A description of what the function does, used by the model to choose when and how to call the function. |
|
||||||
|
| `parameters` | Dict[str, *Any*] | :heavy_minus_sign: | The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/text-generation/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. <br/><br/>Omitting `parameters` defines a function with an empty parameter list. |
|
||||||
9
docs/models/components/httpmetadata.md
Normal file
9
docs/models/components/httpmetadata.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# HTTPMetadata
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||||
|
| `response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `request` | [requests.Request](https://requests.readthedocs.io/en/latest/api/#requests.Request) | :heavy_check_mark: | Raw HTTP request; suitable for debugging |
|
||||||
9
docs/models/components/imageurl.md
Normal file
9
docs/models/components/imageurl.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# ImageURL
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `url` | *str* | :heavy_check_mark: | Either a URL of the image or the base64 encoded image data. |
|
||||||
|
| `detail` | [Optional[components.Detail]](../../models/components/detail.md) | :heavy_minus_sign: | Specifies the detail level of the image. Learn more in the [Vision guide](/docs/guides/vision/low-or-high-fidelity-image-understanding). |
|
||||||
9
docs/models/components/jsonschema.md
Normal file
9
docs/models/components/jsonschema.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# JSONSchema
|
||||||
|
|
||||||
|
The schema of the task. Must be valid JSON Schema.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------- | ----------- | ----------- | ----------- |
|
||||||
9
docs/models/components/jsonvalues.md
Normal file
9
docs/models/components/jsonvalues.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# JSONValues
|
||||||
|
|
||||||
|
The values of the feedback. Must be valid JSON according to the task schema.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------- | ----------- | ----------- | ----------- |
|
||||||
11
docs/models/components/kind.md
Normal file
11
docs/models/components/kind.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# Kind
|
||||||
|
|
||||||
|
The kind of completion i.e. chat messages or prompt
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| -------- | -------- |
|
||||||
|
| `CHAT` | chat |
|
||||||
|
| `PROMPT` | prompt |
|
||||||
10
docs/models/components/logprobs.md
Normal file
10
docs/models/components/logprobs.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# Logprobs
|
||||||
|
|
||||||
|
Log probability information for the choice.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||||
|
| `content` | List[[components.ChatCompletionTokenLogprob](../../models/components/chatcompletiontokenlogprob.md)] | :heavy_check_mark: | A list of message content tokens with log probability information. |
|
||||||
19
docs/models/components/model.md
Normal file
19
docs/models/components/model.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# Model
|
||||||
|
|
||||||
|
ID of the model to use. See the [model endpoint compatibility](/docs/models/model-endpoint-compatibility) table for details on which models work with the Chat API.
|
||||||
|
|
||||||
|
|
||||||
|
## Supported Types
|
||||||
|
|
||||||
|
###
|
||||||
|
|
||||||
|
```python
|
||||||
|
model: str = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
### Two
|
||||||
|
|
||||||
|
```python
|
||||||
|
model: components.Two = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
10
docs/models/components/object.md
Normal file
10
docs/models/components/object.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# Object
|
||||||
|
|
||||||
|
The object type, which is always `chat.completion`.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ----------------- | ----------------- |
|
||||||
|
| `CHAT_COMPLETION` | chat.completion |
|
||||||
12
docs/models/components/one.md
Normal file
12
docs/models/components/one.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# One
|
||||||
|
|
||||||
|
`none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------ | ------ |
|
||||||
|
| `NONE` | none |
|
||||||
|
| `AUTO` | auto |
|
||||||
15
docs/models/components/responseformat.md
Normal file
15
docs/models/components/responseformat.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# ResponseFormat
|
||||||
|
|
||||||
|
An object specifying the format that the model must output. Compatible with [GPT-4 Turbo](/docs/models/gpt-4-and-gpt-4-turbo) and all GPT-3.5 Turbo models newer than `gpt-3.5-turbo-1106`.
|
||||||
|
|
||||||
|
Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is valid JSON.
|
||||||
|
|
||||||
|
**Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `type` | [Optional[components.CreateChatCompletionRequestType]](../../models/components/createchatcompletionrequesttype.md) | :heavy_minus_sign: | Must be one of `text` or `json_object`. | json_object |
|
||||||
10
docs/models/components/role.md
Normal file
10
docs/models/components/role.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# Role
|
||||||
|
|
||||||
|
The role of the messages author, in this case `system`.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| -------- | -------- |
|
||||||
|
| `SYSTEM` | system |
|
||||||
8
docs/models/components/security.md
Normal file
8
docs/models/components/security.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# Security
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `log10_token` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
||||||
8
docs/models/components/session.md
Normal file
8
docs/models/components/session.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# Session
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- |
|
||||||
|
| `id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for this session. |
|
||||||
11
docs/models/components/stacktrace.md
Normal file
11
docs/models/components/stacktrace.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# Stacktrace
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||||
|
| `file` | *str* | :heavy_check_mark: | The file associated with this stacktrace. |
|
||||||
|
| `line` | *str* | :heavy_check_mark: | The line associated with this stacktrace. |
|
||||||
|
| `lineno` | *float* | :heavy_check_mark: | The line number associated with this stacktrace. |
|
||||||
|
| `name` | *str* | :heavy_check_mark: | The function or module associated with this stacktrace. |
|
||||||
12
docs/models/components/status.md
Normal file
12
docs/models/components/status.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# Status
|
||||||
|
|
||||||
|
The status of this completion.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------- | ---------- |
|
||||||
|
| `STARTED` | started |
|
||||||
|
| `FINISHED` | finished |
|
||||||
|
| `FAILED` | failed |
|
||||||
20
docs/models/components/stop.md
Normal file
20
docs/models/components/stop.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# Stop
|
||||||
|
|
||||||
|
Up to 4 sequences where the API will stop generating further tokens.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Supported Types
|
||||||
|
|
||||||
|
###
|
||||||
|
|
||||||
|
```python
|
||||||
|
stop: str = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
|
###
|
||||||
|
|
||||||
|
```python
|
||||||
|
stop: List[str] = /* values here */
|
||||||
|
```
|
||||||
|
|
||||||
13
docs/models/components/task.md
Normal file
13
docs/models/components/task.md
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# Task
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||||
|
| `json_schema` | [components.JSONSchema](../../models/components/jsonschema.md) | :heavy_check_mark: | The schema of the task. Must be valid JSON Schema. |
|
||||||
|
| `name` | *str* | :heavy_check_mark: | The name of the task. |
|
||||||
|
| `instruction` | *str* | :heavy_check_mark: | The instructions for this task. |
|
||||||
|
| `completion_tags_selector` | [components.CompletionTagsSelector](../../models/components/completiontagsselector.md) | :heavy_check_mark: | The completion tag matching with this task i.e. surfaced as needing feedback. |
|
||||||
|
| `id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for this task. |
|
||||||
|
| `created_at_ms` | *Optional[float]* | :heavy_minus_sign: | The epoch this schema was created. |
|
||||||
10
docs/models/components/toplogprobs.md
Normal file
10
docs/models/components/toplogprobs.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# TopLogprobs
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `token` | *str* | :heavy_check_mark: | The token. |
|
||||||
|
| `logprob` | *float* | :heavy_check_mark: | The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely. |
|
||||||
|
| `bytes` | List[*int*] | :heavy_check_mark: | A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. |
|
||||||
26
docs/models/components/two.md
Normal file
26
docs/models/components/two.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# Two
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------------------ | ------------------------ |
|
||||||
|
| `GPT_4_TURBO` | gpt-4-turbo |
|
||||||
|
| `GPT_4_TURBO_2024_04_09` | gpt-4-turbo-2024-04-09 |
|
||||||
|
| `GPT_4_0125_PREVIEW` | gpt-4-0125-preview |
|
||||||
|
| `GPT_4_TURBO_PREVIEW` | gpt-4-turbo-preview |
|
||||||
|
| `GPT_4_1106_PREVIEW` | gpt-4-1106-preview |
|
||||||
|
| `GPT_4_VISION_PREVIEW` | gpt-4-vision-preview |
|
||||||
|
| `GPT_4` | gpt-4 |
|
||||||
|
| `GPT_4_0314` | gpt-4-0314 |
|
||||||
|
| `GPT_4_0613` | gpt-4-0613 |
|
||||||
|
| `GPT_4_32K` | gpt-4-32k |
|
||||||
|
| `GPT_4_32K_0314` | gpt-4-32k-0314 |
|
||||||
|
| `GPT_4_32K_0613` | gpt-4-32k-0613 |
|
||||||
|
| `GPT_3_5_TURBO` | gpt-3.5-turbo |
|
||||||
|
| `GPT_3_5_TURBO_16K` | gpt-3.5-turbo-16k |
|
||||||
|
| `GPT_3_5_TURBO_0301` | gpt-3.5-turbo-0301 |
|
||||||
|
| `GPT_3_5_TURBO_0613` | gpt-3.5-turbo-0613 |
|
||||||
|
| `GPT_3_5_TURBO_1106` | gpt-3.5-turbo-1106 |
|
||||||
|
| `GPT_3_5_TURBO_0125` | gpt-3.5-turbo-0125 |
|
||||||
|
| `GPT_3_5_TURBO_16K_0613` | gpt-3.5-turbo-16k-0613 |
|
||||||
10
docs/models/components/type.md
Normal file
10
docs/models/components/type.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# Type
|
||||||
|
|
||||||
|
The type of the content part.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------ | ------ |
|
||||||
|
| `TEXT` | text |
|
||||||
8
docs/models/internal/globals.md
Normal file
8
docs/models/internal/globals.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# Globals
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||||
|
| `x_log10_organization` | *str* | :heavy_check_mark: | N/A |
|
||||||
9
docs/models/operations/createfeedbacktaskresponse.md
Normal file
9
docs/models/operations/createfeedbacktaskresponse.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# CreateFeedbackTaskResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||||
|
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
|
||||||
|
| `task` | [Optional[components.Task]](../../models/components/task.md) | :heavy_minus_sign: | OK |
|
||||||
8
docs/models/operations/createglobals.md
Normal file
8
docs/models/operations/createglobals.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# CreateGlobals
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||||
|
| `x_log10_organization` | *str* | :heavy_check_mark: | N/A |
|
||||||
9
docs/models/operations/createrequest.md
Normal file
9
docs/models/operations/createrequest.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# CreateRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||||
|
| `completion` | [components.Completion](../../models/components/completion.md) | :heavy_check_mark: | N/A |
|
||||||
|
| `x_log10_organization` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
||||||
10
docs/models/operations/createresponse.md
Normal file
10
docs/models/operations/createresponse.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# CreateResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
|
||||||
|
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
|
||||||
|
| `any` | *Optional[Any]* | :heavy_minus_sign: | Created |
|
||||||
|
| `completion` | [Optional[components.Completion]](../../models/components/completion.md) | :heavy_minus_sign: | Created |
|
||||||
8
docs/models/operations/createsessionglobals.md
Normal file
8
docs/models/operations/createsessionglobals.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# CreateSessionGlobals
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||||
|
| `x_log10_organization` | *str* | :heavy_check_mark: | N/A |
|
||||||
8
docs/models/operations/createsessionrequest.md
Normal file
8
docs/models/operations/createsessionrequest.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# CreateSessionRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||||
|
| `x_log10_organization` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
||||||
9
docs/models/operations/createsessionresponse.md
Normal file
9
docs/models/operations/createsessionresponse.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# CreateSessionResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
|
||||||
|
| `object` | [Optional[operations.CreateSessionResponseBody]](../../models/operations/createsessionresponsebody.md) | :heavy_minus_sign: | Created |
|
||||||
10
docs/models/operations/createsessionresponsebody.md
Normal file
10
docs/models/operations/createsessionresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# CreateSessionResponseBody
|
||||||
|
|
||||||
|
Created
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||||
|
| `session` | [Optional[components.Session]](../../models/components/session.md) | :heavy_minus_sign: | N/A |
|
||||||
8
docs/models/operations/getfeedbacktaskrequest.md
Normal file
8
docs/models/operations/getfeedbacktaskrequest.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetFeedbackTaskRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------- | --------------------- | --------------------- | --------------------- |
|
||||||
|
| `task_id` | *str* | :heavy_check_mark: | The task id to fetch. |
|
||||||
9
docs/models/operations/getfeedbacktaskresponse.md
Normal file
9
docs/models/operations/getfeedbacktaskresponse.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetFeedbackTaskResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||||
|
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
|
||||||
|
| `task` | [Optional[components.Task]](../../models/components/task.md) | :heavy_minus_sign: | OK |
|
||||||
8
docs/models/operations/getglobals.md
Normal file
8
docs/models/operations/getglobals.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetGlobals
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||||
|
| `x_log10_organization` | *str* | :heavy_check_mark: | N/A |
|
||||||
9
docs/models/operations/getrequest.md
Normal file
9
docs/models/operations/getrequest.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||||
|
| `feedback_id` | *str* | :heavy_check_mark: | The feedback id to fetch. |
|
||||||
|
| `x_log10_organization` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
||||||
9
docs/models/operations/getresponse.md
Normal file
9
docs/models/operations/getresponse.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||||
|
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
|
||||||
|
| `feedback` | [Optional[components.Feedback]](../../models/components/feedback.md) | :heavy_minus_sign: | OK |
|
||||||
9
docs/models/operations/jsonvalues.md
Normal file
9
docs/models/operations/jsonvalues.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# JSONValues
|
||||||
|
|
||||||
|
The values of the feedback. Must be valid JSON according to the task schema.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------- | ----------- | ----------- | ----------- |
|
||||||
9
docs/models/operations/listfeedbacktasksresponse.md
Normal file
9
docs/models/operations/listfeedbacktasksresponse.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# ListFeedbackTasksResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||||
|
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
|
||||||
|
| `tasks` | List[[components.Task](../../models/components/task.md)] | :heavy_minus_sign: | OK |
|
||||||
8
docs/models/operations/listglobals.md
Normal file
8
docs/models/operations/listglobals.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# ListGlobals
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||||
|
| `x_log10_organization` | *str* | :heavy_check_mark: | N/A |
|
||||||
9
docs/models/operations/listrequest.md
Normal file
9
docs/models/operations/listrequest.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# ListRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||||
|
| `x_log10_organization` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
||||||
|
| `request_body` | [Optional[operations.ListRequestBody]](../../models/operations/listrequestbody.md) | :heavy_minus_sign: | N/A |
|
||||||
11
docs/models/operations/listrequestbody.md
Normal file
11
docs/models/operations/listrequestbody.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# ListRequestBody
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
|
||||||
|
| `offset` | *Optional[int]* | :heavy_minus_sign: | The offset to start fetching feedback from. |
|
||||||
|
| `limit` | *Optional[int]* | :heavy_minus_sign: | The number of feedback to fetch. |
|
||||||
|
| `completion_id` | *Optional[str]* | :heavy_minus_sign: | The completion id to fetch feedback for. |
|
||||||
|
| `task_id` | *Optional[str]* | :heavy_minus_sign: | The task id to fetch feedback for. |
|
||||||
9
docs/models/operations/listresponse.md
Normal file
9
docs/models/operations/listresponse.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# ListResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||||
|
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
|
||||||
|
| `object` | [Optional[operations.ListResponseBody]](../../models/operations/listresponsebody.md) | :heavy_minus_sign: | OK |
|
||||||
10
docs/models/operations/listresponsebody.md
Normal file
10
docs/models/operations/listresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# ListResponseBody
|
||||||
|
|
||||||
|
OK
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
|
||||||
|
| `feedback` | List[[components.Feedback](../../models/components/feedback.md)] | :heavy_minus_sign: | N/A |
|
||||||
8
docs/models/operations/listungradedglobals.md
Normal file
8
docs/models/operations/listungradedglobals.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# ListUngradedGlobals
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||||
|
| `x_log10_organization` | *str* | :heavy_check_mark: | N/A |
|
||||||
8
docs/models/operations/listungradedrequest.md
Normal file
8
docs/models/operations/listungradedrequest.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# ListUngradedRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||||
|
| `x_log10_organization` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
||||||
9
docs/models/operations/listungradedresponse.md
Normal file
9
docs/models/operations/listungradedresponse.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# ListUngradedResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||||
|
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
|
||||||
|
| `object` | [Optional[operations.ListUngradedResponseBody]](../../models/operations/listungradedresponsebody.md) | :heavy_minus_sign: | OK |
|
||||||
10
docs/models/operations/listungradedresponsebody.md
Normal file
10
docs/models/operations/listungradedresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# ListUngradedResponseBody
|
||||||
|
|
||||||
|
OK
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||||
|
| `completions` | List[[components.Completion](../../models/components/completion.md)] | :heavy_minus_sign: | N/A |
|
||||||
17
docs/models/operations/one.md
Normal file
17
docs/models/operations/one.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# One
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||||
|
| `task_id` | *str* | :heavy_check_mark: | The unique identifier for the task associated with this feedback. |
|
||||||
|
| `json_values` | [operations.JSONValues](../../models/operations/jsonvalues.md) | :heavy_check_mark: | The values of the feedback. Must be valid JSON according to the task schema. |
|
||||||
|
| `matched_completion_ids` | List[*str*] | :heavy_check_mark: | The matched completion ids associated with this feedback. |
|
||||||
|
| `comment` | *str* | :heavy_check_mark: | The comment associated with this feedback. |
|
||||||
|
| `completion_tags_selector` | List[*str*] | :heavy_check_mark: | The completion tags associated with this feedback. |
|
||||||
|
| `id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for this feedback. |
|
||||||
|
| `created_at_ms` | *Optional[float]* | :heavy_minus_sign: | The epoch this schema was created. |
|
||||||
|
| `completions_summary` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
||||||
|
| `allow_unmatched_feedback` | *Optional[bool]* | :heavy_minus_sign: | Whether to allow unmatched feedback. Defaults to false. |
|
||||||
|
| `max_matched_completions` | *Optional[int]* | :heavy_minus_sign: | The maximum number of matched completions. Returns error if exceeded. Defaults to 100. |
|
||||||
9
docs/models/operations/requestbodyjsonvalues.md
Normal file
9
docs/models/operations/requestbodyjsonvalues.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# RequestBodyJSONValues
|
||||||
|
|
||||||
|
The values of the feedback. Must be valid JSON according to the task schema.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------- | ----------- | ----------- | ----------- |
|
||||||
15
docs/models/operations/two.md
Normal file
15
docs/models/operations/two.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# Two
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||||
|
| `task_id` | *str* | :heavy_check_mark: | The unique identifier for the task associated with this feedback. |
|
||||||
|
| `json_values` | [operations.RequestBodyJSONValues](../../models/operations/requestbodyjsonvalues.md) | :heavy_check_mark: | The values of the feedback. Must be valid JSON according to the task schema. |
|
||||||
|
| `matched_completion_ids` | List[*str*] | :heavy_check_mark: | The matched completion ids associated with this feedback. |
|
||||||
|
| `comment` | *str* | :heavy_check_mark: | The comment associated with this feedback. |
|
||||||
|
| `completion_ids` | List[*str*] | :heavy_check_mark: | The completion ids to associate with this feedback. |
|
||||||
|
| `id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for this feedback. |
|
||||||
|
| `created_at_ms` | *Optional[float]* | :heavy_minus_sign: | The epoch this schema was created. |
|
||||||
|
| `completions_summary` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
||||||
8
docs/models/operations/updateglobals.md
Normal file
8
docs/models/operations/updateglobals.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# UpdateGlobals
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||||
|
| `x_log10_organization` | *str* | :heavy_check_mark: | N/A |
|
||||||
10
docs/models/operations/updaterequest.md
Normal file
10
docs/models/operations/updaterequest.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# UpdateRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||||
|
| `completion_id` | *str* | :heavy_check_mark: | The completion id to update. |
|
||||||
|
| `completion` | [components.Completion](../../models/components/completion.md) | :heavy_check_mark: | N/A |
|
||||||
|
| `x_log10_organization` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
||||||
9
docs/models/operations/updateresponse.md
Normal file
9
docs/models/operations/updateresponse.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# UpdateResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
|
||||||
|
| `http_meta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
|
||||||
|
| `completion` | [Optional[components.Completion]](../../models/components/completion.md) | :heavy_minus_sign: | OK |
|
||||||
8
docs/models/operations/uploadglobals.md
Normal file
8
docs/models/operations/uploadglobals.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# UploadGlobals
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||||
|
| `x_log10_organization` | *str* | :heavy_check_mark: | N/A |
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user