Interface AnalyzeText

Package version

Interface representing a AnalyzeText.

Hierarchy

AnalyzeText

Implemented by

AnalyzeTextImpl

Index

Methods

Methods

cancelJob

cancelJob(jobId: string, options?: AnalyzeTextCancelJobOptionalParams): Promise<AnalyzeTextCancelJobResponse>

- Defined in generated/operationsInterfaces/analyzeText.ts:47
Cancel a long-running Text Analysis job.

Parameters
- jobId: string
  
  Job ID
- Optional options: AnalyzeTextCancelJobOptionalParams
  
  The options parameters.
Returns Promise<AnalyzeTextCancelJobResponse>

jobStatus

jobStatus(jobId: string, options?: AnalyzeTextJobStatusOptionalParams): Promise<AnalyzeTextJobStatusResponse>

- Defined in generated/operationsInterfaces/analyzeText.ts:38
Get the status of an analysis job. A job may consist of one or more tasks. Once all tasks are succeeded, the job will transition to the succeeded state and results will be available for each task.

Parameters
- jobId: string
  
  Job ID
- Optional options: AnalyzeTextJobStatusOptionalParams
  
  The options parameters.
Returns Promise<AnalyzeTextJobStatusResponse>

submitJob

submitJob(body: AnalyzeTextJobsInput, options?: AnalyzeTextSubmitJobOptionalParams): Promise<AnalyzeTextSubmitJobResponse>

- Defined in generated/operationsInterfaces/analyzeText.ts:27
Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation.

Parameters
- body: AnalyzeTextJobsInput
  
  Collection of documents to analyze and one or more tasks to execute.
- Optional options: AnalyzeTextSubmitJobOptionalParams
  
  The options parameters.
Returns Promise<AnalyzeTextSubmitJobResponse>

Generated using TypeDoc