Type Members

1.  case class ATError(id: String, error: DocumentError) extends Product with Serializable
2.  case class AbstractiveSummarizationJobState(displayName: Option[String], createdDateTime: String, expirationDateTime: Option[String], jobId: String, lastUpdatedDateTime: String, status: String, errors: Option[Seq[String]], nextLink: Option[String], tasks: AbstractiveSummarizationTaskResult, statistics: Option[RequestStatistics]) extends Product with Serializable
3.  case class AbstractiveSummarizationJobsInput(displayName: Option[String], analysisInput: MultiLanguageAnalysisInput, tasks: Seq[AbstractiveSummarizationLROTask]) extends Product with Serializable
4.  case class AbstractiveSummarizationLROResult(results: AbstractiveSummarizationResult, lastUpdateDateTime: String, status: String, taskName: Option[String], kind: String) extends Product with Serializable
5.  case class AbstractiveSummarizationLROTask(parameters: AbstractiveSummarizationTaskParameters, taskName: Option[String], kind: String) extends Product with Serializable
6.  case class AbstractiveSummarizationResult(errors: Seq[ATError], statistics: Option[RequestStatistics], modelVersion: String, documents: Seq[AbstractiveSummaryDocumentResult]) extends Product with Serializable
7.  case class AbstractiveSummarizationTaskParameters(loggingOptOut: Boolean, modelVersion: String, sentenceCount: Option[Int], stringIndexType: String, summaryLength: Option[String]) extends Product with Serializable
8.  case class AbstractiveSummarizationTaskResult(completed: Int, failed: Int, inProgress: Int, total: Int, items: Option[Seq[AbstractiveSummarizationLROResult]]) extends Product with Serializable
9.  case class AbstractiveSummary(text: String, contexts: Option[Seq[SummaryContext]]) extends Product with Serializable
10.  case class AbstractiveSummaryDocumentResult(id: String, warnings: Seq[DocumentWarning], statistics: Option[RequestStatistics], summaries: Seq[AbstractiveSummary]) extends Product with Serializable
11.  class AnalyzeText extends CognitiveServicesBase with HasCognitiveServiceInput with HasInternalJsonOutputParser with HasSetLocation with HasAPIVersion with HasCountryHint with TextAnalyticsAutoBatch with HasBatchSize with AnalyzeTextTaskParameters with SynapseMLLogging
12.  class AnalyzeTextLongRunningOperations extends CognitiveServicesBaseNoHandler with HasAPIVersion with ModifiableAsyncReply with HasCognitiveServiceInput with HasInternalJsonOutputParser with HasSetLocation with TextAnalyticsAutoBatch with SynapseMLLogging with HasAnalyzeTextServiceBaseParams with HasBatchSize with HandleExtractiveSummarization with HandleAbstractiveSummarization with HandleHealthcareTextAnalystics with HandleSentimentAnalysis with HandleKeyPhraseExtraction with HandlePiiEntityRecognition with HandleEntityLinking with HandleEntityRecognition with HandleCustomEntityRecognition with HandleCustomLabelClassification

    This transformer is used to analyze text using the Azure AI Language service.

    This transformer is used to analyze text using the Azure AI Language service. It uses AI service asynchronously. For more details please visit https://learn.microsoft.com/en-us/azure/ai-services/language-service/concepts/use-asynchronously For each row, it submits a job to the service and polls the service until the job is complete. Delay between polling requests is controlled by the pollingDelay parameter, which is set to 1000 milliseconds by default. Number of polling attempts is controlled by the maxPollingRetries parameter, which is set to 1000 by default.

    This transformer will use the field specified as TextCol to submit the text to the service. The response from the service will be stored in the field specified as OutputCol. The response will be a struct with the following fields:

    • statistics: A struct containing statistics about the job.
    • documents: An array of structs containing the results for each document.
    • errors: An array of structs containing the errors for each document.
    • modelVersion: The version of the model used to analyze the text.

    This transformer support only single task per row. The task to be performed is specified by the kind parameter. The supported tasks are:

    • ExtractiveSummarization
    • AbstractiveSummarization
    • Healthcare
    • SentimentAnalysis
    • KeyPhraseExtraction
    • PiiEntityRecognition
    • EntityLinking
    • EntityRecognition
    • CustomEntityRecognition
    • CustomSingleLabelClassification
    • CustomMultiLabelClassification

    Each task has its own set of parameters that can be set to control the behavior of the service and response schema.

13.  trait AnalyzeTextTaskParameters extends HasAnalyzeTextServiceBaseParams
14.  case class ClassificationDocumentResult(id: String, warnings: Seq[DocumentWarning], statistics: Option[RequestStatistics], classifications: Seq[ClassificationResult]) extends Product with Serializable
15.  case class ClassificationResult(category: String, confidenceScore: Double) extends Product with Serializable
16.  case class CustomEntitiesJobsInput(displayName: Option[String], analysisInput: MultiLanguageAnalysisInput, tasks: Seq[CustomEntityRecognitionLROTask]) extends Product with Serializable
17.  case class CustomEntitiesTaskParameters(loggingOptOut: Boolean, stringIndexType: String, deploymentName: String, projectName: String) extends Product with Serializable
18.  case class CustomEntityRecognitionLROTask(parameters: CustomEntitiesTaskParameters, taskName: Option[String], kind: String) extends Product with Serializable
19.  case class CustomLabelJobState(displayName: Option[String], createdDateTime: String, expirationDateTime: Option[String], jobId: String, lastUpdatedDateTime: String, status: String, errors: Option[Seq[String]], nextLink: Option[String], tasks: CustomLabelTaskResult, statistics: Option[RequestStatistics]) extends Product with Serializable
20.  case class CustomLabelJobsInput(displayName: Option[String], analysisInput: MultiLanguageAnalysisInput, tasks: Seq[CustomLabelLROTask]) extends Product with Serializable
21.  case class CustomLabelLROResult(results: CustomLabelResult, lastUpdateDateTime: String, status: String, taskName: Option[String], kind: String) extends Product with Serializable
22.  case class CustomLabelLROTask(parameters: CustomLabelTaskParameters, taskName: Option[String], kind: String) extends Product with Serializable
23.  case class CustomLabelResult(errors: Seq[DocumentError], statistics: Option[RequestStatistics], modelVersion: String, documents: Seq[ClassificationDocumentResult]) extends Product with Serializable
24.  case class CustomLabelTaskParameters(loggingOptOut: Boolean, deploymentName: String, projectName: String) extends Product with Serializable
25.  case class CustomLabelTaskResult(completed: Int, failed: Int, inProgress: Int, total: Int, items: Option[Seq[CustomLabelLROResult]]) extends Product with Serializable
26.  case class DocumentError(code: String, details: Option[Seq[Map[String, String]]], innererror: Option[InnerError], message: String, target: Option[String]) extends Product with Serializable
27.  case class DocumentWarning(code: String, message: String, targetRef: Option[String]) extends Product with Serializable
28.  case class Entity(category: String, confidenceScore: Double, length: Int, offset: Int, subcategory: Option[String], text: String) extends Product with Serializable
29.  case class EntityInferenceOptions(excludeNormalizedValues: Boolean) extends Product with Serializable
30.  case class EntityLinkingJobState(displayName: Option[String], createdDateTime: String, expirationDateTime: Option[String], jobId: String, lastUpdatedDateTime: String, status: String, errors: Option[Seq[String]], nextLink: Option[String], tasks: EntityLinkingTaskResult, statistics: Option[RequestStatistics]) extends Product with Serializable
31.  case class EntityLinkingJobsInput(displayName: Option[String], analysisInput: MultiLanguageAnalysisInput, tasks: Seq[EntityLinkingLROTask]) extends Product with Serializable
32.  case class EntityLinkingLROResult(results: EntityLinkingResult, lastUpdateDateTime: String, status: String, taskName: Option[String], kind: String) extends Product with Serializable
33.  case class EntityLinkingLROTask(parameters: EntityTaskParameters, taskName: Option[String], kind: String) extends Product with Serializable
34.  case class EntityLinkingResponse(kind: String, results: EntityLinkingResult) extends Product with Serializable
35.  case class EntityLinkingResult(documents: Seq[LinkedEntityDocumentResult], errors: Option[Seq[ATError]], modelVersion: String, statistics: Option[RequestStatistics]) extends Product with Serializable
36.  case class EntityLinkingTaskResult(completed: Int, failed: Int, inProgress: Int, total: Int, items: Option[Seq[EntityLinkingLROResult]]) extends Product with Serializable
37.  case class EntityOverlapPolicy(policyKind: String) extends Product with Serializable
38.  case class EntityRecognitionDocument(entities: Seq[Entity], id: String, statistics: Option[DocumentStatistics], warnings: Seq[TAWarning]) extends Product with Serializable
39.  case class EntityRecognitionJobState(displayName: Option[String], createdDateTime: String, expirationDateTime: Option[String], jobId: String, lastUpdatedDateTime: String, status: String, errors: Option[Seq[String]], nextLink: Option[String], tasks: EntityRecognitionTaskResult, statistics: Option[RequestStatistics]) extends Product with Serializable
40.  case class EntityRecognitionJobsInput(displayName: Option[String], analysisInput: MultiLanguageAnalysisInput, tasks: Seq[EntityRecognitionLROTask]) extends Product with Serializable
41.  case class EntityRecognitionLROResult(results: EntityRecognitionResult, lastUpdateDateTime: String, status: String, taskName: Option[String], kind: String) extends Product with Serializable
42.  case class EntityRecognitionLROTask(parameters: EntityRecognitionTaskParameters, taskName: Option[String], kind: String) extends Product with Serializable
43.  case class EntityRecognitionResponse(kind: String, results: EntityRecognitionResult) extends Product with Serializable
44.  case class EntityRecognitionResult(documents: Seq[EntityRecognitionDocument], errors: Option[Seq[ATError]], modelVersion: String, statistics: Option[RequestStatistics]) extends Product with Serializable
45.  case class EntityRecognitionTaskParameters(loggingOptOut: Boolean, modelVersion: String, stringIndexType: String, inclusionList: Option[Seq[String]], exclusionList: Option[Seq[String]], overlapPolicy: Option[EntityOverlapPolicy], inferenceOptions: Option[EntityInferenceOptions]) extends Product with Serializable
46.  case class EntityRecognitionTaskResult(completed: Int, failed: Int, inProgress: Int, total: Int, items: Option[Seq[EntityRecognitionLROResult]]) extends Product with Serializable
47.  case class EntityTaskParameters(loggingOptOut: Boolean, modelVersion: String, stringIndexType: String) extends Product with Serializable
48.  case class ExtractedSummaryDocumentResult(id: String, warnings: Seq[DocumentWarning], statistics: Option[RequestStatistics], sentences: Seq[ExtractedSummarySentence]) extends Product with Serializable
49.  case class ExtractedSummarySentence(text: String, rankScore: Double, offset: Int, length: Int) extends Product with Serializable
50.  case class ExtractiveSummarizationJobState(displayName: Option[String], createdDateTime: String, expirationDateTime: Option[String], jobId: String, lastUpdatedDateTime: String, status: String, errors: Option[Seq[String]], nextLink: Option[String], tasks: ExtractiveSummarizationTaskResult, statistics: Option[RequestStatistics]) extends Product with Serializable
51.  case class ExtractiveSummarizationJobsInput(displayName: Option[String], analysisInput: MultiLanguageAnalysisInput, tasks: Seq[ExtractiveSummarizationLROTask]) extends Product with Serializable
52.  case class ExtractiveSummarizationLROResult(results: ExtractiveSummarizationResult, lastUpdateDateTime: String, status: String, taskName: Option[String], kind: String) extends Product with Serializable
53.  case class ExtractiveSummarizationLROTask(parameters: ExtractiveSummarizationTaskParameters, taskName: Option[String], kind: String) extends Product with Serializable
54.  case class ExtractiveSummarizationResult(errors: Seq[ATError], statistics: Option[RequestStatistics], modelVersion: String, documents: Seq[ExtractedSummaryDocumentResult]) extends Product with Serializable
55.  case class ExtractiveSummarizationTaskParameters(loggingOptOut: Boolean, modelVersion: String, sentenceCount: Option[Int], sortBy: Option[String], stringIndexType: String) extends Product with Serializable
56.  case class ExtractiveSummarizationTaskResult(completed: Int, failed: Int, inProgress: Int, total: Int, items: Option[Seq[ExtractiveSummarizationLROResult]]) extends Product with Serializable
57.  trait HasAnalyzeTextServiceBaseParams extends HasServiceParams
58.  trait HasCountryHint extends HasServiceParams
59.  case class HealthcareAssertion(conditionality: Option[String], certainty: Option[String], association: Option[String], temporality: Option[String]) extends Product with Serializable
60.  case class HealthcareEntitiesDocumentResult(id: String, warnings: Seq[DocumentWarning], statistics: Option[RequestStatistics], entities: Seq[HealthcareEntity], relations: Seq[HealthcareRelation], fhirBundle: Option[String]) extends Product with Serializable
61.  case class HealthcareEntity(text: String, category: String, subcategory: Option[String], offset: Int, length: Int, confidenceScore: Double, assertion: Option[HealthcareAssertion], name: Option[String], links: Option[Seq[HealthcareEntityLink]]) extends Product with Serializable
62.  case class HealthcareEntityLink(dataSource: String, id: String) extends Product with Serializable
63.  case class HealthcareJobState(displayName: Option[String], createdDateTime: String, expirationDateTime: Option[String], jobId: String, lastUpdatedDateTime: String, status: String, errors: Option[Seq[String]], nextLink: Option[String], tasks: HealthcareTaskResult, statistics: Option[RequestStatistics]) extends Product with Serializable
64.  case class HealthcareJobsInput(displayName: Option[String], analysisInput: MultiLanguageAnalysisInput, tasks: Seq[HealthcareLROTask]) extends Product with Serializable
65.  case class HealthcareLROResult(results: HealthcareResult, lastUpdateDateTime: String, status: String, taskName: Option[String], kind: String) extends Product with Serializable
66.  case class HealthcareLROTask(parameters: HealthcareTaskParameters, taskName: Option[String], kind: String) extends Product with Serializable
67.  case class HealthcareRelation(relationType: String, entities: Seq[HealthcareRelationEntity], confidenceScore: Option[Double]) extends Product with Serializable
68.  case class HealthcareRelationEntity(ref: String, role: String) extends Product with Serializable
69.  case class HealthcareResult(errors: Seq[DocumentError], statistics: Option[RequestStatistics], modelVersion: String, documents: Seq[HealthcareEntitiesDocumentResult]) extends Product with Serializable
70.  case class HealthcareTaskParameters(loggingOptOut: Boolean, modelVersion: String, stringIndexType: String) extends Product with Serializable
71.  case class HealthcareTaskResult(completed: Int, failed: Int, inProgress: Int, total: Int, items: Option[Seq[HealthcareLROResult]]) extends Product with Serializable
72.  case class InnerError(code: Option[String], innerError: Option[String]) extends Product with Serializable
73.  case class KPnLDTaskParameters(loggingOptOut: Boolean, modelVersion: String) extends Product with Serializable
74.  case class KeyPhraseExtractionDocumentResult(id: String, keyPhrases: Seq[String], statistics: Option[DocumentStatistics], warnings: Seq[TAWarning]) extends Product with Serializable
75.  case class KeyPhraseExtractionJobState(displayName: Option[String], createdDateTime: String, expirationDateTime: Option[String], jobId: String, lastUpdatedDateTime: String, status: String, errors: Option[Seq[String]], nextLink: Option[String], tasks: KeyPhraseExtractionTaskResult, statistics: Option[RequestStatistics]) extends Product with Serializable
76.  case class KeyPhraseExtractionJobsInput(displayName: Option[String], analysisInput: MultiLanguageAnalysisInput, tasks: Seq[KeyPhraseExtractionLROTask]) extends Product with Serializable
77.  case class KeyPhraseExtractionLROResult(results: KeyPhraseExtractionResult, lastUpdateDateTime: String, status: String, taskName: Option[String], kind: String) extends Product with Serializable
78.  case class KeyPhraseExtractionLROTask(parameters: KPnLDTaskParameters, taskName: Option[String], kind: String) extends Product with Serializable
79.  case class KeyPhraseExtractionResponse(kind: String, results: KeyPhraseExtractionResult) extends Product with Serializable
80.  case class KeyPhraseExtractionResult(documents: Seq[KeyPhraseExtractionDocumentResult], errors: Option[Seq[ATError]], modelVersion: String, statistics: Option[RequestStatistics]) extends Product with Serializable
81.  case class KeyPhraseExtractionTaskResult(completed: Int, failed: Int, inProgress: Int, total: Int, items: Option[Seq[KeyPhraseExtractionLROResult]]) extends Product with Serializable
82.  case class LanguageDetectionAnalysisInput(documents: Seq[LanguageInput]) extends Product with Serializable
83.  case class LanguageDetectionDocumentResult(detectedLanguage: DetectedLanguage, id: String, statistics: Option[DocumentStatistics], warnings: Seq[TAWarning]) extends Product with Serializable
84.  case class LanguageDetectionResponse(kind: String, results: LanguageDetectionResult) extends Product with Serializable
85.  case class LanguageDetectionResult(documents: Seq[LanguageDetectionDocumentResult], errors: Option[Seq[ATError]], modelVersion: String, statistics: Option[RequestStatistics]) extends Product with Serializable
86.  case class LanguageInput(countryHint: Option[String], id: String, text: String) extends Product with Serializable
87.  case class LinkedEntity(bingId: String, dataSource: String, id: String, language: String, matches: Seq[Match], name: String, url: String) extends Product with Serializable
88.  case class LinkedEntityDocumentResult(detectedLanguage: Option[DetectedLanguage], id: String, entities: Seq[LinkedEntity], statistics: Option[DocumentStatistics], warnings: Seq[TAWarning]) extends Product with Serializable
89.  case class Match(confidenceScore: Double, length: Int, offset: Int, text: String) extends Product with Serializable
90.  trait ModifiableAsyncReply extends BasicAsyncReply

    Trait ModifiableAsyncReply extends BasicAsyncReply and provides a mechanism to modify the HTTP response received from an asynchronous service call.

    Trait ModifiableAsyncReply extends BasicAsyncReply and provides a mechanism to modify the HTTP response received from an asynchronous service call. This trait is designed to be mixed into classes that require custom handling of the response data.

    The primary purpose of this trait is to allow modification of the response before it is processed further. This is particularly useful in scenarios where the response needs to be transformed or certain fields need to be renamed to comply with specific requirements or constraints.

    In this implementation, the queryForResult method is overridden and marked as final to prevent further overriding. This ensures that the response modification logic is consistently applied across all subclasses.

    Note

    This trait is designed to be used with the SynapseMLLogging trait for consistent logging.

91.  case class MultiLanguageAnalysisInput(documents: Seq[TADocument]) extends Product with Serializable
92.  case class PIIDocumentResult(entities: Seq[Entity], id: String, redactedText: String, statistics: Option[DocumentStatistics], warnings: Seq[TAWarning]) extends Product with Serializable
93.  case class PIIResponse(kind: String, results: PIIResult) extends Product with Serializable
94.  case class PIIResult(documents: Seq[PIIDocumentResult], errors: Option[Seq[ATError]], modelVersion: String, statistics: Option[RequestStatistics]) extends Product with Serializable
95.  case class PiiEntityRecognitionJobState(displayName: Option[String], createdDateTime: String, expirationDateTime: Option[String], jobId: String, lastUpdatedDateTime: String, status: String, errors: Option[Seq[String]], nextLink: Option[String], tasks: PiiEntityRecognitionTaskResult, statistics: Option[RequestStatistics]) extends Product with Serializable
96.  case class PiiEntityRecognitionJobsInput(displayName: Option[String], analysisInput: MultiLanguageAnalysisInput, tasks: Seq[PiiEntityRecognitionLROTask]) extends Product with Serializable
97.  case class PiiEntityRecognitionLROResult(results: PIIResult, lastUpdateDateTime: String, status: String, taskName: Option[String], kind: String) extends Product with Serializable
98.  case class PiiEntityRecognitionLROTask(parameters: PiiTaskParameters, taskName: Option[String], kind: String) extends Product with Serializable
99.  case class PiiEntityRecognitionTaskResult(completed: Int, failed: Int, inProgress: Int, total: Int, items: Option[Seq[PiiEntityRecognitionLROResult]]) extends Product with Serializable
100.  case class PiiTaskParameters(domain: String, loggingOptOut: Boolean, modelVersion: String, piiCategories: Option[Seq[String]], stringIndexType: String) extends Product with Serializable
101.  case class RequestStatistics(documentsCount: Int, erroneousDocumentsCount: Int, transactionsCount: Int, validDocumentsCount: Int) extends Product with Serializable
102.  case class SentimentAnalysisJobState(displayName: Option[String], createdDateTime: String, expirationDateTime: Option[String], jobId: String, lastUpdatedDateTime: String, status: String, errors: Option[Seq[String]], nextLink: Option[String], tasks: SentimentAnalysisTaskResult, statistics: Option[RequestStatistics]) extends Product with Serializable
103.  case class SentimentAnalysisJobsInput(displayName: Option[String], analysisInput: MultiLanguageAnalysisInput, tasks: Seq[SentimentAnalysisLROTask]) extends Product with Serializable
104.  case class SentimentAnalysisLROResult(results: SentimentResult, lastUpdateDateTime: String, status: String, taskName: Option[String], kind: String) extends Product with Serializable
105.  case class SentimentAnalysisLROTask(parameters: SentimentAnalysisTaskParameters, taskName: Option[String], kind: String) extends Product with Serializable
106.  case class SentimentAnalysisTaskParameters(loggingOptOut: Boolean, modelVersion: String, opinionMining: Boolean, stringIndexType: String) extends Product with Serializable
107.  case class SentimentAnalysisTaskResult(completed: Int, failed: Int, inProgress: Int, total: Int, items: Option[Seq[SentimentAnalysisLROResult]]) extends Product with Serializable
108.  case class SentimentDocumentResult(id: String, sentiment: String, statistics: Option[DocumentStatistics], confidenceScores: SentimentScore, sentences: Seq[Sentence], warnings: Seq[TAWarning]) extends Product with Serializable
109.  case class SentimentResponse(kind: String, results: SentimentResult) extends Product with Serializable
110.  case class SentimentResult(documents: Seq[SentimentDocumentResult], errors: Option[Seq[ATError]], modelVersion: String, statistics: Option[RequestStatistics]) extends Product with Serializable
111.  case class SummaryContext(offset: Int, length: Int) extends Product with Serializable