Ingestion Jobs - Get

Service:

Azure AI Services

API Version:

2023-10-01-preview

Obtém o estado de uma tarefa de ingestão pelo respetivo ID.

GET {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).
jobId	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.

Respostas

Name	Tipo	Description
200 OK	IngestionJob	Com êxito Headers Retry-After: integer
Other Status Codes	ErrorResponse	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

Getting status of an ingestion job.

Sample Request

HTTP

GET https://aoairesource.openai.azure.com/openai/extensions/on-your-data/ingestion-jobs/test-index?api-version=2023-10-01-preview

Sample Response

Status code:

200

{
  "id": "test-index",
  "dataRefreshIntervalInMinutes": 60,
  "completionAction": "cleanUpAssets",
  "status": "running",
  "warnings": [],
  "progress": {
    "stageProgress": [
      {
        "name": "Preprocessing",
        "totalItems": 100,
        "processedItems": 100
      },
      {
        "name": "Indexing",
        "totalItems": 200,
        "processedItems": 50
      }
    ]
  }
}

Definições

Name	Description
Error	Erro
ErrorCode	CódigoDoErro
ErrorResponse	ErrorResponse
IngestionJob	IngestionJob
IngestionJobCompletionAction	IngestionJobCompletionAction
IngestionJobProgress	IngestionJobProgress
InnerError	InnerError
InnerErrorCode	InnerErrorCode
OperationState	OperationState
StageProgress

Error

Erro

Name	Tipo	Description
code	ErrorCode	CódigoDoErro Códigos de erro conforme definido nas diretrizes REST da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Os detalhes do erro, se disponíveis.
innererror	InnerError	InnerError Erro interno, conforme definido nas diretrizes REST da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
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 atual do recurso.
contentFilter	string	A geração de imagens falhou devido ao 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	Error	Erro Conteúdo do erro conforme definido nas diretrizes REST da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

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		IngestionJobCompletionAction A ação a tomar na conclusão da tarefa de ingestão.
dataRefreshIntervalInMinutes	integer
error	Error		Erro Conteúdo do erro conforme definido nas diretrizes REST da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
id	string
progress	IngestionJobProgress		IngestionJobProgress
status	OperationState		OperationState O estado de uma tarefa ou item.
warnings	string[]

IngestionJobCompletionAction

IngestionJobCompletionAction

Name	Tipo	Description
cleanUpAssets	string	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	StageProgress[]

InnerError

InnerError

Name	Tipo	Description
code	InnerErrorCode	InnerErrorCode Códigos de erro internos, conforme definido nas diretrizes REST da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Erro interno, conforme definido nas diretrizes REST da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

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 mais.
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