Skip to content

integrations/voice/aws-speech/dist/manifest

Variables

awsSpeechIntegration

const awsSpeechIntegration: DefinedIntegration<{
  capabilities: (
     | {
     audiences: "customer-facing"[];
     capability: string;
     description: string;
     exposesSensitiveData: true;
     label: string;
     providerObjects: {
        kind: string;
        label: string;
     }[];
     requiresCredential: true;
     sideEffect: true;
   }
     | {
     audiences: ("customer-facing" | "internal-support")[];
     capability: string;
     description: string;
     exposesSensitiveData: true;
     label: string;
     providerObjects: {
        kind: string;
        label: string;
     }[];
     requiresCredential: true;
     sideEffect?: never;
  })[];
  category: string;
  channelAudiences: ("customer-facing" | "mixed")[];
  coverage: {
     evidence: (
        | {
        label: string;
        url: "https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html";
      }
        | {
        label: string;
        url: "https://docs.aws.amazon.com/transcribe/latest/dg/streaming-setting-up.html";
      }
        | {
        label: string;
        url: "https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe-streaming";
      }
        | {
        label: string;
        url: "https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html";
      }
        | {
        label: string;
        url: "https://docs.aws.amazon.com/polly/latest/dg/API_Reference.html";
      }
        | {
        label: string;
        url: "https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/polly";
     })[];
     notes: string[];
     scope: "provider-api-subset";
  };
  credentialRequirements: (
     | {
     description: string;
     id: string;
     label: string;
     metadata: {
        privilegeGuidance: string;
        scopeKind: string;
     };
     required: true;
     scopes: string[];
   }
     | {
     description: string;
     id: string;
     label: string;
     metadata?: never;
     required: true;
     scopes?: never;
   }
     | {
     description: string;
     id: string;
     label: string;
     metadata?: never;
     required: false;
     scopes?: never;
  })[];
  directions: ("receive-only" | "send-only" | "bidirectional")[];
  id: string;
  limitations: string[];
  maintainers: {
     name: string;
     type: "official";
  }[];
  metadata: {
     channelCoverage: {
        backgroundModelProvider: string;
        browserVoiceProtocol: string;
        fullAmazonPollyApi: string;
        fullAwsTranscribeApi: string;
        speechToText: string;
        telephony: string;
        textToSpeech: string;
     };
     implementation: {
        adapterCoverage: string[];
        rawClientEscapeHatch: boolean;
        sdkPackages: string[];
        strategy: string;
     };
     integrationEntryPoints: {
        manifest: string;
        runtime: string;
     };
     integrationName: string;
     integrationPackageName: string;
  };
  name: string;
  operations: (
     | {
     alias: string;
     capability: string;
     exposesSensitiveData: true;
     externallyVisible?: never;
     providerObject: string;
     providerOperation: string;
     requiresCredential: true;
     sideEffect?: never;
   }
     | {
     alias: string;
     capability: string;
     exposesSensitiveData?: never;
     externallyVisible: true;
     providerObject: string;
     providerOperation: string;
     requiresCredential: true;
     sideEffect: true;
  })[];
  packageName: string;
  privacyNotes: string[];
  provider: string;
  trustLevel: "official";
}, unknown, never>;

awsSpeechManifestInput

const awsSpeechManifestInput: {
  capabilities: (
     | {
     audiences: "customer-facing"[];
     capability: string;
     description: string;
     exposesSensitiveData: true;
     label: string;
     providerObjects: {
        kind: string;
        label: string;
     }[];
     requiresCredential: true;
     sideEffect: true;
   }
     | {
     audiences: ("customer-facing" | "internal-support")[];
     capability: string;
     description: string;
     exposesSensitiveData: true;
     label: string;
     providerObjects: {
        kind: string;
        label: string;
     }[];
     requiresCredential: true;
     sideEffect?: never;
  })[];
  category: string;
  channelAudiences: ("customer-facing" | "mixed")[];
  coverage: {
     evidence: (
        | {
        label: string;
        url: "https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html";
      }
        | {
        label: string;
        url: "https://docs.aws.amazon.com/transcribe/latest/dg/streaming-setting-up.html";
      }
        | {
        label: string;
        url: "https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe-streaming";
      }
        | {
        label: string;
        url: "https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html";
      }
        | {
        label: string;
        url: "https://docs.aws.amazon.com/polly/latest/dg/API_Reference.html";
      }
        | {
        label: string;
        url: "https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/polly";
     })[];
     notes: string[];
     scope: "provider-api-subset";
  };
  credentialRequirements: (
     | {
     description: string;
     id: string;
     label: string;
     metadata: {
        privilegeGuidance: string;
        scopeKind: string;
     };
     required: true;
     scopes: string[];
   }
     | {
     description: string;
     id: string;
     label: string;
     metadata?: never;
     required: true;
     scopes?: never;
   }
     | {
     description: string;
     id: string;
     label: string;
     metadata?: never;
     required: false;
     scopes?: never;
  })[];
  directions: ("receive-only" | "send-only" | "bidirectional")[];
  id: string;
  limitations: string[];
  maintainers: {
     name: string;
     type: "official";
  }[];
  metadata: {
     channelCoverage: {
        backgroundModelProvider: string;
        browserVoiceProtocol: string;
        fullAmazonPollyApi: string;
        fullAwsTranscribeApi: string;
        speechToText: string;
        telephony: string;
        textToSpeech: string;
     };
     implementation: {
        adapterCoverage: string[];
        rawClientEscapeHatch: boolean;
        sdkPackages: string[];
        strategy: string;
     };
     integrationEntryPoints: {
        manifest: string;
        runtime: string;
     };
     integrationName: string;
     integrationPackageName: string;
  };
  name: string;
  operations: (
     | {
     alias: string;
     capability: string;
     exposesSensitiveData: true;
     externallyVisible?: never;
     providerObject: string;
     providerOperation: string;
     requiresCredential: true;
     sideEffect?: never;
   }
     | {
     alias: string;
     capability: string;
     exposesSensitiveData?: never;
     externallyVisible: true;
     providerObject: string;
     providerOperation: string;
     requiresCredential: true;
     sideEffect: true;
  })[];
  packageName: string;
  privacyNotes: string[];
  provider: string;
  trustLevel: "official";
};

Type Declaration

Name Type
capabilities ( | { audiences: "customer-facing"[]; capability: string; description: string; exposesSensitiveData: true; label: string; providerObjects: { kind: string; label: string; }[]; requiresCredential: true; sideEffect: true; } | { audiences: ("customer-facing" | "internal-support")[]; capability: string; description: string; exposesSensitiveData: true; label: string; providerObjects: { kind: string; label: string; }[]; requiresCredential: true; sideEffect?: never; })[]
category string
channelAudiences ("customer-facing" | "mixed")[]
coverage { evidence: ( | { label: string; url: "https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html"; } | { label: string; url: "https://docs.aws.amazon.com/transcribe/latest/dg/streaming-setting-up.html"; } | { label: string; url: "https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe-streaming"; } | { label: string; url: "https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html"; } | { label: string; url: "https://docs.aws.amazon.com/polly/latest/dg/API_Reference.html"; } | { label: string; url: "https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/polly"; })[]; notes: string[]; scope: "provider-api-subset"; }
coverage.evidence ( | { label: string; url: "https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html"; } | { label: string; url: "https://docs.aws.amazon.com/transcribe/latest/dg/streaming-setting-up.html"; } | { label: string; url: "https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe-streaming"; } | { label: string; url: "https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html"; } | { label: string; url: "https://docs.aws.amazon.com/polly/latest/dg/API_Reference.html"; } | { label: string; url: "https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/polly"; })[]
coverage.notes string[]
coverage.scope "provider-api-subset"
credentialRequirements ( | { description: string; id: string; label: string; metadata: { privilegeGuidance: string; scopeKind: string; }; required: true; scopes: string[]; } | { description: string; id: string; label: string; metadata?: never; required: true; scopes?: never; } | { description: string; id: string; label: string; metadata?: never; required: false; scopes?: never; })[]
directions ("receive-only" | "send-only" | "bidirectional")[]
id string
limitations string[]
maintainers { name: string; type: "official"; }[]
metadata { channelCoverage: { backgroundModelProvider: string; browserVoiceProtocol: string; fullAmazonPollyApi: string; fullAwsTranscribeApi: string; speechToText: string; telephony: string; textToSpeech: string; }; implementation: { adapterCoverage: string[]; rawClientEscapeHatch: boolean; sdkPackages: string[]; strategy: string; }; integrationEntryPoints: { manifest: string; runtime: string; }; integrationName: string; integrationPackageName: string; }
metadata.channelCoverage { backgroundModelProvider: string; browserVoiceProtocol: string; fullAmazonPollyApi: string; fullAwsTranscribeApi: string; speechToText: string; telephony: string; textToSpeech: string; }
metadata.channelCoverage.backgroundModelProvider string
metadata.channelCoverage.browserVoiceProtocol string
metadata.channelCoverage.fullAmazonPollyApi string
metadata.channelCoverage.fullAwsTranscribeApi string
metadata.channelCoverage.speechToText string
metadata.channelCoverage.telephony string
metadata.channelCoverage.textToSpeech string
metadata.implementation { adapterCoverage: string[]; rawClientEscapeHatch: boolean; sdkPackages: string[]; strategy: string; }
metadata.implementation.adapterCoverage string[]
metadata.implementation.rawClientEscapeHatch boolean
metadata.implementation.sdkPackages string[]
metadata.implementation.strategy string
metadata.integrationEntryPoints { manifest: string; runtime: string; }
metadata.integrationEntryPoints.manifest string
metadata.integrationEntryPoints.runtime string
metadata.integrationName string
metadata.integrationPackageName string
name string
operations ( | { alias: string; capability: string; exposesSensitiveData: true; externallyVisible?: never; providerObject: string; providerOperation: string; requiresCredential: true; sideEffect?: never; } | { alias: string; capability: string; exposesSensitiveData?: never; externallyVisible: true; providerObject: string; providerOperation: string; requiresCredential: true; sideEffect: true; })[]
packageName string
privacyNotes string[]
provider string
trustLevel "official"

awsSpeechProviderManifest

const awsSpeechProviderManifest: {
  capabilities: {
     audiences?: ("customer-facing" | "internal-support" | "mixed")[];
     capability: string;
     changesWorkflow?: boolean;
     description?: string;
     exposesSensitiveData?: boolean;
     extension?: boolean;
     label?: string;
     metadata?: Record<string, unknown>;
     providerObjects?: {
        description?: string;
        kind: string;
        label?: string;
        metadata?: Record<string, unknown>;
        schemaName?: string;
     }[];
     requiresCredential?: boolean;
     sideEffect?: boolean;
  }[];
  category: string;
  channelAudiences: ("customer-facing" | "internal-support" | "mixed")[];
  coverage: {
     evidence: {
        label: string;
        url?: string;
     }[];
     notes: string[];
     scope:   | "support-workflow-subset"
        | "provider-api-subset"
        | "connector-required"
        | "local-protocol"
        | "full-provider-api";
  };
  credentialRequirements: {
     description?: string;
     id: string;
     label?: string;
     metadata?: Record<string, unknown>;
     required: boolean;
     scopes: string[];
  }[];
  directions: (
     | "receive-only"
     | "send-only"
     | "inbound-only"
     | "outbound-only"
    | "bidirectional")[];
  id: string;
  limitations: string[];
  maintainers: {
     name: string;
     type: "community" | "official" | "unknown" | "partner";
     url?: string;
  }[];
  metadata?: Record<string, unknown>;
  name: string;
  operations: {
     alias: string;
     audience?: "customer-facing" | "internal-support" | "mixed";
     audiences?: ("customer-facing" | "internal-support" | "mixed")[];
     capability: string;
     changesWorkflow?: boolean;
     description?: string;
     exposesSensitiveData?: boolean;
     extension: boolean;
     externallyVisible?: boolean;
     inputSchema?: unknown;
     inputSchemaName?: string;
     inputSchemaRef?: string;
     label?: string;
     metadata?: Record<string, unknown>;
     outputSchema?: unknown;
     outputSchemaName?: string;
     outputSchemaRef?: string;
     providerObject?: string;
     providerObjects?: {
        description?: string;
        kind: string;
        label?: string;
        metadata?: Record<string, unknown>;
        schemaName?: string;
     }[];
     providerOperation?: string;
     requiredPolicyIds?: string[];
     requiresApproval?: boolean;
     requiresCredential?: boolean;
     sideEffect?: boolean;
  }[];
  packageName: string;
  privacyNotes: string[];
  provider: string;
  trustLevel: "community" | "official" | "verified" | "experimental";
} & {
  capabilities: (
     | {
     audiences: "customer-facing"[];
     capability: string;
     description: string;
     exposesSensitiveData: true;
     label: string;
     providerObjects: {
        kind: string;
        label: string;
     }[];
     requiresCredential: true;
     sideEffect: true;
   }
     | {
     audiences: ("customer-facing" | "internal-support")[];
     capability: string;
     description: string;
     exposesSensitiveData: true;
     label: string;
     providerObjects: {
        kind: string;
        label: string;
     }[];
     requiresCredential: true;
     sideEffect?: never;
  })[];
  category: string;
  channelAudiences: ("customer-facing" | "mixed")[];
  coverage: {
     evidence: (
        | {
        label: string;
        url: "https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html";
      }
        | {
        label: string;
        url: "https://docs.aws.amazon.com/transcribe/latest/dg/streaming-setting-up.html";
      }
        | {
        label: string;
        url: "https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe-streaming";
      }
        | {
        label: string;
        url: "https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html";
      }
        | {
        label: string;
        url: "https://docs.aws.amazon.com/polly/latest/dg/API_Reference.html";
      }
        | {
        label: string;
        url: "https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/polly";
     })[];
     notes: string[];
     scope: "provider-api-subset";
  };
  credentialRequirements: (
     | {
     description: string;
     id: string;
     label: string;
     metadata: {
        privilegeGuidance: string;
        scopeKind: string;
     };
     required: true;
     scopes: string[];
   }
     | {
     description: string;
     id: string;
     label: string;
     metadata?: never;
     required: true;
     scopes?: never;
   }
     | {
     description: string;
     id: string;
     label: string;
     metadata?: never;
     required: false;
     scopes?: never;
  })[];
  directions: ("receive-only" | "send-only" | "bidirectional")[];
  id: string;
  limitations: string[];
  maintainers: {
     name: string;
     type: "official";
  }[];
  metadata: {
     channelCoverage: {
        backgroundModelProvider: string;
        browserVoiceProtocol: string;
        fullAmazonPollyApi: string;
        fullAwsTranscribeApi: string;
        speechToText: string;
        telephony: string;
        textToSpeech: string;
     };
     implementation: {
        adapterCoverage: string[];
        rawClientEscapeHatch: boolean;
        sdkPackages: string[];
        strategy: string;
     };
     integrationEntryPoints: {
        manifest: string;
        runtime: string;
     };
     integrationName: string;
     integrationPackageName: string;
  };
  name: string;
  operations: (
     | {
     alias: string;
     capability: string;
     exposesSensitiveData: true;
     externallyVisible?: never;
     providerObject: string;
     providerOperation: string;
     requiresCredential: true;
     sideEffect?: never;
   }
     | {
     alias: string;
     capability: string;
     exposesSensitiveData?: never;
     externallyVisible: true;
     providerObject: string;
     providerOperation: string;
     requiresCredential: true;
     sideEffect: true;
  })[];
  packageName: string;
  privacyNotes: string[];
  provider: string;
  trustLevel: "official";
};

Type Declaration

Name Type
capabilities { audiences?: ("customer-facing" | "internal-support" | "mixed")[]; capability: string; changesWorkflow?: boolean; description?: string; exposesSensitiveData?: boolean; extension?: boolean; label?: string; metadata?: Record\<string, unknown>; providerObjects?: { description?: string; kind: string; label?: string; metadata?: Record\<string, unknown>; schemaName?: string; }[]; requiresCredential?: boolean; sideEffect?: boolean; }[]
category string
channelAudiences ("customer-facing" | "internal-support" | "mixed")[]
coverage { evidence: { label: string; url?: string; }[]; notes: string[]; scope: | "support-workflow-subset" | "provider-api-subset" | "connector-required" | "local-protocol" | "full-provider-api"; }
coverage.evidence { label: string; url?: string; }[]
coverage.notes string[]
coverage.scope | "support-workflow-subset" | "provider-api-subset" | "connector-required" | "local-protocol" | "full-provider-api"
credentialRequirements { description?: string; id: string; label?: string; metadata?: Record\<string, unknown>; required: boolean; scopes: string[]; }[]
directions ( | "receive-only" | "send-only" | "inbound-only" | "outbound-only" | "bidirectional")[]
id string
limitations string[]
maintainers { name: string; type: "community" | "official" | "unknown" | "partner"; url?: string; }[]
metadata? Record\<string, unknown>
name string
operations { alias: string; audience?: "customer-facing" | "internal-support" | "mixed"; audiences?: ("customer-facing" | "internal-support" | "mixed")[]; capability: string; changesWorkflow?: boolean; description?: string; exposesSensitiveData?: boolean; extension: boolean; externallyVisible?: boolean; inputSchema?: unknown; inputSchemaName?: string; inputSchemaRef?: string; label?: string; metadata?: Record\<string, unknown>; outputSchema?: unknown; outputSchemaName?: string; outputSchemaRef?: string; providerObject?: string; providerObjects?: { description?: string; kind: string; label?: string; metadata?: Record\<string, unknown>; schemaName?: string; }[]; providerOperation?: string; requiredPolicyIds?: string[]; requiresApproval?: boolean; requiresCredential?: boolean; sideEffect?: boolean; }[]
packageName string
privacyNotes string[]
provider string
trustLevel "community" | "official" | "verified" | "experimental"

Type Declaration

Name Type
capabilities ( | { audiences: "customer-facing"[]; capability: string; description: string; exposesSensitiveData: true; label: string; providerObjects: { kind: string; label: string; }[]; requiresCredential: true; sideEffect: true; } | { audiences: ("customer-facing" | "internal-support")[]; capability: string; description: string; exposesSensitiveData: true; label: string; providerObjects: { kind: string; label: string; }[]; requiresCredential: true; sideEffect?: never; })[]
category string
channelAudiences ("customer-facing" | "mixed")[]
coverage { evidence: ( | { label: string; url: "https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html"; } | { label: string; url: "https://docs.aws.amazon.com/transcribe/latest/dg/streaming-setting-up.html"; } | { label: string; url: "https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe-streaming"; } | { label: string; url: "https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html"; } | { label: string; url: "https://docs.aws.amazon.com/polly/latest/dg/API_Reference.html"; } | { label: string; url: "https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/polly"; })[]; notes: string[]; scope: "provider-api-subset"; }
coverage.evidence ( | { label: string; url: "https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html"; } | { label: string; url: "https://docs.aws.amazon.com/transcribe/latest/dg/streaming-setting-up.html"; } | { label: string; url: "https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe-streaming"; } | { label: string; url: "https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html"; } | { label: string; url: "https://docs.aws.amazon.com/polly/latest/dg/API_Reference.html"; } | { label: string; url: "https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/polly"; })[]
coverage.notes string[]
coverage.scope "provider-api-subset"
credentialRequirements ( | { description: string; id: string; label: string; metadata: { privilegeGuidance: string; scopeKind: string; }; required: true; scopes: string[]; } | { description: string; id: string; label: string; metadata?: never; required: true; scopes?: never; } | { description: string; id: string; label: string; metadata?: never; required: false; scopes?: never; })[]
directions ("receive-only" | "send-only" | "bidirectional")[]
id string
limitations string[]
maintainers { name: string; type: "official"; }[]
metadata { channelCoverage: { backgroundModelProvider: string; browserVoiceProtocol: string; fullAmazonPollyApi: string; fullAwsTranscribeApi: string; speechToText: string; telephony: string; textToSpeech: string; }; implementation: { adapterCoverage: string[]; rawClientEscapeHatch: boolean; sdkPackages: string[]; strategy: string; }; integrationEntryPoints: { manifest: string; runtime: string; }; integrationName: string; integrationPackageName: string; }
metadata.channelCoverage { backgroundModelProvider: string; browserVoiceProtocol: string; fullAmazonPollyApi: string; fullAwsTranscribeApi: string; speechToText: string; telephony: string; textToSpeech: string; }
metadata.channelCoverage.backgroundModelProvider string
metadata.channelCoverage.browserVoiceProtocol string
metadata.channelCoverage.fullAmazonPollyApi string
metadata.channelCoverage.fullAwsTranscribeApi string
metadata.channelCoverage.speechToText string
metadata.channelCoverage.telephony string
metadata.channelCoverage.textToSpeech string
metadata.implementation { adapterCoverage: string[]; rawClientEscapeHatch: boolean; sdkPackages: string[]; strategy: string; }
metadata.implementation.adapterCoverage string[]
metadata.implementation.rawClientEscapeHatch boolean
metadata.implementation.sdkPackages string[]
metadata.implementation.strategy string
metadata.integrationEntryPoints { manifest: string; runtime: string; }
metadata.integrationEntryPoints.manifest string
metadata.integrationEntryPoints.runtime string
metadata.integrationName string
metadata.integrationPackageName string
name string
operations ( | { alias: string; capability: string; exposesSensitiveData: true; externallyVisible?: never; providerObject: string; providerOperation: string; requiresCredential: true; sideEffect?: never; } | { alias: string; capability: string; exposesSensitiveData?: never; externallyVisible: true; providerObject: string; providerOperation: string; requiresCredential: true; sideEffect: true; })[]
packageName string
privacyNotes string[]
provider string
trustLevel "official"