@gapi/openai 1.8.140 → 1.8.143

package/README.md

@@ -54,3 +54,38 @@ mutation {
   }
 }
 ```
+
+#### Extending the OpenAPI graphql endpoints using internal provided injection token `OpenAI`
+
+```typescript
+import { Controller, GraphQLNonNull, Inject, Mutation, Type } from '@gapi/core';
+import {
+  CreateCompletionInputType,
+  CreateCompletionRequest,
+  CreateCompletionType,
+  OpenAI,
+} from '@gapi/openai';
+import { from } from 'rxjs';
+import { map } from 'rxjs/operators';
+
+@Controller()
+export class CustomControllerController {
+  constructor(@Inject(OpenAI) private openai: OpenAI) {}
+
+  @Type(CreateCompletionType)
+  @Mutation({
+    payload: {
+      type: new GraphQLNonNull(CreateCompletionInputType),
+    },
+  })
+  createCompletion(root, { payload }: { payload: CreateCompletionRequest }) {
+    return from(
+      this.openai.createCompletion({
+        ...payload,
+        max_tokens: payload.max_tokens ?? 2048,
+      }),
+    ).pipe(map((res) => res.data));
+  }
+}
+
+```

package/dist/index.d.ts

@@ -3,3 +3,4 @@ export * from './openai.module';
 export * from './openai.tokens';
 export * from './types/create-completion-input.type';
 export * from './types/create-completion.type';
+export * from 'openai';

package/dist/index.js

@@ -15,4 +15,5 @@ __exportStar(require("./openai.module"), exports);
 __exportStar(require("./openai.tokens"), exports);
 __exportStar(require("./types/create-completion-input.type"), exports);
 __exportStar(require("./types/create-completion.type"), exports);
+__exportStar(require("openai"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,sDAAoC;AACpC,kDAAgC;AAChC,kDAAgC;AAChC,uEAAqD;AACrD,iEAA+C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,sDAAoC;AACpC,kDAAgC;AAChC,kDAAgC;AAChC,uEAAqD;AACrD,iEAA+C;AAC/C,yCAAuB"}

package/dist/openai.controller.js

@@ -24,12 +24,8 @@ let OpenAIController = class OpenAIController {
         this.openai = openai;
     }
     createCompletion(root, { payload }) {
-        var _a, _b;
-        return rxjs_1.from(this.openai.createCompletion({
-            model: (_a = payload.model) !== null && _a !== void 0 ? _a : 'text-davinci-003',
-            prompt: payload.prompt,
-            max_tokens: (_b = payload.max_tokens) !== null && _b !== void 0 ? _b : 2048,
-        })).pipe(operators_1.map((res) => res.data));
+        var _a;
+        return rxjs_1.from(this.openai.createCompletion(Object.assign(Object.assign({}, payload), { max_tokens: (_a = payload.max_tokens) !== null && _a !== void 0 ? _a : 2048 }))).pipe(operators_1.map((res) => res.data));
     }
 };
 __decorate([

package/dist/openai.controller.js.map

@@ -1 +1 @@
-{"version":3,"file":"openai.controller.js","sourceRoot":"","sources":["../src/openai.controller.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,qCAAgF;AAEhF,+BAA4B;AAC5B,8CAAqC;AAErC,mDAAyC;AACzC,uFAAiF;AACjF,2EAAsE;AAGtE,IAAa,gBAAgB,GAA7B,MAAa,gBAAgB;IAC3B,YAAoC,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;IAAG,CAAC;IAQtD,gBAAgB,CAAC,IAAI,EAAE,EAAE,OAAO,EAAwC;;QACtE,OAAO,WAAI,CACT,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;YAC3B,KAAK,QAAE,OAAO,CAAC,KAAK,mCAAI,kBAAkB;YAC1C,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,UAAU,QAAE,OAAO,CAAC,UAAU,mCAAI,IAAI;SACvC,CAAC,CACH,CAAC,IAAI,CAAC,eAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,CAAC;CACF,CAAA;AATC;IANC,WAAI,CAAC,6CAAoB,CAAC;IAC1B,eAAQ,CAAC;QACR,OAAO,EAAE;YACP,IAAI,EAAE,IAAI,qBAAc,CAAC,wDAAyB,CAAC;SACpD;KACF,CAAC;;;;wDASD;AAjBU,gBAAgB;IAD5B,iBAAU,EAAE;IAEE,WAAA,aAAM,CAAC,sBAAM,CAAC,CAAA;;GADhB,gBAAgB,CAkB5B;AAlBY,4CAAgB"}
+{"version":3,"file":"openai.controller.js","sourceRoot":"","sources":["../src/openai.controller.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,qCAAgF;AAEhF,+BAA4B;AAC5B,8CAAqC;AAErC,mDAAyC;AACzC,uFAAiF;AACjF,2EAAsE;AAGtE,IAAa,gBAAgB,GAA7B,MAAa,gBAAgB;IAC3B,YAAoC,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;IAAG,CAAC;IAQtD,gBAAgB,CAAC,IAAI,EAAE,EAAE,OAAO,EAAwC;;QACtE,OAAO,WAAI,CACT,IAAI,CAAC,MAAM,CAAC,gBAAgB,iCACvB,OAAO,KACV,UAAU,QAAE,OAAO,CAAC,UAAU,mCAAI,IAAI,IACtC,CACH,CAAC,IAAI,CAAC,eAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IACjC,CAAC;CACF,CAAA;AARC;IANC,WAAI,CAAC,6CAAoB,CAAC;IAC1B,eAAQ,CAAC;QACR,OAAO,EAAE;YACP,IAAI,EAAE,IAAI,qBAAc,CAAC,wDAAyB,CAAC;SACpD;KACF,CAAC;;;;wDAQD;AAhBU,gBAAgB;IAD5B,iBAAU,EAAE;IAEE,WAAA,aAAM,CAAC,sBAAM,CAAC,CAAA;;GADhB,gBAAgB,CAiB5B;AAjBY,4CAAgB"}

package/dist/types/create-completion-input.type.js

@@ -6,13 +6,47 @@ exports.CreateCompletionInputType = new graphql_1.GraphQLInputObjectType({
     name: 'CreateCompletionInputType',
     fields: () => ({
         model: {
+            description: 'ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.',
             type: new graphql_1.GraphQLNonNull(graphql_1.GraphQLString),
         },
         prompt: {
             type: new graphql_1.GraphQLNonNull(graphql_1.GraphQLString),
         },
         max_tokens: {
-            type: new graphql_1.GraphQLNonNull(graphql_1.GraphQLInt),
+            description: "The maximum number of [tokens](/tokenizer) to generate in the completion.  The token count of your prompt plus `max_tokens` cannot exceed the model's context length. Most models have a context length of 2048 tokens (except for the newest models, which support 4096).",
+            type: graphql_1.GraphQLInt,
+        },
+        suffix: {
+            description: 'The suffix that comes after a completion of inserted text.',
+            type: graphql_1.GraphQLString,
+        },
+        temperature: {
+            description: 'What [sampling temperature](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277) to use. Higher values means the model will take more risks. Try 0.9 for more creative applications, and 0 (argmax sampling) for ones with a well-defined answer.  We generally recommend altering this or `top_p` but not both.',
+            type: graphql_1.GraphQLInt,
+        },
+        top_p: {
+            description: '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.  We generally recommend altering this or `temperature` but not both.',
+            type: graphql_1.GraphQLInt,
+        },
+        n: {
+            description: 'How many completions to generate for each prompt.  **Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.',
+            type: graphql_1.GraphQLInt,
+        },
+        logprobs: {
+            description: 'Include the log probabilities on the `logprobs` most likely tokens, as well the chosen tokens. For example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The API will always return the `logprob` of the sampled token, so there may be up to `logprobs+1` elements in the response.  The maximum value for `logprobs` is 5. If you need more than this, please contact us through our [Help center](https://help.openai.com) and describe your use case.',
+            type: graphql_1.GraphQLString,
+        },
+        presence_penalty: {
+            description: "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.  [See more information about frequency and presence penalties.](https://platform.openai.com/docs/api-reference/parameter-details)",
+            type: graphql_1.GraphQLInt,
+        },
+        frequency_penalty: {
+            description: "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.  [See more information about frequency and presence penalties.](https://platform.openai.com/docs/api-reference/parameter-details)",
+            type: graphql_1.GraphQLInt,
+        },
+        best_of: {
+            description: 'Generates `best_of` completions server-side and returns the "best" (the one with the highest log probability per token). Results cannot be streamed.  When used with `n`, `best_of` controls the number of candidate completions and `n` specifies how many to return – `best_of` must be greater than `n`.  **Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.',
+            type: graphql_1.GraphQLInt,
         },
     }),
 });

package/dist/types/create-completion-input.type.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-completion-input.type.js","sourceRoot":"","sources":["../../src/types/create-completion-input.type.ts"],"names":[],"mappings":";;;AAAA,qCAKiB;AAEJ,QAAA,yBAAyB,GAAG,IAAI,gCAAsB,CAAC;IAClE,IAAI,EAAE,2BAA2B;IACjC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;QACb,KAAK,EAAE;YACL,IAAI,EAAE,IAAI,wBAAc,CAAC,uBAAa,CAAC;SACxC;QACD,MAAM,EAAE;YACN,IAAI,EAAE,IAAI,wBAAc,CAAC,uBAAa,CAAC;SACxC;QACD,UAAU,EAAE;YACV,IAAI,EAAE,IAAI,wBAAc,CAAC,oBAAU,CAAC;SACrC;KACF,CAAC;CACH,CAAC,CAAC"}
+{"version":3,"file":"create-completion-input.type.js","sourceRoot":"","sources":["../../src/types/create-completion-input.type.ts"],"names":[],"mappings":";;;AAAA,qCAKiB;AAEJ,QAAA,yBAAyB,GAAG,IAAI,gCAAsB,CAAC;IAClE,IAAI,EAAE,2BAA2B;IACjC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;QACb,KAAK,EAAE;YACL,WAAW,EACT,yOAAyO;YAC3O,IAAI,EAAE,IAAI,wBAAc,CAAC,uBAAa,CAAC;SACxC;QACD,MAAM,EAAE;YACN,IAAI,EAAE,IAAI,wBAAc,CAAC,uBAAa,CAAC;SACxC;QACD,UAAU,EAAE;YACV,WAAW,EACT,4QAA4Q;YAC9Q,IAAI,EAAE,oBAAU;SACjB;QAED,MAAM,EAAE;YACN,WAAW,EAAE,4DAA4D;YACzE,IAAI,EAAE,uBAAa;SACpB;QAED,WAAW,EAAE;YACX,WAAW,EACT,6UAA6U;YAC/U,IAAI,EAAE,oBAAU;SACjB;QAED,KAAK,EAAE;YACL,WAAW,EACT,kTAAkT;YACpT,IAAI,EAAE,oBAAU;SACjB;QAED,CAAC,EAAE;YACD,WAAW,EACT,kPAAkP;YACpP,IAAI,EAAE,oBAAU;SACjB;QACD,QAAQ,EAAE;YACR,WAAW,EACT,0dAA0d;YAC5d,IAAI,EAAE,uBAAa;SACpB;QAED,gBAAgB,EAAE;YAChB,WAAW,EACT,iTAAiT;YACnT,IAAI,EAAE,oBAAU;SACjB;QAED,iBAAiB,EAAE;YACjB,WAAW,EACT,8TAA8T;YAChU,IAAI,EAAE,oBAAU;SACjB;QAED,OAAO,EAAE;YACP,WAAW,EACT,4eAA4e;YAC9e,IAAI,EAAE,oBAAU;SACjB;KACF,CAAC;CACH,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gapi/openai",
-  "version": "1.8.140",
+  "version": "1.8.143",
   "repository": {
     "type": "git",
     "url": "https://github.com/Stradivario/gapi.git"
@@ -30,7 +30,7 @@
   },
   "dependencies": {
     "openai": "^3.1.0",
-    "@gapi/core": "^1.8.139"
+    "@gapi/core": "^1.8.142"
   },
   "devDependencies": {
     "@types/node": "^13.11.1",

package/src/index.ts

@@ -3,3 +3,4 @@ export * from './openai.module';
 export * from './openai.tokens';
 export * from './types/create-completion-input.type';
 export * from './types/create-completion.type';
+export * from 'openai';

package/src/openai.controller.ts

@@ -20,8 +20,7 @@ export class OpenAIController {
   createCompletion(root, { payload }: { payload: CreateCompletionRequest }) {
     return from(
       this.openai.createCompletion({
-        model: payload.model ?? 'text-davinci-003',
-        prompt: payload.prompt,
+        ...payload,
         max_tokens: payload.max_tokens ?? 2048,
       }),
     ).pipe(map((res) => res.data));

package/src/types/create-completion-input.type.ts

@@ -9,13 +9,63 @@ export const CreateCompletionInputType = new GraphQLInputObjectType({
   name: 'CreateCompletionInputType',
   fields: () => ({
     model: {
+      description:
+        'ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.',
       type: new GraphQLNonNull(GraphQLString),
     },
     prompt: {
       type: new GraphQLNonNull(GraphQLString),
     },
     max_tokens: {
-      type: new GraphQLNonNull(GraphQLInt),
+      description:
+        "The maximum number of [tokens](/tokenizer) to generate in the completion.  The token count of your prompt plus `max_tokens` cannot exceed the model's context length. Most models have a context length of 2048 tokens (except for the newest models, which support 4096).",
+      type: GraphQLInt,
+    },
+
+    suffix: {
+      description: 'The suffix that comes after a completion of inserted text.',
+      type: GraphQLString,
+    },
+
+    temperature: {
+      description:
+        'What [sampling temperature](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277) to use. Higher values means the model will take more risks. Try 0.9 for more creative applications, and 0 (argmax sampling) for ones with a well-defined answer.  We generally recommend altering this or `top_p` but not both.',
+      type: GraphQLInt,
+    },
+
+    top_p: {
+      description:
+        '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.  We generally recommend altering this or `temperature` but not both.',
+      type: GraphQLInt,
+    },
+
+    n: {
+      description:
+        'How many completions to generate for each prompt.  **Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.',
+      type: GraphQLInt,
+    },
+    logprobs: {
+      description:
+        'Include the log probabilities on the `logprobs` most likely tokens, as well the chosen tokens. For example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The API will always return the `logprob` of the sampled token, so there may be up to `logprobs+1` elements in the response.  The maximum value for `logprobs` is 5. If you need more than this, please contact us through our [Help center](https://help.openai.com) and describe your use case.',
+      type: GraphQLString,
+    },
+
+    presence_penalty: {
+      description:
+        "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.  [See more information about frequency and presence penalties.](https://platform.openai.com/docs/api-reference/parameter-details)",
+      type: GraphQLInt,
+    },
+
+    frequency_penalty: {
+      description:
+        "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.  [See more information about frequency and presence penalties.](https://platform.openai.com/docs/api-reference/parameter-details)",
+      type: GraphQLInt,
+    },
+
+    best_of: {
+      description:
+        'Generates `best_of` completions server-side and returns the "best" (the one with the highest log probability per token). Results cannot be streamed.  When used with `n`, `best_of` controls the number of candidate completions and `n` specifies how many to return – `best_of` must be greater than `n`.  **Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.',
+      type: GraphQLInt,
     },
   }),
 });