n8n-nodes-base/dist/node-definitions/nodes/n8n-nodes-base/awsComprehend/v1.ts

Base nodes of n8n

/**
 * AWS Comprehend Node - Version 1
 * Sends data to Amazon Comprehend
 */


export interface AwsComprehendV1Params {
  authentication?: 'iam' | 'assumeRole' | Expression<string>;
/**
 * The resource to perform
 * @default text
 */
    resource?: 'text';
  operation?: 'detectDominantLanguage' | 'detectEntities' | 'detectSentiment';
/**
 * The language code for text
 * @displayOptions.show { resource: ["text"], operation: ["detectSentiment", "detectEntities"] }
 * @default en
 */
    languageCode?: 'ar' | 'zh' | 'zh-TW' | 'en' | 'fr' | 'de' | 'hi' | 'it' | 'ja' | 'ko' | 'pt' | 'es' | Expression<string>;
/**
 * The text to send
 * @displayOptions.show { resource: ["text"] }
 */
    text?: string | Expression<string> | PlaceholderValue;
/**
 * Whether to return a simplified version of the response instead of the raw data
 * @displayOptions.show { resource: ["text"], operation: ["detectDominantLanguage"] }
 * @default true
 */
    simple?: boolean | Expression<boolean>;
/**
 * Additional Fields
 * @displayOptions.show { resource: ["text"], operation: ["detectEntities"] }
 * @default {}
 */
    additionalFields?: {
    /** The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model
     */
    endpointArn?: string | Expression<string> | PlaceholderValue;
  };
}

export interface AwsComprehendV1Credentials {
  aws: CredentialReference;
  awsAssumeRole: CredentialReference;
}

interface AwsComprehendV1NodeBase {
  type: 'n8n-nodes-base.awsComprehend';
  version: 1;
  credentials?: AwsComprehendV1Credentials;
}

export type AwsComprehendV1ParamsNode = AwsComprehendV1NodeBase & {
  config: NodeConfig<AwsComprehendV1Params>;
};

export type AwsComprehendV1Node = AwsComprehendV1ParamsNode;