ContentUnderstandingClient class

Пакет:: @azure/ai-content-understanding

Конструкторы

ContentUnderstandingClient(string, KeyCredential | TokenCredential, ContentUnderstandingClientOptionalParams)

Свойства

Конвейер, используемый этим клиентом для выполнения запросов

Методы

analyze(string, AnalysisInput[], AnalyzeOptionalParams)	Извлечение содержимого и полей из входных данных.
analyzeBinary(string, Uint8Array, string, AnalyzeBinaryOptionalParams)	Извлечение содержимого и полей из входных данных.
copyAnalyzer(string, string, CopyAnalyzerOptionalParams)	Создайте копию исходного анализатора в текущем месте.
createAnalyzer(string, ContentAnalyzer, CreateAnalyzerOptionalParams)	Создание анализатора асинхронно.
deleteAnalyzer(string, DeleteAnalyzerOptionalParams)	Удаление анализатора.
deleteResult(string, DeleteResultOptionalParams)	Отметьте результат операции анализа для удаления.
getAnalyzer(string, GetAnalyzerOptionalParams)	Получение свойств анализатора.
getDefaults(GetDefaultsOptionalParams)	Вернуть настройки по умолчанию для этого ресурса Content Understanding.
getResultFile(string, string, GetResultFileOptionalParams)	Получение файла, связанного с результатом операции анализа.
grantCopyAuthorization(string, string, GrantCopyAuthorizationOptionalParams)	Получите разрешение на копирование этого анализатора в другое место.
listAnalyzers(ListAnalyzersOptionalParams)	Вывод списка анализаторов.
updateAnalyzer(string, ContentAnalyzer, UpdateAnalyzerOptionalParams)	Обновление свойств анализатора.
updateDefaults(UpdateDefaultsOptionalParams)	Обновите параметры по умолчанию для этого ресурса Content Understanding.

Сведения о конструкторе

ContentUnderstandingClient(string, KeyCredential | TokenCredential, ContentUnderstandingClientOptionalParams)

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

Параметры

endpoint: string

credential: KeyCredential | TokenCredential

options: ContentUnderstandingClientOptionalParams

Сведения о свойстве

pipeline

Конвейер, используемый этим клиентом для выполнения запросов

pipeline: Pipeline

Значение свойства

Pipeline

Сведения о методе

analyze(string, AnalysisInput[], AnalyzeOptionalParams)

Извлечение содержимого и полей из входных данных.

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

Параметры

analyzerId: string

inputs: AnalysisInput[]

options: AnalyzeOptionalParams

Возвращаемое значение

AnalysisResultPoller

analyzeBinary(string, Uint8Array, string, AnalyzeBinaryOptionalParams)

Извлечение содержимого и полей из входных данных.

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

Параметры

analyzerId: string

binaryInput: Uint8Array

contentType: string

options: AnalyzeBinaryOptionalParams

Возвращаемое значение

AnalysisResultPoller

copyAnalyzer(string, string, CopyAnalyzerOptionalParams)

Создайте копию исходного анализатора в текущем месте.

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

Параметры

analyzerId: string

sourceAnalyzerId: string

options: CopyAnalyzerOptionalParams

Возвращаемое значение

PollerLike<OperationState<ContentAnalyzer>, ContentAnalyzer>

createAnalyzer(string, ContentAnalyzer, CreateAnalyzerOptionalParams)

Создание анализатора асинхронно.

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

Параметры

analyzerId: string

resource: ContentAnalyzer

options: CreateAnalyzerOptionalParams

Возвращаемое значение

PollerLike<OperationState<ContentAnalyzer>, ContentAnalyzer>

deleteAnalyzer(string, DeleteAnalyzerOptionalParams)

Удаление анализатора.

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

Параметры

analyzerId: string

options: DeleteAnalyzerOptionalParams

Возвращаемое значение

Promise<void>

deleteResult(string, DeleteResultOptionalParams)

Отметьте результат операции анализа для удаления.

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

Параметры

operationId: string

options: DeleteResultOptionalParams

Возвращаемое значение

Promise<void>

getAnalyzer(string, GetAnalyzerOptionalParams)

Получение свойств анализатора.

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

Параметры

analyzerId: string

options: GetAnalyzerOptionalParams

Возвращаемое значение

Promise<ContentAnalyzer>

getDefaults(GetDefaultsOptionalParams)

Вернуть настройки по умолчанию для этого ресурса Content Understanding.

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

Параметры

options: GetDefaultsOptionalParams

Возвращаемое значение

Promise<ContentUnderstandingDefaults>

getResultFile(string, string, GetResultFileOptionalParams)

Получение файла, связанного с результатом операции анализа.

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

Параметры

operationId: string

path: string

options: GetResultFileOptionalParams

Возвращаемое значение

Promise<Uint8Array>

grantCopyAuthorization(string, string, GrantCopyAuthorizationOptionalParams)

Получите разрешение на копирование этого анализатора в другое место.

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

Параметры

analyzerId: string

targetAzureResourceId: string

options: GrantCopyAuthorizationOptionalParams

Возвращаемое значение

Promise<CopyAuthorization>

listAnalyzers(ListAnalyzersOptionalParams)

Вывод списка анализаторов.

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

Параметры

options: ListAnalyzersOptionalParams

Возвращаемое значение

PagedAsyncIterableIterator<ContentAnalyzer, ContentAnalyzer[], PageSettings>

updateAnalyzer(string, ContentAnalyzer, UpdateAnalyzerOptionalParams)

Обновление свойств анализатора.

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

Параметры

analyzerId: string

resource: ContentAnalyzer

options: UpdateAnalyzerOptionalParams

Возвращаемое значение

Promise<ContentAnalyzer>

updateDefaults(UpdateDefaultsOptionalParams)

Обновите параметры по умолчанию для этого ресурса Content Understanding.

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

Параметры

options: UpdateDefaultsOptionalParams

Возвращаемое значение

Promise<ContentUnderstandingDefaults>