Class ChatGPTTrait

The ChatGPT trait adds chatgpt resolver to the Query of the entities that its attached to.

Usage:

traits:
  - type: chatgpt

In config.yml

chatgpt:
    organisation: <OpenAI Organisation> Required
    apiKey: <OpenAI API Key> Required
    model: <OpenAI GPT-3 Model ID> Optional, defaults to davinci
    maxTokens: <OpenAI API MaxTokens> Optional, defaults to 100
    mock: <Boolean> Optional, defaults to false

Mermaid

ChatGPT Query

%%{init:{"theme":"dark"}}%% sequenceDiagram actor User participant Kosmos participant OpenAI User->>Kosmos: Query ChatGPT Kosmos->>OpenAI: Call OpenAI createCompletion activate OpenAI OpenAI->>Kosmos: Response deactivate OpenAI Kosmos->>User: Response

%%{init:{"theme":"default"}}%% sequenceDiagram actor User participant Kosmos participant OpenAI User->>Kosmos: Query ChatGPT Kosmos->>OpenAI: Call OpenAI createCompletion activate OpenAI OpenAI->>Kosmos: Response deactivate OpenAI Kosmos->>User: Response

sequenceDiagram
   actor User
   participant Kosmos
   participant OpenAI
   User->>Kosmos: Query ChatGPT
   Kosmos->>OpenAI: Call OpenAI createCompletion
   activate OpenAI
   OpenAI->>Kosmos: Response
   deactivate OpenAI
   Kosmos->>User: Response

Hierarchy

Trait<ChatGPTTraitConfig>
- ChatGPTTrait

Index

Constructors

constructor

new ChatGPTTrait(_runtimeConfig: RuntimeConfig, graphqlSchemaManager: GraphQLSchemaManager, dataSourceWrapper: DataSourceWrapper, _graphqlSchemaManager: GraphQLSchemaManager): ChatGPTTrait
Parameters
- _runtimeConfig: RuntimeConfig
- graphqlSchemaManager: GraphQLSchemaManager
- dataSourceWrapper: DataSourceWrapper
- _graphqlSchemaManager: GraphQLSchemaManager
Returns ChatGPTTrait
Overrides Trait.constructor
- Defined in src/traits/ChatGPTTrait.ts:82

Properties

`Protected` `Optional` _config

_config?: ChatGPTTraitConfig

Trait instance configuration.

`Protected` _global

_global: boolean = false

Whether this is a global (not bound to any specific schema item) trait instance.

`Protected` `Readonly` _graphqlSchemaManager

_graphqlSchemaManager: GraphQLSchemaManager

_openai

_openai: any

`Protected` _runtimeConfig

_runtimeConfig: RuntimeConfig

`Protected` `Optional` _type

_type?: "chatgpt"

Trait type.

`Protected` `Readonly` dataSourceWrapper

dataSourceWrapper: DataSourceWrapper

`Protected` `Readonly` graphqlSchemaManager

graphqlSchemaManager: GraphQLSchemaManager

Methods

chatGPT

chatGPT(datasourceWrapper: DataSourceWrapper, data: any): Promise<any>
The chatGPT resolver is the function that is called when the chatgpt field is called. It calls the OpenAI API to get the response, using the input as the prompt. It then returns the response, first choice, first text.

Returns
The response from OpenAI.
Parameters
- datasourceWrapper: DataSourceWrapper
  
  Datasource wrapper object.
- data: any
  
  The data object.
Returns Promise<any>
- Defined in src/traits/ChatGPTTrait.ts:162

hookIntoSchema

hookIntoSchema(schemaItem: SchemaItem<SchemaItemType>): void
Attaches Trait callbacks to schema item hooks.
Parameters
- schemaItem: SchemaItem<SchemaItemType>
Returns void
Overrides Trait.hookIntoSchema
- Defined in src/traits/ChatGPTTrait.ts:198

hookIntoSchemaManager

hookIntoSchemaManager(): void
Attaches Trait callbacks to schema manager hooks.

Returns void
Inherited from Trait.hookIntoSchemaManager
- Defined in src/traits/Trait.ts:225

makeGlobal

makeGlobal(): ChatGPTTrait
Makes this Trait instance global.

Returns ChatGPTTrait
Inherited from Trait.makeGlobal
- Defined in src/traits/Trait.ts:237

name

name(): string
Used to return the name.

Returns string
Inherited from Trait.name
- Defined in src/traits/Trait.ts:198

process

process<RT, Payload>(callbackName: string, datasourceWrapper: DataSourceWrapper, data: TraitDataObject<RT, Payload, Promise<any>>): Promise<RT>
This method is triggered when a trait callback has been activated
Type Parameters
- RT = any
- Payload = any
Parameters
- callbackName: string
  
  This is the name of the callback function to call.
- datasourceWrapper: DataSourceWrapper
  
  References to the Graph Hanlder
- data: TraitDataObject<RT, Payload, Promise<any>>
  
  Request data passed along as part of the request.
Returns Promise<RT>
Inherited from Trait.process
- Defined in src/traits/Trait.ts:147

querySchema

querySchema(schemaString: string): string
Parameters
- schemaString: string
Returns string
- Defined in src/traits/ChatGPTTrait.ts:147

setConfig

setConfig(config: ChatGPTTraitConfig): void
ChatGPTTrait configuration setter.
Parameters
- config: ChatGPTTraitConfig
  
  This configuration object.
Returns void
Overrides Trait.setConfig
- Defined in src/traits/ChatGPTTrait.ts:123

traitConfig

traitConfig(): ChatGPTTraitConfig
Returns ChatGPTTraitConfig
Inherited from Trait.traitConfig
- Defined in src/traits/Trait.ts:205

wrapLegacyResolver

wrapLegacyResolver<RT, Payload>(resolver: LegacyKosmosTraitResolverCallback<RT, any>, datasourceWrapper: DataSourceWrapper, callbackName?: string): KosmosGraphQLResolver<RT, Payload, Promise<RT>>
Helper method for wrapping legacy Kosmos traits callbacks.

TODO: Remove this method once all Traits are converted.
Type Parameters
- RT = any
- Payload = any
Parameters
- resolver: LegacyKosmosTraitResolverCallback<RT, any>
- datasourceWrapper: DataSourceWrapper
- Optional callbackName: string
  
  Optional callback name; passing this parameter will additionally wrap the callback into legacy process().
Returns KosmosGraphQLResolver<RT, Payload, Promise<RT>>
Inherited from Trait.wrapLegacyResolver
- Defined in src/traits/Trait.ts:168

`Static` traitTypeName

traitTypeName(): string
This method should return the trait machine name(s).

Returns

Returns string
Overrides Trait.traitTypeName
- Defined in src/traits/ChatGPTTrait.ts:142

Class ChatGPTTrait

Mermaid

ChatGPT Query

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

_runtimeConfig: RuntimeConfig

graphqlSchemaManager: GraphQLSchemaManager

dataSourceWrapper: DataSourceWrapper

_graphqlSchemaManager: GraphQLSchemaManager

Returns ChatGPTTrait

Properties

Protected Optional _config

Protected _global

Protected Readonly _graphqlSchemaManager

_openai

Protected _runtimeConfig

Protected Optional _type

Protected Readonly dataSourceWrapper

Protected Readonly graphqlSchemaManager

Methods

chatGPT

Returns

Parameters

datasourceWrapper: DataSourceWrapper

data: any

Returns Promise<any>

hookIntoSchema

Parameters

schemaItem: SchemaItem<SchemaItemType>

Returns void

hookIntoSchemaManager

Returns void

makeGlobal

Returns ChatGPTTrait

name

Returns string

process

Type Parameters

RT = any

Payload = any

Parameters

callbackName: string

datasourceWrapper: DataSourceWrapper

data: TraitDataObject<RT, Payload, Promise<any>>

Returns Promise<RT>

querySchema

Parameters

schemaString: string

Returns string

setConfig

Parameters

config: ChatGPTTraitConfig

Returns void

traitConfig

Returns ChatGPTTraitConfig

wrapLegacyResolver

Type Parameters

RT = any

Payload = any

Parameters

resolver: LegacyKosmosTraitResolverCallback<RT, any>

datasourceWrapper: DataSourceWrapper

Optional callbackName: string

Returns KosmosGraphQLResolver<RT, Payload, Promise<RT>>

Static traitTypeName

Returns

Returns string

Settings

Member Visibility

Theme

`Protected` `Optional` _config

`Protected` _global

`Protected` `Readonly` _graphqlSchemaManager

`Protected` _runtimeConfig

`Protected` `Optional` _type

`Protected` `Readonly` dataSourceWrapper

`Protected` `Readonly` graphqlSchemaManager

`Optional` callbackName: string

`Static` traitTypeName