Ingestion Jobs - Create

Serviço:: Azure AI Services

Versão API:: 2025-03-01-preview

Cria um trabalho de ingestão com a ID de trabalho especificada.

PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-03-01-preview

Parâmetros URI

Nome	Em	Necessário	Tipo	Descrição
endpoint	path	True	string (url)	Pontos de extremidade de Serviços Cognitivos suportados (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome da sua conta do Azure OpenAI).
job-id	path	True	string	O id do trabalho que será criado.
api-version	query	True	string	A versão da API solicitada.

Cabeçalho de Pedido

Nome	Necessário	Tipo	Descrição
mgmt-user-token		string	O token usado para acessar o espaço de trabalho (necessário apenas para trabalhos de computação do usuário).
aml-user-token		string	O token usado para acessar os recursos dentro do trabalho no espaço de trabalho (necessário apenas para trabalhos de computação do usuário).

Órgão do Pedido

O órgão do pedido pode ser um dos seguintes:

Nome	Descrição
IngestionJobSystemCompute
IngestionJobUserCompute

IngestionJobSystemCompute

Nome	Necessário	Tipo	Descrição
kind	True	string: SystemCompute	IngestionJobType O tipo de trabalho.
completionAction		IngestionJobCompletionAction	A ação de conclusão.
dataRefreshIntervalInHours		integer
datasource		SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId		string
searchServiceConnection		BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Uma conexão com um recurso.

IngestionJobUserCompute

Nome	Necessário	Tipo	Descrição
kind	True	string: UserCompute	IngestionJobType O tipo de trabalho.
workspaceId	True	string
compute		JobCompute: CustomCompute ServerlessCompute	JobCompute As configurações de computação do trabalho.
dataRefreshIntervalInHours		integer
datasource		UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId		string
target		TargetIndex: AzureAISearchIndex CosmosDBIndex PineconeIndex	TargetIndex Informações sobre o índice a ser criado.

Respostas

Nome	Tipo	Descrição
200 OK	IngestionJob: IngestionJobSystemCompute IngestionJobUserCompute	Sucesso
Other Status Codes	ErrorResponse	Ocorreu um erro.

Segurança

api-key

Autenticação de chave de API

Tipo: apiKey
Em: header

OAuth2Auth

Autenticação OAuth2

Tipo: oauth2
Flow: implicit
URL de autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Alcances

Nome	Descrição
https://cognitiveservices.azure.com/.default

Exemplos

Create a system-compute ingestion job

Create a user-compute ingestion job

Create a system-compute ingestion job

Pedido de exemplo

HTTP

PUT {endpoint}/openai/ingestion/jobs/ingestion-job?api-version=2025-03-01-preview

{
  "kind": "SystemCompute",
  "searchServiceConnection": {
    "kind": "EndpointWithManagedIdentity",
    "endpoint": "https://aykame-dev-search.search.windows.net"
  },
  "datasource": {
    "kind": "Storage",
    "connection": {
      "kind": "EndpointWithManagedIdentity",
      "endpoint": "https://mystorage.blob.core.windows.net/",
      "resourceId": "/subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage"
    },
    "containerName": "container",
    "chunking": {
      "maxChunkSizeInTokens": 2048
    },
    "embeddings": [
      {
        "connection": {
          "kind": "RelativeConnection"
        },
        "deploymentName": "Ada"
      }
    ]
  },
  "dataRefreshIntervalInHours": 24,
  "completionAction": "keepAllAssets"
}

Resposta de exemplo

Código de estado:: 200

operation-location: https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-03-01-preview

{
  "kind": "SystemCompute",
  "jobId": "ingestion-job",
  "searchServiceConnection": {
    "kind": "EndpointWithManagedIdentity",
    "endpoint": "https://aykame-dev-search.search.windows.net"
  },
  "datasource": {
    "kind": "Storage",
    "connection": {
      "kind": "EndpointWithManagedIdentity",
      "endpoint": "https://mystorage.blob.core.windows.net/",
      "resourceId": "/subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage"
    },
    "containerName": "container",
    "chunking": {
      "maxChunkSizeInTokens": 2048
    },
    "embeddings": [
      {
        "connection": {
          "kind": "RelativeConnection"
        },
        "deploymentName": "Ada"
      }
    ]
  },
  "dataRefreshIntervalInHours": 24,
  "completionAction": "keepAllAssets"
}

Create a user-compute ingestion job

Pedido de exemplo

HTTP

PUT {endpoint}/openai/ingestion/jobs/ingestion-job?api-version=2025-03-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"
  }
}

Resposta de exemplo

Código de estado:: 200

operation-location: https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-03-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	Descrição
AzureAISearchIndex	Azure AI Search Index.
ChunkingSettings	ChunkingSettings
ComputeType	O tipo de computação.
ConnectionStringConnection	Conexão de cadeia de conexão.
ConnectionType	O tipo de conexão.
CosmosDBIndex	Índice CosmosDB.
CrawlingSettings	CrawlingSettings
CustomCompute	Computação personalizada.
DeploymentConnection	Conexão de implantação relativa.
EndpointKeyConnection	Conexão de chave de ponto de extremidade.
EndpointMIConnection	Conexão de identidade gerenciada de ponto de extremidade.
Error	Erro
ErrorCode	Código de Erro
ErrorResponse	Resposta de Erro
GenericEmbeddingSettings	ConnectionEmbeddingSettings
IngestionJobCompletionAction	A ação de conclusão.
IngestionJobSystemCompute
IngestionJobType	IngestionJobType
IngestionJobUserCompute
InnerError	InnerError
InnerErrorCode	InnerErrorCode
PineconeIndex	Índice de pinha.
ServerlessCompute	Computação sem servidor.
SystemComputeDatasourceType	O tipo de fonte de dados.
SystemComputeStorage	SystemComputeStorage
SystemComputeUrl	SystemComputeUrl
TargetType	O tipo de destino.
UserComputeDataset	UserComputeStorage
UserComputeDatasourceType	O tipo de fonte de dados.
UserComputeUrl	UserComputeUrl
WorkspaceConnection	Conexão do espaço de trabalho AML.
WorkspaceConnectionEmbeddingSettings	WorkspaceConnectionEmbeddingSettings

AzureAISearchIndex

Objetivo

Azure AI Search Index.

Nome	Tipo	Descrição
connectionId	string	A id da conexão apontando para o Índice de Pesquisa do Azure AI.
kind	string: AzureAISearch	O tipo de destino.

ChunkingSettings

Objetivo

ChunkingSettings

Nome	Tipo	Descrição
maxChunkSizeInTokens	integer

ComputeType

Enumeração

O tipo de computação.

Valor	Descrição
ServerlessCompute	Computação de usuário sem servidor.
CustomCompute	Computação personalizada do usuário.

ConnectionStringConnection

Objetivo

Conexão de cadeia de conexão.

Nome	Tipo	Descrição
connectionString	string	Cadeia de ligação
kind	string: ConnectionString	O tipo de conexão.

ConnectionType

Enumeração

O tipo de conexão.

Valor	Descrição
EndpointWithKey	Ponto final e conexão de chave.
ConnectionString	Cadeia de conexão.
EndpointWithManagedIdentity	Ponto de extremidade e identidade gerenciada.
WorkspaceConnection	Conexão do espaço de trabalho AML.
RelativeConnection	Implantação relativa

CosmosDBIndex

Objetivo

Índice CosmosDB.

Nome	Tipo	Descrição
collectionName	string	O nome da coleção cosmos DB.
connectionId	string	O id da conexão apontando para o cosmos DB.
databaseName	string	O nome do banco de dados do cosmos DB.
kind	string: CosmosDB	O tipo de destino.

CrawlingSettings

Objetivo

CrawlingSettings

Nome	Tipo	Descrição
maxCrawlDepth	integer
maxCrawlTimeInMins	integer
maxDownloadTimeInMins	integer
maxFileSize	integer
maxFiles	integer
maxRedirects	integer

CustomCompute

Objetivo

Computação personalizada.

Nome	Tipo	Descrição
computeId	string	Id do cálculo personalizado
kind	string: CustomCompute	O tipo de computação.

DeploymentConnection

Objetivo

Conexão de implantação relativa.

Nome	Tipo	Descrição
kind	string: RelativeConnection	O tipo de conexão.

EndpointKeyConnection

Objetivo

Conexão de chave de ponto de extremidade.

Nome	Tipo	Descrição
endpoint	string	Ponto final
key	string	Chave
kind	string: EndpointWithKey	O tipo de conexão.

EndpointMIConnection

Objetivo

Conexão de identidade gerenciada de ponto de extremidade.

Nome	Tipo	Descrição
endpoint	string	Ponto final
kind	string: EndpointWithManagedIdentity	O tipo de conexão.
resourceId	string	ID do recurso

Error

Objetivo

Erro

Nome	Tipo	Descrição
code	ErrorCode	Código de Erro Códigos de erro, conforme definido nas diretrizes do Microsoft REST (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 do Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string minLength: 1	A mensagem deste erro.
target	string	O local onde o erro aconteceu, se disponível.

ErrorCode

Enumeração

Código de Erro

Valor	Descrição
conflict	A operação solicitada entra em conflito com o estado atual do recurso.
invalidPayload	Os dados da solicitação são inválidos para esta operação.
forbidden	A operação é proibida para a chave de usuário/api atual.
notFound	O recurso não foi encontrado.
unexpectedEntityState	A operação não pode ser executada no estado do recurso atual.
itemDoesAlreadyExist	O item já existe.
serviceUnavailable	O serviço não está disponível no momento.
internalFailure	Erro interno. Tente novamente.
quotaExceeded	Quota excedida.
jsonlValidationFailed	Falha na validação dos dados jsonl.
fileImportFailed	Falha na importação do arquivo.
tooManyRequests	Demasiados pedidos. Tente novamente mais tarde
unauthorized	A chave de usuário/api atual não está autorizada para a operação.
contentFilter	A geração de imagens falhou como resultado do nosso sistema de segurança.

ErrorResponse

Objetivo

Resposta de Erro

Nome	Tipo	Descrição
error	Error	Erro Conteúdo de erro, conforme definido nas diretrizes do Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

GenericEmbeddingSettings

Objetivo

ConnectionEmbeddingSettings

Nome	Tipo	Descrição
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Uma conexão com um recurso.
deploymentName	string
modelName	string

IngestionJobCompletionAction

Enumeração

A ação de conclusão.

Valor	Descrição
cleanUpTempAssets	Limpará ativos intermediários criados durante o processo de ingestão.
keepAllAssets	Não limpará nenhum dos ativos intermediários criados durante o processo de ingestão.

IngestionJobSystemCompute

Objetivo

Nome	Tipo	Descrição
completionAction	IngestionJobCompletionAction	A ação de conclusão.
dataRefreshIntervalInHours	integer
datasource	SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId	string
kind	string: SystemCompute	IngestionJobType O tipo de trabalho.
searchServiceConnection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Uma conexão com um recurso.

IngestionJobType

Enumeração

IngestionJobType

Valor	Descrição
SystemCompute	Trabalhos executados em recursos de propriedade do serviço.
UserCompute	Trabalhos executados no espaço de trabalho de propriedade do usuário.

IngestionJobUserCompute

Objetivo

Nome	Tipo	Descrição
compute	JobCompute: CustomCompute ServerlessCompute	JobCompute As configurações de computação do trabalho.
dataRefreshIntervalInHours	integer
datasource	UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId	string
kind	string: UserCompute	IngestionJobType O tipo de trabalho.
target	TargetIndex: AzureAISearchIndex CosmosDBIndex PineconeIndex	TargetIndex Informações sobre o índice a ser criado.
workspaceId	string

InnerError

Objetivo

InnerError

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

InnerErrorCode

Enumeração

InnerErrorCode

Valor	Descrição
invalidPayload	Os dados da solicitação são inválidos para esta operação.

PineconeIndex

Objetivo

Índice de pinha.

Nome	Tipo	Descrição
connectionId	string	O id da conexão apontando para a pinha.
kind	string: Pinecone	O tipo de destino.

ServerlessCompute

Objetivo

Computação sem servidor.

Nome	Tipo	Descrição
instanceCount	integer	A contagem de instâncias para executar o trabalho.
kind	string: ServerlessCompute	O tipo de computação.
sku	string	Nível de SKU

SystemComputeDatasourceType

Enumeração

O tipo de fonte de dados.

Valor	Descrição
Storage	Conta de Armazenamento do Azure.
Urls	URLs.

SystemComputeStorage

Objetivo

SystemComputeStorage

Nome	Tipo	Descrição
chunking	ChunkingSettings	ChunkingSettings Configurações de fragmentação
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Uma conexão com um recurso.
containerName	string	nome do contêiner
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Configurações de incorporação de conexão
kind	string: Storage	O tipo de fonte de dados.

SystemComputeUrl

Objetivo

SystemComputeUrl

Nome	Tipo	Descrição
chunking	ChunkingSettings	ChunkingSettings Configurações de fragmentação
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Uma conexão com um recurso.
containerName	string	nome do contêiner
crawling	CrawlingSettings	CrawlingSettings Configurações de rastreamento
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Configurações de incorporação de conexão
kind	string: Urls	O tipo de fonte de dados.
urls	string[]

TargetType

Enumeração

O tipo de destino.

Valor	Descrição
AzureAISearch	Azure AI Search Index.
CosmosDB	Índice CosmosDB.
Pinecone	Índice de pinha.

UserComputeDataset

Objetivo

UserComputeStorage

Nome	Tipo	Descrição
chunking	ChunkingSettings	ChunkingSettings Configurações de fragmentação
datasetId	string
datasetType	string
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings ID de conexão com o modelo de incorporação
kind	string: Dataset	O tipo de fonte de dados.

UserComputeDatasourceType

Enumeração

O tipo de fonte de dados.

Valor	Descrição
Dataset	Conjunto de dados do espaço de trabalho.
Urls	URLs.

UserComputeUrl

Objetivo

UserComputeUrl

Nome	Tipo	Descrição
chunking	ChunkingSettings	ChunkingSettings Configurações de fragmentação
crawling	CrawlingSettings	CrawlingSettings Configurações de rastreamento
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings ID de conexão com o modelo de incorporação
kind	string: Urls	O tipo de fonte de dados.
urls	string[]

WorkspaceConnection

Objetivo

Conexão do espaço de trabalho AML.

Nome	Tipo	Descrição
connectionId	string	ConnectionId
kind	string: WorkspaceConnection	O tipo de conexão.

WorkspaceConnectionEmbeddingSettings

Objetivo

WorkspaceConnectionEmbeddingSettings

Nome	Tipo	Descrição
connectionId	string
deploymentName	string
modelName	string

Partilhar via

Ingestion Jobs - Create

Parâmetros URI

Cabeçalho de Pedido

Órgão do Pedido

IngestionJobSystemCompute

IngestionJobUserCompute

Respostas

Segurança

api-key

OAuth2Auth

Alcances

Exemplos

Create a system-compute ingestion job

Pedido de exemplo

Resposta de exemplo

Create a user-compute ingestion job

Pedido de exemplo

Resposta de exemplo

Definições

AzureAISearchIndex

ChunkingSettings

ComputeType

ConnectionStringConnection

ConnectionType

CosmosDBIndex

CrawlingSettings

CustomCompute

DeploymentConnection

EndpointKeyConnection

EndpointMIConnection

Error

ErrorCode

ErrorResponse

GenericEmbeddingSettings

IngestionJobCompletionAction

IngestionJobSystemCompute

IngestionJobType

IngestionJobUserCompute

InnerError

InnerErrorCode

PineconeIndex

ServerlessCompute

SystemComputeDatasourceType

SystemComputeStorage

SystemComputeUrl

TargetType

UserComputeDataset

UserComputeDatasourceType

UserComputeUrl

WorkspaceConnection

WorkspaceConnectionEmbeddingSettings