chatgpt-api/docs/modules/openai.md

[chatgpt](../readme.md) / [Exports](../modules.md) / openai

# Namespace: openai

## Table of contents

### Interfaces

- [ChatCompletionRequestMessage](../interfaces/openai.ChatCompletionRequestMessage.md)
- [ChatCompletionResponseMessage](../interfaces/openai.ChatCompletionResponseMessage.md)
- [CreateChatCompletionDeltaResponse](../interfaces/openai.CreateChatCompletionDeltaResponse.md)
- [CreateChatCompletionRequest](../interfaces/openai.CreateChatCompletionRequest.md)
- [CreateChatCompletionResponse](../interfaces/openai.CreateChatCompletionResponse.md)
- [CreateChatCompletionResponseChoicesInner](../interfaces/openai.CreateChatCompletionResponseChoicesInner.md)
- [CreateCompletionResponseUsage](../interfaces/openai.CreateCompletionResponseUsage.md)

### Type Aliases

- [ChatCompletionRequestMessageRoleEnum](openai.md#chatcompletionrequestmessageroleenum)
- [ChatCompletionResponseMessageRoleEnum](openai.md#chatcompletionresponsemessageroleenum)
- [CreateChatCompletionRequestStop](openai.md#createchatcompletionrequeststop)

### Variables

- [ChatCompletionRequestMessageRoleEnum](openai.md#chatcompletionrequestmessageroleenum-1)
- [ChatCompletionResponseMessageRoleEnum](openai.md#chatcompletionresponsemessageroleenum-1)

## Type Aliases

### ChatCompletionRequestMessageRoleEnum

Ƭ **ChatCompletionRequestMessageRoleEnum**: typeof [`ChatCompletionRequestMessageRoleEnum`](openai.md#chatcompletionrequestmessageroleenum-1)[keyof typeof [`ChatCompletionRequestMessageRoleEnum`](openai.md#chatcompletionrequestmessageroleenum-1)]

#### Defined in

[src/types.ts:216](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L216)

[src/types.ts:221](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L221)

___

### ChatCompletionResponseMessageRoleEnum

Ƭ **ChatCompletionResponseMessageRoleEnum**: typeof [`ChatCompletionResponseMessageRoleEnum`](openai.md#chatcompletionresponsemessageroleenum-1)[keyof typeof [`ChatCompletionResponseMessageRoleEnum`](openai.md#chatcompletionresponsemessageroleenum-1)]

#### Defined in

[src/types.ts:242](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L242)

[src/types.ts:247](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L247)

___

### CreateChatCompletionRequestStop

Ƭ **CreateChatCompletionRequestStop**: `string`[] \| `string`

**`Export`**

#### Defined in

[src/types.ts:333](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L333)

## Variables

### ChatCompletionRequestMessageRoleEnum

• `Const` **ChatCompletionRequestMessageRoleEnum**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `Assistant` | ``"assistant"`` |
| `System` | ``"system"`` |
| `User` | ``"user"`` |

#### Defined in

[src/types.ts:216](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L216)

[src/types.ts:221](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L221)

___

### ChatCompletionResponseMessageRoleEnum

• `Const` **ChatCompletionResponseMessageRoleEnum**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `Assistant` | ``"assistant"`` |
| `System` | ``"system"`` |
| `User` | ``"user"`` |

#### Defined in

[src/types.ts:242](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L242)

[src/types.ts:247](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L247)
docs: update readme and auto-gen docs 2023-02-01 10:58:25 +00:00			`[chatgpt](../readme.md) / [Exports](../modules.md) / openai`

			`# Namespace: openai`

			`## Table of contents`

chore: update docs 2023-03-02 05:32:33 +00:00			`### Interfaces`

			`- [ChatCompletionRequestMessage](../interfaces/openai.ChatCompletionRequestMessage.md)`
			`- [ChatCompletionResponseMessage](../interfaces/openai.ChatCompletionResponseMessage.md)`
			`- [CreateChatCompletionDeltaResponse](../interfaces/openai.CreateChatCompletionDeltaResponse.md)`
			`- [CreateChatCompletionRequest](../interfaces/openai.CreateChatCompletionRequest.md)`
			`- [CreateChatCompletionResponse](../interfaces/openai.CreateChatCompletionResponse.md)`
			`- [CreateChatCompletionResponseChoicesInner](../interfaces/openai.CreateChatCompletionResponseChoicesInner.md)`
			`- [CreateCompletionResponseUsage](../interfaces/openai.CreateCompletionResponseUsage.md)`

docs: update readme and auto-gen docs 2023-02-01 10:58:25 +00:00			`### Type Aliases`

chore: update docs 2023-03-02 05:32:33 +00:00			`- [ChatCompletionRequestMessageRoleEnum](openai.md#chatcompletionrequestmessageroleenum)`
			`- [ChatCompletionResponseMessageRoleEnum](openai.md#chatcompletionresponsemessageroleenum)`
			`- [CreateChatCompletionRequestStop](openai.md#createchatcompletionrequeststop)`
docs: update readme and auto-gen docs 2023-02-01 10:58:25 +00:00
chore: update docs 2023-03-02 05:32:33 +00:00			`### Variables`
docs: update readme and auto-gen docs 2023-02-01 10:58:25 +00:00
chore: update docs 2023-03-02 05:32:33 +00:00			`- [ChatCompletionRequestMessageRoleEnum](openai.md#chatcompletionrequestmessageroleenum-1)`
			`- [ChatCompletionResponseMessageRoleEnum](openai.md#chatcompletionresponsemessageroleenum-1)`
docs: update readme and auto-gen docs 2023-02-01 10:58:25 +00:00
chore: update docs 2023-03-02 05:32:33 +00:00			`## Type Aliases`
docs: update readme and auto-gen docs 2023-02-01 10:58:25 +00:00
chore: update docs 2023-03-02 05:32:33 +00:00			`### ChatCompletionRequestMessageRoleEnum`
docs: update readme and auto-gen docs 2023-02-01 10:58:25 +00:00
chore: update docs 2023-03-02 05:32:33 +00:00			Ƭ ChatCompletionRequestMessageRoleEnum: typeof [`ChatCompletionRequestMessageRoleEnum`](openai.md#chatcompletionrequestmessageroleenum-1)[keyof typeof [`ChatCompletionRequestMessageRoleEnum`](openai.md#chatcompletionrequestmessageroleenum-1)]
docs: update readme and auto-gen docs 2023-02-01 10:58:25 +00:00
			`#### Defined in`

chore: update ts docs 2023-03-02 23:25:26 +00:00			`[src/types.ts:216](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L216)`
docs: update readme and auto-gen docs 2023-02-01 10:58:25 +00:00
chore: update ts docs 2023-03-02 23:25:26 +00:00			`[src/types.ts:221](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L221)`
docs: update readme and auto-gen docs 2023-02-01 10:58:25 +00:00
chore: update docs 2023-03-02 05:32:33 +00:00			`___`
docs: update readme and auto-gen docs 2023-02-01 10:58:25 +00:00
chore: update docs 2023-03-02 05:32:33 +00:00			`### ChatCompletionResponseMessageRoleEnum`
docs: update readme and auto-gen docs 2023-02-01 10:58:25 +00:00
chore: update docs 2023-03-02 05:32:33 +00:00			Ƭ ChatCompletionResponseMessageRoleEnum: typeof [`ChatCompletionResponseMessageRoleEnum`](openai.md#chatcompletionresponsemessageroleenum-1)[keyof typeof [`ChatCompletionResponseMessageRoleEnum`](openai.md#chatcompletionresponsemessageroleenum-1)]
docs: update readme and auto-gen docs 2023-02-01 10:58:25 +00:00
			`#### Defined in`

chore: update ts docs 2023-03-02 23:25:26 +00:00			`[src/types.ts:242](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L242)`
chore: update docs 2023-03-02 05:32:33 +00:00
chore: update ts docs 2023-03-02 23:25:26 +00:00			`[src/types.ts:247](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L247)`
docs: update readme and auto-gen docs 2023-02-01 10:58:25 +00:00
			`___`

chore: update docs 2023-03-02 05:32:33 +00:00			`### CreateChatCompletionRequestStop`

			Ƭ CreateChatCompletionRequestStop: `string`[] \\| `string`
docs: update readme and auto-gen docs 2023-02-01 10:58:25 +00:00
chore: update docs 2023-03-02 05:32:33 +00:00			`Export`
docs: update readme and auto-gen docs 2023-02-01 10:58:25 +00:00
			`#### Defined in`

chore: update ts docs 2023-03-02 23:25:26 +00:00			`[src/types.ts:333](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L333)`
docs: update readme and auto-gen docs 2023-02-01 10:58:25 +00:00
chore: update docs 2023-03-02 05:32:33 +00:00			`## Variables`
docs: update readme and auto-gen docs 2023-02-01 10:58:25 +00:00
chore: update docs 2023-03-02 05:32:33 +00:00			`### ChatCompletionRequestMessageRoleEnum`
docs: update readme and auto-gen docs 2023-02-01 10:58:25 +00:00
chore: update docs 2023-03-02 05:32:33 +00:00			• `Const` ChatCompletionRequestMessageRoleEnum: `Object`
docs: update readme and auto-gen docs 2023-02-01 10:58:25 +00:00
			`#### Type declaration`

			`\| Name \| Type \|`
			`\| :------ \| :------ \|`
chore: update docs 2023-03-02 05:32:33 +00:00			\| `Assistant` \| ``"assistant"`` \|
			\| `System` \| ``"system"`` \|
			\| `User` \| ``"user"`` \|
docs: update readme and auto-gen docs 2023-02-01 10:58:25 +00:00
			`#### Defined in`

chore: update ts docs 2023-03-02 23:25:26 +00:00			`[src/types.ts:216](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L216)`
chore: update docs 2023-03-02 05:32:33 +00:00
chore: update ts docs 2023-03-02 23:25:26 +00:00			`[src/types.ts:221](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L221)`
chore: update ts docs 2023-02-19 08:51:53 +00:00
			`___`

chore: update docs 2023-03-02 05:32:33 +00:00			`### ChatCompletionResponseMessageRoleEnum`

			• `Const` ChatCompletionResponseMessageRoleEnum: `Object`
chore: update ts docs 2023-02-19 08:51:53 +00:00
chore: update docs 2023-03-02 05:32:33 +00:00			`#### Type declaration`

			`\| Name \| Type \|`
			`\| :------ \| :------ \|`
			\| `Assistant` \| ``"assistant"`` \|
			\| `System` \| ``"system"`` \|
			\| `User` \| ``"user"`` \|
chore: update ts docs 2023-02-19 08:51:53 +00:00
			`#### Defined in`

chore: update ts docs 2023-03-02 23:25:26 +00:00			`[src/types.ts:242](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L242)`
chore: update docs 2023-03-02 05:32:33 +00:00
chore: update ts docs 2023-03-02 23:25:26 +00:00			`[src/types.ts:247](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L247)`