Ingestion Jobs - Create
Cria um trabalho de ingestão com a ID do trabalho especificada.
PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2024-05-01-preview
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
endpoint
|
path | True |
string url |
Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome da conta do Azure OpenAI). |
job-id
|
path | True |
string |
A ID do trabalho que será criado. |
api-version
|
query | True |
string |
A versão da API solicitada. |
Cabeçalho da solicitação
Nome | Obrigatório | Tipo | Description |
---|---|---|---|
api-key | True |
string |
Forneça sua chave de conta do Azure OpenAI dos Serviços Cognitivos aqui. |
mgmt-user-token |
string |
O token usado para acessar o workspace (necessário apenas para trabalhos de computação de usuário). |
|
aml-user-token |
string |
O token usado para acessar os recursos dentro do trabalho no workspace (necessário apenas para trabalhos de computação do usuário). |
Corpo da solicitação
O corpo da solicitação pode ser um dos seguintes:
Nome | Description |
---|---|
Ingestion |
|
Ingestion |
IngestionJobSystemCompute
Nome | Obrigatório | Tipo | Description |
---|---|---|---|
kind | True |
string:
system |
IngestionJobType |
completionAction |
A ação de conclusão. |
||
dataRefreshIntervalInHours |
integer |
||
datasource | SystemComputeDatasource: |
SystemComputeDatasource |
|
jobId |
string |
||
searchServiceConnection | BaseConnection: |
BaseConnection |
IngestionJobUserCompute
Nome | Obrigatório | Tipo | Description |
---|---|---|---|
kind | True |
string:
user |
IngestionJobType |
workspaceId | True |
string |
|
compute | JobCompute: |
JobCompute |
|
dataRefreshIntervalInHours |
integer |
||
datasource | UserComputeDatasource: |
UserComputeDatasource |
|
jobId |
string |
||
target | TargetIndex: |
TargetIndex |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK | IngestionJob: |
Êxito |
Other Status Codes |
Ocorreu um erro. |
Segurança
api-key
Forneça sua chave de conta do Azure OpenAI dos Serviços Cognitivos aqui.
Type:
apiKey
In:
header
Exemplos
Create a system-compute ingestion job |
Create a user-compute ingestion job |
Create a system-compute ingestion job
Sample Request
PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2024-05-01-preview
{
"kind": "SystemCompute",
"searchServiceConnection": {
"kind": "EndpointWithManagedIdentity",
"endpoint": "https://aykame-dev-search.search.windows.net"
},
"datasource": {
"kind": "Storage",
"storageAccountConnection": {
"kind": "EndpointWithManagedIdentity",
"endpoint": "https://mystorage.blob.core.windows.net/",
"resourceId": "ResourceId=/subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage"
},
"containerName": "container",
"chunkingSettings": {
"maxChunkSizeInTokens": 2048
},
"embeddingsSettings": [
{
"embeddingResourceConnection": {
"kind": "RelativeConnection"
},
"modelProvider": "AOAI",
"deploymentName": "Ada"
}
]
},
"dataRefreshIntervalInHours": 24,
"completionAction": 0
}
Sample Response
operation-location: https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2024-05-01-preview
{
"kind": "SystemCompute",
"jobId": "ingestion-job",
"searchServiceConnection": {
"kind": "EndpointWithManagedIdentity",
"endpoint": "https://aykame-dev-search.search.windows.net"
},
"datasource": {
"kind": "Storage",
"storageAccountConnection": {
"kind": "EndpointWithManagedIdentity",
"endpoint": "https://mystorage.blob.core.windows.net/",
"resourceId": "ResourceId=/subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage"
},
"containerName": "container",
"chunkingSettings": {
"maxChunkSizeInTokens": 2048
},
"embeddingsSettings": [
{
"embeddingResourceConnection": {
"kind": "RelativeConnection"
},
"modelProvider": "AOAI",
"deploymentName": "Ada"
}
]
},
"dataRefreshIntervalInHours": 24,
"completionAction": 0
}
Create a user-compute ingestion job
Sample Request
PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2024-05-01-preview
{
"kind": "UserCompute",
"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"
}
}
Sample Response
operation-location: https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2024-05-01-preview
{
"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"
}
}
Definições
Nome | Description |
---|---|
ACSIndex |
Índice ACS. |
Base |
BaseConnection |
Chunking |
ChunkingSettings |
Compute |
O tipo de computação. |
Connection |
Conexão de cadeia de conexão. |
Connection |
O tipo de conexão. |
Cosmos |
Índice do CosmosDB. |
Crawling |
CrawlingSettings |
Custom |
Computação personalizada. |
Datasource |
O tipo de fonte de dados. |
Deployment |
Conexão de implantação relativa. |
Endpoint |
Conexão de chave de ponto de extremidade. |
Endpoint |
Conexão de Identidade Gerenciada de Ponto de Extremidade. |
Error |
Erro |
Error |
ErrorCode |
Error |
ErrorResponse |
Generic |
ConnectionEmbeddingSettings |
Ingestion |
A ação de conclusão. |
Ingestion |
|
Ingestion |
IngestionJobType |
Ingestion |
|
Inner |
InnerError |
Inner |
InnerErrorCode |
Pinecone |
Índice Pinecone. |
Serverless |
Computação sem servidor. |
System |
SystemComputeDatasource |
System |
SystemComputeStorage |
System |
SystemComputeUrl |
Target |
O tipo de destino. |
User |
UserComputeStorage |
User |
UserComputeUrl |
Workspace |
Conexão de workspace do AML. |
Workspace |
WorkspaceConnectionEmbeddingSettings |
ACSIndex
Índice ACS.
Nome | Tipo | Description |
---|---|---|
connectionId |
string |
A ID da conexão que aponta para o índice ACS. |
kind |
string:
acs |
O tipo de destino. |
BaseConnection
BaseConnection
Nome | Tipo | Description |
---|---|---|
kind |
O tipo de conexão. |
ChunkingSettings
ChunkingSettings
Nome | Tipo | Description |
---|---|---|
maxChunkSizeInTokens |
integer |
ComputeType
O tipo de computação.
Nome | Tipo | Description |
---|---|---|
custom |
string |
Computação de usuário personalizada. |
serverless |
string |
Computação de usuário sem servidor. |
ConnectionStringConnection
Conexão de cadeia de conexão.
Nome | Tipo | Description |
---|---|---|
connectionString |
string |
Cadeia de conexão |
kind |
O tipo de conexão. |
ConnectionType
O tipo de conexão.
Nome | Tipo | Description |
---|---|---|
connectionString |
string |
Cadeia de conexão. |
endpointKey |
string |
Ponto de extremidade e conexão de chave. |
endpointMI |
string |
Ponto de extremidade e identidade gerenciada. |
workspace |
string |
Conexão de workspace do AML. |
CosmosDBIndex
Índice do CosmosDB.
Nome | Tipo | Description |
---|---|---|
collectionName |
string |
O nome da coleção cosmos DB. |
connectionId |
string |
A ID da conexão que aponta para o cosmos DB. |
databaseName |
string |
O nome do banco de dados cosmos DB. |
kind |
string:
cosmosdb |
O tipo de destino. |
CrawlingSettings
CrawlingSettings
Nome | Tipo | Description |
---|---|---|
maxCrawlDepth |
integer |
|
maxCrawlTimeInMins |
integer |
|
maxDownloadTimeInMins |
integer |
|
maxFileSize |
integer |
|
maxFiles |
integer |
|
maxRedirects |
integer |
CustomCompute
Computação personalizada.
Nome | Tipo | Description |
---|---|---|
computeId |
string |
ID da computação personalizada |
kind |
string:
custom |
O tipo de computação. |
DatasourceType
O tipo de fonte de dados.
Nome | Tipo | Description |
---|---|---|
storage |
string |
Conta de Armazenamento do Azure. |
urls |
string |
URLs. |
DeploymentConnection
Conexão de implantação relativa.
Nome | Tipo | Description |
---|---|---|
kind |
O tipo de conexão. |
EndpointKeyConnection
Conexão de chave de ponto de extremidade.
Nome | Tipo | Description |
---|---|---|
endpoint |
string |
Ponto de extremidade |
key |
string |
Chave |
kind |
O tipo de conexão. |
EndpointMIConnection
Conexão de Identidade Gerenciada de Ponto de Extremidade.
Nome | Tipo | Description |
---|---|---|
endpoint |
string |
Ponto de extremidade |
kind |
O tipo de conexão. |
Error
Erro
Nome | Tipo | Description |
---|---|---|
code |
ErrorCode |
|
details |
Error[] |
Os detalhes do erro, se disponíveis. |
innererror |
InnerError |
|
message |
string |
A mensagem desse erro. |
target |
string |
O local em que o erro ocorreu, se disponível. |
ErrorCode
ErrorCode
Nome | Tipo | Description |
---|---|---|
conflict |
string |
A operação solicitada entra em conflito com o estado do recurso atual. |
contentFilter |
string |
A geração de imagens falhou como resultado do nosso sistema de segurança. |
fileImportFailed |
string |
Falha na importação de arquivo. |
forbidden |
string |
A operação é proibida para a chave de usuário/api atual. |
internalFailure |
string |
Erro interno. Tente novamente. |
invalidPayload |
string |
Os dados de solicitação são inválidos para essa operação. |
itemDoesAlreadyExist |
string |
O item já existe. |
jsonlValidationFailed |
string |
Falha na validação de dados jsonl. |
notFound |
string |
O recurso não foi encontrado. |
quotaExceeded |
string |
Cota excedida. |
serviceUnavailable |
string |
No momento, o serviço não está disponível. |
tooManyRequests |
string |
Solicitações demais. Tente novamente mais tarde. |
unauthorized |
string |
A chave de usuário/api atual não está autorizada para a operação. |
unexpectedEntityState |
string |
A operação não pode ser executada no estado do recurso atual. |
ErrorResponse
ErrorResponse
Nome | Tipo | Description |
---|---|---|
error |
Erro |
GenericEmbeddingSettings
ConnectionEmbeddingSettings
Nome | Tipo | Description |
---|---|---|
connection | BaseConnection: |
BaseConnection |
deploymentName |
string |
|
modelName |
string |
IngestionJobCompletionAction
A ação de conclusão.
Nome | Tipo | Description |
---|---|---|
cleanUpAssets |
string |
O limpo ativos intermediários criados durante o processo de ingestão. |
keepAllAssets |
string |
Não limpo nenhum dos ativos intermediários criados durante o processo de ingestão. |
IngestionJobSystemCompute
Nome | Tipo | Description |
---|---|---|
completionAction |
A ação de conclusão. |
|
dataRefreshIntervalInHours |
integer |
|
datasource | SystemComputeDatasource: |
SystemComputeDatasource |
jobId |
string |
|
kind |
string:
system |
IngestionJobType |
searchServiceConnection | BaseConnection: |
BaseConnection |
IngestionJobType
IngestionJobType
Nome | Tipo | Description |
---|---|---|
system |
string |
Trabalhos executados em recursos de serviço. |
user |
string |
Trabalhos executados no workspace de propriedade do usuário. |
IngestionJobUserCompute
Nome | Tipo | Description |
---|---|---|
compute | JobCompute: |
JobCompute |
dataRefreshIntervalInHours |
integer |
|
datasource | UserComputeDatasource: |
UserComputeDatasource |
jobId |
string |
|
kind |
string:
user |
IngestionJobType |
target | TargetIndex: |
TargetIndex |
workspaceId |
string |
InnerError
InnerError
Nome | Tipo | Description |
---|---|---|
code |
InnerErrorCode |
|
innererror |
InnerError |
InnerErrorCode
InnerErrorCode
Nome | Tipo | Description |
---|---|---|
invalidPayload |
string |
Os dados de solicitação são inválidos para essa operação. |
PineconeIndex
Índice Pinecone.
Nome | Tipo | Description |
---|---|---|
connectionId |
string |
A ID da conexão apontando para o pinecone. |
kind |
string:
pinecone |
O tipo de destino. |
ServerlessCompute
Computação sem servidor.
Nome | Tipo | Description |
---|---|---|
instanceCount |
integer |
A contagem de instâncias em que executar o trabalho. |
kind |
string:
serverless |
O tipo de computação. |
sku |
string |
Nível de SKU |
SystemComputeDatasource
SystemComputeDatasource
Nome | Tipo | Description |
---|---|---|
kind |
O tipo de fonte de dados. |
SystemComputeStorage
SystemComputeStorage
Nome | Tipo | Description |
---|---|---|
chunking |
ChunkingSettings |
|
connection | BaseConnection: |
BaseConnection |
containerName |
string |
nome do contêiner |
embeddings |
ConnectionEmbeddingSettings |
|
kind |
O tipo de fonte de dados. |
SystemComputeUrl
SystemComputeUrl
Nome | Tipo | Description |
---|---|---|
chunking |
ChunkingSettings |
|
connection | BaseConnection: |
BaseConnection |
containerName |
string |
nome do contêiner |
crawling |
CrawlingSettings |
|
embeddings |
ConnectionEmbeddingSettings |
|
kind |
O tipo de fonte de dados. |
|
urls |
string[] |
TargetType
O tipo de destino.
Nome | Tipo | Description |
---|---|---|
acs |
string |
Índice do Azure AI Search. |
cosmosdb |
string |
Índice do CosmosDB. |
pinecone |
string |
Índice Pinecone. |
UserComputeDataset
UserComputeStorage
Nome | Tipo | Description |
---|---|---|
chunking |
ChunkingSettings |
|
datasetId |
string |
|
datasetType |
string |
|
embeddings |
WorkspaceConnectionEmbeddingSettings |
|
kind |
string:
dataset |
O tipo de fonte de dados. |
UserComputeUrl
UserComputeUrl
Nome | Tipo | Description |
---|---|---|
chunking |
ChunkingSettings |
|
crawling |
CrawlingSettings |
|
embeddings |
WorkspaceConnectionEmbeddingSettings |
|
kind |
string:
urls |
O tipo de fonte de dados. |
urls |
string[] |
WorkspaceConnection
Conexão de workspace do AML.
Nome | Tipo | Description |
---|---|---|
connectionId |
string |
ConnectionId |
kind |
O tipo de conexão. |
WorkspaceConnectionEmbeddingSettings
WorkspaceConnectionEmbeddingSettings
Nome | Tipo | Description |
---|---|---|
connectionId |
string |
|
deploymentName |
string |
|
modelName |
string |