通过

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

Ingestion Jobs - Get

  • 参考
Service:
Azure AI Services
API Version:
2024-05-01-preview

获取指定作业 ID 的详细信息。

GET {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2024-05-01-preview

URI 参数

名称 在 必需 类型 说明
endpoint
 path True

string

url

支持的认知服务终结点 (协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 帐户名称) 。
job-id
 path True

string

作业的 ID。
api-version
 query True

string

请求的 API 版本。

请求头

名称 必需 类型 说明
api-key True

string

在此处提供认知服务 Azure OpenAI 帐户密钥。

响应

名称 类型 说明
200 OK IngestionJob:

成功
Other Status Codes

ErrorResponse

出现了错误。

安全性

api-key

在此处提供认知服务 Azure OpenAI 帐户密钥。

Type: apiKey
In: header

示例

Get ingestion job

Sample Request

GET {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2024-05-01-preview

Sample Response

Status code:
200 
{
  "kind": "UserCompute",
  "jobId": "ingestion-job",
  "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev",
  "compute": {
    "kind": "ServerlessCompute"
  },
  "target": {
    "kind": "AzureAISearch",
    "connectionId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection"
  },
  "datasource": {
    "kind": "Dataset",
    "datasetId": "azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1",
    "datasetType": "uri_folder"
  }
}

定义

名称 说明
ACSIndex

ACS 索引。
BaseConnection

BaseConnection
ChunkingSettings

ChunkingSettings
ComputeType

计算类型。
ConnectionStringConnection

连接字符串连接。
ConnectionType

连接类型。
CosmosDBIndex

CosmosDB 索引。
CrawlingSettings

CrawlingSettings
CustomCompute

自定义计算。
DatasourceType

数据源类型。
DeploymentConnection

相对部署连接。
EndpointKeyConnection

终结点密钥连接。
EndpointMIConnection

终结点托管标识连接。
Error

错误
ErrorCode

ErrorCode
ErrorResponse

ErrorResponse
GenericEmbeddingSettings

ConnectionEmbeddingSettings
IngestionJobCompletionAction

完成操作。
IngestionJobSystemCompute
IngestionJobType

IngestionJobType
IngestionJobUserCompute
InnerError

InnerError
InnerErrorCode

InnerErrorCode
PineconeIndex

Pinecone Index。
ServerlessCompute

无服务器计算。
SystemComputeDatasource

SystemComputeDatasource
SystemComputeStorage

SystemComputeStorage
SystemComputeUrl

SystemComputeUrl
TargetType

目标类型。
UserComputeDataset

UserComputeStorage
UserComputeUrl

UserComputeUrl
WorkspaceConnection

AML 工作区连接。
WorkspaceConnectionEmbeddingSettings

WorkspaceConnectionEmbeddingSettings

ACSIndex

ACS 索引。

名称 类型 说明
connectionId

string

指向 ACS 索引的连接 ID。
kind string:

acs

目标类型。

BaseConnection

BaseConnection

名称 类型 说明
kind

ConnectionType

连接类型。

ChunkingSettings

ChunkingSettings

名称 类型 说明
maxChunkSizeInTokens

integer

ComputeType

计算类型。

名称 类型 说明
custom

string

自定义用户计算。
serverless

string

无服务器用户计算。

ConnectionStringConnection

连接字符串连接。

名称 类型 说明
connectionString

string

连接字符串
kind

ConnectionType

连接类型。

ConnectionType

连接类型。

名称 类型 说明
connectionString

string

连接字符串。
endpointKey

string

终结点和密钥连接。
endpointMI

string

终结点和托管标识。
workspace

string

AML 工作区连接。

CosmosDBIndex

CosmosDB 索引。

名称 类型 说明
collectionName

string

cosmos DB 集合的名称。
connectionId

string

指向 cosmos DB 的连接 ID。
databaseName

string

cosmos DB 数据库的名称。
kind string:

cosmosdb

目标类型。

CrawlingSettings

CrawlingSettings

名称 类型 说明
maxCrawlDepth

integer

maxCrawlTimeInMins

integer

maxDownloadTimeInMins

integer

maxFileSize

integer

maxFiles

integer

maxRedirects

integer

CustomCompute

自定义计算。

名称 类型 说明
computeId

string

自定义计算的 ID
kind string:

custom

计算类型。

DatasourceType

数据源类型。

名称 类型 说明
storage

string

Azure 存储帐户。
urls

string

URL。

DeploymentConnection

相对部署连接。

名称 类型 说明
kind

ConnectionType

连接类型。

EndpointKeyConnection

终结点密钥连接。

名称 类型 说明
endpoint

string

终结点
key

string

密钥
kind

ConnectionType

连接类型。

EndpointMIConnection

终结点托管标识连接。

名称 类型 说明
endpoint

string

终结点
kind

ConnectionType

连接类型。

Error

错误

名称 类型 说明
code

ErrorCode

ErrorCode
Microsoft REST 指南中定义的错误代码 (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) 。
details

Error[]

错误详细信息（如果可用）。
innererror

InnerError

InnerError
Microsoft REST 指南中定义的内部错误 (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) 。
message

string

此错误的消息。
target

string

发生错误的位置（如果可用）。

ErrorCode

ErrorCode

名称 类型 说明
conflict

string

请求的操作与当前资源状态冲突。
contentFilter

string

由于我们的安全系统，映像生成失败。
fileImportFailed

string

导入文件失败。
forbidden

string

当前用户/API 密钥禁止此操作。
internalFailure

string

内部错误。 请重试。
invalidPayload

string

此操作的请求数据无效。
itemDoesAlreadyExist

string

该项已存在。
jsonlValidationFailed

string

jsonl 数据的验证失败。
notFound

string

找不到资源。
quotaExceeded

string

已超出配额。
serviceUnavailable

string

该服务当前不可用。
tooManyRequests

string

请求过多。 请稍后重试。
unauthorized

string

当前用户/API 密钥无权执行该操作。
unexpectedEntityState

string

无法以当前资源的状态执行操作。

ErrorResponse

ErrorResponse

名称 类型 说明
error

Error

错误
Microsoft REST 指南中定义的错误内容 (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) 。

GenericEmbeddingSettings

ConnectionEmbeddingSettings

名称 类型 说明
connection BaseConnection:

BaseConnection
与资源的连接。
deploymentName

string

modelName

string

IngestionJobCompletionAction

完成操作。

名称 类型 说明
cleanUpAssets

string

将清理在引入过程中创建的中间资产。
keepAllAssets

string

不会清理在引入过程中创建的任何中间资产。

IngestionJobSystemCompute

名称 类型 说明
completionAction

IngestionJobCompletionAction

完成操作。
dataRefreshIntervalInHours

integer

datasource SystemComputeDatasource:

SystemComputeDatasource
jobId

string

kind string:

system

IngestionJobType
作业类型。
searchServiceConnection BaseConnection:

BaseConnection
与资源的连接。

IngestionJobType

IngestionJobType

名称 类型 说明
system

string

在服务拥有的资源上运行的作业。
user

string

在用户拥有的工作区上运行的作业。

IngestionJobUserCompute

名称 类型 说明
compute JobCompute:

JobCompute
作业的计算设置。
dataRefreshIntervalInHours

integer

datasource UserComputeDatasource:

UserComputeDatasource
jobId

string

kind string:

user

IngestionJobType
作业类型。
target TargetIndex:

TargetIndex
有关要创建的索引的信息。
workspaceId

string

InnerError

InnerError

名称 类型 说明
code

InnerErrorCode

InnerErrorCode
Microsoft REST 指南中定义的内部错误代码 (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) 。
innererror

InnerError

InnerError
Microsoft REST 指南中定义的内部错误 (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) 。

InnerErrorCode

InnerErrorCode

名称 类型 说明
invalidPayload

string

此操作的请求数据无效。

PineconeIndex

Pinecone Index。

名称 类型 说明
connectionId

string

指向松果的连接 ID。
kind string:

pinecone

目标类型。

ServerlessCompute

无服务器计算。

名称 类型 说明
instanceCount

integer

要运行作业的实例计数。
kind string:

serverless

计算类型。
sku

string

SKU 级别

SystemComputeDatasource

SystemComputeDatasource

名称 类型 说明
kind

DatasourceType

数据源类型。

SystemComputeStorage

SystemComputeStorage

名称 类型 说明
chunking

ChunkingSettings

ChunkingSettings
分块设置
connection BaseConnection:

BaseConnection
与资源的连接。
containerName

string

容器名称
embeddings

GenericEmbeddingSettings[]

ConnectionEmbeddingSettings
连接嵌入设置
kind

DatasourceType

数据源类型。

SystemComputeUrl

SystemComputeUrl

名称 类型 说明
chunking

ChunkingSettings

ChunkingSettings
分块设置
connection BaseConnection:

BaseConnection
与资源的连接。
containerName

string

容器名称
crawling

CrawlingSettings

CrawlingSettings
爬网设置
embeddings

GenericEmbeddingSettings[]

ConnectionEmbeddingSettings
连接嵌入设置
kind

DatasourceType

数据源类型。
urls

string[]

TargetType

目标类型。

名称 类型 说明
acs

string

Azure AI 搜索索引。
cosmosdb

string

CosmosDB 索引。
pinecone

string

Pinecone Index。

UserComputeDataset

UserComputeStorage

名称 类型 说明
chunking

ChunkingSettings

ChunkingSettings
分块设置
datasetId

string

datasetType

string

embeddings

WorkspaceConnectionEmbeddingSettings[]

WorkspaceConnectionEmbeddingSettings
嵌入模型的连接 ID
kind string:

dataset

数据源类型。

UserComputeUrl

UserComputeUrl

名称 类型 说明
chunking

ChunkingSettings

ChunkingSettings
分块设置
crawling

CrawlingSettings

CrawlingSettings
爬网设置
embeddings

WorkspaceConnectionEmbeddingSettings[]

WorkspaceConnectionEmbeddingSettings
嵌入模型的连接 ID
kind string:

urls

数据源类型。
urls

string[]

WorkspaceConnection

AML 工作区连接。

名称 类型 说明
connectionId

string

ConnectionId
kind

ConnectionType

连接类型。

WorkspaceConnectionEmbeddingSettings

WorkspaceConnectionEmbeddingSettings

名称 类型 说明
connectionId

string

deploymentName

string

modelName

string