mirror of
https://github.com/LukeHagar/log10ts.git
synced 2025-12-06 04:20:12 +00:00
180 lines
16 KiB
Markdown
180 lines
16 KiB
Markdown
# 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 | */* |
|