Ingestion Jobs - Create

Référence

Service:: Azure AI Services

Version d'API:: 2025-02-01-preview

Crée un travail d’ingestion avec l’ID de travail spécifié.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string url	Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre compte Azure OpenAI).
job-id	path	True	string	ID du travail qui sera créé.
api-version	query	True	string	Version de l’API demandée.

En-tête de la demande

Nom	Obligatoire	Type	Description
mgmt-user-token		string	Jeton utilisé pour accéder à l’espace de travail (nécessaire uniquement pour les travaux de calcul utilisateur).
aml-user-token		string	Jeton utilisé pour accéder aux ressources au sein du travail dans l’espace de travail (nécessaire uniquement pour les travaux de calcul utilisateur).

Corps de la demande

Le corps de la requête peut être l’un des suivants :

Nom	Description
IngestionJobSystemCompute
IngestionJobUserCompute

IngestionJobSystemCompute

Nom	Obligatoire	Type	Description
kind	True	string: SystemCompute	IngestionJobType Type de travail.
completionAction		IngestionJobCompletionAction	Action d’achèvement.
dataRefreshIntervalInHours		integer
datasource		SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId		string
searchServiceConnection		BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Connexion à une ressource.

IngestionJobUserCompute

Nom	Obligatoire	Type	Description
kind	True	string: UserCompute	IngestionJobType Type de travail.
workspaceId	True	string
compute		JobCompute: CustomCompute ServerlessCompute	JobCompute Paramètres de calcul du travail.
dataRefreshIntervalInHours		integer
datasource		UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId		string
target		TargetIndex: AzureAISearchIndex CosmosDBIndex PineconeIndex	TargetIndex Informations sur l’index à créer.

Réponses

Nom	Type	Description
200 OK	IngestionJob: IngestionJobSystemCompute IngestionJobUserCompute	Succès
Other Status Codes	ErrorResponse	Une erreur s’est produite.

Sécurité

api-key

Authentification par clé API

Type: apiKey
Dans: header

OAuth2Auth

Authentification OAuth2

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Étendues

Nom	Description
https://cognitiveservices.azure.com/.default

Exemples

Create a system-compute ingestion job

Create a user-compute ingestion job

Create a system-compute ingestion job

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

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

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
AzureAISearchIndex	Index Recherche d’IA Azure.
ChunkingSettings	ChunkingSettings
ComputeType	Type de calcul.
ConnectionStringConnection	Connexion à la chaîne de connexion.
ConnectionType	Type de connexion.
CosmosDBIndex	Index CosmosDB.
CrawlingSettings	CrawlingSettings
CustomCompute	Calcul personnalisé.
DeploymentConnection	Connexion de déploiement relative.
EndpointKeyConnection	Connexion de clé de point de terminaison.
EndpointMIConnection	Connexion d’identité managée de point de terminaison.
Error	Erreur
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
GenericEmbeddingSettings	ConnectionEmbeddingSettings
IngestionJobCompletionAction	Action d’achèvement.
IngestionJobSystemCompute
IngestionJobType	IngestionJobType
IngestionJobUserCompute
InnerError	InnerError
InnerErrorCode	InnerErrorCode
PineconeIndex	Pinecone Index.
ServerlessCompute	Calcul serverless.
SystemComputeDatasourceType	Type de source de données.
SystemComputeStorage	SystemComputeStorage
SystemComputeUrl	SystemComputeUrl
TargetType	Type cible.
UserComputeDataset	UserComputeStorage
UserComputeDatasourceType	Type de source de données.
UserComputeUrl	UserComputeUrl
WorkspaceConnection	Connexion de l’espace de travail AML.
WorkspaceConnectionEmbeddingSettings	WorkspaceConnectionEmbeddingSettings

AzureAISearchIndex

Object

Index Recherche d’IA Azure.

Nom	Type	Description
connectionId	string	ID de la connexion pointant vers l’index Recherche d’IA Azure.
kind	string: AzureAISearch	Type cible.

ChunkingSettings

Object

ChunkingSettings

Nom	Type	Description
maxChunkSizeInTokens	integer

ComputeType

Enumeration

Type de calcul.

Valeur	Description
CustomCompute	Calcul utilisateur personnalisé.
ServerlessCompute	Calcul utilisateur serverless.

ConnectionStringConnection

Object

Connexion à la chaîne de connexion.

Nom	Type	Description
connectionString	string	Chaîne de connexion
kind	string: ConnectionString	Type de connexion.

ConnectionType

Enumeration

Type de connexion.

Valeur	Description
ConnectionString	Chaîne de connexion.
EndpointWithKey	Connexion de point de terminaison et de clé.
EndpointWithManagedIdentity	Point de terminaison et identité managée.
RelativeConnection	Déploiement relatif
WorkspaceConnection	Connexion de l’espace de travail AML.

CosmosDBIndex

Object

Index CosmosDB.

Nom	Type	Description
collectionName	string	Nom de la collection cosmos DB.
connectionId	string	ID de la connexion pointant vers cosmos DB.
databaseName	string	Nom de la base de données cosmos DB.
kind	string: CosmosDB	Type cible.

CrawlingSettings

Object

CrawlingSettings

Nom	Type	Description
maxCrawlDepth	integer
maxCrawlTimeInMins	integer
maxDownloadTimeInMins	integer
maxFileSize	integer
maxFiles	integer
maxRedirects	integer

CustomCompute

Object

Calcul personnalisé.

Nom	Type	Description
computeId	string	ID du calcul personnalisé
kind	string: CustomCompute	Type de calcul.

DeploymentConnection

Object

Connexion de déploiement relative.

Nom	Type	Description
kind	string: RelativeConnection	Type de connexion.

EndpointKeyConnection

Object

Connexion de clé de point de terminaison.

Nom	Type	Description
endpoint	string	Extrémité
key	string	Clé
kind	string: EndpointWithKey	Type de connexion.

EndpointMIConnection

Object

Connexion d’identité managée de point de terminaison.

Nom	Type	Description
endpoint	string	Extrémité
kind	string: EndpointWithManagedIdentity	Type de connexion.
resourceId	string	ID de ressource

Error

Object

Erreur

Nom	Type	Description
code	ErrorCode	ErrorCode Codes d’erreur tels que définis dans les instructions REST Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Détails de l’erreur s’il est disponible.
innererror	InnerError	InnerError Erreur interne telle que définie dans les instructions REST Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	Message de cette erreur.
target	string	Emplacement où l’erreur s’est produite si disponible.

ErrorCode

Enumeration

ErrorCode

Valeur	Description
conflict	L’opération demandée est en conflit avec l’état de ressource actuel.
contentFilter	La génération d’images a échoué suite à notre système de sécurité.
fileImportFailed	Échec de l’importation du fichier.
forbidden	L’opération est interdite pour la clé utilisateur/API actuelle.
internalFailure	Erreur interne. Réessayez.
invalidPayload	Les données de requête ne sont pas valides pour cette opération.
itemDoesAlreadyExist	L’élément existe déjà.
jsonlValidationFailed	Échec de la validation des données jsonl.
notFound	La ressource est introuvable.
quotaExceeded	Quota dépassé.
serviceUnavailable	Le service n’est actuellement pas disponible.
tooManyRequests	Trop de demandes. Réessayez ultérieurement.
unauthorized	La clé utilisateur/API actuelle n’est pas autorisée pour l’opération.
unexpectedEntityState	L’opération ne peut pas être exécutée dans l’état de la ressource actuelle.

ErrorResponse

Object

ErrorResponse

Nom	Type	Description
error	Error	Erreur Contenu d’erreur tel que défini dans les instructions REST Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

GenericEmbeddingSettings

Object

ConnectionEmbeddingSettings

Nom	Type	Description
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Connexion à une ressource.
deploymentName	string
modelName	string

IngestionJobCompletionAction

Enumeration

Action d’achèvement.

Valeur	Description
cleanUpTempAssets	Nettoie les ressources intermédiaires créées pendant le processus d’ingestion.
keepAllAssets	Ne nettoie pas les ressources intermédiaires créées pendant le processus d’ingestion.

IngestionJobSystemCompute

Object

Nom	Type	Description
completionAction	IngestionJobCompletionAction	Action d’achèvement.
dataRefreshIntervalInHours	integer
datasource	SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId	string
kind	string: SystemCompute	IngestionJobType Type de travail.
searchServiceConnection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Connexion à une ressource.

IngestionJobType

Enumeration

IngestionJobType

Valeur	Description
SystemCompute	Travaux qui s’exécutent sur des ressources appartenant au service.
UserCompute	Travaux qui s’exécutent sur l’espace de travail appartenant à l’utilisateur.

IngestionJobUserCompute

Object

Nom	Type	Description
compute	JobCompute: CustomCompute ServerlessCompute	JobCompute Paramètres de calcul du travail.
dataRefreshIntervalInHours	integer
datasource	UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId	string
kind	string: UserCompute	IngestionJobType Type de travail.
target	TargetIndex: AzureAISearchIndex CosmosDBIndex PineconeIndex	TargetIndex Informations sur l’index à créer.
workspaceId	string

InnerError

Object

InnerError

Nom	Type	Description
code	InnerErrorCode	InnerErrorCode Codes d’erreur internes tels que définis dans les instructions MICROSOFT REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Erreur interne telle que définie dans les instructions REST Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Enumeration

InnerErrorCode

Valeur	Description
invalidPayload	Les données de requête ne sont pas valides pour cette opération.

PineconeIndex

Object

Pinecone Index.

Nom	Type	Description
connectionId	string	ID de la connexion pointant vers le pincone.
kind	string: Pinecone	Type cible.

ServerlessCompute

Object

Calcul serverless.

Nom	Type	Description
instanceCount	integer	Nombre d’instances sur laquelle exécuter le travail.
kind	string: ServerlessCompute	Type de calcul.
sku	string	Niveau de référence SKU

SystemComputeDatasourceType

Enumeration

Type de source de données.

Valeur	Description
Storage	Compte de stockage Azure.
Urls	URL.

SystemComputeStorage

Object

SystemComputeStorage

Nom	Type	Description
chunking	ChunkingSettings	ChunkingSettings Paramètres de segmentation
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Connexion à une ressource.
containerName	string	nom du conteneur
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Paramètres d’incorporation de connexion
kind	string: Storage	Type de source de données.

SystemComputeUrl

Object

SystemComputeUrl

Nom	Type	Description
chunking	ChunkingSettings	ChunkingSettings Paramètres de segmentation
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Connexion à une ressource.
containerName	string	nom du conteneur
crawling	CrawlingSettings	CrawlingSettings Paramètres d’analyse
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Paramètres d’incorporation de connexion
kind	string: Urls	Type de source de données.
urls	string[]

TargetType

Enumeration

Type cible.

Valeur	Description
AzureAISearch	Index Recherche d’IA Azure.
CosmosDB	Index CosmosDB.
Pinecone	Pinecone Index.

UserComputeDataset

Object

UserComputeStorage

Nom	Type	Description
chunking	ChunkingSettings	ChunkingSettings Paramètres de segmentation
datasetId	string
datasetType	string
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings ID de connexion au modèle d’incorporation
kind	string: Dataset	Type de source de données.

UserComputeDatasourceType

Enumeration

Type de source de données.

Valeur	Description
Dataset	Jeu de données d’espace de travail.
Urls	URL.

UserComputeUrl

Object

UserComputeUrl

Nom	Type	Description
chunking	ChunkingSettings	ChunkingSettings Paramètres de segmentation
crawling	CrawlingSettings	CrawlingSettings Paramètres d’analyse
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings ID de connexion au modèle d’incorporation
kind	string: Urls	Type de source de données.
urls	string[]

WorkspaceConnection

Object

Connexion de l’espace de travail AML.

Nom	Type	Description
connectionId	string	ConnectionId
kind	string: WorkspaceConnection	Type de connexion.

WorkspaceConnectionEmbeddingSettings

Object

WorkspaceConnectionEmbeddingSettings

Nom	Type	Description
connectionId	string
deploymentName	string
modelName	string

Partager via

Ingestion Jobs - Create

Paramètres URI

En-tête de la demande

Corps de la demande

IngestionJobSystemCompute

IngestionJobUserCompute

Réponses

Sécurité

api-key

OAuth2Auth

Étendues

Exemples

Create a system-compute ingestion job

Exemple de requête

Exemple de réponse

Create a user-compute ingestion job

Exemple de requête

Exemple de réponse

Définitions

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

Ressources supplémentaires