@salesforce/lds-adapters-industries-nlpservice 1.228.1 → 1.229.0-dev10

package/dist/es/es2018/industries-nlpservice.js

@@ -7,7 +7,7 @@
 import { serializeStructuredKey, ingestShape, deepFreeze, StoreKeyMap, createResourceParams as createResourceParams$2, buildNetworkSnapshotCachePolicy as buildNetworkSnapshotCachePolicy$1, typeCheckConfig as typeCheckConfig$2 } from '@luvio/engine';
 
 const { hasOwnProperty: ObjectPrototypeHasOwnProperty } = Object.prototype;
-const { keys: ObjectKeys, create: ObjectCreate } = Object;
+const { keys: ObjectKeys$1, create: ObjectCreate$1 } = Object;
 const { isArray: ArrayIsArray$1 } = Array;
 /**
  * Validates an adapter config is well-formed.
@@ -31,7 +31,7 @@ function validateConfig(config, adapter, oneOf) {
         throw new TypeError(`adapter ${displayName} does not yet support ${unsupported.sort().join(', ')}`);
     }
     const supported = required.concat(optional);
-    if (ObjectKeys(config).some(key => !supported.includes(key))) {
+    if (ObjectKeys$1(config).some(key => !supported.includes(key))) {
         throw new TypeError(`adapter ${displayName} configuration supports only ${supported.sort().join(', ')}`);
     }
 }
@@ -71,6 +71,7 @@ function buildAdapterValidationConfig(displayName, paramsMeta) {
 }
 const keyPrefix = 'NlpService';
 
+const { keys: ObjectKeys, create: ObjectCreate, assign: ObjectAssign } = Object;
 const { isArray: ArrayIsArray } = Array;
 const { stringify: JSONStringify } = JSON;
 function createLink(ref) {
@@ -79,11 +80,58 @@ function createLink(ref) {
     };
 }
 
+function validate$4(obj, path = 'NullableAdditionalParametersInputMap') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_keys = ObjectKeys(obj);
+        for (let i = 0; i < obj_keys.length; i++) {
+            const key = obj_keys[i];
+            const obj_prop = obj[key];
+            const path_prop = path + '["' + key + '"]';
+            if (obj_prop === undefined) {
+                return new TypeError('Expected "defined" but received "' + typeof obj_prop + '" (at "' + path_prop + '")');
+            }
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+
+function validate$3(obj, path = 'AdditionalParametersInputMap') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        if (obj.additionalParameters !== undefined) {
+            const obj_additionalParameters = obj.additionalParameters;
+            const path_additionalParameters = path + '.additionalParameters';
+            const referencepath_additionalParametersValidationError = validate$4(obj_additionalParameters, path_additionalParameters);
+            if (referencepath_additionalParametersValidationError !== null) {
+                let message = 'Object doesn\'t match NullableAdditionalParametersInputMap (at "' + path_additionalParameters + '")\n';
+                message += referencepath_additionalParametersValidationError.message.split('\n').map((line) => '\t' + line).join('\n');
+                return new TypeError(message);
+            }
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+
 function validate$2(obj, path = 'AINaturalLangProcessResultInputRepresentation') {
     const v_error = (() => {
         if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
             return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
         }
+        if (obj.additionalParameters !== undefined) {
+            const obj_additionalParameters = obj.additionalParameters;
+            const path_additionalParameters = path + '.additionalParameters';
+            const referencepath_additionalParametersValidationError = validate$3(obj_additionalParameters, path_additionalParameters);
+            if (referencepath_additionalParametersValidationError !== null) {
+                let message = 'Object doesn\'t match AdditionalParametersInputMap (at "' + path_additionalParameters + '")\n';
+                message += referencepath_additionalParametersValidationError.message.split('\n').map((line) => '\t' + line).join('\n');
+                return new TypeError(message);
+            }
+        }
         if (obj.query !== undefined) {
             const obj_query = obj.query;
             const path_query = path + '.query';

package/dist/es/es2018/types/src/generated/types/AINaturalLangProcessResultInputRepresentation.d.ts

@@ -1,5 +1,6 @@
+import { AdditionalParametersInputMap as AdditionalParametersInputMap_AdditionalParametersInputMap } from './AdditionalParametersInputMap';
 import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
-export declare const VERSION = "03c3a2a041972ab9bf12b287f2cfe595";
+export declare const VERSION = "0c058aa70c964e5f9c52617324bc03da";
 export declare function validate(obj: any, path?: string): TypeError | null;
 export declare const RepresentationType: string;
 export declare function normalize(input: AINaturalLangProcessResultInputRepresentation, existing: AINaturalLangProcessResultInputRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): AINaturalLangProcessResultInputRepresentationNormalized;
@@ -14,6 +15,8 @@ export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableSto
  *    (none)
  */
 export interface AINaturalLangProcessResultInputRepresentationNormalized {
+    /** Additional Parameters */
+    additionalParameters?: AdditionalParametersInputMap_AdditionalParametersInputMap;
     /** Query */
     query?: string;
     /** Service Type */
@@ -26,6 +29,7 @@ export interface AINaturalLangProcessResultInputRepresentationNormalized {
  *    (none)
  */
 export interface AINaturalLangProcessResultInputRepresentation {
+    additionalParameters?: AdditionalParametersInputMap_AdditionalParametersInputMap;
     query?: string;
     serviceType?: string;
 }

package/dist/es/es2018/types/src/generated/types/AdditionalParametersInputMap.d.ts

@@ -0,0 +1,28 @@
+import { NullableAdditionalParametersInputMap as NullableAdditionalParametersInputMap_NullableAdditionalParametersInputMap } from './NullableAdditionalParametersInputMap';
+import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
+export declare const VERSION = "32a675f18d4e87e59653cde5fb93e006";
+export declare function validate(obj: any, path?: string): TypeError | null;
+export declare const RepresentationType: string;
+export declare function normalize(input: AdditionalParametersInputMap, existing: AdditionalParametersInputMapNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): AdditionalParametersInputMapNormalized;
+export declare const select: () => $64$luvio_engine_FragmentSelection;
+export declare function equals(existing: AdditionalParametersInputMapNormalized, incoming: AdditionalParametersInputMapNormalized): boolean;
+export declare const ingest: $64$luvio_engine_ResourceIngest;
+export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: AdditionalParametersInputMap, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
+/**
+ * Represents a map of additional parameters.
+ *
+ * Keys:
+ *    (none)
+ */
+export interface AdditionalParametersInputMapNormalized {
+    additionalParameters?: NullableAdditionalParametersInputMap_NullableAdditionalParametersInputMap;
+}
+/**
+ * Represents a map of additional parameters.
+ *
+ * Keys:
+ *    (none)
+ */
+export interface AdditionalParametersInputMap {
+    additionalParameters?: NullableAdditionalParametersInputMap_NullableAdditionalParametersInputMap;
+}

package/dist/es/es2018/types/src/generated/types/ErrorRepresentation.d.ts

@@ -0,0 +1,31 @@
+import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
+export declare const VERSION = "00afa7e60a8201c64074ac5356795a7d";
+export declare function validate(obj: any, path?: string): TypeError | null;
+export declare const RepresentationType: string;
+export declare function normalize(input: ErrorRepresentation, existing: ErrorRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): ErrorRepresentationNormalized;
+export declare const select: () => $64$luvio_engine_FragmentSelection;
+export declare function equals(existing: ErrorRepresentationNormalized, incoming: ErrorRepresentationNormalized): boolean;
+export declare const ingest: $64$luvio_engine_ResourceIngest;
+export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: ErrorRepresentation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
+/**
+ * Represents clause results fetched from OpenAI
+ *
+ * Keys:
+ *    (none)
+ */
+export interface ErrorRepresentationNormalized {
+    /** Represents error code */
+    errorCode: number;
+    /** Represents error message */
+    errorMessage: string;
+}
+/**
+ * Represents clause results fetched from OpenAI
+ *
+ * Keys:
+ *    (none)
+ */
+export interface ErrorRepresentation {
+    errorCode: number;
+    errorMessage: string;
+}

package/dist/es/es2018/types/src/generated/types/NullableAdditionalParametersInputMap.d.ts

@@ -0,0 +1,27 @@
+import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
+export declare const VERSION = "b175ba6bc288736f40f6c4f59fab798c";
+export declare function validate(obj: any, path?: string): TypeError | null;
+export declare const RepresentationType: string;
+export declare function normalize(input: NullableAdditionalParametersInputMap, existing: NullableAdditionalParametersInputMapNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): NullableAdditionalParametersInputMapNormalized;
+export declare const select: () => $64$luvio_engine_FragmentSelection;
+export declare function equals(existing: NullableAdditionalParametersInputMapNormalized, incoming: NullableAdditionalParametersInputMapNormalized): boolean;
+export declare const ingest: $64$luvio_engine_ResourceIngest;
+export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: NullableAdditionalParametersInputMap, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
+/**
+ * Wrapper for Nullable Map Object.
+ *
+ * Keys:
+ *    (none)
+ */
+export interface NullableAdditionalParametersInputMapNormalized {
+    [key: string]: unknown;
+}
+/**
+ * Wrapper for Nullable Map Object.
+ *
+ * Keys:
+ *    (none)
+ */
+export interface NullableAdditionalParametersInputMap {
+    [key: string]: unknown;
+}

package/dist/es/es2018/types/src/generated/types/OpenAISurveyGenerationRepresentation.d.ts

@@ -0,0 +1,32 @@
+import { SurveyStructRepresentation as SurveyStructRepresentation_SurveyStructRepresentation } from './SurveyStructRepresentation';
+import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
+export declare const VERSION = "2be0b5c65b2e7d8a86ccb3827fa81c10";
+export declare function validate(obj: any, path?: string): TypeError | null;
+export declare const RepresentationType: string;
+export declare function normalize(input: OpenAISurveyGenerationRepresentation, existing: OpenAISurveyGenerationRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): OpenAISurveyGenerationRepresentationNormalized;
+export declare const select: () => $64$luvio_engine_FragmentSelection;
+export declare function equals(existing: OpenAISurveyGenerationRepresentationNormalized, incoming: OpenAISurveyGenerationRepresentationNormalized): boolean;
+export declare const ingest: $64$luvio_engine_ResourceIngest;
+export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: OpenAISurveyGenerationRepresentation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
+/**
+ * Represents survey generationr results from OpenAI
+ *
+ * Keys:
+ *    (none)
+ */
+export interface OpenAISurveyGenerationRepresentationNormalized {
+    /** Represents the total count of survey questions */
+    questionCount: number;
+    /** Represents a list of survey questions */
+    questions: Array<SurveyStructRepresentation_SurveyStructRepresentation>;
+}
+/**
+ * Represents survey generationr results from OpenAI
+ *
+ * Keys:
+ *    (none)
+ */
+export interface OpenAISurveyGenerationRepresentation {
+    questionCount: number;
+    questions: Array<SurveyStructRepresentation_SurveyStructRepresentation>;
+}

package/dist/es/es2018/types/src/generated/types/SurveyStructRepresentation.d.ts

@@ -0,0 +1,40 @@
+import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, FragmentSelection as $64$luvio_engine_FragmentSelection, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
+export declare const VERSION = "82568a3fb0ce245db4c8ff3daf3d32cf";
+export declare function validate(obj: any, path?: string): TypeError | null;
+export declare const RepresentationType: string;
+export declare function normalize(input: SurveyStructRepresentation, existing: SurveyStructRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): SurveyStructRepresentationNormalized;
+export declare const select: () => $64$luvio_engine_FragmentSelection;
+export declare function equals(existing: SurveyStructRepresentationNormalized, incoming: SurveyStructRepresentationNormalized): boolean;
+export declare const ingest: $64$luvio_engine_ResourceIngest;
+export declare function getTypeCacheKeys(rootKeySet: $64$luvio_engine_DurableStoreKeyMetadataMap, luvio: $64$luvio_engine_Luvio, input: SurveyStructRepresentation, fullPathFactory: () => string | $64$luvio_engine_NormalizedKeyMetadata): void;
+/**
+ * Contents within a survey question
+ *
+ * Keys:
+ *    (none)
+ */
+export interface SurveyStructRepresentationNormalized {
+    /** List of question choices */
+    questionChoices: Array<string>;
+    /** The question description */
+    questionDescription: string;
+    /** The question label */
+    questionLabel: string;
+    /** Generated question type */
+    questionType: string;
+    /** Is question required */
+    required: boolean;
+}
+/**
+ * Contents within a survey question
+ *
+ * Keys:
+ *    (none)
+ */
+export interface SurveyStructRepresentation {
+    questionChoices: Array<string>;
+    questionDescription: string;
+    questionLabel: string;
+    questionType: string;
+    required: boolean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-adapters-industries-nlpservice",
-    "version": "1.228.1",
+    "version": "1.229.0-dev10",
     "description": "Ai Natural Language Processing Service",
     "license": "SEE LICENSE IN LICENSE.txt",
     "main": "dist/es/es2018/industries-nlpservice.js",
@@ -43,11 +43,11 @@
         "test:compat": "karma start --single-run --compat"
     },
     "dependencies": {
-        "@salesforce/lds-bindings": "*"
+        "@salesforce/lds-bindings": "1.229.0-dev10"
     },
     "devDependencies": {
-        "@salesforce/lds-karma": "*",
-        "@salesforce/lds-compiler-plugins": "*"
+        "@salesforce/lds-compiler-plugins": "1.229.0-dev10",
+        "@salesforce/lds-karma": "1.229.0-dev10"
     },
     "nx": {
         "targets": {

package/sfdc/index.js

@@ -17,7 +17,7 @@ import { withDefaultLuvio } from 'force/ldsEngine';
 import { serializeStructuredKey, ingestShape, deepFreeze, StoreKeyMap, createResourceParams as createResourceParams$2, buildNetworkSnapshotCachePolicy as buildNetworkSnapshotCachePolicy$1, typeCheckConfig as typeCheckConfig$2 } from 'force/luvioEngine';
 
 const { hasOwnProperty: ObjectPrototypeHasOwnProperty } = Object.prototype;
-const { keys: ObjectKeys, create: ObjectCreate } = Object;
+const { keys: ObjectKeys$1, create: ObjectCreate$1 } = Object;
 const { isArray: ArrayIsArray$1 } = Array;
 /**
  * Validates an adapter config is well-formed.
@@ -41,7 +41,7 @@ function validateConfig(config, adapter, oneOf) {
         throw new TypeError(`adapter ${displayName} does not yet support ${unsupported.sort().join(', ')}`);
     }
     const supported = required.concat(optional);
-    if (ObjectKeys(config).some(key => !supported.includes(key))) {
+    if (ObjectKeys$1(config).some(key => !supported.includes(key))) {
         throw new TypeError(`adapter ${displayName} configuration supports only ${supported.sort().join(', ')}`);
     }
 }
@@ -81,6 +81,7 @@ function buildAdapterValidationConfig(displayName, paramsMeta) {
 }
 const keyPrefix = 'NlpService';
 
+const { keys: ObjectKeys, create: ObjectCreate, assign: ObjectAssign } = Object;
 const { isArray: ArrayIsArray } = Array;
 const { stringify: JSONStringify } = JSON;
 function createLink(ref) {
@@ -89,11 +90,58 @@ function createLink(ref) {
     };
 }
 
+function validate$4(obj, path = 'NullableAdditionalParametersInputMap') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_keys = ObjectKeys(obj);
+        for (let i = 0; i < obj_keys.length; i++) {
+            const key = obj_keys[i];
+            const obj_prop = obj[key];
+            const path_prop = path + '["' + key + '"]';
+            if (obj_prop === undefined) {
+                return new TypeError('Expected "defined" but received "' + typeof obj_prop + '" (at "' + path_prop + '")');
+            }
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+
+function validate$3(obj, path = 'AdditionalParametersInputMap') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        if (obj.additionalParameters !== undefined) {
+            const obj_additionalParameters = obj.additionalParameters;
+            const path_additionalParameters = path + '.additionalParameters';
+            const referencepath_additionalParametersValidationError = validate$4(obj_additionalParameters, path_additionalParameters);
+            if (referencepath_additionalParametersValidationError !== null) {
+                let message = 'Object doesn\'t match NullableAdditionalParametersInputMap (at "' + path_additionalParameters + '")\n';
+                message += referencepath_additionalParametersValidationError.message.split('\n').map((line) => '\t' + line).join('\n');
+                return new TypeError(message);
+            }
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+
 function validate$2(obj, path = 'AINaturalLangProcessResultInputRepresentation') {
     const v_error = (() => {
         if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
             return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
         }
+        if (obj.additionalParameters !== undefined) {
+            const obj_additionalParameters = obj.additionalParameters;
+            const path_additionalParameters = path + '.additionalParameters';
+            const referencepath_additionalParametersValidationError = validate$3(obj_additionalParameters, path_additionalParameters);
+            if (referencepath_additionalParametersValidationError !== null) {
+                let message = 'Object doesn\'t match AdditionalParametersInputMap (at "' + path_additionalParameters + '")\n';
+                message += referencepath_additionalParametersValidationError.message.split('\n').map((line) => '\t' + line).join('\n');
+                return new TypeError(message);
+            }
+        }
         if (obj.query !== undefined) {
             const obj_query = obj.query;
             const path_query = path + '.query';
@@ -569,4 +617,4 @@ withDefaultLuvio((luvio) => {
 });
 
 export { createAINaturalLangProcessResult, getAINaturalLangProcessResultsBySourceId, getAINaturalLangProcessResultsBySourceId_imperative };
-// version: 1.228.1-0cb6f94f1
+// version: 1.229.0-dev10-abb060196

package/src/raml/api.raml

@@ -25,6 +25,20 @@ annotationTypes:
     type: string
     allowedTargets: TypeDeclaration
 types:
+  AdditionalParametersInputMap:
+    description: Represents a map of additional parameters.
+    properties:
+      additionalParameters:
+        description: Additional context input parameters.
+        type: NullableAdditionalParametersInputMap
+        required: false
+    type: object
+  NullableAdditionalParametersInputMap:
+    description: Wrapper for Nullable Map Object.
+    type: object
+    properties:
+      //:
+        type: any
   AINaturalLangProcessResultCollectionRepresentation:
     description: The output representation of the list for AINaturalLangProcessResult
     type: object
@@ -45,6 +59,10 @@ types:
     description: Input representation for AINaturalLangProcessResult
     type: object
     properties:
+      additionalParameters:
+        description: Additional Parameters
+        type: AdditionalParametersInputMap
+        required: false # TODO Hand-rolled W-9314597
       query:
         description: Query
         type: string
@@ -56,6 +74,7 @@ types:
           - OpenAIClauseExtraction
           - OpenAIClauseGeneration
           - OpenAIEntityRecognition
+          - OpenAISurveyGeneration
         required: false # TODO Hand-rolled W-9314597
   AINaturalLangProcessResultRepresentation:
     description: The output representation of the AINaturalLangProcessResult
@@ -102,6 +121,16 @@ types:
         type: array
         items:
           type: string
+  ErrorRepresentation:
+    description: Represents clause results fetched from OpenAI
+    properties:
+      errorCode:
+        description: Represents error code
+        type: integer
+      errorMessage:
+        description: Represents error message
+        type: string
+    type: object
   OpenAIClauseRepresentation:
     description: Represents clause results fetched from OpenAI
     type: object
@@ -114,6 +143,39 @@ types:
       totalResults:
         description: Represents total number of clauses
         type: integer
+  OpenAISurveyGenerationRepresentation:
+    description: Represents survey generationr results from OpenAI
+    properties:
+      questionCount:
+        description: Represents the total count of survey questions
+        type: integer
+      questions:
+        description: Represents a list of survey questions
+        items:
+          type: SurveyStructRepresentation
+        type: array
+    type: object
+  SurveyStructRepresentation:
+    description: Contents within a survey question
+    properties:
+      questionChoices:
+        description: List of question choices
+        items:
+          type: string
+        type: array
+      questionDescription:
+        description: The question description
+        type: string
+      questionLabel:
+        description: The question label
+        type: string
+      questionType:
+        description: Generated question type
+        type: string
+      required:
+        description: Is question required
+        type: boolean
+    type: object
   OpenAIEntityRepresentation:
     description: Represents entity results fetched from OpenAI
     type: object
@@ -162,6 +224,7 @@ types:
             - OpenAIClauseExtraction
             - OpenAIClauseGeneration
             - OpenAIEntityRecognition
+            - OpenAISurveyGeneration
           (oas-collectionFormat): csv
   uriParameters:
     sourceRecordId: