Ingestion Jobs - Create
Inicia uma tarefa para ingerir dados num índice do Azure Search para ser utilizado como uma origem de dados para conclusão. O estado da tarefa de ingestão será mantido durante 48 horas após a conclusão e será eliminado posteriormente.
PUT {endpoint}/openai/extensions/on-your-data/ingestion-jobs/{jobId}?api-version=2023-10-01-preview
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
endpoint
|
path | True |
string url |
Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome da sua conta OpenAI do Azure). |
job
|
path | True |
string |
O ID da tarefa de ingestão. |
api-version
|
query | True |
string |
A versão da API pedida. |
Cabeçalho do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
api-key | True |
string |
Forneça a sua chave de conta do Azure OpenAI dos Serviços Cognitivos aqui. |
searchServiceEndpoint | True |
string |
O ponto final do recurso do serviço de pesquisa onde os recursos de ingestão serão criados. |
searchServiceAdminKey |
string |
A chave de administração do recurso do serviço de pesquisa se a Identidade Gerida não estiver configurada. |
|
storageConnectionString | True |
string |
O cadeia de ligação para a conta de armazenamento de blobs que aloja os dados que serão ingeridos. |
storageContainer | True |
string |
O nome do contentor que aloja os dados que serão ingeridos. |
embeddingEndpoint |
string |
O ponto final do modelo de incorporações a ser utilizado para cálculos de incorporação, se ativado. |
|
embeddingKey |
string |
A chave a utilizar para aceder ao modelo de incorporações se estiver ativada e se a Identidade Gerida não estiver configurada. |
|
storageEndpoint |
string |
O ponto final de armazenamento de blobs que aloja os dados que serão ingeridos. Necessário para o formato ResourceId do storageConnectionString. |
|
embeddingDeploymentName |
string |
O nome da incorporação da implementação do recurso OpenAI do Azure atual a utilizar para aceder ao modelo de incorporações. |
Corpo do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
dataRefreshIntervalInMinutes | True |
integer |
|
chunkSize |
integer |
Este número define o número máximo de tokens em cada segmento produzido pelo fluxo de ingestão. |
|
completionAction |
IngestionJobCompletionAction |
||
id |
string |
||
progress |
IngestionJobProgress |
||
warnings |
string[] |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
Com êxito |
|
Other Status Codes |
Ocorreu um erro. |
Segurança
api-key
Forneça a sua chave de conta do Azure OpenAI dos Serviços Cognitivos aqui.
Type:
apiKey
In:
header
Exemplos
Starting an ingestion job.
Sample Request
PUT https://aoairesource.openai.azure.com/openai/extensions/on-your-data/ingestion-jobs/test?api-version=2023-10-01-preview
{
"dataRefreshIntervalInMinutes": 60,
"completionAction": "cleanUpAssets"
}
Sample Response
{
"id": "test",
"dataRefreshIntervalInMinutes": 60,
"completionAction": "cleanUpAssets",
"status": "notRunning",
"warnings": [],
"progress": {
"stageProgress": [
{
"name": "Preprocessing",
"totalItems": 0,
"processedItems": 0
},
{
"name": "Indexing",
"totalItems": 0,
"processedItems": 0
}
]
}
}
Definições
Name | Description |
---|---|
Error |
Erro |
Error |
CódigoDoErro |
Error |
ErrorResponse |
Ingestion |
IngestionJob |
Ingestion |
IngestionJobCompletionAction |
Ingestion |
IngestionJobProgress |
Inner |
InnerError |
Inner |
InnerErrorCode |
Operation |
OperationState |
Stage |
Error
Erro
Name | Tipo | Description |
---|---|---|
code |
CódigoDoErro |
|
details |
Error[] |
Os detalhes do erro, se disponíveis. |
innererror |
InnerError |
|
message |
string |
A mensagem deste erro. |
target |
string |
A localização onde ocorreu o erro, se disponível. |
ErrorCode
CódigoDoErro
Name | Tipo | Description |
---|---|---|
conflict |
string |
A operação pedida 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 do ficheiro. |
forbidden |
string |
A operação é proibida para a chave de utilizador/api atual. |
internalFailure |
string |
Erro interno. Tente novamente. |
invalidPayload |
string |
Os dados do pedido são inválidos para esta operação. |
itemDoesAlreadyExist |
string |
O item já existe. |
jsonlValidationFailed |
string |
Falha na validação dos dados jsonl. |
notFound |
string |
O recurso não foi encontrado. |
quotaExceeded |
string |
Quota excedida. |
serviceUnavailable |
string |
O serviço não está atualmente disponível. |
tooManyRequests |
string |
Demasiados pedidos. Repita mais tarde. |
unauthorized |
string |
A chave de utilizador/api atual não está autorizada para a operação. |
unexpectedEntityState |
string |
Não é possível executar a operação no estado do recurso atual. |
ErrorResponse
ErrorResponse
Name | Tipo | Description |
---|---|---|
error |
Erro |
IngestionJob
IngestionJob
Name | Tipo | Valor Predefinido | Description |
---|---|---|---|
chunkSize |
integer |
1024 |
Este número define o número máximo de tokens em cada segmento produzido pelo fluxo de ingestão. |
completionAction |
IngestionJobCompletionAction |
||
dataRefreshIntervalInMinutes |
integer |
||
error |
Erro |
||
id |
string |
||
progress |
IngestionJobProgress |
||
status |
OperationState |
||
warnings |
string[] |
IngestionJobCompletionAction
IngestionJobCompletionAction
Name | Tipo | Description |
---|---|---|
cleanUpAssets |
string |
Irá limpar os recursos intermédios criados durante o processo de ingestão. |
keepAllAssets |
string |
Não limpará nenhum dos recursos intermédios criados durante o processo de ingestão. |
IngestionJobProgress
IngestionJobProgress
Name | Tipo | Description |
---|---|---|
stageProgress |
InnerError
InnerError
Name | Tipo | Description |
---|---|---|
code |
InnerErrorCode |
|
innererror |
InnerError |
InnerErrorCode
InnerErrorCode
Name | Tipo | Description |
---|---|---|
invalidPayload |
string |
Os dados do pedido são inválidos para esta operação. |
OperationState
OperationState
Name | Tipo | Description |
---|---|---|
failed |
string |
A operação concluiu o processamento com uma falha e não pode ser consumida. |
notRunning |
string |
A operação ainda não está em fila para ser processada no futuro. |
running |
string |
A operação começou a ser processada. |
succeeded |
string |
A operação foi processada com êxito e está pronta para consumo. |
StageProgress
Name | Tipo | Description |
---|---|---|
name |
string |
|
processedItems |
integer |
|
totalItems |
integer |