LukeParke/log10ts
1
0
Fork 0
mirror of https://github.com/LukeHagar/log10ts.git synced 2025-12-06 04:20:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adding first generated sdk

Browse Source
This commit is contained in:
Niklas Nielsen
2024-05-24 17:16:47 -07:00
parent 4d01baa842
commit 4bdba6d48c
175 changed files with 25807 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
Makefile Normal file
View 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

22
RUNTIMES.md Normal file
View File

@@ -0,0 +1,22 @@
# Supported JavaScript runtimes
This SDK is intended to be used in JavaScript runtimes that support the following features:
* [Web Fetch API][web-fetch]
* [Web Streams API](web-streams) and in particular `ReadableStream`
* [Async iterables][async-iter] using `Symbol.asyncIterator`
[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
Runtime environments that are explicitly supported are:
- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
- Node.js active and maintenance LTS releases
- Currently, this is v18 and v20
- Bun v1 and above
- Deno v1.39
- Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
[deno-file-streaming]: https://github.com/denoland/deno/issues/11018

20
USAGE.md Normal file
View File

@@ -0,0 +1,20 @@
<!-- Start SDK Example Usage [usage] -->
```typescript
import { Log10 } from "log10ts";
const log10 = new Log10({
log10Token: "<YOUR_API_KEY_HERE>",
xLog10Organization: "<value>",
});
async function run() {
const result = await log10.sessions.create("<value>");
// Handle the result
console.log(result);
}
run();
```
<!-- End SDK Example Usage [usage] -->

11
docs/models/components/chatcompletionfunctioncalloption.md Normal file
View 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` | *string* | :heavy_check_mark: | The name of the function to call. |

12
docs/models/components/chatcompletionfunctions.md Normal file
View 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 |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `description` | *string* | :heavy_minus_sign: | A description of what the function does, used by the model to choose when and how to call the function. |
| `name` | *string* | :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. |
| `parameters` | Record<string, *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
View File

@@ -0,0 +1,10 @@
# ChatCompletionMessageToolCall
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `id` | *string* | :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.FunctionT](../../models/components/functiont.md) | :heavy_check_mark: | The function that the model called. |

10
docs/models/components/chatcompletionmessagetoolcalltype.md Normal file
View 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
View 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 |

8
docs/models/components/chatcompletionnamedtoolchoicefunction.md Normal file
View File

@@ -0,0 +1,8 @@
# ChatCompletionNamedToolChoiceFunction
## Fields
| Field | Type | Required | Description |
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
| `name` | *string* | :heavy_check_mark: | The name of the function to call. |

10
docs/models/components/chatcompletionnamedtoolchoicetype.md Normal file
View File

@@ -0,0 +1,10 @@
# ChatCompletionNamedToolChoiceType
The type of the tool. Currently, only `function` is supported.
## Values
| Name | Value |
| ---------- | ---------- |
| `Function` | function |

12
docs/models/components/chatcompletionrequestassistantmessage.md Normal file
View File

@@ -0,0 +1,12 @@
# ChatCompletionRequestAssistantMessage
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `content` | *string* | :heavy_minus_sign: | The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.<br/> |
| `role` | [components.ChatCompletionRequestAssistantMessageRole](../../models/components/chatcompletionrequestassistantmessagerole.md) | :heavy_check_mark: | The role of the messages author, in this case `assistant`. |
| `name` | *string* | :heavy_minus_sign: | An optional name for the participant. Provides the model information to differentiate between participants of the same role. |
| `toolCalls` | [components.ChatCompletionMessageToolCall](../../models/components/chatcompletionmessagetoolcall.md)[] | :heavy_minus_sign: | The tool calls generated by the model, such as function calls. |
| ~~`functionCall`~~ | [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. |

10
docs/models/components/chatcompletionrequestassistantmessagerole.md Normal file
View File

@@ -0,0 +1,10 @@
# ChatCompletionRequestAssistantMessageRole
The role of the messages author, in this case `assistant`.
## Values
| Name | Value |
| ----------- | ----------- |
| `Assistant` | assistant |

12
docs/models/components/chatcompletionrequestfunctionmessage.md Normal file
View File

@@ -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` | *string* | :heavy_check_mark: | The contents of the function message. |
| `name` | *string* | :heavy_check_mark: | The name of the function to call. |

10
docs/models/components/chatcompletionrequestfunctionmessagerole.md Normal file
View File

@@ -0,0 +1,10 @@
# ChatCompletionRequestFunctionMessageRole
The role of the messages author, in this case `function`.
## Values
| Name | Value |
| ---------- | ---------- |
| `Function` | function |

2
docs/models/components/chatcompletionrequestmessage.md Normal file
View File

@@ -0,0 +1,2 @@
# ChatCompletionRequestMessage

2
docs/models/components/chatcompletionrequestmessagecontentpart.md Normal file
View File

@@ -0,0 +1,2 @@
# ChatCompletionRequestMessageContentPart

9
docs/models/components/chatcompletionrequestmessagecontentpartimage.md Normal file
View File

@@ -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. |
| `imageUrl` | [components.ImageUrl](../../models/components/imageurl.md) | :heavy_check_mark: | N/A |

10
docs/models/components/chatcompletionrequestmessagecontentpartimagetype.md Normal file
View File

@@ -0,0 +1,10 @@
# ChatCompletionRequestMessageContentPartImageType
The type of the content part.
## Values
| Name | Value |
| ---------- | ---------- |
| `ImageUrl` | image_url |

9
docs/models/components/chatcompletionrequestmessagecontentparttext.md Normal file
View File

@@ -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` | *string* | :heavy_check_mark: | The text content. |

10
docs/models/components/chatcompletionrequestsystemmessage.md Normal file
View File

@@ -0,0 +1,10 @@
# ChatCompletionRequestSystemMessage
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `content` | *string* | :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` | *string* | :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
View 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` | *string* | :heavy_check_mark: | The contents of the tool message. |
| `toolCallId` | *string* | :heavy_check_mark: | Tool call that this message is responding to. |

10
docs/models/components/chatcompletionrequesttoolmessagerole.md Normal file
View File

@@ -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
View File

@@ -0,0 +1,10 @@
# ChatCompletionRequestUserMessage
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `content` | *components.Content* | :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` | *string* | :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/chatcompletionrequestusermessagerole.md Normal file
View File

@@ -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
View File

@@ -0,0 +1,13 @@
# ChatCompletionResponseMessage
A chat completion message generated by the model.
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `content` | *string* | :heavy_check_mark: | The contents of the message. |
| `toolCalls` | [components.ChatCompletionMessageToolCall](../../models/components/chatcompletionmessagetoolcall.md)[] | :heavy_minus_sign: | The tool calls generated by the model, such as function calls. |
| `role` | [components.ChatCompletionResponseMessageRole](../../models/components/chatcompletionresponsemessagerole.md) | :heavy_check_mark: | The role of the author of this message. |
| ~~`functionCall`~~ | [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. |

13
docs/models/components/chatcompletionresponsemessagefunctioncall.md Normal file
View File

@@ -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` | *string* | :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` | *string* | :heavy_check_mark: | The name of the function to call. |

10
docs/models/components/chatcompletionresponsemessagerole.md Normal file
View 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
View File

@@ -0,0 +1,11 @@
# ChatCompletionStreamOptions
Options for streaming response. Only set this when you set `stream: true`.
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `includeUsage` | *boolean* | :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
View File

@@ -0,0 +1,11 @@
# ChatCompletionTokenLogprob
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `token` | *string* | :heavy_check_mark: | The token. |
| `logprob` | *number* | :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` | *number*[] | :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. |
| `topLogprobs` | [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
View 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 |

11
docs/models/components/chatcompletiontoolchoiceoption.md Normal file
View File

@@ -0,0 +1,11 @@
# 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.

13
docs/models/components/chatcompletiontoolchoiceoption1.md Normal file
View 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
View 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
View File

@@ -0,0 +1,11 @@
# Choices
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `finishReason` | [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` | *number* | :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` | [components.Logprobs](../../models/components/logprobs.md) | :heavy_check_mark: | Log probability information for the choice. |

19
docs/models/components/completion.md Normal file
View File

@@ -0,0 +1,19 @@
# Completion
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `id` | *string* | :heavy_minus_sign: | The unique identifier for this task. |
| `organizationId` | *string* | :heavy_check_mark: | The unique identifier for the organization. |
| `kind` | [components.Kind](../../models/components/kind.md) | :heavy_minus_sign: | The kind of completion i.e. chat messages or prompt |
| `status` | [components.Status](../../models/components/status.md) | :heavy_minus_sign: | The status of this completion. |
| `tags` | *string*[] | :heavy_minus_sign: | The tags for this completion. |
| `request` | [components.CreateChatCompletionRequest](../../models/components/createchatcompletionrequest.md) | :heavy_minus_sign: | N/A |
| `response` | [components.CreateChatCompletionResponse](../../models/components/createchatcompletionresponse.md) | :heavy_minus_sign: | Represents a chat completion response returned by model, based on the provided input. |
| `stacktrace` | [components.Stacktrace](../../models/components/stacktrace.md)[] | :heavy_minus_sign: | The stacktrace for this completion. |
| `sessionId` | *string* | :heavy_minus_sign: | The session id for this completion. |
| `duration` | *number* | :heavy_minus_sign: | The duration of this completion in seconds. |
| `failureKind` | *string* | :heavy_minus_sign: | The failure kind of this completion. |
| `failureReason` | *string* | :heavy_minus_sign: | The failure reason of this completion. |

9
docs/models/components/completiontagsselector.md Normal file
View 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
View File

@@ -0,0 +1,12 @@
# CompletionUsage
Usage statistics for the completion request.
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
| `completionTokens` | *number* | :heavy_check_mark: | Number of tokens in the generated completion. |
| `promptTokens` | *number* | :heavy_check_mark: | Number of tokens in the prompt. |
| `totalTokens` | *number* | :heavy_check_mark: | Total number of tokens used in the request (prompt + completion). |

5
docs/models/components/content.md Normal file
View File

@@ -0,0 +1,5 @@
# Content
The contents of the user message.

28
docs/models/components/createchatcompletionrequest.md Normal file
View File

@@ -0,0 +1,28 @@
# CreateChatCompletionRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `messages` | *components.ChatCompletionRequestMessage*[] | :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* | :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 |
| `frequencyPenalty` | *number* | :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/> | |
| `logitBias` | Record<string, *number*> | :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` | *boolean* | :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`. | |
| `topLogprobs` | *number* | :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. | |
| `maxTokens` | *number* | :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` | *number* | :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 |
| `presencePenalty` | *number* | :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/> | |
| `responseFormat` | [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` | *number* | :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` | *components.Stop* | :heavy_minus_sign: | Up to 4 sequences where the API will stop generating further tokens.<br/> | |
| `stream` | *boolean* | :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/> | |
| `streamOptions` | [components.ChatCompletionStreamOptions](../../models/components/chatcompletionstreamoptions.md) | :heavy_minus_sign: | Options for streaming response. Only set this when you set `stream: true`.<br/> | |
| `temperature` | *number* | :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 |
| `topP` | *number* | :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` | [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/> | |
| `toolChoice` | *components.ChatCompletionToolChoiceOption* | :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` | *string* | :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 |
| ~~`functionCall`~~ | *components.CreateChatCompletionRequestFunctionCall* | :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`~~ | [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/> | |

14
docs/models/components/createchatcompletionrequestfunctioncall.md Normal file
View File

@@ -0,0 +1,14 @@
# ~~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.

11
docs/models/components/createchatcompletionrequesttype.md Normal file
View File

@@ -0,0 +1,11 @@
# CreateChatCompletionRequestType
Must be one of `text` or `json_object`.
## Values
| Name | Value |
| ------------ | ------------ |
| `Text` | text |
| `JsonObject` | json_object |

16
docs/models/components/createchatcompletionresponse.md Normal file
View 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` | *string* | :heavy_check_mark: | A unique identifier for the chat completion. |
| `choices` | [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` | *number* | :heavy_check_mark: | The Unix timestamp (in seconds) of when the chat completion was created. |
| `model` | *string* | :heavy_check_mark: | The model used for the chat completion. |
| `systemFingerprint` | *string* | :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/> |
| `object` | [components.ObjectT](../../models/components/objectt.md) | :heavy_check_mark: | The object type, which is always `chat.completion`. |
| `usage` | [components.CompletionUsage](../../models/components/completionusage.md) | :heavy_minus_sign: | Usage statistics for the completion request. |

12
docs/models/components/detail.md Normal file
View 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
View File

@@ -0,0 +1,14 @@
# Feedback
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| `id` | *string* | :heavy_minus_sign: | The unique identifier for this feedback. |
| `createdAtMs` | *number* | :heavy_minus_sign: | The epoch this schema was created. |
| `taskId` | *string* | :heavy_check_mark: | The unique identifier for the task associated with this feedback. |
| `jsonValues` | [components.JsonValues](../../models/components/jsonvalues.md) | :heavy_check_mark: | The values of the feedback. Must be valid JSON according to the task schema. |
| `matchedCompletionIds` | *string*[] | :heavy_check_mark: | The matched completion ids associated with this feedback. |
| `comment` | *string* | :heavy_check_mark: | The comment associated with this feedback. |
| `completionsSummary` | *string* | :heavy_minus_sign: | N/A |

18
docs/models/components/finishreason.md Normal file
View 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 |
| `ToolCalls` | tool_calls |
| `ContentFilter` | content_filter |
| `FunctionCall` | function_call |

13
docs/models/components/functioncall.md Normal file
View 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` | *string* | :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` | *string* | :heavy_check_mark: | The name of the function to call. |

10
docs/models/components/functionobject.md Normal file
View File

@@ -0,0 +1,10 @@
# FunctionObject
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `description` | *string* | :heavy_minus_sign: | A description of what the function does, used by the model to choose when and how to call the function. |
| `name` | *string* | :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. |
| `parameters` | Record<string, *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. |

11
docs/models/components/functiont.md Normal file
View File

@@ -0,0 +1,11 @@
# FunctionT
The function that the model called.
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | *string* | :heavy_check_mark: | The name of the function to call. |
| `arguments` | *string* | :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. |

9
docs/models/components/httpmetadata.md Normal file
View File

@@ -0,0 +1,9 @@
# HTTPMetadata
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `response` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `request` | *Request* | :heavy_check_mark: | Raw HTTP request; suitable for debugging |

9
docs/models/components/imageurl.md Normal file
View File

@@ -0,0 +1,9 @@
# ImageUrl
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `url` | *string* | :heavy_check_mark: | Either a URL of the image or the base64 encoded image data. |
| `detail` | [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
View 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
View 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
View 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
View File

@@ -0,0 +1,10 @@
# Logprobs
Log probability information for the choice.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `content` | [components.ChatCompletionTokenLogprob](../../models/components/chatcompletiontokenlogprob.md)[] | :heavy_check_mark: | A list of message content tokens with log probability information. |

4
docs/models/components/model.md Normal file
View File

@@ -0,0 +1,4 @@
# 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.

10
docs/models/components/objectt.md Normal file
View File

@@ -0,0 +1,10 @@
# ObjectT
The object type, which is always `chat.completion`.
## Values
| Name | Value |
| ---------------- | ---------------- |
| `ChatCompletion` | chat.completion |

12
docs/models/components/one.md Normal file
View 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
View 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` | [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
View 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
View File

@@ -0,0 +1,8 @@
# Security
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `log10Token` | *string* | :heavy_minus_sign: | N/A |

8
docs/models/components/session.md Normal file
View File

@@ -0,0 +1,8 @@
# Session
## Fields
| Field | Type | Required | Description |
| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- |
| `id` | *string* | :heavy_minus_sign: | The unique identifier for this session. |

11
docs/models/components/stacktrace.md Normal file
View File

@@ -0,0 +1,11 @@
# Stacktrace
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
| `file` | *string* | :heavy_check_mark: | The file associated with this stacktrace. |
| `line` | *string* | :heavy_check_mark: | The line associated with this stacktrace. |
| `lineno` | *number* | :heavy_check_mark: | The line number associated with this stacktrace. |
| `name` | *string* | :heavy_check_mark: | The function or module associated with this stacktrace. |

12
docs/models/components/status.md Normal file
View File

@@ -0,0 +1,12 @@
# Status
The status of this completion.
## Values
| Name | Value |
| ---------- | ---------- |
| `Started` | started |
| `Finished` | finished |
| `Failed` | failed |

5
docs/models/components/stop.md Normal file
View File

@@ -0,0 +1,5 @@
# Stop
Up to 4 sequences where the API will stop generating further tokens.

13
docs/models/components/task.md Normal file
View File

@@ -0,0 +1,13 @@
# Task
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `id` | *string* | :heavy_minus_sign: | The unique identifier for this task. |
| `createdAtMs` | *number* | :heavy_minus_sign: | The epoch this schema was created. |
| `jsonSchema` | [components.JsonSchema](../../models/components/jsonschema.md) | :heavy_check_mark: | The schema of the task. Must be valid JSON Schema. |
| `name` | *string* | :heavy_check_mark: | The name of the task. |
| `instruction` | *string* | :heavy_check_mark: | The instructions for this task. |
| `completionTagsSelector` | [components.CompletionTagsSelector](../../models/components/completiontagsselector.md) | :heavy_check_mark: | The completion tag matching with this task i.e. surfaced as needing feedback. |

10
docs/models/components/toplogprobs.md Normal file
View File

@@ -0,0 +1,10 @@
# TopLogprobs
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `token` | *string* | :heavy_check_mark: | The token. |
| `logprob` | *number* | :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` | *number*[] | :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
View File

@@ -0,0 +1,26 @@
# Two
## Values
| Name | Value |
| ---------------------- | ---------------------- |
| `Gpt4Turbo` | gpt-4-turbo |
| `Gpt4Turbo20240409` | gpt-4-turbo-2024-04-09 |
| `Gpt40125Preview` | gpt-4-0125-preview |
| `Gpt4TurboPreview` | gpt-4-turbo-preview |
| `Gpt41106Preview` | gpt-4-1106-preview |
| `Gpt4VisionPreview` | gpt-4-vision-preview |
| `Gpt4` | gpt-4 |
| `Gpt40314` | gpt-4-0314 |
| `Gpt40613` | gpt-4-0613 |
| `Gpt432k` | gpt-4-32k |
| `Gpt432k0314` | gpt-4-32k-0314 |
| `Gpt432k0613` | gpt-4-32k-0613 |
| `Gpt35Turbo` | gpt-3.5-turbo |
| `Gpt35Turbo16k` | gpt-3.5-turbo-16k |
| `Gpt35Turbo0301` | gpt-3.5-turbo-0301 |
| `Gpt35Turbo0613` | gpt-3.5-turbo-0613 |
| `Gpt35Turbo1106` | gpt-3.5-turbo-1106 |
| `Gpt35Turbo0125` | gpt-3.5-turbo-0125 |
| `Gpt35Turbo16k0613` | gpt-3.5-turbo-16k-0613 |

10
docs/models/components/type.md Normal file
View File

@@ -0,0 +1,10 @@
# Type
The type of the content part.
## Values
| Name | Value |
| ------ | ------ |
| `Text` | text |

9
docs/models/operations/createfeedbacktaskresponse.md Normal file
View File

@@ -0,0 +1,9 @@
# CreateFeedbackTaskResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `httpMeta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
| `task` | [components.Task](../../models/components/task.md) | :heavy_minus_sign: | OK |

8
docs/models/operations/createglobals.md Normal file
View File

@@ -0,0 +1,8 @@
# CreateGlobals
## Fields
| Field | Type | Required | Description |
| -------------------- | -------------------- | -------------------- | -------------------- |
| `xLog10Organization` | *string* | :heavy_check_mark: | N/A |

9
docs/models/operations/createrequest.md Normal file
View File

@@ -0,0 +1,9 @@
# CreateRequest
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `xLog10Organization` | *string* | :heavy_minus_sign: | N/A |
| `completion` | [components.Completion](../../models/components/completion.md) | :heavy_check_mark: | N/A |

10
docs/models/operations/createresponse.md Normal file
View File

@@ -0,0 +1,10 @@
# CreateResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `httpMeta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
| `any` | *any* | :heavy_minus_sign: | Created |
| `completion` | [components.Completion](../../models/components/completion.md) | :heavy_minus_sign: | Created |

8
docs/models/operations/createsessionglobals.md Normal file
View File

@@ -0,0 +1,8 @@
# CreateSessionGlobals
## Fields
| Field | Type | Required | Description |
| -------------------- | -------------------- | -------------------- | -------------------- |
| `xLog10Organization` | *string* | :heavy_check_mark: | N/A |

8
docs/models/operations/createsessionrequest.md Normal file
View File

@@ -0,0 +1,8 @@
# CreateSessionRequest
## Fields
| Field | Type | Required | Description |
| -------------------- | -------------------- | -------------------- | -------------------- |
| `xLog10Organization` | *string* | :heavy_minus_sign: | N/A |

9
docs/models/operations/createsessionresponse.md Normal file
View File

@@ -0,0 +1,9 @@
# CreateSessionResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `httpMeta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
| `object` | [operations.CreateSessionResponseBody](../../models/operations/createsessionresponsebody.md) | :heavy_minus_sign: | Created |

10
docs/models/operations/createsessionresponsebody.md Normal file
View File

@@ -0,0 +1,10 @@
# CreateSessionResponseBody
Created
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
| `session` | [components.Session](../../models/components/session.md) | :heavy_minus_sign: | N/A |

8
docs/models/operations/getfeedbacktaskrequest.md Normal file
View File

@@ -0,0 +1,8 @@
# GetFeedbackTaskRequest
## Fields
| Field | Type | Required | Description |
| --------------------- | --------------------- | --------------------- | --------------------- |
| `taskId` | *string* | :heavy_check_mark: | The task id to fetch. |

9
docs/models/operations/getfeedbacktaskresponse.md Normal file
View File

@@ -0,0 +1,9 @@
# GetFeedbackTaskResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `httpMeta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
| `task` | [components.Task](../../models/components/task.md) | :heavy_minus_sign: | OK |

8
docs/models/operations/getglobals.md Normal file
View File

@@ -0,0 +1,8 @@
# GetGlobals
## Fields
| Field | Type | Required | Description |
| -------------------- | -------------------- | -------------------- | -------------------- |
| `xLog10Organization` | *string* | :heavy_check_mark: | N/A |

9
docs/models/operations/getrequest.md Normal file
View File

@@ -0,0 +1,9 @@
# GetRequest
## Fields
| Field | Type | Required | Description |
| ------------------------- | ------------------------- | ------------------------- | ------------------------- |
| `feedbackId` | *string* | :heavy_check_mark: | The feedback id to fetch. |
| `xLog10Organization` | *string* | :heavy_minus_sign: | N/A |

9
docs/models/operations/getresponse.md Normal file
View File

@@ -0,0 +1,9 @@
# GetResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `httpMeta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
| `feedback` | [components.Feedback](../../models/components/feedback.md) | :heavy_minus_sign: | OK |

9
docs/models/operations/jsonvalues.md Normal file
View 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
View File

@@ -0,0 +1,9 @@
# ListFeedbackTasksResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `httpMeta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
| `tasks` | [components.Task](../../models/components/task.md)[] | :heavy_minus_sign: | OK |

8
docs/models/operations/listungradedglobals.md Normal file
View File

@@ -0,0 +1,8 @@
# ListUngradedGlobals
## Fields
| Field | Type | Required | Description |
| -------------------- | -------------------- | -------------------- | -------------------- |
| `xLog10Organization` | *string* | :heavy_check_mark: | N/A |

8
docs/models/operations/listungradedrequest.md Normal file
View File

@@ -0,0 +1,8 @@
# ListUngradedRequest
## Fields
| Field | Type | Required | Description |
| -------------------- | -------------------- | -------------------- | -------------------- |
| `xLog10Organization` | *string* | :heavy_minus_sign: | N/A |

9
docs/models/operations/listungradedresponse.md Normal file
View File

@@ -0,0 +1,9 @@
# ListUngradedResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `httpMeta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
| `object` | [operations.ListUngradedResponseBody](../../models/operations/listungradedresponsebody.md) | :heavy_minus_sign: | OK |

10
docs/models/operations/listungradedresponsebody.md Normal file
View File

@@ -0,0 +1,10 @@
# ListUngradedResponseBody
OK
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
| `completions` | [components.Completion](../../models/components/completion.md)[] | :heavy_minus_sign: | N/A |

17
docs/models/operations/one.md Normal file
View File

@@ -0,0 +1,17 @@
# One
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `id` | *string* | :heavy_minus_sign: | The unique identifier for this feedback. |
| `createdAtMs` | *number* | :heavy_minus_sign: | The epoch this schema was created. |
| `taskId` | *string* | :heavy_check_mark: | The unique identifier for the task associated with this feedback. |
| `jsonValues` | [operations.JsonValues](../../models/operations/jsonvalues.md) | :heavy_check_mark: | The values of the feedback. Must be valid JSON according to the task schema. |
| `matchedCompletionIds` | *string*[] | :heavy_check_mark: | The matched completion ids associated with this feedback. |
| `comment` | *string* | :heavy_check_mark: | The comment associated with this feedback. |
| `completionsSummary` | *string* | :heavy_minus_sign: | N/A |
| `allowUnmatchedFeedback` | *boolean* | :heavy_minus_sign: | Whether to allow unmatched feedback. Defaults to false. |
| `maxMatchedCompletions` | *number* | :heavy_minus_sign: | The maximum number of matched completions. Returns error if exceeded. Defaults to 100. |
| `completionTagsSelector` | *string*[] | :heavy_check_mark: | The completion tags associated with this feedback. |

9
docs/models/operations/requestbodyjsonvalues.md Normal file
View 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
View File

@@ -0,0 +1,15 @@
# Two
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `id` | *string* | :heavy_minus_sign: | The unique identifier for this feedback. |
| `createdAtMs` | *number* | :heavy_minus_sign: | The epoch this schema was created. |
| `taskId` | *string* | :heavy_check_mark: | The unique identifier for the task associated with this feedback. |
| `jsonValues` | [operations.RequestBodyJsonValues](../../models/operations/requestbodyjsonvalues.md) | :heavy_check_mark: | The values of the feedback. Must be valid JSON according to the task schema. |
| `matchedCompletionIds` | *string*[] | :heavy_check_mark: | The matched completion ids associated with this feedback. |
| `comment` | *string* | :heavy_check_mark: | The comment associated with this feedback. |
| `completionsSummary` | *string* | :heavy_minus_sign: | N/A |
| `completionIds` | *string*[] | :heavy_check_mark: | The completion ids to associate with this feedback. |

8
docs/models/operations/updateglobals.md Normal file
View File

@@ -0,0 +1,8 @@
# UpdateGlobals
## Fields
| Field | Type | Required | Description |
| -------------------- | -------------------- | -------------------- | -------------------- |
| `xLog10Organization` | *string* | :heavy_check_mark: | N/A |

10
docs/models/operations/updaterequest.md Normal file
View File

@@ -0,0 +1,10 @@
# UpdateRequest
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `completionId` | *string* | :heavy_check_mark: | The completion id to update. |
| `xLog10Organization` | *string* | :heavy_minus_sign: | N/A |
| `completion` | [components.Completion](../../models/components/completion.md) | :heavy_check_mark: | N/A |

9
docs/models/operations/updateresponse.md Normal file
View File

@@ -0,0 +1,9 @@
# UpdateResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `httpMeta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
| `completion` | [components.Completion](../../models/components/completion.md) | :heavy_minus_sign: | OK |

8
docs/models/operations/uploadglobals.md Normal file
View File

@@ -0,0 +1,8 @@
# UploadGlobals
## Fields
| Field | Type | Required | Description |
| -------------------- | -------------------- | -------------------- | -------------------- |
| `xLog10Organization` | *string* | :heavy_check_mark: | N/A |

9
docs/models/operations/uploadrequest.md Normal file
View File

@@ -0,0 +1,9 @@
# UploadRequest
## Fields
| Field | Type | Required | Description |
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
| `xLog10Organization` | *string* | :heavy_minus_sign: | N/A |
| `requestBody` | *operations.UploadRequestBody* | :heavy_check_mark: | N/A |

2
docs/models/operations/uploadrequestbody.md Normal file
View File

@@ -0,0 +1,2 @@
# UploadRequestBody

9
docs/models/operations/uploadresponse.md Normal file
View File

@@ -0,0 +1,9 @@
# UploadResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `httpMeta` | [components.HTTPMetadata](../../models/components/httpmetadata.md) | :heavy_check_mark: | N/A |
| `feedback` | [components.Feedback](../../models/components/feedback.md) | :heavy_minus_sign: | OK |

179
docs/sdks/completions/README.md Normal file
View File

@@ -0,0 +1,179 @@
# Completions
(*completions*)
## Overview
Completions
### Available Operations
* [create](#create) - Create a completion
* [update](#update) - Update completion by id.
* [listUngraded](#listungraded) - List ungraded completions i.e. completions that have not been associated with feedback but matches task selector.
## create
Create a completion
### Example Usage
```typescript
import { Log10 } from "log10ts";
import { ChatCompletionRequestAssistantMessageRole, CreateChatCompletionRequestType, Two } from "log10ts/models/components";
const log10 = new Log10({
log10Token: "<YOUR_API_KEY_HERE>",
xLog10Organization: "<value>",
});
async function run() {
const result = await log10.completions.create({
organizationId: "<value>",
request: {
messages: [
{
role: ChatCompletionRequestAssistantMessageRole.Assistant,
},
],
model: Two.Gpt4Turbo,
n: 1,
responseFormat: {
type: CreateChatCompletionRequestType.JsonObject,
},
temperature: 1,
topP: 1,
user: "user-1234",
},
}, "<value>");
// Handle the result
console.log(result)
}
run();
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `completion` | [components.Completion](../../models/components/completion.md) | :heavy_check_mark: | N/A |
| `xLog10Organization` | *string* | :heavy_minus_sign: | N/A |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
### Response
**Promise\<[operations.CreateResponse](../../models/operations/createresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
| --------------- | --------------- | --------------- |
| errors.SDKError | 4xx-5xx | */* |
## update
Update completion by id.
### Example Usage
```typescript
import { Log10 } from "log10ts";
import { ChatCompletionRequestFunctionMessageRole, CreateChatCompletionRequestType, Two } from "log10ts/models/components";
const log10 = new Log10({
log10Token: "<YOUR_API_KEY_HERE>",
xLog10Organization: "<value>",
});
async function run() {
const result = await log10.completions.update("<value>", {
organizationId: "<value>",
request: {
messages: [
{
role: ChatCompletionRequestFunctionMessageRole.Function,
content: "<value>",
name: "<value>",
},
],
model: Two.Gpt4Turbo,
n: 1,
responseFormat: {
type: CreateChatCompletionRequestType.JsonObject,
},
temperature: 1,
topP: 1,
user: "user-1234",
},
}, "<value>");
// Handle the result
console.log(result)
}
run();
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `completionId` | *string* | :heavy_check_mark: | The completion id to update. |
| `completion` | [components.Completion](../../models/components/completion.md) | :heavy_check_mark: | N/A |
| `xLog10Organization` | *string* | :heavy_minus_sign: | N/A |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
### Response
**Promise\<[operations.UpdateResponse](../../models/operations/updateresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
| --------------- | --------------- | --------------- |
| errors.SDKError | 4xx-5xx | */* |
## listUngraded
List ungraded completions i.e. completions that have not been associated with feedback but matches task selector.
### Example Usage
```typescript
import { Log10 } from "log10ts";
const log10 = new Log10({
log10Token: "<YOUR_API_KEY_HERE>",
xLog10Organization: "<value>",
});
async function run() {
const result = await log10.completions.listUngraded("<value>");
// Handle the result
console.log(result)
}
run();
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `xLog10Organization` | *string* | :heavy_minus_sign: | N/A |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
### Response
**Promise\<[operations.ListUngradedResponse](../../models/operations/listungradedresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
| --------------- | --------------- | --------------- |
| errors.SDKError | 4xx-5xx | */* |

107
docs/sdks/feedback/README.md Normal file
View File

@@ -0,0 +1,107 @@
# Feedback
(*feedback*)
## Overview
Feedback
### Available Operations
* [get](#get) - Fetch feedback by id.
* [upload](#upload) - Upload a piece of feedback
## get
Fetch feedback by id.
### Example Usage
```typescript
import { Log10 } from "log10ts";
const log10 = new Log10({
log10Token: "<YOUR_API_KEY_HERE>",
xLog10Organization: "<value>",
});
async function run() {
const result = await log10.feedback.get("<value>", "<value>");
// Handle the result
console.log(result)
}
run();
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `feedbackId` | *string* | :heavy_check_mark: | The feedback id to fetch. |
| `xLog10Organization` | *string* | :heavy_minus_sign: | N/A |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
### Response
**Promise\<[operations.GetResponse](../../models/operations/getresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
| --------------- | --------------- | --------------- |
| errors.SDKError | 4xx-5xx | */* |
## upload
Upload a piece of feedback
### Example Usage
```typescript
import { Log10 } from "log10ts";
const log10 = new Log10({
log10Token: "<YOUR_API_KEY_HERE>",
xLog10Organization: "<value>",
});
async function run() {
const result = await log10.feedback.upload({
taskId: "<value>",
jsonValues: {},
matchedCompletionIds: [
"<value>",
],
comment: "The slim & simple Maple Gaming Keyboard from Dev Byte comes with a sleek body and 7- Color RGB LED Back-lighting for smart functionality",
completionTagsSelector: [
"<value>",
],
}, "<value>");
// Handle the result
console.log(result)
}
run();
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `requestBody` | *operations.UploadRequestBody* | :heavy_check_mark: | N/A |
| `xLog10Organization` | *string* | :heavy_minus_sign: | N/A |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
### Response
**Promise\<[operations.UploadResponse](../../models/operations/uploadresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
| --------------- | --------------- | --------------- |
| errors.SDKError | 4xx-5xx | */* |

142
docs/sdks/feedbacktasks/README.md Normal file
View File

@@ -0,0 +1,142 @@
# FeedbackTasks
(*feedbackTasks*)
## Overview
FeedbackTasks
### Available Operations
* [list](#list) - List feedback tasks.
* [create](#create) - Create a new task.
* [get](#get) - Retrieves feedback task `taskId`.
## list
List feedback tasks.
### Example Usage
```typescript
import { Log10 } from "log10ts";
const log10 = new Log10({
log10Token: "<YOUR_API_KEY_HERE>",
xLog10Organization: "<value>",
});
async function run() {
const result = await log10.feedbackTasks.list();
// Handle the result
console.log(result)
}
run();
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
### Response
**Promise\<[operations.ListFeedbackTasksResponse](../../models/operations/listfeedbacktasksresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
| --------------- | --------------- | --------------- |
| errors.SDKError | 4xx-5xx | */* |
## create
Create a new task.
### Example Usage
```typescript
import { Log10 } from "log10ts";
const log10 = new Log10({
log10Token: "<YOUR_API_KEY_HERE>",
xLog10Organization: "<value>",
});
async function run() {
const result = await log10.feedbackTasks.create({
jsonSchema: {},
name: "<value>",
instruction: "<value>",
completionTagsSelector: {},
});
// Handle the result
console.log(result)
}
run();
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [components.Task](../../models/components/task.md) | :heavy_check_mark: | The request object to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
### Response
**Promise\<[operations.CreateFeedbackTaskResponse](../../models/operations/createfeedbacktaskresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
| --------------- | --------------- | --------------- |
| errors.SDKError | 4xx-5xx | */* |
## get
Retrieves feedback task `taskId`.
### Example Usage
```typescript
import { Log10 } from "log10ts";
const log10 = new Log10({
log10Token: "<YOUR_API_KEY_HERE>",
xLog10Organization: "<value>",
});
async function run() {
const result = await log10.feedbackTasks.get("<value>");
// Handle the result
console.log(result)
}
run();
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `taskId` | *string* | :heavy_check_mark: | The task id to fetch. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
### Response
**Promise\<[operations.GetFeedbackTaskResponse](../../models/operations/getfeedbacktaskresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
| --------------- | --------------- | --------------- |
| errors.SDKError | 4xx-5xx | */* |

Some files were not shown because too many files have changed in this diff Show More