ContentUnderstandingClient class
Constructors
| Content |
Properties
| pipeline | The pipeline used by this client to make requests |
Methods
Constructor Details
ContentUnderstandingClient(string, KeyCredential | TokenCredential, ContentUnderstandingClientOptionalParams)
new ContentUnderstandingClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: ContentUnderstandingClientOptionalParams)
Parameters
- endpoint
-
string
- credential
Property Details
pipeline
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
- options
- AnalyzeOptionalParams
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
- options
- AnalyzeBinaryOptionalParams
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
- options
- CopyAnalyzerOptionalParams
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
- options
- CreateAnalyzerOptionalParams
Returns
deleteAnalyzer(string, DeleteAnalyzerOptionalParams)
Delete analyzer.
function deleteAnalyzer(analyzerId: string, options?: DeleteAnalyzerOptionalParams): Promise<void>
Parameters
- analyzerId
-
string
- options
- DeleteAnalyzerOptionalParams
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
- options
- DeleteResultOptionalParams
Returns
Promise<void>
getAnalyzer(string, GetAnalyzerOptionalParams)
Get analyzer properties.
function getAnalyzer(analyzerId: string, options?: GetAnalyzerOptionalParams): Promise<ContentAnalyzer>
Parameters
- analyzerId
-
string
- options
- GetAnalyzerOptionalParams
Returns
Promise<ContentAnalyzer>
getDefaults(GetDefaultsOptionalParams)
Return default settings for this Content Understanding resource.
function getDefaults(options?: GetDefaultsOptionalParams): Promise<ContentUnderstandingDefaults>
Parameters
- options
- GetDefaultsOptionalParams
Returns
Promise<ContentUnderstandingDefaults>
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
- options
- GetResultFileOptionalParams
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
Promise<CopyAuthorization>
listAnalyzers(ListAnalyzersOptionalParams)
List analyzers.
function listAnalyzers(options?: ListAnalyzersOptionalParams): PagedAsyncIterableIterator<ContentAnalyzer, ContentAnalyzer[], PageSettings>
Parameters
- options
- ListAnalyzersOptionalParams
Returns
updateAnalyzer(string, ContentAnalyzer, UpdateAnalyzerOptionalParams)
Update analyzer properties.
function updateAnalyzer(analyzerId: string, resource: ContentAnalyzer, options?: UpdateAnalyzerOptionalParams): Promise<ContentAnalyzer>
Parameters
- analyzerId
-
string
- resource
- ContentAnalyzer
- options
- UpdateAnalyzerOptionalParams
Returns
Promise<ContentAnalyzer>
updateDefaults(UpdateDefaultsOptionalParams)
Update default settings for this Content Understanding resource.
function updateDefaults(options?: UpdateDefaultsOptionalParams): Promise<ContentUnderstandingDefaults>
Parameters
- options
- UpdateDefaultsOptionalParams
Returns
Promise<ContentUnderstandingDefaults>