@azure-rest/ai-document-intelligence package
Interfaces
| AddressValueOutput |
Valor de campo de dirección. |
| AnalyzeDocument202Headers | |
| AnalyzeDocument202Response |
La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado. |
| AnalyzeDocumentBodyParam | |
| AnalyzeDocumentDefaultResponse | |
| AnalyzeDocumentFromStream | |
| AnalyzeDocumentFromStream202Headers | |
| AnalyzeDocumentFromStream202Response |
La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado. |
| AnalyzeDocumentFromStreamBodyParam | |
| AnalyzeDocumentFromStreamDefaultResponse | |
| AnalyzeDocumentFromStreamLogicalResponse |
La respuesta final para la operación analyzeDocumentFromStream de larga duración |
| AnalyzeDocumentFromStreamMediaTypesParam | |
| AnalyzeDocumentFromStreamQueryParam | |
| AnalyzeDocumentFromStreamQueryParamProperties | |
| AnalyzeDocumentLogicalResponse |
La respuesta final para la operación analyzeDocument de larga duración |
| AnalyzeDocumentMediaTypesParam | |
| AnalyzeDocumentQueryParam | |
| AnalyzeDocumentQueryParamProperties | |
| AnalyzeDocumentRequest |
Parámetros de análisis de documentos. |
| AnalyzeResultOperationOutput |
Estado y resultado de la operación de análisis. |
| AnalyzeResultOutput |
Resultado del análisis de documentos. |
| AuthorizeCopyRequest |
Cuerpo de la solicitud para autorizar la copia del modelo de documento. |
| AuthorizeModelCopy | |
| AuthorizeModelCopy200Response |
La solicitud se ha realizado correctamente. |
| AuthorizeModelCopyBodyParam | |
| AuthorizeModelCopyDefaultResponse | |
| AzureBlobContentSource |
Azure Blob Storage contenido. |
| AzureBlobContentSourceOutput |
Azure Blob Storage contenido. |
| AzureBlobFileListContentSource |
Lista de archivos en Azure Blob Storage. |
| AzureBlobFileListContentSourceOutput |
Lista de archivos en Azure Blob Storage. |
| BoundingRegionOutput |
Polígono delimitador en una página específica de la entrada. |
| BuildClassifier | |
| BuildClassifier202Headers | |
| BuildClassifier202Response |
La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado. |
| BuildClassifierBodyParam | |
| BuildClassifierDefaultResponse | |
| BuildClassifierLogicalResponse |
La respuesta final para la operación buildClassifier de larga duración |
| BuildDocumentClassifierRequest |
Cuerpo de la solicitud para crear un nuevo clasificador de documentos personalizado. |
| BuildDocumentModelRequest |
Cuerpo de la solicitud para crear un nuevo modelo de documento personalizado. |
| BuildModel | |
| BuildModel202Headers | |
| BuildModel202Response |
La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado. |
| BuildModelBodyParam | |
| BuildModelDefaultResponse | |
| BuildModelLogicalResponse |
La respuesta final para la operación buildModel de larga duración |
| ClassifierDocumentTypeDetails |
Información del tipo de documento clasificador. |
| ClassifierDocumentTypeDetailsOutput |
Información del tipo de documento clasificador. |
| ClassifyDocument202Headers | |
| ClassifyDocument202Response |
La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado. |
| ClassifyDocumentBodyParam | |
| ClassifyDocumentDefaultResponse | |
| ClassifyDocumentFromStream | |
| ClassifyDocumentFromStream202Headers | |
| ClassifyDocumentFromStream202Response |
La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado. |
| ClassifyDocumentFromStreamBodyParam | |
| ClassifyDocumentFromStreamDefaultResponse | |
| ClassifyDocumentFromStreamLogicalResponse |
La respuesta final para la operación classifyDocumentFromStream de larga duración |
| ClassifyDocumentFromStreamMediaTypesParam | |
| ClassifyDocumentFromStreamQueryParam | |
| ClassifyDocumentFromStreamQueryParamProperties | |
| ClassifyDocumentLogicalResponse |
La respuesta final para la operación classifyDocument de larga duración |
| ClassifyDocumentMediaTypesParam | |
| ClassifyDocumentQueryParam | |
| ClassifyDocumentQueryParamProperties | |
| ClassifyDocumentRequest |
Parámetros de clasificación de documentos. |
| ClientRequestIdHeaderOutput |
Proporciona el encabezado "x-ms-client-request-id" para habilitar la correlación de solicitudes en solicitudes y respuestas. |
| ComponentDocumentModelDetails |
Componente de un modelo de documento compuesto. |
| ComposeDocumentModelRequest |
Cuerpo de la solicitud para crear un modelo de documento compuesto a partir de modelos de documentos componentes. |
| ComposeModel | |
| ComposeModel202Headers | |
| ComposeModel202Response |
La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado. |
| ComposeModelBodyParam | |
| ComposeModelDefaultResponse | |
| ComposeModelLogicalResponse |
La respuesta final para la operación composeModel de ejecución prolongada |
| CopyAuthorization |
Autorización para copiar un modelo de documento en el recurso de destino y modelId especificados. |
| CopyAuthorizationOutput |
Autorización para copiar un modelo de documento en el recurso de destino y modelId especificados. |
| CopyModelTo | |
| CopyModelTo202Headers | |
| CopyModelTo202Response |
La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado. |
| CopyModelToBodyParam | |
| CopyModelToDefaultResponse | |
| CopyModelToLogicalResponse |
La respuesta final para la operación copyModelTo de ejecución prolongada |
| CurrencyValueOutput |
Valor del campo moneda. |
| CustomDocumentModelsDetailsOutput |
Detalles relacionados con los modelos de documentos personalizados. |
| DeleteClassifier204Headers | |
| DeleteClassifier204Response |
No hay contenido que enviar para esta solicitud, pero los encabezados pueden ser útiles. |
| DeleteClassifierDefaultResponse | |
| DeleteClassifierHeaderParam | |
| DeleteClassifierHeaders | |
| DeleteModel204Headers | |
| DeleteModel204Response |
No hay contenido que enviar para esta solicitud, pero los encabezados pueden ser útiles. |
| DeleteModelDefaultResponse | |
| DeleteModelHeaderParam | |
| DeleteModelHeaders | |
| DocumentBarcodeOutput |
Objeto de código de barras. |
| DocumentCaptionOutput |
Objeto subtítulo que describe una tabla o una figura. |
| DocumentClassifierBuildOperationDetailsOutput |
Obtiene el objeto de respuesta Operation. |
| DocumentClassifierDetailsOutput |
Información del clasificador de documentos. |
| DocumentFieldOutput |
Objeto que representa el contenido y la ubicación de un valor de campo. |
| DocumentFieldSchemaOutput |
Descripción del esquema semántico de campo mediante una sintaxis de estilo de esquema JSON. |
| DocumentFigureOutput |
Objeto que representa una figura del documento. |
| DocumentFootnoteOutput |
Objeto de nota al pie que describe una tabla o una figura. |
| DocumentFormulaOutput |
Objeto de fórmula. |
| DocumentKeyValueElementOutput |
Objeto que representa la clave de campo o el valor en un par clave-valor. |
| DocumentKeyValuePairOutput |
Objeto que representa un campo de formulario con una etiqueta de campo (clave) y un valor de campo distintos (puede estar vacío). |
| DocumentLanguageOutput |
Objeto que representa el idioma detectado para un intervalo de texto determinado. |
| DocumentLineOutput |
Objeto de línea de contenido que consta de una secuencia adyacente de elementos de contenido, como palabras y marcas de selección. |
| DocumentListItemOutput |
Objeto que representa un elemento de lista en el documento. |
| DocumentListOutput |
Objeto que representa una lista en el documento. |
| DocumentModelBuildOperationDetailsOutput |
Obtiene el objeto de respuesta Operation. |
| DocumentModelComposeOperationDetailsOutput |
Obtiene el objeto de respuesta Operation. |
| DocumentModelCopyToOperationDetailsOutput |
Obtiene el objeto de respuesta Operation. |
| DocumentModelDetailsOutput |
Información del modelo de documento. |
| DocumentOutput |
Objeto que describe la ubicación y el contenido semántico de un documento. |
| DocumentPageOutput |
Elementos de contenido y diseño extraídos de una página de la entrada. |
| DocumentParagraphOutput |
Un objeto de párrafo que consta de líneas contiguas generalmente con alineación y espaciado comunes. |
| DocumentSectionOutput |
Objeto que representa una sección del documento. |
| DocumentSelectionMarkOutput |
Objeto de marca de selección que representa casillas, botones de radio y otros elementos que indican una selección. |
| DocumentSpanOutput |
Región contigua de la propiedad de contenido concatenada, especificada como desplazamiento y longitud. |
| DocumentStyleOutput |
Objeto que representa estilos de texto observados. |
| DocumentTableCellOutput |
Objeto que representa la ubicación y el contenido de una celda de tabla. |
| DocumentTableOutput |
Objeto de tabla que consta de celdas de tabla organizadas en un diseño rectangular. |
| DocumentTypeDetailsOutput |
Información de tipo de documento. |
| DocumentWordOutput |
Objeto de palabra que consta de una secuencia contigua de caracteres. Para idiomas no delimitados por espacios, como chino, japonés y coreano, cada carácter se representa como su propia palabra. |
| ErrorModelOutput |
Objeto de error. |
| ErrorResponseOutput |
Objeto de respuesta de error. |
| GetAnalyzeResult | |
| GetAnalyzeResult200Response |
La solicitud se ha realizado correctamente. |
| GetAnalyzeResultDefaultResponse | |
| GetClassifier | |
| GetClassifier200Headers | |
| GetClassifier200Response |
La solicitud se ha realizado correctamente. |
| GetClassifierDefaultResponse | |
| GetClassifierHeaderParam | |
| GetClassifierHeaders | |
| GetClassifyResult | |
| GetClassifyResult200Response |
La solicitud se ha realizado correctamente. |
| GetClassifyResultDefaultResponse | |
| GetDocumentClassifierBuildOperation200Headers | |
| GetDocumentClassifierBuildOperation200Response |
La solicitud se ha realizado correctamente. |
| GetDocumentClassifierBuildOperationDefaultResponse | |
| GetDocumentClassifierBuildOperationHeaderParam | |
| GetDocumentClassifierBuildOperationHeaders | |
| GetDocumentModelBuildOperation | |
| GetDocumentModelBuildOperation200Headers | |
| GetDocumentModelBuildOperation200Response |
La solicitud se ha realizado correctamente. |
| GetDocumentModelBuildOperationDefaultResponse | |
| GetDocumentModelBuildOperationHeaderParam | |
| GetDocumentModelBuildOperationHeaders | |
| GetDocumentModelComposeOperation200Headers | |
| GetDocumentModelComposeOperation200Response |
La solicitud se ha realizado correctamente. |
| GetDocumentModelComposeOperationDefaultResponse | |
| GetDocumentModelComposeOperationHeaderParam | |
| GetDocumentModelComposeOperationHeaders | |
| GetDocumentModelCopyToOperation200Headers | |
| GetDocumentModelCopyToOperation200Response |
La solicitud se ha realizado correctamente. |
| GetDocumentModelCopyToOperationDefaultResponse | |
| GetDocumentModelCopyToOperationHeaderParam | |
| GetDocumentModelCopyToOperationHeaders | |
| GetModel | |
| GetModel200Headers | |
| GetModel200Response |
La solicitud se ha realizado correctamente. |
| GetModelDefaultResponse | |
| GetModelHeaderParam | |
| GetModelHeaders | |
| GetOperation200Headers | |
| GetOperation200Response |
La solicitud se ha realizado correctamente. |
| GetOperationDefaultResponse | |
| GetOperationHeaderParam | |
| GetOperationHeaders | |
| GetResourceInfo | |
| GetResourceInfo200Response |
La solicitud se ha realizado correctamente. |
| GetResourceInfoDefaultResponse | |
| InnerErrorOutput |
Objeto que contiene información más específica sobre el error. |
| ListClassifiers | |
| ListClassifiers200Headers | |
| ListClassifiers200Response |
La solicitud se ha realizado correctamente. |
| ListClassifiersDefaultResponse | |
| ListClassifiersHeaderParam | |
| ListClassifiersHeaders | |
| ListModels | |
| ListModels200Headers | |
| ListModels200Response |
La solicitud se ha realizado correctamente. |
| ListModelsDefaultResponse | |
| ListModelsHeaderParam | |
| ListModelsHeaders | |
| ListOperations | |
| ListOperations200Headers | |
| ListOperations200Response |
La solicitud se ha realizado correctamente. |
| ListOperationsDefaultResponse | |
| ListOperationsHeaderParam | |
| ListOperationsHeaders | |
| OperationDetailsOutputParent |
Información de la operación. |
| PagingOptions |
Opciones para el asistente de paginación |
| QuotaDetailsOutput |
Cuota usada, límite y siguiente restablecimiento de fecha y hora. |
| ResourceDetailsOutput |
Información general sobre el recurso actual. |
| Routes | |
| WarningOutput |
Objeto de error. |
Alias de tipos
Funciones
Detalles de la función
default(string, TokenCredential | KeyCredential, ClientOptions)
Inicialización de una nueva instancia de DocumentIntelligenceClient
function default(endpoint: string, credentials: TokenCredential | KeyCredential, options?: ClientOptions): DocumentIntelligenceClientParámetros
- endpoint
-
string
Punto de conexión del servicio Document Intelligence.
- credentials
identificar de forma única las credenciales de cliente
- options
- ClientOptions
el parámetro para todos los parámetros opcionales
Devoluciones
getLongRunningPoller<TResult>(Client, BuildModelDefaultResponse | BuildModel202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
Función auxiliar que crea un objeto Poller para ayudar a sondear una operación de larga duración.
function getLongRunningPoller<TResult>(client: Client, initialResponse: BuildModelDefaultResponse | BuildModel202Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>Parámetros
- client
- Client
Cliente que se va a usar para enviar la solicitud para obtener páginas adicionales.
- initialResponse
Respuesta inicial.
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Opciones para establecer un estado de reanudación o un intervalo de sondeo personalizado.
Devoluciones
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
- Objeto de sondeo para sondear las actualizaciones de estado de la operación y, finalmente, obtener la respuesta final.
getLongRunningPoller<TResult>(Client, ComposeModelDefaultResponse | ComposeModel202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
function getLongRunningPoller<TResult>(client: Client, initialResponse: ComposeModelDefaultResponse | ComposeModel202Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>Parámetros
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Devoluciones
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
getLongRunningPoller<TResult>(Client, CopyModelToDefaultResponse | CopyModelTo202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
function getLongRunningPoller<TResult>(client: Client, initialResponse: CopyModelToDefaultResponse | CopyModelTo202Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>Parámetros
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Devoluciones
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
getLongRunningPoller<TResult>(Client, BuildClassifierDefaultResponse | BuildClassifier202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
function getLongRunningPoller<TResult>(client: Client, initialResponse: BuildClassifierDefaultResponse | BuildClassifier202Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>Parámetros
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Devoluciones
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
getLongRunningPoller<TResult>(Client, AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStream202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
function getLongRunningPoller<TResult>(client: Client, initialResponse: AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStream202Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>Parámetros
- client
- Client
- initialResponse
-
AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStream202Response
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Devoluciones
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
getLongRunningPoller<TResult>(Client, ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStream202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
function getLongRunningPoller<TResult>(client: Client, initialResponse: ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStream202Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>Parámetros
- client
- Client
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Devoluciones
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
isUnexpected(ListOperations200Response | ListOperationsDefaultResponse)
function isUnexpected(response: ListOperations200Response | ListOperationsDefaultResponse): responseParámetros
Devoluciones
response
isUnexpected(GetDocumentModelBuildOperation200Response | GetDocumentModelComposeOperation200Response | GetDocumentModelCopyToOperation200Response | GetDocumentClassifierBuildOperation200Response | GetOperation200Response | GetDocumentModelBuildOperationDefaultResponse)
function isUnexpected(response: GetDocumentModelBuildOperation200Response | GetDocumentModelComposeOperation200Response | GetDocumentModelCopyToOperation200Response | GetDocumentClassifierBuildOperation200Response | GetOperation200Response | GetDocumentModelBuildOperationDefaultResponse): responseParámetros
Devoluciones
response
isUnexpected(GetResourceInfo200Response | GetResourceInfoDefaultResponse)
function isUnexpected(response: GetResourceInfo200Response | GetResourceInfoDefaultResponse): responseParámetros
Devoluciones
response
isUnexpected(GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse)
function isUnexpected(response: GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse): responseParámetros
Devoluciones
response
isUnexpected(AnalyzeDocumentFromStreamLogicalResponse | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStream202Response | AnalyzeDocument202Response | AnalyzeDocumentLogicalResponse)
function isUnexpected(response: AnalyzeDocumentFromStreamLogicalResponse | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStream202Response | AnalyzeDocument202Response | AnalyzeDocumentLogicalResponse): responseParámetros
Devoluciones
response
isUnexpected(GetModel200Response | GetModelDefaultResponse)
function isUnexpected(response: GetModel200Response | GetModelDefaultResponse): responseParámetros
- response
Devoluciones
response
isUnexpected(DeleteModel204Response | DeleteModelDefaultResponse)
function isUnexpected(response: DeleteModel204Response | DeleteModelDefaultResponse): responseParámetros
- response
Devoluciones
response
isUnexpected(BuildModelLogicalResponse | BuildModelDefaultResponse | BuildModel202Response)
function isUnexpected(response: BuildModelLogicalResponse | BuildModelDefaultResponse | BuildModel202Response): responseParámetros
Devoluciones
response
isUnexpected(ComposeModelLogicalResponse | ComposeModelDefaultResponse | ComposeModel202Response)
function isUnexpected(response: ComposeModelLogicalResponse | ComposeModelDefaultResponse | ComposeModel202Response): responseParámetros
Devoluciones
response
isUnexpected(AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse)
function isUnexpected(response: AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse): responseParámetros
Devoluciones
response
isUnexpected(CopyModelToLogicalResponse | CopyModelToDefaultResponse | CopyModelTo202Response)
function isUnexpected(response: CopyModelToLogicalResponse | CopyModelToDefaultResponse | CopyModelTo202Response): responseParámetros
Devoluciones
response
isUnexpected(ListModels200Response | ListModelsDefaultResponse)
function isUnexpected(response: ListModels200Response | ListModelsDefaultResponse): responseParámetros
- response
Devoluciones
response
isUnexpected(BuildClassifierLogicalResponse | BuildClassifierDefaultResponse | BuildClassifier202Response)
function isUnexpected(response: BuildClassifierLogicalResponse | BuildClassifierDefaultResponse | BuildClassifier202Response): responseParámetros
Devoluciones
response
isUnexpected(ListClassifiers200Response | ListClassifiersDefaultResponse)
function isUnexpected(response: ListClassifiers200Response | ListClassifiersDefaultResponse): responseParámetros
Devoluciones
response
isUnexpected(GetClassifier200Response | GetClassifierDefaultResponse)
function isUnexpected(response: GetClassifier200Response | GetClassifierDefaultResponse): responseParámetros
Devoluciones
response
isUnexpected(DeleteClassifier204Response | DeleteClassifierDefaultResponse)
function isUnexpected(response: DeleteClassifier204Response | DeleteClassifierDefaultResponse): responseParámetros
Devoluciones
response
isUnexpected(ClassifyDocumentFromStreamLogicalResponse | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStream202Response | ClassifyDocument202Response | ClassifyDocumentLogicalResponse)
function isUnexpected(response: ClassifyDocumentFromStreamLogicalResponse | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStream202Response | ClassifyDocument202Response | ClassifyDocumentLogicalResponse): responseParámetros
Devoluciones
response
isUnexpected(GetClassifyResult200Response | GetClassifyResultDefaultResponse)
function isUnexpected(response: GetClassifyResult200Response | GetClassifyResultDefaultResponse): responseParámetros
Devoluciones
response
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)
Asistente para paginar los resultados de una respuesta inicial que sigue la especificación de la extensión Autorest x-ms-pageable
function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>Parámetros
- client
- Client
Cliente que se va a usar para enviar las solicitudes de la página siguiente
- initialResponse
-
TResponse
Respuesta inicial que contiene la página nextLink y la página actual de elementos
- options
-
PagingOptions<TResponse>
Devoluciones
PagedAsyncIterableIterator<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator para iterar los elementos
Azure SDK for JavaScript
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de