Share via


ContentUnderstandingClient class

Properties

pipeline

The pipeline used by this client to make requests

Methods

analyze(string, AnalysisInput[], AnalyzeOptionalParams)

Extract content and fields from input.

analyzeBinary(string, Uint8Array, string, AnalyzeBinaryOptionalParams)

Extract content and fields from input.

copyAnalyzer(string, string, CopyAnalyzerOptionalParams)

Create a copy of the source analyzer to the current location.

createAnalyzer(string, ContentAnalyzer, CreateAnalyzerOptionalParams)

Create a new analyzer asynchronously.

deleteAnalyzer(string, DeleteAnalyzerOptionalParams)

Delete analyzer.

deleteResult(string, DeleteResultOptionalParams)

Mark the result of an analysis operation for deletion.

getAnalyzer(string, GetAnalyzerOptionalParams)

Get analyzer properties.

getDefaults(GetDefaultsOptionalParams)

Return default settings for this Content Understanding resource.

getResultFile(string, string, GetResultFileOptionalParams)

Get a file associated with the result of an analysis operation.

grantCopyAuthorization(string, string, GrantCopyAuthorizationOptionalParams)

Get authorization for copying this analyzer to another location.

listAnalyzers(ListAnalyzersOptionalParams)

List analyzers.

updateAnalyzer(string, ContentAnalyzer, UpdateAnalyzerOptionalParams)

Update analyzer properties.

updateDefaults(UpdateDefaultsOptionalParams)

Update default settings for this Content Understanding resource.

Constructor Details

ContentUnderstandingClient(string, KeyCredential | TokenCredential, ContentUnderstandingClientOptionalParams)

new ContentUnderstandingClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: ContentUnderstandingClientOptionalParams)

Parameters

endpoint

string

Property Details

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value

Method Details

analyze(string, AnalysisInput[], AnalyzeOptionalParams)

Extract content and fields from input.

function analyze(analyzerId: string, inputs: AnalysisInput[], options?: AnalyzeOptionalParams): AnalysisResultPoller

Parameters

analyzerId

string

inputs

AnalysisInput[]

Returns

analyzeBinary(string, Uint8Array, string, AnalyzeBinaryOptionalParams)

Extract content and fields from input.

function analyzeBinary(analyzerId: string, binaryInput: Uint8Array, contentType?: string, options?: AnalyzeBinaryOptionalParams): AnalysisResultPoller

Parameters

analyzerId

string

binaryInput

Uint8Array

contentType

string

Returns

copyAnalyzer(string, string, CopyAnalyzerOptionalParams)

Create a copy of the source analyzer to the current location.

function copyAnalyzer(analyzerId: string, sourceAnalyzerId: string, options?: CopyAnalyzerOptionalParams): PollerLike<OperationState<ContentAnalyzer>, ContentAnalyzer>

Parameters

analyzerId

string

sourceAnalyzerId

string

Returns

createAnalyzer(string, ContentAnalyzer, CreateAnalyzerOptionalParams)

Create a new analyzer asynchronously.

function createAnalyzer(analyzerId: string, resource: ContentAnalyzer, options?: CreateAnalyzerOptionalParams): PollerLike<OperationState<ContentAnalyzer>, ContentAnalyzer>

Parameters

analyzerId

string

resource
ContentAnalyzer

Returns

deleteAnalyzer(string, DeleteAnalyzerOptionalParams)

Delete analyzer.

function deleteAnalyzer(analyzerId: string, options?: DeleteAnalyzerOptionalParams): Promise<void>

Parameters

analyzerId

string

Returns

Promise<void>

deleteResult(string, DeleteResultOptionalParams)

Mark the result of an analysis operation for deletion.

function deleteResult(operationId: string, options?: DeleteResultOptionalParams): Promise<void>

Parameters

operationId

string

Returns

Promise<void>

getAnalyzer(string, GetAnalyzerOptionalParams)

Get analyzer properties.

function getAnalyzer(analyzerId: string, options?: GetAnalyzerOptionalParams): Promise<ContentAnalyzer>

Parameters

analyzerId

string

Returns

Promise<ContentAnalyzer>

getDefaults(GetDefaultsOptionalParams)

Return default settings for this Content Understanding resource.

function getDefaults(options?: GetDefaultsOptionalParams): Promise<ContentUnderstandingDefaults>

Parameters

Returns

getResultFile(string, string, GetResultFileOptionalParams)

Get a file associated with the result of an analysis operation.

function getResultFile(operationId: string, path: string, options?: GetResultFileOptionalParams): Promise<Uint8Array>

Parameters

operationId

string

path

string

Returns

Promise<Uint8Array>

grantCopyAuthorization(string, string, GrantCopyAuthorizationOptionalParams)

Get authorization for copying this analyzer to another location.

function grantCopyAuthorization(analyzerId: string, targetAzureResourceId: string, options?: GrantCopyAuthorizationOptionalParams): Promise<CopyAuthorization>

Parameters

analyzerId

string

targetAzureResourceId

string

Returns

listAnalyzers(ListAnalyzersOptionalParams)

List analyzers.

function listAnalyzers(options?: ListAnalyzersOptionalParams): PagedAsyncIterableIterator<ContentAnalyzer, ContentAnalyzer[], PageSettings>

Parameters

Returns

updateAnalyzer(string, ContentAnalyzer, UpdateAnalyzerOptionalParams)

Update analyzer properties.

function updateAnalyzer(analyzerId: string, resource: ContentAnalyzer, options?: UpdateAnalyzerOptionalParams): Promise<ContentAnalyzer>

Parameters

analyzerId

string

resource
ContentAnalyzer

Returns

Promise<ContentAnalyzer>

updateDefaults(UpdateDefaultsOptionalParams)

Update default settings for this Content Understanding resource.

function updateDefaults(options?: UpdateDefaultsOptionalParams): Promise<ContentUnderstandingDefaults>

Parameters

Returns