Freigeben über


Ingestion Jobs - Create

Erstellt einen Aufnahmeauftrag mit der angegebenen Auftrags-ID.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
path True

string

url

Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B.: https://aoairesource.openai.azure.com. Ersetzen Sie "aoairesource" durch Ihren Azure OpenAI-Kontonamen.

job-id
path True

string

Die ID des Auftrags, der erstellt wird.

api-version
query True

string

Die angeforderte API-Version.

Anforderungsheader

Name Erforderlich Typ Beschreibung
mgmt-user-token

string

Das Token, das für den Zugriff auf den Arbeitsbereich verwendet wird (nur für Benutzerberechnungsaufträge erforderlich).

aml-user-token

string

Das Token, das für den Zugriff auf die Ressourcen innerhalb des Auftrags im Arbeitsbereich verwendet wird (nur für Benutzerberechnungsaufträge erforderlich).

Anforderungstext

Beim Anforderungstext kann es sich um eines der folgenden Elemente handeln:

Name Beschreibung
IngestionJobSystemCompute
IngestionJobUserCompute

IngestionJobSystemCompute

Name Erforderlich Typ Beschreibung
kind True string:

SystemCompute

IngestionJobType
Der Auftragstyp.

completionAction

IngestionJobCompletionAction

Die Abschlussaktion.

dataRefreshIntervalInHours

integer

datasource SystemComputeDatasource:

SystemComputeDatasource

jobId

string

searchServiceConnection BaseConnection:

BaseConnection
Eine Verbindung mit einer Ressource.

IngestionJobUserCompute

Name Erforderlich Typ Beschreibung
kind True string:

UserCompute

IngestionJobType
Der Auftragstyp.

workspaceId True

string

compute JobCompute:

JobCompute
Die Berechnungseinstellungen des Auftrags.

dataRefreshIntervalInHours

integer

datasource UserComputeDatasource:

UserComputeDatasource

jobId

string

target TargetIndex:

TargetIndex
Informationen zum zu erstellenden Index.

Antworten

Name Typ Beschreibung
200 OK IngestionJob:

Erfolg

Other Status Codes

ErrorResponse

Fehler.

Sicherheit

api-key

API-Schlüsselauthentifizierung

Typ: apiKey
In: header

OAuth2Auth

OAuth2-Authentifizierung

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiche

Name Beschreibung
https://cognitiveservices.azure.com/.default

Beispiele

Create a system-compute ingestion job
Create a user-compute ingestion job

Create a system-compute ingestion job

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
AzureAISearchIndex

Azure AI Search Index.

ChunkingSettings

ChunkingSettings

ComputeType

Der Berechnungstyp.

ConnectionStringConnection

Verbindungszeichenfolgenverbindung.

ConnectionType

Der Verbindungstyp.

CosmosDBIndex

CosmosDB Index.

CrawlingSettings

CrawlingSettings

CustomCompute

Benutzerdefinierter Compute.

DeploymentConnection

Relative Bereitstellungsverbindung.

EndpointKeyConnection

Endpunktschlüsselverbindung.

EndpointMIConnection

Verwaltete Endpunktidentitätsverbindung.

Error

Fehler

ErrorCode

ErrorCode

ErrorResponse

ErrorResponse

GenericEmbeddingSettings

ConnectionEmbeddingSettings

IngestionJobCompletionAction

Die Abschlussaktion.

IngestionJobSystemCompute
IngestionJobType

IngestionJobType

IngestionJobUserCompute
InnerError

InnerError

InnerErrorCode

InnerErrorCode

PineconeIndex

Pinecone Index.

ServerlessCompute

Serverlose Berechnung.

SystemComputeDatasourceType

Der Datenquellentyp.

SystemComputeStorage

SystemComputeStorage

SystemComputeUrl

SystemComputeUrl

TargetType

Der Zieltyp.

UserComputeDataset

UserComputeStorage

UserComputeDatasourceType

Der Datenquellentyp.

UserComputeUrl

UserComputeUrl

WorkspaceConnection

AML-Arbeitsbereichsverbindung.

WorkspaceConnectionEmbeddingSettings

WorkspaceConnectionEmbeddingSettings

AzureAISearchIndex

Azure AI Search Index.

Name Typ Beschreibung
connectionId

string

Die ID der Verbindung, die auf den Azure AI Search-Index verweist.

kind string:

AzureAISearch

Der Zieltyp.

ChunkingSettings

ChunkingSettings

Name Typ Beschreibung
maxChunkSizeInTokens

integer

ComputeType

Der Berechnungstyp.

Wert Beschreibung
CustomCompute

Benutzerdefinierte Benutzerberechnung.

ServerlessCompute

Serverlose Benutzerberechnung.

ConnectionStringConnection

Verbindungszeichenfolgenverbindung.

Name Typ Beschreibung
connectionString

string

Verbindungszeichenfolge

kind string:

ConnectionString

Der Verbindungstyp.

ConnectionType

Der Verbindungstyp.

Wert Beschreibung
ConnectionString

Verbindungszeichenfolge.

EndpointWithKey

Endpunkt- und Schlüsselverbindung.

EndpointWithManagedIdentity

Endpunkt und verwaltete Identität.

RelativeConnection

Relative Bereitstellung

WorkspaceConnection

AML-Arbeitsbereichsverbindung.

CosmosDBIndex

CosmosDB Index.

Name Typ Beschreibung
collectionName

string

Der Name der Cosmos DB-Sammlung.

connectionId

string

Die ID der Verbindung, die auf den Cosmos DB zeigt.

databaseName

string

Der Name der Cosmos DB-Datenbank.

kind string:

CosmosDB

Der Zieltyp.

CrawlingSettings

CrawlingSettings

Name Typ Beschreibung
maxCrawlDepth

integer

maxCrawlTimeInMins

integer

maxDownloadTimeInMins

integer

maxFileSize

integer

maxFiles

integer

maxRedirects

integer

CustomCompute

Benutzerdefinierter Compute.

Name Typ Beschreibung
computeId

string

ID des benutzerdefinierten Computes

kind string:

CustomCompute

Der Berechnungstyp.

DeploymentConnection

Relative Bereitstellungsverbindung.

Name Typ Beschreibung
kind string:

RelativeConnection

Der Verbindungstyp.

EndpointKeyConnection

Endpunktschlüsselverbindung.

Name Typ Beschreibung
endpoint

string

Endpunkt

key

string

Schlüssel

kind string:

EndpointWithKey

Der Verbindungstyp.

EndpointMIConnection

Verwaltete Endpunktidentitätsverbindung.

Name Typ Beschreibung
endpoint

string

Endpunkt

kind string:

EndpointWithManagedIdentity

Der Verbindungstyp.

resourceId

string

Ressourcen-ID

Error

Fehler

Name Typ Beschreibung
code

ErrorCode

ErrorCode
Fehlercodes gemäß der Definition in den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

details

Error[]

Die Fehlerdetails, falls verfügbar.

innererror

InnerError

InnerError
Innerer Fehler gemäß den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

message

string

Die Meldung dieses Fehlers.

target

string

Der Ort, an dem der Fehler aufgetreten ist, falls verfügbar.

ErrorCode

ErrorCode

Wert Beschreibung
conflict

Der angeforderte Vorgang ist mit dem aktuellen Ressourcenstatus in Konflikt.

contentFilter

Die Bildgenerierung ist aufgrund unseres Sicherheitssystems fehlgeschlagen.

fileImportFailed

Fehler beim Importieren der Datei.

forbidden

Der Vorgang ist für den aktuellen Benutzer-/API-Schlüssel verboten.

internalFailure

Interner Fehler. Versuchen Sie es erneut.

invalidPayload

Die Anforderungsdaten sind für diesen Vorgang ungültig.

itemDoesAlreadyExist

Das Element ist bereits vorhanden.

jsonlValidationFailed

Fehler bei der Überprüfung von JSONL-Daten.

notFound

Die Ressource wurde nicht gefunden.

quotaExceeded

Das Kontingent wurde überschritten.

serviceUnavailable

Der Dienst ist derzeit nicht verfügbar.

tooManyRequests

Zu viele Anforderungen. Versuchen Sie es später erneut.

unauthorized

Der aktuelle Benutzer-/API-Schlüssel ist für den Vorgang nicht autorisiert.

unexpectedEntityState

Der Vorgang kann nicht im Zustand der aktuellen Ressource ausgeführt werden.

ErrorResponse

ErrorResponse

Name Typ Beschreibung
error

Error

Fehler
Fehlerinhalte gemäß den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

GenericEmbeddingSettings

ConnectionEmbeddingSettings

Name Typ Beschreibung
connection BaseConnection:

BaseConnection
Eine Verbindung mit einer Ressource.

deploymentName

string

modelName

string

IngestionJobCompletionAction

Die Abschlussaktion.

Wert Beschreibung
cleanUpTempAssets

Bereinigt Zwischenressourcen, die während des Aufnahmevorgangs erstellt wurden.

keepAllAssets

Bereinigt keine der zwischengeschalteten Ressourcen, die während des Aufnahmevorgangs erstellt wurden.

IngestionJobSystemCompute

Name Typ Beschreibung
completionAction

IngestionJobCompletionAction

Die Abschlussaktion.

dataRefreshIntervalInHours

integer

datasource SystemComputeDatasource:

SystemComputeDatasource

jobId

string

kind string:

SystemCompute

IngestionJobType
Der Auftragstyp.

searchServiceConnection BaseConnection:

BaseConnection
Eine Verbindung mit einer Ressource.

IngestionJobType

IngestionJobType

Wert Beschreibung
SystemCompute

Aufträge, die in diensteigenen Ressourcen ausgeführt werden.

UserCompute

Aufträge, die im Arbeitsbereich des Benutzers ausgeführt werden.

IngestionJobUserCompute

Name Typ Beschreibung
compute JobCompute:

JobCompute
Die Berechnungseinstellungen des Auftrags.

dataRefreshIntervalInHours

integer

datasource UserComputeDatasource:

UserComputeDatasource

jobId

string

kind string:

UserCompute

IngestionJobType
Der Auftragstyp.

target TargetIndex:

TargetIndex
Informationen zum zu erstellenden Index.

workspaceId

string

InnerError

InnerError

Name Typ Beschreibung
code

InnerErrorCode

InnerErrorCode
Innere Fehlercodes gemäß den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

innererror

InnerError

InnerError
Innerer Fehler gemäß den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

InnerErrorCode

Wert Beschreibung
invalidPayload

Die Anforderungsdaten sind für diesen Vorgang ungültig.

PineconeIndex

Pinecone Index.

Name Typ Beschreibung
connectionId

string

Die ID der Verbindung, die auf den Pinecone zeigt.

kind string:

Pinecone

Der Zieltyp.

ServerlessCompute

Serverlose Berechnung.

Name Typ Beschreibung
instanceCount

integer

Die Anzahl der Instanzen, auf denen der Auftrag ausgeführt werden soll.

kind string:

ServerlessCompute

Der Berechnungstyp.

sku

string

SKU-Ebene

SystemComputeDatasourceType

Der Datenquellentyp.

Wert Beschreibung
Storage

Azure Storage-Konto.

Urls

URLs.

SystemComputeStorage

SystemComputeStorage

Name Typ Beschreibung
chunking

ChunkingSettings

ChunkingSettings
Abschnittseinstellungen

connection BaseConnection:

BaseConnection
Eine Verbindung mit einer Ressource.

containerName

string

Containername

embeddings

GenericEmbeddingSettings[]

ConnectionEmbeddingSettings
Einstellungen für das Einbetten von Verbindungen

kind string:

Storage

Der Datenquellentyp.

SystemComputeUrl

SystemComputeUrl

Name Typ Beschreibung
chunking

ChunkingSettings

ChunkingSettings
Abschnittseinstellungen

connection BaseConnection:

BaseConnection
Eine Verbindung mit einer Ressource.

containerName

string

Containername

crawling

CrawlingSettings

CrawlingSettings
Durchforstungseinstellungen

embeddings

GenericEmbeddingSettings[]

ConnectionEmbeddingSettings
Einstellungen für das Einbetten von Verbindungen

kind string:

Urls

Der Datenquellentyp.

urls

string[]

TargetType

Der Zieltyp.

Wert Beschreibung
AzureAISearch

Azure AI Search Index.

CosmosDB

CosmosDB Index.

Pinecone

Pinecone Index.

UserComputeDataset

UserComputeStorage

Name Typ Beschreibung
chunking

ChunkingSettings

ChunkingSettings
Abschnittseinstellungen

datasetId

string

datasetType

string

embeddings

WorkspaceConnectionEmbeddingSettings[]

WorkspaceConnectionEmbeddingSettings
Verbindungs-ID mit dem Einbettungsmodell

kind string:

Dataset

Der Datenquellentyp.

UserComputeDatasourceType

Der Datenquellentyp.

Wert Beschreibung
Dataset

Arbeitsbereichs-Dataset.

Urls

URLs.

UserComputeUrl

UserComputeUrl

Name Typ Beschreibung
chunking

ChunkingSettings

ChunkingSettings
Abschnittseinstellungen

crawling

CrawlingSettings

CrawlingSettings
Durchforstungseinstellungen

embeddings

WorkspaceConnectionEmbeddingSettings[]

WorkspaceConnectionEmbeddingSettings
Verbindungs-ID mit dem Einbettungsmodell

kind string:

Urls

Der Datenquellentyp.

urls

string[]

WorkspaceConnection

AML-Arbeitsbereichsverbindung.

Name Typ Beschreibung
connectionId

string

ConnectionId

kind string:

WorkspaceConnection

Der Verbindungstyp.

WorkspaceConnectionEmbeddingSettings

WorkspaceConnectionEmbeddingSettings

Name Typ Beschreibung
connectionId

string

deploymentName

string

modelName

string