Ingestion Jobs - Create

Riferimento

Servizio:: Azure AI Services

Versione API:: 2025-01-01-preview

Crea un processo di inserimento con l'ID processo specificato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string url	Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il nome dell'account Azure OpenAI.
job-id	path	True	string	ID del processo che verrà creato.
api-version	query	True	string	Versione dell'API richiesta.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
mgmt-user-token		string	Token usato per accedere all'area di lavoro (necessario solo per i processi di calcolo utente).
aml-user-token		string	Token usato per accedere alle risorse all'interno del processo nell'area di lavoro (necessario solo per i processi di calcolo utente).

Corpo della richiesta

Il corpo della richiesta può essere uno dei seguenti:

Nome	Descrizione
IngestionJobSystemCompute
IngestionJobUserCompute

IngestionJobSystemCompute

Nome	Necessario	Tipo	Descrizione
kind	True	string: SystemCompute	IngestionJobType Tipo di processo.
completionAction		IngestionJobCompletionAction	Azione di completamento.
dataRefreshIntervalInHours		integer
datasource		SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId		string
searchServiceConnection		BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Connessione a una risorsa.

IngestionJobUserCompute

Nome	Necessario	Tipo	Descrizione
kind	True	string: UserCompute	IngestionJobType Tipo di processo.
workspaceId	True	string
compute		JobCompute: CustomCompute ServerlessCompute	JobCompute Impostazioni di calcolo del processo.
dataRefreshIntervalInHours		integer
datasource		UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId		string
target		TargetIndex: AzureAISearchIndex CosmosDBIndex PineconeIndex	TargetIndex Informazioni sull'indice da creare.

Risposte

Nome	Tipo	Descrizione
200 OK	IngestionJob: IngestionJobSystemCompute IngestionJobUserCompute	Successo
Other Status Codes	ErrorResponse	Si è verificato un errore.

Sicurezza

api-key

Autenticazione con chiave API

Tipo: apiKey
In: header

OAuth2Auth

Autenticazione OAuth2

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ambiti

Nome	Descrizione
https://cognitiveservices.azure.com/.default

Esempio

Create a system-compute ingestion job

Create a user-compute ingestion job

Create a system-compute ingestion job

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 200

operation-location: https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-01-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

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 200

operation-location: https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-01-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"
  }
}

Definizioni

Nome	Descrizione
AzureAISearchIndex	Indice di Ricerca di intelligenza artificiale di Azure.
ChunkingSettings	ChunkingSettings
ComputeType	Tipo di calcolo.
ConnectionStringConnection	Connessione alla stringa di connessione.
ConnectionType	Tipo di connessione.
CosmosDBIndex	Indice di CosmosDB.
CrawlingSettings	CrawlingSettings
CustomCompute	Calcolo personalizzato.
DeploymentConnection	Connessione di distribuzione relativa.
EndpointKeyConnection	Connessione della chiave dell'endpoint.
EndpointMIConnection	Connessione identità gestita da endpoint.
Error	Errore
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
GenericEmbeddingSettings	ConnectionEmbeddingSettings
IngestionJobCompletionAction	Azione di completamento.
IngestionJobSystemCompute
IngestionJobType	IngestionJobType
IngestionJobUserCompute
InnerError	InnerError
InnerErrorCode	InnerErrorCode
PineconeIndex	Pinecone Index.
ServerlessCompute	Calcolo serverless.
SystemComputeDatasourceType	Tipo di origine dati.
SystemComputeStorage	SystemComputeStorage
SystemComputeUrl	SystemComputeUrl
TargetType	Tipo di destinazione.
UserComputeDataset	UserComputeStorage
UserComputeDatasourceType	Tipo di origine dati.
UserComputeUrl	UserComputeUrl
WorkspaceConnection	Connessione dell'area di lavoro AML.
WorkspaceConnectionEmbeddingSettings	WorkspaceConnectionEmbeddingSettings

AzureAISearchIndex

Indice di Ricerca di intelligenza artificiale di Azure.

Nome	Tipo	Descrizione
connectionId	string	ID della connessione che punta all'indice di Ricerca di intelligenza artificiale di Azure.
kind	string: AzureAISearch	Tipo di destinazione.

ChunkingSettings

Nome	Tipo	Descrizione
maxChunkSizeInTokens	integer

ComputeType

Tipo di calcolo.

Nome	Tipo	Descrizione
CustomCompute	string	Calcolo utente personalizzato.
ServerlessCompute	string	Calcolo utente serverless.

ConnectionStringConnection

Connessione alla stringa di connessione.

Nome	Tipo	Descrizione
connectionString	string	Stringa di connessione
kind	string: ConnectionString	Tipo di connessione.

ConnectionType

Tipo di connessione.

Nome	Tipo	Descrizione
ConnectionString	string	Stringa di connessione.
EndpointWithKey	string	Endpoint e connessione con chiave.
EndpointWithManagedIdentity	string	Endpoint e identità gestita.
RelativeConnection	string	Distribuzione relativa
WorkspaceConnection	string	Connessione dell'area di lavoro AML.

CosmosDBIndex

Indice di CosmosDB.

Nome	Tipo	Descrizione
collectionName	string	Nome della raccolta cosmos DB.
connectionId	string	ID della connessione che punta a cosmos DB.
databaseName	string	Nome del database cosmos DB.
kind	string: CosmosDB	Tipo di destinazione.

CrawlingSettings

Nome	Tipo	Descrizione
maxCrawlDepth	integer
maxCrawlTimeInMins	integer
maxDownloadTimeInMins	integer
maxFileSize	integer
maxFiles	integer
maxRedirects	integer

CustomCompute

Calcolo personalizzato.

Nome	Tipo	Descrizione
computeId	string	ID dell'ambiente di calcolo personalizzato
kind	string: CustomCompute	Tipo di calcolo.

DeploymentConnection

Connessione di distribuzione relativa.

Nome	Tipo	Descrizione
kind	string: RelativeConnection	Tipo di connessione.

EndpointKeyConnection

Connessione della chiave dell'endpoint.

Nome	Tipo	Descrizione
endpoint	string	Endpoint
key	string	Chiave
kind	string: EndpointWithKey	Tipo di connessione.

EndpointMIConnection

Connessione identità gestita da endpoint.

Nome	Tipo	Descrizione
endpoint	string	Endpoint
kind	string: EndpointWithManagedIdentity	Tipo di connessione.
resourceId	string	ID risorsa

Error

Errore

Nome	Tipo	Descrizione
code	ErrorCode	ErrorCode Codici di errore definiti nelle linee guida di Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Dettagli dell'errore, se disponibile.
innererror	InnerError	InnerError Errore interno come definito nelle linee guida di Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	Messaggio di questo errore.
target	string	Posizione in cui si è verificato l'errore, se disponibile.

ErrorCode

Nome	Tipo	Descrizione
conflict	string	L'operazione richiesta è in conflitto con lo stato della risorsa corrente.
contentFilter	string	La generazione di immagini non è riuscita a causa del nostro sistema di sicurezza.
fileImportFailed	string	Importazione del file non riuscita.
forbidden	string	L'operazione non è consentita per la chiave utente/API corrente.
internalFailure	string	Errore interno. Riprovare.
invalidPayload	string	I dati della richiesta non sono validi per questa operazione.
itemDoesAlreadyExist	string	L'elemento esiste già.
jsonlValidationFailed	string	La convalida dei dati jsonl non è riuscita.
notFound	string	La risorsa non viene trovata.
quotaExceeded	string	Quota superata.
serviceUnavailable	string	Il servizio non è attualmente disponibile.
tooManyRequests	string	Troppe richieste. Riprovare più tardi.
unauthorized	string	La chiave utente/API corrente non è autorizzata per l'operazione.
unexpectedEntityState	string	L'operazione non può essere eseguita nello stato della risorsa corrente.

ErrorResponse

Nome	Tipo	Descrizione
error	Error	Errore Contenuto degli errori come definito nelle linee guida microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

GenericEmbeddingSettings

ConnectionEmbeddingSettings

Nome	Tipo	Descrizione
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Connessione a una risorsa.
deploymentName	string
modelName	string

IngestionJobCompletionAction

Azione di completamento.

Nome	Tipo	Descrizione
cleanUpTempAssets	string	Pulisce gli asset intermedi creati durante il processo di inserimento.
keepAllAssets	string	Non eseguirà la pulizia di nessuno degli asset intermedi creati durante il processo di inserimento.

IngestionJobSystemCompute

Nome	Tipo	Descrizione
completionAction	IngestionJobCompletionAction	Azione di completamento.
dataRefreshIntervalInHours	integer
datasource	SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId	string
kind	string: SystemCompute	IngestionJobType Tipo di processo.
searchServiceConnection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Connessione a una risorsa.

IngestionJobType

Nome	Tipo	Descrizione
SystemCompute	string	Processi eseguiti sulle risorse di proprietà del servizio.
UserCompute	string	Processi eseguiti nell'area di lavoro di proprietà dell'utente.

IngestionJobUserCompute

Nome	Tipo	Descrizione
compute	JobCompute: CustomCompute ServerlessCompute	JobCompute Impostazioni di calcolo del processo.
dataRefreshIntervalInHours	integer
datasource	UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId	string
kind	string: UserCompute	IngestionJobType Tipo di processo.
target	TargetIndex: AzureAISearchIndex CosmosDBIndex PineconeIndex	TargetIndex Informazioni sull'indice da creare.
workspaceId	string

InnerError

Nome	Tipo	Descrizione
code	InnerErrorCode	InnerErrorCode Codici di errore interni definiti nelle linee guida di Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Errore interno come definito nelle linee guida di Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Nome	Tipo	Descrizione
invalidPayload	string	I dati della richiesta non sono validi per questa operazione.

PineconeIndex

Pinecone Index.

Nome	Tipo	Descrizione
connectionId	string	ID della connessione che punta al pinecone.
kind	string: Pinecone	Tipo di destinazione.

ServerlessCompute

Calcolo serverless.

Nome	Tipo	Descrizione
instanceCount	integer	Numero di istanze in cui eseguire il processo.
kind	string: ServerlessCompute	Tipo di calcolo.
sku	string	Livello SKU

SystemComputeDatasourceType

Tipo di origine dati.

Nome	Tipo	Descrizione
Storage	string	Account di archiviazione di Azure.
Urls	string	URL.

SystemComputeStorage

Nome	Tipo	Descrizione
chunking	ChunkingSettings	ChunkingSettings Impostazioni di suddivisione in blocchi
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Connessione a una risorsa.
containerName	string	nome contenitore
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Impostazioni di incorporamento della connessione
kind	string: Storage	Tipo di origine dati.

SystemComputeUrl

Nome	Tipo	Descrizione
chunking	ChunkingSettings	ChunkingSettings Impostazioni di suddivisione in blocchi
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Connessione a una risorsa.
containerName	string	nome contenitore
crawling	CrawlingSettings	CrawlingSettings Impostazioni di ricerca per indicizzazione
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Impostazioni di incorporamento della connessione
kind	string: Urls	Tipo di origine dati.
urls	string[]

TargetType

Tipo di destinazione.

Nome	Tipo	Descrizione
AzureAISearch	string	Indice di Ricerca di intelligenza artificiale di Azure.
CosmosDB	string	Indice di CosmosDB.
Pinecone	string	Pinecone Index.

UserComputeDataset

UserComputeStorage

Nome	Tipo	Descrizione
chunking	ChunkingSettings	ChunkingSettings Impostazioni di suddivisione in blocchi
datasetId	string
datasetType	string
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings ID connessione al modello di incorporamento
kind	string: Dataset	Tipo di origine dati.

UserComputeDatasourceType

Tipo di origine dati.

Nome	Tipo	Descrizione
Dataset	string	Set di dati dell'area di lavoro.
Urls	string	URL.

UserComputeUrl

Nome	Tipo	Descrizione
chunking	ChunkingSettings	ChunkingSettings Impostazioni di suddivisione in blocchi
crawling	CrawlingSettings	CrawlingSettings Impostazioni di ricerca per indicizzazione
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings ID connessione al modello di incorporamento
kind	string: Urls	Tipo di origine dati.
urls	string[]

WorkspaceConnection

Connessione dell'area di lavoro AML.

Nome	Tipo	Descrizione
connectionId	string	ConnectionId
kind	string: WorkspaceConnection	Tipo di connessione.

WorkspaceConnectionEmbeddingSettings

Nome	Tipo	Descrizione
connectionId	string
deploymentName	string
modelName	string

Condividi tramite

Ingestion Jobs - Create

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

IngestionJobSystemCompute

IngestionJobUserCompute

Risposte

Sicurezza

api-key

OAuth2Auth

Ambiti

Esempio

Create a system-compute ingestion job

Esempio di richiesta

Risposta di esempio

Create a user-compute ingestion job

Esempio di richiesta

Risposta di esempio

Definizioni

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

Risorse aggiuntive