commonMain.aws.sdk.kotlin.services.comprehendmedical.ComprehendMedicalClient.kt Maven / Gradle / Ivy
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.comprehendmedical
import aws.sdk.kotlin.runtime.auth.credentials.DefaultChainCredentialsProvider
import aws.sdk.kotlin.runtime.auth.credentials.internal.manage
import aws.sdk.kotlin.runtime.client.AwsSdkClientConfig
import aws.sdk.kotlin.runtime.config.AbstractAwsSdkClientFactory
import aws.sdk.kotlin.runtime.config.endpoints.resolveEndpointUrl
import aws.sdk.kotlin.runtime.config.profile.AwsProfile
import aws.sdk.kotlin.runtime.config.profile.AwsSharedConfig
import aws.sdk.kotlin.runtime.http.retries.AwsRetryPolicy
import aws.sdk.kotlin.services.comprehendmedical.auth.ComprehendMedicalAuthSchemeProvider
import aws.sdk.kotlin.services.comprehendmedical.auth.DefaultComprehendMedicalAuthSchemeProvider
import aws.sdk.kotlin.services.comprehendmedical.endpoints.ComprehendMedicalEndpointParameters
import aws.sdk.kotlin.services.comprehendmedical.endpoints.ComprehendMedicalEndpointProvider
import aws.sdk.kotlin.services.comprehendmedical.endpoints.DefaultComprehendMedicalEndpointProvider
import aws.sdk.kotlin.services.comprehendmedical.model.DescribeEntitiesDetectionV2JobRequest
import aws.sdk.kotlin.services.comprehendmedical.model.DescribeEntitiesDetectionV2JobResponse
import aws.sdk.kotlin.services.comprehendmedical.model.DescribeIcd10CmInferenceJobRequest
import aws.sdk.kotlin.services.comprehendmedical.model.DescribeIcd10CmInferenceJobResponse
import aws.sdk.kotlin.services.comprehendmedical.model.DescribePhiDetectionJobRequest
import aws.sdk.kotlin.services.comprehendmedical.model.DescribePhiDetectionJobResponse
import aws.sdk.kotlin.services.comprehendmedical.model.DescribeRxNormInferenceJobRequest
import aws.sdk.kotlin.services.comprehendmedical.model.DescribeRxNormInferenceJobResponse
import aws.sdk.kotlin.services.comprehendmedical.model.DescribeSnomedctInferenceJobRequest
import aws.sdk.kotlin.services.comprehendmedical.model.DescribeSnomedctInferenceJobResponse
import aws.sdk.kotlin.services.comprehendmedical.model.DetectEntitiesRequest
import aws.sdk.kotlin.services.comprehendmedical.model.DetectEntitiesResponse
import aws.sdk.kotlin.services.comprehendmedical.model.DetectEntitiesV2Request
import aws.sdk.kotlin.services.comprehendmedical.model.DetectEntitiesV2Response
import aws.sdk.kotlin.services.comprehendmedical.model.DetectPhiRequest
import aws.sdk.kotlin.services.comprehendmedical.model.DetectPhiResponse
import aws.sdk.kotlin.services.comprehendmedical.model.InferIcd10CmRequest
import aws.sdk.kotlin.services.comprehendmedical.model.InferIcd10CmResponse
import aws.sdk.kotlin.services.comprehendmedical.model.InferRxNormRequest
import aws.sdk.kotlin.services.comprehendmedical.model.InferRxNormResponse
import aws.sdk.kotlin.services.comprehendmedical.model.InferSnomedctRequest
import aws.sdk.kotlin.services.comprehendmedical.model.InferSnomedctResponse
import aws.sdk.kotlin.services.comprehendmedical.model.ListEntitiesDetectionV2JobsRequest
import aws.sdk.kotlin.services.comprehendmedical.model.ListEntitiesDetectionV2JobsResponse
import aws.sdk.kotlin.services.comprehendmedical.model.ListIcd10CmInferenceJobsRequest
import aws.sdk.kotlin.services.comprehendmedical.model.ListIcd10CmInferenceJobsResponse
import aws.sdk.kotlin.services.comprehendmedical.model.ListPhiDetectionJobsRequest
import aws.sdk.kotlin.services.comprehendmedical.model.ListPhiDetectionJobsResponse
import aws.sdk.kotlin.services.comprehendmedical.model.ListRxNormInferenceJobsRequest
import aws.sdk.kotlin.services.comprehendmedical.model.ListRxNormInferenceJobsResponse
import aws.sdk.kotlin.services.comprehendmedical.model.ListSnomedctInferenceJobsRequest
import aws.sdk.kotlin.services.comprehendmedical.model.ListSnomedctInferenceJobsResponse
import aws.sdk.kotlin.services.comprehendmedical.model.StartEntitiesDetectionV2JobRequest
import aws.sdk.kotlin.services.comprehendmedical.model.StartEntitiesDetectionV2JobResponse
import aws.sdk.kotlin.services.comprehendmedical.model.StartIcd10CmInferenceJobRequest
import aws.sdk.kotlin.services.comprehendmedical.model.StartIcd10CmInferenceJobResponse
import aws.sdk.kotlin.services.comprehendmedical.model.StartPhiDetectionJobRequest
import aws.sdk.kotlin.services.comprehendmedical.model.StartPhiDetectionJobResponse
import aws.sdk.kotlin.services.comprehendmedical.model.StartRxNormInferenceJobRequest
import aws.sdk.kotlin.services.comprehendmedical.model.StartRxNormInferenceJobResponse
import aws.sdk.kotlin.services.comprehendmedical.model.StartSnomedctInferenceJobRequest
import aws.sdk.kotlin.services.comprehendmedical.model.StartSnomedctInferenceJobResponse
import aws.sdk.kotlin.services.comprehendmedical.model.StopEntitiesDetectionV2JobRequest
import aws.sdk.kotlin.services.comprehendmedical.model.StopEntitiesDetectionV2JobResponse
import aws.sdk.kotlin.services.comprehendmedical.model.StopIcd10CmInferenceJobRequest
import aws.sdk.kotlin.services.comprehendmedical.model.StopIcd10CmInferenceJobResponse
import aws.sdk.kotlin.services.comprehendmedical.model.StopPhiDetectionJobRequest
import aws.sdk.kotlin.services.comprehendmedical.model.StopPhiDetectionJobResponse
import aws.sdk.kotlin.services.comprehendmedical.model.StopRxNormInferenceJobRequest
import aws.sdk.kotlin.services.comprehendmedical.model.StopRxNormInferenceJobResponse
import aws.sdk.kotlin.services.comprehendmedical.model.StopSnomedctInferenceJobRequest
import aws.sdk.kotlin.services.comprehendmedical.model.StopSnomedctInferenceJobResponse
import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProvider
import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProviderConfig
import aws.smithy.kotlin.runtime.awsprotocol.ClockSkewInterceptor
import aws.smithy.kotlin.runtime.client.AbstractSdkClientBuilder
import aws.smithy.kotlin.runtime.client.IdempotencyTokenConfig
import aws.smithy.kotlin.runtime.client.IdempotencyTokenProvider
import aws.smithy.kotlin.runtime.client.LogMode
import aws.smithy.kotlin.runtime.client.RetryClientConfig
import aws.smithy.kotlin.runtime.client.RetryStrategyClientConfig
import aws.smithy.kotlin.runtime.client.RetryStrategyClientConfigImpl
import aws.smithy.kotlin.runtime.client.SdkClient
import aws.smithy.kotlin.runtime.client.SdkClientConfig
import aws.smithy.kotlin.runtime.client.SdkClientFactory
import aws.smithy.kotlin.runtime.http.auth.AuthScheme
import aws.smithy.kotlin.runtime.http.auth.HttpAuthConfig
import aws.smithy.kotlin.runtime.http.config.HttpClientConfig
import aws.smithy.kotlin.runtime.http.config.HttpEngineConfig
import aws.smithy.kotlin.runtime.http.engine.HttpClientEngine
import aws.smithy.kotlin.runtime.http.engine.HttpEngineConfigImpl
import aws.smithy.kotlin.runtime.http.interceptors.HttpInterceptor
import aws.smithy.kotlin.runtime.net.url.Url
import aws.smithy.kotlin.runtime.retries.RetryStrategy
import aws.smithy.kotlin.runtime.retries.policy.RetryPolicy
import aws.smithy.kotlin.runtime.telemetry.Global
import aws.smithy.kotlin.runtime.telemetry.TelemetryConfig
import aws.smithy.kotlin.runtime.telemetry.TelemetryProvider
import aws.smithy.kotlin.runtime.util.LazyAsyncValue
import kotlin.collections.List
import kotlin.jvm.JvmStatic
public const val ServiceId: String = "ComprehendMedical"
public const val SdkVersion: String = "1.0.52"
public const val ServiceApiVersion: String = "2018-10-30"
/**
* Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents. Amazon Comprehend Medical only detects entities in English language texts. Amazon Comprehend Medical places limits on the sizes of files allowed for different API operations. To learn more, see [Guidelines and quotas](https://docs.aws.amazon.com/comprehend-medical/latest/dev/comprehendmedical-quotas.html) in the *Amazon Comprehend Medical Developer Guide*.
*/
public interface ComprehendMedicalClient : SdkClient {
/**
* ComprehendMedicalClient's configuration
*/
public override val config: Config
public companion object : AbstractAwsSdkClientFactory() {
@JvmStatic
override fun builder(): Builder = Builder()
override suspend fun finalizeConfig(builder: Builder, sharedConfig: LazyAsyncValue, activeProfile: LazyAsyncValue) {
builder.config.endpointUrl = builder.config.endpointUrl ?: resolveEndpointUrl(
sharedConfig,
"ComprehendMedical",
"COMPREHENDMEDICAL",
"comprehendmedical",
)
builder.config.interceptors.add(0, ClockSkewInterceptor())
}
}
public class Builder internal constructor(): AbstractSdkClientBuilder() {
override val config: Config.Builder = Config.Builder()
override fun newClient(config: Config): ComprehendMedicalClient = DefaultComprehendMedicalClient(config)
}
public class Config private constructor(builder: Builder) : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig by builder.buildHttpEngineConfig(), IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig by builder.buildRetryStrategyClientConfig(), SdkClientConfig, TelemetryConfig {
override val clientName: String = builder.clientName
override val region: String? = builder.region
override val authSchemes: kotlin.collections.List = builder.authSchemes
override val credentialsProvider: CredentialsProvider = builder.credentialsProvider ?: DefaultChainCredentialsProvider(httpClient = httpClient, region = region).manage()
public val endpointProvider: ComprehendMedicalEndpointProvider = builder.endpointProvider ?: DefaultComprehendMedicalEndpointProvider()
public val endpointUrl: Url? = builder.endpointUrl
override val idempotencyTokenProvider: IdempotencyTokenProvider = builder.idempotencyTokenProvider ?: IdempotencyTokenProvider.Default
override val interceptors: kotlin.collections.List = builder.interceptors
override val logMode: LogMode = builder.logMode ?: LogMode.Default
override val retryPolicy: RetryPolicy = builder.retryPolicy ?: AwsRetryPolicy.Default
override val telemetryProvider: TelemetryProvider = builder.telemetryProvider ?: TelemetryProvider.Global
override val useDualStack: Boolean = builder.useDualStack ?: false
override val useFips: Boolean = builder.useFips ?: false
override val applicationId: String? = builder.applicationId
public val authSchemeProvider: ComprehendMedicalAuthSchemeProvider = builder.authSchemeProvider ?: DefaultComprehendMedicalAuthSchemeProvider()
public companion object {
public inline operator fun invoke(block: Builder.() -> kotlin.Unit): Config = Builder().apply(block).build()
}
public fun toBuilder(): Builder = Builder().apply {
clientName = [email protected]
region = [email protected]
authSchemes = [email protected]
credentialsProvider = [email protected]
endpointProvider = [email protected]
endpointUrl = [email protected]
httpClient = [email protected]
idempotencyTokenProvider = [email protected]
interceptors = [email protected]()
logMode = [email protected]
retryPolicy = [email protected]
retryStrategy = [email protected]
telemetryProvider = [email protected]
useDualStack = [email protected]
useFips = [email protected]
applicationId = [email protected]
authSchemeProvider = [email protected]
}
public class Builder : AwsSdkClientConfig.Builder, CredentialsProviderConfig.Builder, HttpAuthConfig.Builder, HttpClientConfig.Builder, HttpEngineConfig.Builder by HttpEngineConfigImpl.BuilderImpl(), IdempotencyTokenConfig.Builder, RetryClientConfig.Builder, RetryStrategyClientConfig.Builder by RetryStrategyClientConfigImpl.BuilderImpl(), SdkClientConfig.Builder, TelemetryConfig.Builder {
/**
* A reader-friendly name for the client.
*/
override var clientName: String = "ComprehendMedical"
/**
* The AWS region (e.g. `us-west-2`) to make requests to. See about AWS
* [global infrastructure](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/) for more
* information
*/
override var region: String? = null
/**
* Register new or override default [AuthScheme]s configured for this client. By default, the set
* of auth schemes configured comes from the service model. An auth scheme configured explicitly takes
* precedence over the defaults and can be used to customize identity resolution and signing for specific
* authentication schemes.
*/
override var authSchemes: kotlin.collections.List = emptyList()
/**
* The AWS credentials provider to use for authenticating requests. If not provided a
* [aws.sdk.kotlin.runtime.auth.credentials.DefaultChainCredentialsProvider] instance will be used.
* NOTE: The caller is responsible for managing the lifetime of the provider when set. The SDK
* client will not close it when the client is closed.
*/
override var credentialsProvider: CredentialsProvider? = null
/**
* The endpoint provider used to determine where to make service requests. **This is an advanced config
* option.**
*
* Endpoint resolution occurs as part of the workflow for every request made via the service client.
*
* The inputs to endpoint resolution are defined on a per-service basis (see [EndpointParameters]).
*/
public var endpointProvider: ComprehendMedicalEndpointProvider? = null
/**
* A custom endpoint to route requests to. The endpoint set here is passed to the configured
* [endpointProvider], which may inspect and modify it as needed.
*
* Setting a custom endpointUrl should generally be preferred to overriding the [endpointProvider] and is
* the recommended way to route requests to development or preview instances of a service.
*
* **This is an advanced config option.**
*/
public var endpointUrl: Url? = null
/**
* Override the default idempotency token generator. SDK clients will generate tokens for members
* that represent idempotent tokens when not explicitly set by the caller using this generator.
*/
override var idempotencyTokenProvider: IdempotencyTokenProvider? = null
/**
* Add an [aws.smithy.kotlin.runtime.client.Interceptor] that will have access to read and modify
* the request and response objects as they are processed by the SDK.
* Interceptors added using this method are executed in the order they are configured and are always
* later than any added automatically by the SDK.
*/
override var interceptors: kotlin.collections.MutableList = kotlin.collections.mutableListOf()
/**
* Configure events that will be logged. By default clients will not output
* raw requests or responses. Use this setting to opt-in to additional debug logging.
*
* This can be used to configure logging of requests, responses, retries, etc of SDK clients.
*
* **NOTE**: Logging of raw requests or responses may leak sensitive information! It may also have
* performance considerations when dumping the request/response body. This is primarily a tool for
* debug purposes.
*/
override var logMode: LogMode? = null
/**
* The policy to use for evaluating operation results and determining whether/how to retry.
*/
override var retryPolicy: RetryPolicy? = null
/**
* The telemetry provider used to instrument the SDK operations with. By default, the global telemetry
* provider will be used.
*/
override var telemetryProvider: TelemetryProvider? = null
/**
* Flag to toggle whether to use dual-stack endpoints when making requests.
* See [https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html] for more information.
* ` Disabled by default.
*/
override var useDualStack: Boolean? = null
/**
* Flag to toggle whether to use [FIPS](https://aws.amazon.com/compliance/fips/) endpoints when making requests.
* ` Disabled by default.
*/
override var useFips: Boolean? = null
/**
* An optional application specific identifier.
* When set it will be appended to the User-Agent header of every request in the form of: `app/{applicationId}`.
* When not explicitly set, the value will be loaded from the following locations:
*
* - JVM System Property: `aws.userAgentAppId`
* - Environment variable: `AWS_SDK_UA_APP_ID`
* - Shared configuration profile attribute: `sdk_ua_app_id`
*
* See [shared configuration settings](https://docs.aws.amazon.com/sdkref/latest/guide/settings-reference.html)
* reference for more information on environment variables and shared config settings.
*/
override var applicationId: String? = null
/**
* Configure the provider used to resolve the authentication scheme to use for a particular operation.
*/
public var authSchemeProvider: ComprehendMedicalAuthSchemeProvider? = null
override fun build(): Config = Config(this)
}
}
/**
* Gets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job.
*/
public suspend fun describeEntitiesDetectionV2Job(input: DescribeEntitiesDetectionV2JobRequest): DescribeEntitiesDetectionV2JobResponse
/**
* Gets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference job.
*/
public suspend fun describeIcd10CmInferenceJob(input: DescribeIcd10CmInferenceJobRequest): DescribeIcd10CmInferenceJobResponse
/**
* Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.
*/
public suspend fun describePhiDetectionJob(input: DescribePhiDetectionJobRequest): DescribePhiDetectionJobResponse
/**
* Gets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job.
*/
public suspend fun describeRxNormInferenceJob(input: DescribeRxNormInferenceJobRequest): DescribeRxNormInferenceJobResponse
/**
* Gets the properties associated with an InferSNOMEDCT job. Use this operation to get the status of an inference job.
*/
public suspend fun describeSnomedctInferenceJob(input: DescribeSnomedctInferenceJobRequest): DescribeSnomedctInferenceJobResponse
/**
* The `DetectEntities` operation is deprecated. You should use the DetectEntitiesV2 operation instead.
*
* Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information.
*/
@Deprecated("No longer recommended for use. See AWS API documentation for more details.")
public suspend fun detectEntities(input: DetectEntitiesRequest): DetectEntitiesResponse
/**
* Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information. Amazon Comprehend Medical only detects medical entities in English language texts.
*
* The `DetectEntitiesV2` operation replaces the DetectEntities operation. This new action uses a different model for determining the entities in your medical text and changes the way that some entities are returned in the output. You should use the `DetectEntitiesV2` operation in all new applications.
*
* The `DetectEntitiesV2` operation returns the `Acuity` and `Direction` entities as attributes instead of types.
*/
public suspend fun detectEntitiesV2(input: DetectEntitiesV2Request): DetectEntitiesV2Response
/**
* Inspects the clinical text for protected health information (PHI) entities and returns the entity category, location, and confidence score for each entity. Amazon Comprehend Medical only detects entities in English language texts.
*/
public suspend fun detectPhi(input: DetectPhiRequest): DetectPhiResponse
/**
* InferICD10CM detects medical conditions as entities listed in a patient record and links those entities to normalized concept identifiers in the ICD-10-CM knowledge base from the Centers for Disease Control. Amazon Comprehend Medical only detects medical entities in English language texts.
*/
public suspend fun inferIcd10Cm(input: InferIcd10CmRequest): InferIcd10CmResponse
/**
* InferRxNorm detects medications as entities listed in a patient record and links to the normalized concept identifiers in the RxNorm database from the National Library of Medicine. Amazon Comprehend Medical only detects medical entities in English language texts.
*/
public suspend fun inferRxNorm(input: InferRxNormRequest): InferRxNormResponse
/**
* InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontology
*/
public suspend fun inferSnomedct(input: InferSnomedctRequest): InferSnomedctResponse
/**
* Gets a list of medical entity detection jobs that you have submitted.
*/
public suspend fun listEntitiesDetectionV2Jobs(input: ListEntitiesDetectionV2JobsRequest = ListEntitiesDetectionV2JobsRequest { }): ListEntitiesDetectionV2JobsResponse
/**
* Gets a list of InferICD10CM jobs that you have submitted.
*/
public suspend fun listIcd10CmInferenceJobs(input: ListIcd10CmInferenceJobsRequest = ListIcd10CmInferenceJobsRequest { }): ListIcd10CmInferenceJobsResponse
/**
* Gets a list of protected health information (PHI) detection jobs you have submitted.
*/
public suspend fun listPhiDetectionJobs(input: ListPhiDetectionJobsRequest = ListPhiDetectionJobsRequest { }): ListPhiDetectionJobsResponse
/**
* Gets a list of InferRxNorm jobs that you have submitted.
*/
public suspend fun listRxNormInferenceJobs(input: ListRxNormInferenceJobsRequest = ListRxNormInferenceJobsRequest { }): ListRxNormInferenceJobsResponse
/**
* Gets a list of InferSNOMEDCT jobs a user has submitted.
*/
public suspend fun listSnomedctInferenceJobs(input: ListSnomedctInferenceJobsRequest = ListSnomedctInferenceJobsRequest { }): ListSnomedctInferenceJobsResponse
/**
* Starts an asynchronous medical entity detection job for a collection of documents. Use the `DescribeEntitiesDetectionV2Job` operation to track the status of a job.
*/
public suspend fun startEntitiesDetectionV2Job(input: StartEntitiesDetectionV2JobRequest): StartEntitiesDetectionV2JobResponse
/**
* Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology. Use the `DescribeICD10CMInferenceJob` operation to track the status of a job.
*/
public suspend fun startIcd10CmInferenceJob(input: StartIcd10CmInferenceJobRequest): StartIcd10CmInferenceJobResponse
/**
* Starts an asynchronous job to detect protected health information (PHI). Use the `DescribePHIDetectionJob` operation to track the status of a job.
*/
public suspend fun startPhiDetectionJob(input: StartPhiDetectionJobRequest): StartPhiDetectionJobResponse
/**
* Starts an asynchronous job to detect medication entities and link them to the RxNorm ontology. Use the `DescribeRxNormInferenceJob` operation to track the status of a job.
*/
public suspend fun startRxNormInferenceJob(input: StartRxNormInferenceJobRequest): StartRxNormInferenceJobResponse
/**
* Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology. Use the DescribeSNOMEDCTInferenceJob operation to track the status of a job.
*/
public suspend fun startSnomedctInferenceJob(input: StartSnomedctInferenceJobRequest): StartSnomedctInferenceJobResponse
/**
* Stops a medical entities detection job in progress.
*/
public suspend fun stopEntitiesDetectionV2Job(input: StopEntitiesDetectionV2JobRequest): StopEntitiesDetectionV2JobResponse
/**
* Stops an InferICD10CM inference job in progress.
*/
public suspend fun stopIcd10CmInferenceJob(input: StopIcd10CmInferenceJobRequest): StopIcd10CmInferenceJobResponse
/**
* Stops a protected health information (PHI) detection job in progress.
*/
public suspend fun stopPhiDetectionJob(input: StopPhiDetectionJobRequest): StopPhiDetectionJobResponse
/**
* Stops an InferRxNorm inference job in progress.
*/
public suspend fun stopRxNormInferenceJob(input: StopRxNormInferenceJobRequest): StopRxNormInferenceJobResponse
/**
* Stops an InferSNOMEDCT inference job in progress.
*/
public suspend fun stopSnomedctInferenceJob(input: StopSnomedctInferenceJobRequest): StopSnomedctInferenceJobResponse
}
/**
* Create a copy of the client with one or more configuration values overridden.
* This method allows the caller to perform scoped config overrides for one or more client operations.
*
* Any resources created on your behalf will be shared between clients, and will only be closed when ALL clients using them are closed.
* If you provide a resource (e.g. [HttpClientEngine]) to the SDK, you are responsible for managing the lifetime of that resource.
*/
public fun ComprehendMedicalClient.withConfig(block: ComprehendMedicalClient.Config.Builder.() -> Unit): ComprehendMedicalClient {
val newConfig = config.toBuilder().apply(block).build()
return DefaultComprehendMedicalClient(newConfig)
}
/**
* Gets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job.
*/
public suspend inline fun ComprehendMedicalClient.describeEntitiesDetectionV2Job(crossinline block: DescribeEntitiesDetectionV2JobRequest.Builder.() -> Unit): DescribeEntitiesDetectionV2JobResponse = describeEntitiesDetectionV2Job(DescribeEntitiesDetectionV2JobRequest.Builder().apply(block).build())
/**
* Gets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference job.
*/
public suspend inline fun ComprehendMedicalClient.describeIcd10CmInferenceJob(crossinline block: DescribeIcd10CmInferenceJobRequest.Builder.() -> Unit): DescribeIcd10CmInferenceJobResponse = describeIcd10CmInferenceJob(DescribeIcd10CmInferenceJobRequest.Builder().apply(block).build())
/**
* Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.
*/
public suspend inline fun ComprehendMedicalClient.describePhiDetectionJob(crossinline block: DescribePhiDetectionJobRequest.Builder.() -> Unit): DescribePhiDetectionJobResponse = describePhiDetectionJob(DescribePhiDetectionJobRequest.Builder().apply(block).build())
/**
* Gets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job.
*/
public suspend inline fun ComprehendMedicalClient.describeRxNormInferenceJob(crossinline block: DescribeRxNormInferenceJobRequest.Builder.() -> Unit): DescribeRxNormInferenceJobResponse = describeRxNormInferenceJob(DescribeRxNormInferenceJobRequest.Builder().apply(block).build())
/**
* Gets the properties associated with an InferSNOMEDCT job. Use this operation to get the status of an inference job.
*/
public suspend inline fun ComprehendMedicalClient.describeSnomedctInferenceJob(crossinline block: DescribeSnomedctInferenceJobRequest.Builder.() -> Unit): DescribeSnomedctInferenceJobResponse = describeSnomedctInferenceJob(DescribeSnomedctInferenceJobRequest.Builder().apply(block).build())
/**
* The `DetectEntities` operation is deprecated. You should use the DetectEntitiesV2 operation instead.
*
* Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information.
*/
@Deprecated("No longer recommended for use. See AWS API documentation for more details.")
public suspend inline fun ComprehendMedicalClient.detectEntities(crossinline block: DetectEntitiesRequest.Builder.() -> Unit): DetectEntitiesResponse = detectEntities(DetectEntitiesRequest.Builder().apply(block).build())
/**
* Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information. Amazon Comprehend Medical only detects medical entities in English language texts.
*
* The `DetectEntitiesV2` operation replaces the DetectEntities operation. This new action uses a different model for determining the entities in your medical text and changes the way that some entities are returned in the output. You should use the `DetectEntitiesV2` operation in all new applications.
*
* The `DetectEntitiesV2` operation returns the `Acuity` and `Direction` entities as attributes instead of types.
*/
public suspend inline fun ComprehendMedicalClient.detectEntitiesV2(crossinline block: DetectEntitiesV2Request.Builder.() -> Unit): DetectEntitiesV2Response = detectEntitiesV2(DetectEntitiesV2Request.Builder().apply(block).build())
/**
* Inspects the clinical text for protected health information (PHI) entities and returns the entity category, location, and confidence score for each entity. Amazon Comprehend Medical only detects entities in English language texts.
*/
public suspend inline fun ComprehendMedicalClient.detectPhi(crossinline block: DetectPhiRequest.Builder.() -> Unit): DetectPhiResponse = detectPhi(DetectPhiRequest.Builder().apply(block).build())
/**
* InferICD10CM detects medical conditions as entities listed in a patient record and links those entities to normalized concept identifiers in the ICD-10-CM knowledge base from the Centers for Disease Control. Amazon Comprehend Medical only detects medical entities in English language texts.
*/
public suspend inline fun ComprehendMedicalClient.inferIcd10Cm(crossinline block: InferIcd10CmRequest.Builder.() -> Unit): InferIcd10CmResponse = inferIcd10Cm(InferIcd10CmRequest.Builder().apply(block).build())
/**
* InferRxNorm detects medications as entities listed in a patient record and links to the normalized concept identifiers in the RxNorm database from the National Library of Medicine. Amazon Comprehend Medical only detects medical entities in English language texts.
*/
public suspend inline fun ComprehendMedicalClient.inferRxNorm(crossinline block: InferRxNormRequest.Builder.() -> Unit): InferRxNormResponse = inferRxNorm(InferRxNormRequest.Builder().apply(block).build())
/**
* InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontology
*/
public suspend inline fun ComprehendMedicalClient.inferSnomedct(crossinline block: InferSnomedctRequest.Builder.() -> Unit): InferSnomedctResponse = inferSnomedct(InferSnomedctRequest.Builder().apply(block).build())
/**
* Gets a list of medical entity detection jobs that you have submitted.
*/
public suspend inline fun ComprehendMedicalClient.listEntitiesDetectionV2Jobs(crossinline block: ListEntitiesDetectionV2JobsRequest.Builder.() -> Unit): ListEntitiesDetectionV2JobsResponse = listEntitiesDetectionV2Jobs(ListEntitiesDetectionV2JobsRequest.Builder().apply(block).build())
/**
* Gets a list of InferICD10CM jobs that you have submitted.
*/
public suspend inline fun ComprehendMedicalClient.listIcd10CmInferenceJobs(crossinline block: ListIcd10CmInferenceJobsRequest.Builder.() -> Unit): ListIcd10CmInferenceJobsResponse = listIcd10CmInferenceJobs(ListIcd10CmInferenceJobsRequest.Builder().apply(block).build())
/**
* Gets a list of protected health information (PHI) detection jobs you have submitted.
*/
public suspend inline fun ComprehendMedicalClient.listPhiDetectionJobs(crossinline block: ListPhiDetectionJobsRequest.Builder.() -> Unit): ListPhiDetectionJobsResponse = listPhiDetectionJobs(ListPhiDetectionJobsRequest.Builder().apply(block).build())
/**
* Gets a list of InferRxNorm jobs that you have submitted.
*/
public suspend inline fun ComprehendMedicalClient.listRxNormInferenceJobs(crossinline block: ListRxNormInferenceJobsRequest.Builder.() -> Unit): ListRxNormInferenceJobsResponse = listRxNormInferenceJobs(ListRxNormInferenceJobsRequest.Builder().apply(block).build())
/**
* Gets a list of InferSNOMEDCT jobs a user has submitted.
*/
public suspend inline fun ComprehendMedicalClient.listSnomedctInferenceJobs(crossinline block: ListSnomedctInferenceJobsRequest.Builder.() -> Unit): ListSnomedctInferenceJobsResponse = listSnomedctInferenceJobs(ListSnomedctInferenceJobsRequest.Builder().apply(block).build())
/**
* Starts an asynchronous medical entity detection job for a collection of documents. Use the `DescribeEntitiesDetectionV2Job` operation to track the status of a job.
*/
public suspend inline fun ComprehendMedicalClient.startEntitiesDetectionV2Job(crossinline block: StartEntitiesDetectionV2JobRequest.Builder.() -> Unit): StartEntitiesDetectionV2JobResponse = startEntitiesDetectionV2Job(StartEntitiesDetectionV2JobRequest.Builder().apply(block).build())
/**
* Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology. Use the `DescribeICD10CMInferenceJob` operation to track the status of a job.
*/
public suspend inline fun ComprehendMedicalClient.startIcd10CmInferenceJob(crossinline block: StartIcd10CmInferenceJobRequest.Builder.() -> Unit): StartIcd10CmInferenceJobResponse = startIcd10CmInferenceJob(StartIcd10CmInferenceJobRequest.Builder().apply(block).build())
/**
* Starts an asynchronous job to detect protected health information (PHI). Use the `DescribePHIDetectionJob` operation to track the status of a job.
*/
public suspend inline fun ComprehendMedicalClient.startPhiDetectionJob(crossinline block: StartPhiDetectionJobRequest.Builder.() -> Unit): StartPhiDetectionJobResponse = startPhiDetectionJob(StartPhiDetectionJobRequest.Builder().apply(block).build())
/**
* Starts an asynchronous job to detect medication entities and link them to the RxNorm ontology. Use the `DescribeRxNormInferenceJob` operation to track the status of a job.
*/
public suspend inline fun ComprehendMedicalClient.startRxNormInferenceJob(crossinline block: StartRxNormInferenceJobRequest.Builder.() -> Unit): StartRxNormInferenceJobResponse = startRxNormInferenceJob(StartRxNormInferenceJobRequest.Builder().apply(block).build())
/**
* Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology. Use the DescribeSNOMEDCTInferenceJob operation to track the status of a job.
*/
public suspend inline fun ComprehendMedicalClient.startSnomedctInferenceJob(crossinline block: StartSnomedctInferenceJobRequest.Builder.() -> Unit): StartSnomedctInferenceJobResponse = startSnomedctInferenceJob(StartSnomedctInferenceJobRequest.Builder().apply(block).build())
/**
* Stops a medical entities detection job in progress.
*/
public suspend inline fun ComprehendMedicalClient.stopEntitiesDetectionV2Job(crossinline block: StopEntitiesDetectionV2JobRequest.Builder.() -> Unit): StopEntitiesDetectionV2JobResponse = stopEntitiesDetectionV2Job(StopEntitiesDetectionV2JobRequest.Builder().apply(block).build())
/**
* Stops an InferICD10CM inference job in progress.
*/
public suspend inline fun ComprehendMedicalClient.stopIcd10CmInferenceJob(crossinline block: StopIcd10CmInferenceJobRequest.Builder.() -> Unit): StopIcd10CmInferenceJobResponse = stopIcd10CmInferenceJob(StopIcd10CmInferenceJobRequest.Builder().apply(block).build())
/**
* Stops a protected health information (PHI) detection job in progress.
*/
public suspend inline fun ComprehendMedicalClient.stopPhiDetectionJob(crossinline block: StopPhiDetectionJobRequest.Builder.() -> Unit): StopPhiDetectionJobResponse = stopPhiDetectionJob(StopPhiDetectionJobRequest.Builder().apply(block).build())
/**
* Stops an InferRxNorm inference job in progress.
*/
public suspend inline fun ComprehendMedicalClient.stopRxNormInferenceJob(crossinline block: StopRxNormInferenceJobRequest.Builder.() -> Unit): StopRxNormInferenceJobResponse = stopRxNormInferenceJob(StopRxNormInferenceJobRequest.Builder().apply(block).build())
/**
* Stops an InferSNOMEDCT inference job in progress.
*/
public suspend inline fun ComprehendMedicalClient.stopSnomedctInferenceJob(crossinline block: StopSnomedctInferenceJobRequest.Builder.() -> Unit): StopSnomedctInferenceJobResponse = stopSnomedctInferenceJob(StopSnomedctInferenceJobRequest.Builder().apply(block).build())
© 2015 - 2025 Weber Informatics LLC | Privacy Policy