Ingestion Jobs - List
Lists the ingestion jobs.
GET {endpoint}/openai/ingestion/jobs?api-version=2024-05-01-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string url |
Supported Cognitive Services endpoints (protocol and hostname, for example: https://aoairesource.openai.azure.com. Replace "aoairesource" with your Azure OpenAI account name). |
api-version
|
query | True |
string |
The requested API version. |
Request Header
Name | Required | Type | Description |
---|---|---|---|
api-key | True |
string |
Provide your Cognitive Services Azure OpenAI account key here. |
mgmt-user-token |
string |
The token used to access the workspace (needed only for user compute jobs). |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Success |
|
Other Status Codes |
An error occurred. |
Security
api-key
Provide your Cognitive Services Azure OpenAI account key here.
Type:
apiKey
In:
header
Examples
List all ingestion jobs
Sample request
GET {endpoint}/openai/ingestion/jobs?api-version=2024-05-01-preview
Sample response
{
"value": [
{
"jobId": "usercompute-ingestion-job",
"kind": "UserCompute",
"workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev"
},
{
"jobId": "syscompute-ingestion-job",
"kind": "SystemCompute"
}
]
}
Definitions
Name | Description |
---|---|
ACSIndex |
ACS Index. |
Base |
BaseConnection |
Chunking |
ChunkingSettings |
Compute |
The compute type. |
Connection |
Connection string connection. |
Connection |
The connection type. |
Cosmos |
CosmosDB Index. |
Crawling |
CrawlingSettings |
Custom |
Custom compute. |
Datasource |
The datasource type. |
Deployment |
Relative deployment connection. |
Endpoint |
Endpoint key connection. |
Endpoint |
Endpoint Managed Identity connection. |
Error |
Error |
Error |
ErrorCode |
Error |
ErrorResponse |
Generic |
ConnectionEmbeddingSettings |
Ingestion |
The completion action. |
Ingestion |
IngestionJobList |
Ingestion |
|
Ingestion |
IngestionJobType |
Ingestion |
|
Inner |
InnerError |
Inner |
InnerErrorCode |
Pinecone |
Pinecone Index. |
Serverless |
Serverless compute. |
System |
SystemComputeDatasource |
System |
SystemComputeStorage |
System |
SystemComputeUrl |
Target |
The target type. |
User |
UserComputeStorage |
User |
UserComputeUrl |
Workspace |
AML Workspace connection. |
Workspace |
WorkspaceConnectionEmbeddingSettings |
ACSIndex
ACS Index.
Name | Type | Description |
---|---|---|
connectionId |
string |
The id of the connection pointing to the ACS Index. |
kind |
string:
acs |
The target type. |
BaseConnection
BaseConnection
Name | Type | Description |
---|---|---|
kind |
The connection type. |
ChunkingSettings
ChunkingSettings
Name | Type | Description |
---|---|---|
maxChunkSizeInTokens |
integer |
ComputeType
The compute type.
Name | Type | Description |
---|---|---|
custom |
string |
Custom user compute. |
serverless |
string |
Serverless user compute. |
ConnectionStringConnection
Connection string connection.
Name | Type | Description |
---|---|---|
connectionString |
string |
Connection string |
kind |
The connection type. |
ConnectionType
The connection type.
Name | Type | Description |
---|---|---|
connectionString |
string |
Connection string. |
endpointKey |
string |
Endpoint and key connection. |
endpointMI |
string |
Endpoint and managed identity. |
workspace |
string |
AML Workspace connection. |
CosmosDBIndex
CosmosDB Index.
Name | Type | Description |
---|---|---|
collectionName |
string |
The name of the cosmos DB collection. |
connectionId |
string |
The id of the connection pointing to the cosmos DB. |
databaseName |
string |
The name of the cosmos DB database. |
kind |
string:
cosmosdb |
The target type. |
CrawlingSettings
CrawlingSettings
Name | Type | Description |
---|---|---|
maxCrawlDepth |
integer |
|
maxCrawlTimeInMins |
integer |
|
maxDownloadTimeInMins |
integer |
|
maxFileSize |
integer |
|
maxFiles |
integer |
|
maxRedirects |
integer |
CustomCompute
Custom compute.
Name | Type | Description |
---|---|---|
computeId |
string |
Id of the custom compute |
kind |
string:
custom |
The compute type. |
DatasourceType
The datasource type.
Name | Type | Description |
---|---|---|
storage |
string |
Azure Storage Account. |
urls |
string |
URLs. |
DeploymentConnection
Relative deployment connection.
Name | Type | Description |
---|---|---|
kind |
The connection type. |
EndpointKeyConnection
Endpoint key connection.
Name | Type | Description |
---|---|---|
endpoint |
string |
Endpoint |
key |
string |
Key |
kind |
The connection type. |
EndpointMIConnection
Endpoint Managed Identity connection.
Name | Type | Description |
---|---|---|
endpoint |
string |
Endpoint |
kind |
The connection type. |
Error
Error
Name | Type | Description |
---|---|---|
code |
ErrorCode |
|
details |
Error[] |
The error details if available. |
innererror |
InnerError |
|
message |
string |
The message of this error. |
target |
string |
The location where the error happened if available. |
ErrorCode
ErrorCode
Name | Type | Description |
---|---|---|
conflict |
string |
The requested operation conflicts with the current resource state. |
contentFilter |
string |
Image generation failed as a result of our safety system. |
fileImportFailed |
string |
Import of file failed. |
forbidden |
string |
The operation is forbidden for the current user/api key. |
internalFailure |
string |
Internal error. Please retry. |
invalidPayload |
string |
The request data is invalid for this operation. |
itemDoesAlreadyExist |
string |
The item does already exist. |
jsonlValidationFailed |
string |
Validation of jsonl data failed. |
notFound |
string |
The resource is not found. |
quotaExceeded |
string |
Quota exceeded. |
serviceUnavailable |
string |
The service is currently not available. |
tooManyRequests |
string |
Too many requests. Please retry later. |
unauthorized |
string |
The current user/api key is not authorized for the operation. |
unexpectedEntityState |
string |
The operation cannot be executed in the current resource's state. |
ErrorResponse
ErrorResponse
Name | Type | Description |
---|---|---|
error |
Error |
GenericEmbeddingSettings
ConnectionEmbeddingSettings
Name | Type | Description |
---|---|---|
connection | BaseConnection: |
BaseConnection |
deploymentName |
string |
|
modelName |
string |
IngestionJobCompletionAction
The completion action.
Name | Type | Description |
---|---|---|
cleanUpAssets |
string |
Will clean up intermediate assets created during the ingestion process. |
keepAllAssets |
string |
Will not clean up any of the intermediate assets created during the ingestion process. |
IngestionJobList
IngestionJobList
Name | Type | Description |
---|---|---|
nextLink |
string |
The link to the next page. |
value | IngestionJob[]: |
The list of items. |
IngestionJobSystemCompute
Name | Type | Description |
---|---|---|
completionAction |
The completion action. |
|
dataRefreshIntervalInHours |
integer |
|
datasource | SystemComputeDatasource: |
SystemComputeDatasource |
jobId |
string |
|
kind |
string:
system |
IngestionJobType |
searchServiceConnection | BaseConnection: |
BaseConnection |
IngestionJobType
IngestionJobType
Name | Type | Description |
---|---|---|
system |
string |
Jobs that run on service owned resources. |
user |
string |
Jobs that run on user owned workspace. |
IngestionJobUserCompute
Name | Type | Description |
---|---|---|
compute | JobCompute: |
JobCompute |
dataRefreshIntervalInHours |
integer |
|
datasource | UserComputeDatasource: |
UserComputeDatasource |
jobId |
string |
|
kind |
string:
user |
IngestionJobType |
target | TargetIndex: |
TargetIndex |
workspaceId |
string |
InnerError
InnerError
Name | Type | Description |
---|---|---|
code |
InnerErrorCode |
|
innererror |
InnerError |
InnerErrorCode
InnerErrorCode
Name | Type | Description |
---|---|---|
invalidPayload |
string |
The request data is invalid for this operation. |
PineconeIndex
Pinecone Index.
Name | Type | Description |
---|---|---|
connectionId |
string |
The id of the connection pointing to the pinecone. |
kind |
string:
pinecone |
The target type. |
ServerlessCompute
Serverless compute.
Name | Type | Description |
---|---|---|
instanceCount |
integer |
The count of instances to run the job on. |
kind |
string:
serverless |
The compute type. |
sku |
string |
SKU Level |
SystemComputeDatasource
SystemComputeDatasource
Name | Type | Description |
---|---|---|
kind |
The datasource type. |
SystemComputeStorage
SystemComputeStorage
Name | Type | Description |
---|---|---|
chunking |
ChunkingSettings |
|
connection | BaseConnection: |
BaseConnection |
containerName |
string |
container name |
embeddings |
ConnectionEmbeddingSettings |
|
kind |
The datasource type. |
SystemComputeUrl
SystemComputeUrl
Name | Type | Description |
---|---|---|
chunking |
ChunkingSettings |
|
connection | BaseConnection: |
BaseConnection |
containerName |
string |
container name |
crawling |
CrawlingSettings |
|
embeddings |
ConnectionEmbeddingSettings |
|
kind |
The datasource type. |
|
urls |
string[] |
TargetType
The target type.
Name | Type | Description |
---|---|---|
acs |
string |
Azure AI Search Index. |
cosmosdb |
string |
CosmosDB Index. |
pinecone |
string |
Pinecone Index. |
UserComputeDataset
UserComputeStorage
Name | Type | Description |
---|---|---|
chunking |
ChunkingSettings |
|
datasetId |
string |
|
datasetType |
string |
|
embeddings |
WorkspaceConnectionEmbeddingSettings |
|
kind |
string:
dataset |
The datasource type. |
UserComputeUrl
UserComputeUrl
Name | Type | Description |
---|---|---|
chunking |
ChunkingSettings |
|
crawling |
CrawlingSettings |
|
embeddings |
WorkspaceConnectionEmbeddingSettings |
|
kind |
string:
urls |
The datasource type. |
urls |
string[] |
WorkspaceConnection
AML Workspace connection.
Name | Type | Description |
---|---|---|
connectionId |
string |
ConnectionId |
kind |
The connection type. |
WorkspaceConnectionEmbeddingSettings
WorkspaceConnectionEmbeddingSettings
Name | Type | Description |
---|---|---|
connectionId |
string |
|
deploymentName |
string |
|
modelName |
string |