Ingestion Jobs - Create

Referência

Service:: Cognitive Services - Azure OpenAI

API Version:: 2023-10-01-preview

Inicia um trabalho para ingerir dados em um índice do Azure Search a ser usado como uma fonte de dados para conclusões. O status do trabalho de ingestão será mantido por 48 horas após sua conclusão e será excluído posteriormente.

PUT {endpoint}/openai/extensions/on-your-data/ingestion-jobs/{jobId}?api-version=2023-10-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 OpenAI do Azure).
jobId	path	True	string	A ID do trabalho de ingestão.
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 a chave de conta do Azure OpenAI dos Serviços Cognitivos aqui.
searchServiceEndpoint	True	string	O ponto de extremidade para o recurso de serviço de pesquisa em que os ativos de ingestão serão criados.
searchServiceAdminKey		string	A chave de administrador para o recurso de serviço de pesquisa se a Identidade Gerenciada não estiver configurada.
storageConnectionString	True	string	O cadeia de conexão à conta de armazenamento de blobs que hospeda os dados que serão ingeridos.
storageContainer	True	string	O nome do contêiner que hospeda os dados que serão ingeridos.
embeddingEndpoint		string	O ponto de extremidade do modelo de inserções a ser usado para cálculos de inserções, se habilitado.
embeddingKey		string	A chave a ser usada para acessar o modelo de inserções se habilitada e se a Identidade Gerenciada não estiver configurada.
storageEndpoint		string	O ponto de extremidade de armazenamento de blobs que hospeda os dados que serão ingeridos. Necessário para o formato ResourceId de storageConnectionString.
embeddingDeploymentName		string	O nome da implantação de inserção do recurso OpenAI do Azure atual a ser usado para acessar o modelo de inserções.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
dataRefreshIntervalInMinutes	True	integer
chunkSize		integer	Esse número define o número máximo de tokens em cada parte produzida pelo fluxo de ingestão.
completionAction		IngestionJobCompletionAction	IngestionJobCompletionAction A ação a ser tomada na conclusão do trabalho de ingestão.
id		string
progress		IngestionJobProgress	IngestionJobProgress
warnings		string[]

Respostas

Nome	Tipo	Description
200 OK	IngestionJob	Êxito
Other Status Codes	ErrorResponse	Ocorreu um erro.

Segurança

api-key

Forneça a chave de conta do Azure OpenAI dos Serviços Cognitivos aqui.

Type: apiKey
In: header

Exemplos

Starting an ingestion job.

Sample Request

HTTP

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

Status code:: 200

{
  "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

Nome	Description
Error	Erro
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
IngestionJob	IngestionJob
IngestionJobCompletionAction	IngestionJobCompletionAction
IngestionJobProgress	IngestionJobProgress
InnerError	InnerError
InnerErrorCode	InnerErrorCode
OperationState	OperationState
StageProgress

Error

Erro

Nome	Tipo	Description
code	ErrorCode	ErrorCode 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 desse erro.
target	string	O local em que o erro ocorreu, se disponível.

ErrorCode

Nome	Tipo	Description
conflict	string	A operação solicitada está em conflito com o estado atual do recurso.
contentFilter	string	A geração de imagens falhou como resultado do nosso sistema de segurança.
fileImportFailed	string	Falha na importação do 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 da solicitação são inválidos para esta 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

Nome	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

Nome	Tipo	Valor padrão	Description
chunkSize	integer	1024	Esse número define o número máximo de tokens em cada parte produzida pelo fluxo de ingestão.
completionAction	IngestionJobCompletionAction		IngestionJobCompletionAction A ação a ser tomada na conclusão do trabalho 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 um trabalho ou item.
warnings	string[]

IngestionJobCompletionAction

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.

IngestionJobProgress

Nome	Tipo	Description
stageProgress	StageProgress[]

InnerError

Nome	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

Nome	Tipo	Description
invalidPayload	string	Os dados da solicitação são inválidos para esta operação.

OperationState

Nome	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á na 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

Nome	Tipo	Description
name	string
processedItems	integer
totalItems	integer

Share via