sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ Comprehend/ DetectSyntax.ts

import type * as comprehend from "@distilled.cloud/aws/comprehend";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";

/**
 * Runtime binding for `comprehend:DetectSyntax` — tokenize the input text
 * and label each token with its part of speech (noun, verb, adjective, …).
 *
 * The binding takes no arguments and grants the action on `*` (the action
 * has no resource-level IAM).
 *
 * ### Real-Time Analysis
 * **Example:** Parse Parts of Speech
 * ```typescript
 * // init
 * const detectSyntax = yield* AWS.Comprehend.DetectSyntax();
 *
 * // runtime
 * const result = yield* detectSyntax({
 *   Text: "The cat sat on the mat.",
 *   LanguageCode: "en",
 * });
 * // result.SyntaxTokens: [{ Text: "cat", PartOfSpeech: { Tag: "NOUN" } }, …]
 * ```
 *
 * @binding
 */
export interface DetectSyntax extends Binding.Service<
  DetectSyntax,
  "AWS.Comprehend.DetectSyntax",
  () => Effect.Effect<
    (
      request: comprehend.DetectSyntaxRequest,
    ) => Effect.Effect<comprehend.DetectSyntaxResponse, comprehend.DetectSyntaxError>
  >
> {}
export const DetectSyntax = Binding.Service<DetectSyntax>("AWS.Comprehend.DetectSyntax");