你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Analyze Documents Submit Job - Analyze Documents Submit Job

参考

服务:: Azure AI Services

API 版本:: 2023-11-15-preview

提交用于分析的文本文档的集合。指定要作为长时间运行的操作执行的一个或多个唯一任务。

POST {Endpoint}/language/analyze-documents/jobs?api-version=2023-11-15-preview

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string	支持的认知服务终结点（例如 https://.api.cognitiveservices.azure.com).
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。

请求头

名称	必需	类型	说明
Ocp-Apim-Subscription-Key	True	string

请求正文

名称	必需	类型	说明
analysisInput	True	MultiLanguageAnalysisInput	包含要分析的输入。
tasks	True	AnalyzeDocumentsLROTask[]: AbstractiveSummarizationLROTask[] ExtractiveSummarizationLROTask[] PiiLROTask[]	要作为 LRO 的一部分执行的任务的列表。
defaultLanguage		string	要用于记录的默认语言。
displayName		string	任务的名称。

响应

名称	类型	说明
202 Accepted		已接受请求进行处理，但尚未完成处理。标头 Operation-Location: string
Other Status Codes	ErrorResponse	意外的错误响应。标头 x-ms-error-code: string

名称

类型

说明

202 Accepted

已接受请求进行处理，但尚未完成处理。

标头

Operation-Location: string

Other Status Codes

ErrorResponse

意外的错误响应。

标头

x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

示例

SuccessfulAnalyzeDocumentsJobsTaskSubmitRequest

示例请求

HTTP

POST {Endpoint}/language/analyze-documents/jobs?api-version=2023-11-15-preview


{
  "displayName": "Redact PII Example",
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "source": {
          "location": "https://myblob.blob.core.windows.net/Container/document.txt",
          "kind": "AzureBlob",
          "managedIdentityClientId": "edaa610c-d7e8-4ba2-823a-97d871d661fb"
        },
        "target": {
          "location": "https://myblob.blob.core.windows.net/Container",
          "kind": "AzureBlob"
        }
      }
    ]
  },
  "tasks": [
    {
      "kind": "PiiEntityRecognition",
      "taskName": "Redact PII Task 1",
      "parameters": {
        "redactionCharacter": "-",
        "piiCategories": [
          "Person",
          "Organization"
        ]
      }
    }
  ]
}

示例响应

状态代码:: 202

Operation-Location: {endpoint}/language/analyze-documents/jobs/{jobId}?api-version=2023-11-15-preview

定义

名称	说明
AbstractiveSummarizationLROTask	一个对象，表示抽象摘要任务的任务定义。
AbstractiveSummarizationTaskParameters	预生成的抽象摘要任务支持的参数。
AnalyzeDocumentJobsInput	分析文档 LRO 的输入对象。
AnalyzeDocumentsLROTaskKind	支持的长时间运行的分析文档任务的类型。
AzureBlobDocumentLocation	Azure Blob 的文档位置。
DocumentLocationKind	支持的文档位置的枚举。
Error	服务在处理请求期间遇到一些错误时返回的错误响应对象。
ErrorCode	人工可读错误代码。
ErrorResponse	错误响应。
ExtractiveSummarizationLROTask	一个对象，表示提取摘要任务的任务定义。
ExtractiveSummarizationSortingCriteria	指定如何对提取的摘要进行排序。
ExtractiveSummarizationTaskParameters	提取摘要任务支持的参数。
InnerErrorCode	人工可读错误代码。
InnerErrorModel	包含有关错误的更具体信息的对象。根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
MultiLanguageAnalysisInput	要由服务分析的输入文档的集合。
MultiLanguageInput	包含要由服务分析的输入文档。
PiiCategoriesExclude	（可选）描述要返回的 PII 类别
PiiCategory	（可选）描述要返回的 PII 类别
PiiDomain	PII 任务的域
PiiLROTask	包含分析文本 PIIEntityRecognition LRO 任务。
PiiTaskParameters	PII 实体识别任务支持的参数。
redactionCharacter	要用于编修的字符。默认值为“*”。
StringIndexType	字符串索引类型
SummaryLengthBucket	定义输出摘要长度的枚举。

AbstractiveSummarizationLROTask

Object

一个对象，表示抽象摘要任务的任务定义。

名称	类型	说明
kind	string: AbstractiveSummarization	要执行的任务类型。
parameters	AbstractiveSummarizationTaskParameters	抽象摘要任务的参数。
taskName	string	任务名称

AbstractiveSummarizationTaskParameters

Object

预生成的抽象摘要任务支持的参数。

名称	类型	默认值	说明
loggingOptOut	boolean	False	日志记录选择退出
modelVersion	string	latest	模型版本
query	string		（可选）如果提供，查询将用于生成摘要。
sentenceCount	integer (int32)		控制输出摘要中的大致句子数。
stringIndexType	StringIndexType	TextElements_v8	字符串索引类型
summaryLength	SummaryLengthBucket		（注意：建议使用 summaryLength over sentenceCount）控制输出摘要的大致长度。

AnalyzeDocumentJobsInput

Object

分析文档 LRO 的输入对象。

名称	类型	说明
analysisInput	MultiLanguageAnalysisInput	包含要分析的输入。
defaultLanguage	string	要用于记录的默认语言。
displayName	string	任务的名称。
tasks	AnalyzeDocumentsLROTask[]: AbstractiveSummarizationLROTask[] ExtractiveSummarizationLROTask[] PiiLROTask[]	要作为 LRO 的一部分执行的任务的列表。

AnalyzeDocumentsLROTaskKind

枚举

支持的长时间运行的分析文档任务的类型。

值	说明
AbstractiveSummarization	抽象摘要任务
ExtractiveSummarization	提取摘要任务
PiiEntityRecognition	PII 实体识别任务

AzureBlobDocumentLocation

Object

Azure Blob 的文档位置。

名称	类型	说明
kind	string: AzureBlob	文档位置的类型。
location	string	文档的位置。
managedIdentityClientId	string	用于对存储帐户进行身份验证的用户托管标识客户端 ID

DocumentLocationKind

枚举

支持的文档位置的枚举。

值	说明
AzureBlob	文档是 URL。

Error

Object

服务在处理请求期间遇到一些错误时返回的错误响应对象。

名称	类型	说明
code	ErrorCode	服务器定义的错误代码集之一。
details	Error[]	导致此报告错误的特定错误的详细信息数组。
innererror	InnerErrorModel	包含与当前对象有关错误的更具体信息的对象。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

ErrorCode

枚举

人工可读错误代码。

值	说明
AzureCognitiveSearchIndexLimitReached	Azure 认知搜索索引限制达到错误
AzureCognitiveSearchIndexNotFound	Azure 认知搜索索引找不到错误
AzureCognitiveSearchNotFound	Azure 认知搜索找不到错误
AzureCognitiveSearchThrottling	Azure 认知搜索限制错误
Conflict	冲突错误
Forbidden	禁止访问错误
InternalServerError	内部服务器错误
InvalidArgument	参数错误无效
InvalidRequest	请求错误无效
NotFound	找不到错误
OperationNotFound	找不到操作错误
ProjectNotFound	项目找不到错误
QuotaExceeded	超出配额错误
ServiceUnavailable	服务不可用错误
Timeout	超时错误
TooManyRequests	请求过多错误
Unauthorized	未经授权的访问错误
Warning	警告错误

ErrorResponse

Object

错误响应。

名称	类型	说明
error	Error	错误对象。

ExtractiveSummarizationLROTask

Object

一个对象，表示提取摘要任务的任务定义。

名称	类型	说明
kind	string: ExtractiveSummarization	要执行的任务类型。
parameters	ExtractiveSummarizationTaskParameters	提取摘要任务的参数。
taskName	string	任务名称

ExtractiveSummarizationSortingCriteria

枚举

指定如何对提取的摘要进行排序。

值	说明
Offset	指示结果应按文本外观顺序排序。
Rank	指示应按重要性顺序（即排名分数）根据模型对结果进行排序。

ExtractiveSummarizationTaskParameters

Object

提取摘要任务支持的参数。

名称	类型	默认值	说明
loggingOptOut	boolean	False	日志记录选择退出
modelVersion	string	latest	模型版本
query	string		（可选）如果提供，查询将用于从文档中提取最相关的句子。
sentenceCount	integer (int64)	3	指定提取摘要中的句子数。
sortBy	ExtractiveSummarizationSortingCriteria	Offset	指定如何对提取的摘要进行排序。
stringIndexType	StringIndexType	TextElements_v8	指定用于解释字符串偏移的方法。

InnerErrorCode

枚举

人工可读错误代码。

值	说明
AzureCognitiveSearchNotFound	Azure 认知搜索找不到错误
AzureCognitiveSearchThrottling	Azure 认知搜索限制错误
EmptyRequest	空请求错误
ExtractionFailure	提取失败错误
InvalidCountryHint	国家/地区提示错误无效
InvalidDocument	文档错误无效
InvalidDocumentBatch	文档批处理错误无效
InvalidParameterValue	参数值错误无效
InvalidRequest	请求错误无效
InvalidRequestBodyFormat	请求正文格式错误无效
KnowledgeBaseNotFound	知识库找不到错误
MissingInputDocuments	缺少输入文档错误
ModelVersionIncorrect	模型版本错误错误
UnsupportedLanguageCode	不支持的语言代码错误

InnerErrorModel

Object

包含有关错误的更具体信息的对象。根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名称	类型	说明
code	InnerErrorCode	服务器定义的错误代码集之一。
details	object	错误详细信息。
innererror	InnerErrorModel	包含与当前对象有关错误的更具体信息的对象。
message	string	Error message.
target	string	错误目标。

MultiLanguageAnalysisInput

Object

要由服务分析的输入文档的集合。

名称	类型	说明
documents	MultiLanguageInput[]	要分析的输入文档。

MultiLanguageInput

Object

包含要由服务分析的输入文档。

名称	类型	说明
id	string	唯一的非空文档标识符。
language	string	（可选）这是语言的 2 个字母 ISO 639-1 表示形式。例如，将“en”用于英语;西班牙语等的“es”。如果未设置，请将“en”用于英语作为默认值。
source	DocumentLocation: AzureBlobDocumentLocation	要处理的输入文档的位置。
target	DocumentLocation: AzureBlobDocumentLocation	将存储已处理文档的位置。

PiiCategoriesExclude

枚举

（可选）描述要返回的 PII 类别

值	说明
ABARoutingNumber	ABA 路由编号
ARNationalIdentityNumber	AR 国家标识号
ATIdentityCard	AT 标识卡
ATTaxIdentificationNumber	AT 税务标识号
ATValueAddedTaxNumber	AT 增值税号码
AUBankAccountNumber	AT 标识卡
AUBusinessNumber	AU 业务编号
AUCompanyNumber	AU 公司编号
AUDriversLicenseNumber	AU 驾照编号
AUMedicalAccountNumber	AU 医疗帐户号
AUPassportNumber	AU Passport 号码
AUTaxFileNumber	AU 税务文件编号
Address	地址
Age	年龄
AzureDocumentDBAuthKey	Azure Document DB 身份验证密钥
AzureIAASDatabaseConnectionAndSQLString	Azure IAAS 数据库连接和 SQL 字符串
AzureIoTConnectionString	Azure IoT 连接字符串
AzurePublishSettingPassword	Azure 发布设置密码
AzureRedisCacheString	Azure Redis 缓存字符串
AzureSAS	Azure SAS
AzureServiceBusString	Azure 服务总线字符串
AzureStorageAccountGeneric	Azure 存储帐户通用
AzureStorageAccountKey	Azure 存储帐户密钥
BENationalNumber	BE National Number
BENationalNumberV2	BE National Number V2
BEValueAddedTaxNumber	BE 增值税号码
BGUniformCivilNumber	BG 统一民用号码
BRCPFNumber	BR CPF 编号
BRLegalEntityNumber	BR 法律实体编号
BRNationalIDRG	BR 国家 ID RG
CABankAccountNumber	CA 银行帐户号
CADriversLicenseNumber	CA 驱动程序许可证号
CAHealthServiceNumber	CA 运行状况服务编号
CAPassportNumber	CA Passport 号码
CAPersonalHealthIdentification	CA 个人运行状况标识
CASocialInsuranceNumber	CA 社会保险号码
CHSocialSecurityNumber	CH 社会保险号码
CLIdentityCardNumber	CL 标识卡号
CNResidentIdentityCardNumber	CN 居民身份证号
CYIdentityCard	CY 标识卡
CYTaxIdentificationNumber	CY 税务标识号
CZPersonalIdentityNumber	CZ 个人标识号
CZPersonalIdentityV2	CZ 个人标识 V2
CreditCardNumber	信用卡号
DEDriversLicenseNumber	DE Driver's License Number
DEIdentityCardNumber	DE Identity Card Number
DEPassportNumber	DE Passport 号码
DETaxIdentificationNumber	DE 税务标识号
DEValueAddedNumber	DE Value Added Number
DKPersonalIdentificationNumber	DK 个人标识号
DKPersonalIdentificationV2	DK 个人标识 V2
Date	日期
DrugEnforcementAgencyNumber	毒品执法局号码
EEPersonalIdentificationCode	EE 个人标识代码
ESDNI	ES DNI
ESSocialSecurityNumber	ES 社会保险号码
ESTaxIdentificationNumber	ES 税务标识号
EUDebitCardNumber	欧盟借记卡号码
EUDriversLicenseNumber	欧盟驾照编号
EUGPSCoordinates	欧盟 GPS 坐标
EUNationalIdentificationNumber	欧盟国家标识号
EUPassportNumber	欧盟护照号码
EUSocialSecurityNumber	欧盟社会保障号码
EUTaxIdentificationNumber	欧盟税务标识号
Email	电子邮件
FIEuropeanHealthNumber	FI 欧洲健康号码
FINationalID	FI 国家/地区 ID
FINationalIDV2	FI 国家/地区 ID V2
FIPassportNumber	FI Passport 号码
FRDriversLicenseNumber	FR 驱动程序许可证号
FRHealthInsuranceNumber	FR 健康保险号码
FRNationalID	FR 国家/地区 ID
FRPassportNumber	FR Passport 号码
FRSocialSecurityNumber	FR 社会保险号码
FRTaxIdentificationNumber	FR 税务标识号
FRValueAddedTaxNumber	FR 增值税号
GRNationalIDCard	GR 国家 ID 卡
GRNationalIDV2	GR 国家/地区 ID V2
GRTaxIdentificationNumber	GR 税务标识号
HKIdentityCardNumber	HK 身份证号码
HRIdentityCardNumber	HR 标识卡号
HRNationalIDNumber	HR 国家/地区 ID 编号
HRPersonalIdentificationNumber	HR 个人标识号
HRPersonalIdentificationOIBNumberV2	HR 个人标识 OIB 号码 V2
HUPersonalIdentificationNumber	胡个人标识号
HUTaxIdentificationNumber	胡税务标识号
HUValueAddedNumber	胡增值数字
IDIdentityCardNumber	ID 标识卡号
IEPersonalPublicServiceNumber	IE 个人公共服务号码
IEPersonalPublicServiceNumberV2	IE 个人公共服务号码 V2
ILBankAccountNumber	IL 银行帐户号
ILNationalID	IL 国家/地区 ID
INPermanentAccount	IN 永久帐户
INUniqueIdentificationNumber	IN 唯一标识号
IPAddress	IP地址
ITDriversLicenseNumber	IT 驱动程序的许可证号
ITFiscalCode	IT 会计代码
ITValueAddedTaxNumber	IT 增值税号
InternationalBankingAccountNumber	国际银行帐户编号
JPBankAccountNumber	JP 银行帐户编号
JPDriversLicenseNumber	JP 驱动程序许可证号
JPMyNumberCorporate	JP 我的号码公司
JPMyNumberPersonal	JP 我的号码个人
JPPassportNumber	JP Passport 号码
JPResidenceCardNumber	JP 住宅卡号码
JPResidentRegistrationNumber	JP 居民注册号
JPSocialInsuranceNumber	JP 社会保险号码
KRResidentRegistrationNumber	KR 居民注册号码
LTPersonalCode	LT 个人代码
LUNationalIdentificationNumberNatural	LU 国家标识号自然
LUNationalIdentificationNumberNonNatural	LU 国家标识号非自然
LVPersonalCode	LV 个人代码
MTIdentityCardNumber	MT 标识卡号
MTTaxIDNumber	MT 税号
MYIdentityCardNumber	MY Identity Card Number
NLCitizensServiceNumber	NL 公民服务号码
NLCitizensServiceNumberV2	NL 公民服务号码 V2
NLTaxIdentificationNumber	NL 税务标识号
NLValueAddedTaxNumber	NL 增值税号
NOIdentityNumber	NO 标识号
NZBankAccountNumber	NZ Bank 帐户编号
NZDriversLicenseNumber	NZ Driver's License Number
NZInlandRevenueNumber	NZ 内陆收入号码
NZMinistryOfHealthNumber	新西兰卫生部号码
NZSocialWelfareNumber	NZ 社会福利号码
Organization	组织
PHUnifiedMultiPurposeIDNumber	PH 统一多用途 ID 号
PLIdentityCard	PL 标识卡
PLNationalID	PL 国家 ID
PLNationalIDV2	PL 国家 ID V2
PLPassportNumber	PL Passport 号码
PLREGONNumber	PL REGON 编号
PLTaxIdentificationNumber	PL 税务标识号
PTCitizenCardNumber	PT 公民卡号码
PTCitizenCardNumberV2	PT 公民卡号码 V2
PTTaxIdentificationNumber	PT 税务标识号
Person	人员
PhoneNumber	电话号码
ROPersonalNumericalCode	RO 个人数字代码
RUPassportNumberDomestic	RU Passport 号码国内
RUPassportNumberInternational	RU Passport 号码国际
SANationalID	SA 国家/地区 ID
SENationalID	SE 国家/地区 ID
SENationalIDV2	SE 国家 ID V2
SEPassportNumber	SE Passport 号码
SETaxIdentificationNumber	SE 税务标识号
SGNationalRegistrationIdentityCardNumber	SG 国家注册身份证号
SITaxIdentificationNumber	SI 税务标识号
SIUniqueMasterCitizenNumber	SI 唯一主公民号码
SKPersonalNumber	SK 个人号码
SQLServerConnectionString	SQL Server 连接字符串
SWIFTCode	SWIFT 代码
THPopulationIdentificationCode	TH 总体标识代码
TRNationalIdentificationNumber	TR 国家标识号
TWNationalID	TW 国家/地区 ID
TWPassportNumber	TW Passport 号码
TWResidentCertificate	TW 居民证书
UAPassportNumberDomestic	UA 护照号码国内
UAPassportNumberInternational	UA Passport Number International
UKDriversLicenseNumber	英国驾照编号
UKElectoralRollNumber	英国选举卷编号
UKNationalHealthNumber	英国国民健康号码
UKNationalInsuranceNumber	英国国民保险号码
UKUniqueTaxpayerNumber	英国唯一纳税人号码
URL	网址
USBankAccountNumber	美国银行帐户号
USDriversLicenseNumber	美国驾照编号
USIndividualTaxpayerIdentification	美国个人纳税人身份
USSocialSecurityNumber	美国社会保险号码
USUKPassportNumber	美国英国护照号码
ZAIdentificationNumber	ZA 标识号

PiiCategory

枚举

（可选）描述要返回的 PII 类别

值	说明
ABARoutingNumber	ABA 路由编号
ARNationalIdentityNumber	AR 国家标识号
ATIdentityCard	AT 标识卡
ATTaxIdentificationNumber	AT 税务标识号
ATValueAddedTaxNumber	AT 增值税号码
AUBankAccountNumber	AT 标识卡
AUBusinessNumber	AU 业务编号
AUCompanyNumber	AU 公司编号
AUDriversLicenseNumber	AU 驾照编号
AUMedicalAccountNumber	AU 医疗帐户号
AUPassportNumber	AU Passport 号码
AUTaxFileNumber	AU 税务文件编号
Address	地址
Age	年龄
All	所有 PII 类别。
AzureDocumentDBAuthKey	Azure Document DB 身份验证密钥
AzureIAASDatabaseConnectionAndSQLString	Azure IAAS 数据库连接和 SQL 字符串
AzureIoTConnectionString	Azure IoT 连接字符串
AzurePublishSettingPassword	Azure 发布设置密码
AzureRedisCacheString	Azure Redis 缓存字符串
AzureSAS	Azure SAS
AzureServiceBusString	Azure 服务总线字符串
AzureStorageAccountGeneric	Azure 存储帐户通用
AzureStorageAccountKey	Azure 存储帐户密钥
BENationalNumber	BE National Number
BENationalNumberV2	BE National Number V2
BEValueAddedTaxNumber	BE 增值税号码
BGUniformCivilNumber	BG 统一民用号码
BRCPFNumber	BR CPF 编号
BRLegalEntityNumber	BR 法律实体编号
BRNationalIDRG	BR 国家 ID RG
CABankAccountNumber	CA 银行帐户号
CADriversLicenseNumber	CA 驱动程序许可证号
CAHealthServiceNumber	CA 运行状况服务编号
CAPassportNumber	CA Passport 号码
CAPersonalHealthIdentification	CA 个人运行状况标识
CASocialInsuranceNumber	CA 社会保险号码
CHSocialSecurityNumber	CH 社会保险号码
CLIdentityCardNumber	CL 标识卡号
CNResidentIdentityCardNumber	CN 居民身份证号
CYIdentityCard	CY 标识卡
CYTaxIdentificationNumber	CY 税务标识号
CZPersonalIdentityNumber	CZ 个人标识号
CZPersonalIdentityV2	CZ 个人标识 V2
CreditCardNumber	信用卡号
DEDriversLicenseNumber	DE Driver's License Number
DEIdentityCardNumber	DE Identity Card Number
DEPassportNumber	DE Passport 号码
DETaxIdentificationNumber	DE 税务标识号
DEValueAddedNumber	DE Value Added Number
DKPersonalIdentificationNumber	DK 个人标识号
DKPersonalIdentificationV2	DK 个人标识 V2
Date	日期
Default	语言的默认 PII 类别。
DrugEnforcementAgencyNumber	毒品执法局号码
EEPersonalIdentificationCode	EE 个人标识代码
ESDNI	ES DNI
ESSocialSecurityNumber	ES 社会保险号码
ESTaxIdentificationNumber	ES 税务标识号
EUDebitCardNumber	欧盟借记卡号码
EUDriversLicenseNumber	欧盟驾照编号
EUGPSCoordinates	欧盟 GPS 坐标
EUNationalIdentificationNumber	欧盟国家标识号
EUPassportNumber	欧盟护照号码
EUSocialSecurityNumber	欧盟社会保障号码
EUTaxIdentificationNumber	欧盟税务标识号
Email	电子邮件
FIEuropeanHealthNumber	FI 欧洲健康号码
FINationalID	FI 国家/地区 ID
FINationalIDV2	FI 国家/地区 ID V2
FIPassportNumber	FI Passport 号码
FRDriversLicenseNumber	FR 驱动程序许可证号
FRHealthInsuranceNumber	FR 健康保险号码
FRNationalID	FR 国家/地区 ID
FRPassportNumber	FR Passport 号码
FRSocialSecurityNumber	FR 社会保险号码
FRTaxIdentificationNumber	FR 税务标识号
FRValueAddedTaxNumber	FR 增值税号
GRNationalIDCard	GR 国家 ID 卡
GRNationalIDV2	GR 国家/地区 ID V2
GRTaxIdentificationNumber	GR 税务标识号
HKIdentityCardNumber	HK 身份证号码
HRIdentityCardNumber	HR 标识卡号
HRNationalIDNumber	HR 国家/地区 ID 编号
HRPersonalIdentificationNumber	HR 个人标识号
HRPersonalIdentificationOIBNumberV2	HR 个人标识 OIB 号码 V2
HUPersonalIdentificationNumber	胡个人标识号
HUTaxIdentificationNumber	胡税务标识号
HUValueAddedNumber	胡增值数字
IDIdentityCardNumber	ID 标识卡号
IEPersonalPublicServiceNumber	IE 个人公共服务号码
IEPersonalPublicServiceNumberV2	IE 个人公共服务号码 V2
ILBankAccountNumber	IL 银行帐户号
ILNationalID	IL 国家/地区 ID
INPermanentAccount	IN 永久帐户
INUniqueIdentificationNumber	IN 唯一标识号
IPAddress	IP地址
ITDriversLicenseNumber	IT 驱动程序的许可证号
ITFiscalCode	IT 会计代码
ITValueAddedTaxNumber	IT 增值税号
InternationalBankingAccountNumber	国际银行帐户编号
JPBankAccountNumber	JP 银行帐户编号
JPDriversLicenseNumber	JP 驱动程序许可证号
JPMyNumberCorporate	JP 我的号码公司
JPMyNumberPersonal	JP 我的号码个人
JPPassportNumber	JP Passport 号码
JPResidenceCardNumber	JP 住宅卡号码
JPResidentRegistrationNumber	JP 居民注册号
JPSocialInsuranceNumber	JP 社会保险号码
KRResidentRegistrationNumber	KR 居民注册号码
LTPersonalCode	LT 个人代码
LUNationalIdentificationNumberNatural	LU 国家标识号自然
LUNationalIdentificationNumberNonNatural	LU 国家标识号非自然
LVPersonalCode	LV 个人代码
MTIdentityCardNumber	MT 标识卡号
MTTaxIDNumber	MT 税号
MYIdentityCardNumber	MY Identity Card Number
NLCitizensServiceNumber	NL 公民服务号码
NLCitizensServiceNumberV2	NL 公民服务号码 V2
NLTaxIdentificationNumber	NL 税务标识号
NLValueAddedTaxNumber	NL 增值税号
NOIdentityNumber	NO 标识号
NZBankAccountNumber	NZ Bank 帐户编号
NZDriversLicenseNumber	NZ Driver's License Number
NZInlandRevenueNumber	NZ 内陆收入号码
NZMinistryOfHealthNumber	新西兰卫生部号码
NZSocialWelfareNumber	NZ 社会福利号码
Organization	组织
PHUnifiedMultiPurposeIDNumber	PH 统一多用途 ID 号
PLIdentityCard	PL 标识卡
PLNationalID	PL 国家 ID
PLNationalIDV2	PL 国家 ID V2
PLPassportNumber	PL Passport 号码
PLREGONNumber	PL REGON 编号
PLTaxIdentificationNumber	PL 税务标识号
PTCitizenCardNumber	PT 公民卡号码
PTCitizenCardNumberV2	PT 公民卡号码 V2
PTTaxIdentificationNumber	PT 税务标识号
Person	人员
PhoneNumber	电话号码
ROPersonalNumericalCode	RO 个人数字代码
RUPassportNumberDomestic	RU Passport 号码国内
RUPassportNumberInternational	RU Passport 号码国际
SANationalID	SA 国家/地区 ID
SENationalID	SE 国家/地区 ID
SENationalIDV2	SE 国家 ID V2
SEPassportNumber	SE Passport 号码
SETaxIdentificationNumber	SE 税务标识号
SGNationalRegistrationIdentityCardNumber	SG 国家注册身份证号
SITaxIdentificationNumber	SI 税务标识号
SIUniqueMasterCitizenNumber	SI 唯一主公民号码
SKPersonalNumber	SK 个人号码
SQLServerConnectionString	SQL Server 连接字符串
SWIFTCode	SWIFT 代码
THPopulationIdentificationCode	TH 总体标识代码
TRNationalIdentificationNumber	TR 国家标识号
TWNationalID	TW 国家/地区 ID
TWPassportNumber	TW Passport 号码
TWResidentCertificate	TW 居民证书
UAPassportNumberDomestic	UA 护照号码国内
UAPassportNumberInternational	UA Passport Number International
UKDriversLicenseNumber	英国驾照编号
UKElectoralRollNumber	英国选举卷编号
UKNationalHealthNumber	英国国民健康号码
UKNationalInsuranceNumber	英国国民保险号码
UKUniqueTaxpayerNumber	英国唯一纳税人号码
URL	网址
USBankAccountNumber	美国银行帐户号
USDriversLicenseNumber	美国驾照编号
USIndividualTaxpayerIdentification	美国个人纳税人身份
USSocialSecurityNumber	美国社会保险号码
USUKPassportNumber	美国英国护照号码
ZAIdentificationNumber	ZA 标识号

PiiDomain

枚举

PII 任务的域

值	说明
none	指示未指定域。
phi	指示应对个人运行状况信息域中的实体进行修订。

PiiLROTask

Object

包含分析文本 PIIEntityRecognition LRO 任务。

名称	类型	说明
kind	string: PiiEntityRecognition	要执行的任务类型。
parameters	PiiTaskParameters	Pii 任务参数。
taskName	string	任务名称

PiiTaskParameters

Object

PII 实体识别任务支持的参数。

名称	类型	默认值	说明
domain	PiiDomain	none	PII 任务的域
excludePiiCategories	PiiCategoriesExclude[]		要排除在响应中的 PII 类别的枚举。
loggingOptOut	boolean	False	日志记录选择退出
modelVersion	string	latest	模型版本
piiCategories	PiiCategory[]		将在响应中返回的 PII 类别的枚举。
redactionCharacter	redactionCharacter	*	要用于编修的字符。默认值为“*”。
stringIndexType	StringIndexType	TextElements_v8	要用于分析的 StringIndexType。

redactionCharacter

枚举

要用于编修的字符。默认值为“*”。

值	说明
!	感叹号字符
#	数字符号字符
$	美元符号字符
%	百分比符号字符
&	Ampersand 字符
*	星号字符
+	加号字符
-	减号字符
=	等于符号字符
?	问号字符
@	符号字符
^	插入符号字符
_	下划线字符
~	波形符

StringIndexType

枚举

字符串索引类型

值	说明
TextElements_v8	返回的偏移量和长度值将对应于文本Elements（Graphemes 和 Grapheme 群集），确认为 Unicode 8.0.0 标准。如果应用程序是用 .Net Framework 或 .Net Core 编写的，并且将使用 StringInfo，请使用此选项。
UnicodeCodePoint	返回的偏移量和长度值将对应于 Unicode 码位。如果使用支持 Unicode 的语言（例如 Python）编写应用程序，请使用此选项。
Utf16CodeUnit	返回的偏移量和长度值将对应于 UTF-16 代码单元。如果应用程序是用支持 Unicode 的语言（例如 Java、JavaScript）编写的，请使用此选项。

SummaryLengthBucket

枚举

定义输出摘要长度的枚举。

值	说明
long	指示模型生成更长的长度摘要。
medium	指示模型生成中等长度摘要。
short	指示模型生成较短的长度摘要。

通过

Analyze Documents Submit Job - Analyze Documents Submit Job

URI 参数

请求头

请求正文

响应

安全性

Ocp-Apim-Subscription-Key

示例

SuccessfulAnalyzeDocumentsJobsTaskSubmitRequest

示例请求

示例响应

定义

AbstractiveSummarizationLROTask

AbstractiveSummarizationTaskParameters

AnalyzeDocumentJobsInput

AnalyzeDocumentsLROTaskKind

AzureBlobDocumentLocation

DocumentLocationKind

Error

ErrorCode

ErrorResponse

ExtractiveSummarizationLROTask

ExtractiveSummarizationSortingCriteria

ExtractiveSummarizationTaskParameters

InnerErrorCode

InnerErrorModel

MultiLanguageAnalysisInput

MultiLanguageInput

PiiCategoriesExclude

PiiCategory

PiiDomain

PiiLROTask

PiiTaskParameters

redactionCharacter

StringIndexType

SummaryLengthBucket