Ingestion Jobs - Create

Referenz

Service:: Cognitive Services - Azure OpenAI

API Version:: 2023-10-01-preview

Startet einen Auftrag zum Erfassen von Daten in einem Azure Search-Index, der als Datenquelle für Vervollständigungen verwendet werden soll. Der status des Erfassungsauftrags wird nach Abschluss 48 Stunden aufbewahrt und anschließend gelöscht.

PUT {endpoint}/openai/extensions/on-your-data/ingestion-jobs/{jobId}?api-version=2023-10-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 den Namen Ihres Azure OpenAI-Kontos.
jobId	path	True	string	Die ID des Erfassungsauftrags.
api-version	query	True	string	Die angeforderte API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
api-key	True	string	Geben Sie hier Ihren Azure OpenAI-Kontoschlüssel für Cognitive Services an.
searchServiceEndpoint	True	string	Der Endpunkt der Suchdienstressource, in der die Erfassungsressourcen erstellt werden.
searchServiceAdminKey		string	Der Administratorschlüssel für die Suchdienstressource, wenn die verwaltete Identität nicht eingerichtet ist.
storageConnectionString	True	string	Die Verbindungszeichenfolge an das Blobspeicherkonto, das die erfassten Daten hostet.
storageContainer	True	string	Der Name des Containers, in dem die erfassten Daten gehostet werden.
embeddingEndpoint		string	Der Endpunkt des Einbettungsmodells, das bei Aktivierung für Einbettungsberechnungen verwendet werden soll.
embeddingKey		string	Der Schlüssel, der für den Zugriff auf das Einbettungsmodell verwendet werden soll, wenn aktiviert und die verwaltete Identität nicht eingerichtet ist.
storageEndpoint		string	Der Blob storage-Endpunkt, der die erfassten Daten hostet. Erforderlich für das ResourceId-Format von storageConnectionString.
embeddingDeploymentName		string	Der Name der Einbettungsbereitstellung der aktuellen Azure OpenAI-Ressource, die für den Zugriff auf das Einbettungsmodell verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
dataRefreshIntervalInMinutes	True	integer
chunkSize		integer	Diese Zahl definiert die maximale Anzahl von Token in jedem Blöcke, der vom Erfassungsfluss erzeugt wird.
completionAction		IngestionJobCompletionAction	IngestionJobCompletionAction Die Aktion, die beim Abschluss des Erfassungsauftrags ausgeführt werden soll.
id		string
progress		IngestionJobProgress	IngestionJobProgress
warnings		string[]

Antworten

Name	Typ	Beschreibung
200 OK	IngestionJob	Erfolg
Other Status Codes	ErrorResponse	Ein Fehler ist aufgetreten.

Sicherheit

api-key

Geben Sie hier Ihren Azure OpenAI-Kontoschlüssel für Cognitive Services an.

Type: apiKey
In: header

Beispiele

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

Definitionen

Name	Beschreibung
Error	Fehler
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
IngestionJob	IngestionJob
IngestionJobCompletionAction	IngestionJobCompletionAction
IngestionJobProgress	IngestionJobProgress
InnerError	InnerError
InnerErrorCode	InnerErrorCode
OperationState	OperationState
StageProgress

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, wie in den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) definiert.
message	string	Die Meldung dieses Fehlers.
target	string	Der Speicherort, an dem der Fehler aufgetreten ist, falls verfügbar.

ErrorCode

Name	Typ	Beschreibung
conflict	string	Der angeforderte Vorgang ist in Konflikt mit dem aktuellen Ressourcenzustand.
contentFilter	string	Die Bildgenerierung ist aufgrund unseres Sicherheitssystems fehlgeschlagen.
fileImportFailed	string	Fehler beim Importieren der Datei.
forbidden	string	Der Vorgang ist für den aktuellen Benutzer-/API-Schlüssel unzulässig.
internalFailure	string	Interner Fehler. Versuchen Sie es erneut.
invalidPayload	string	Die Anforderungsdaten sind für diesen Vorgang ungültig.
itemDoesAlreadyExist	string	Das Element ist bereits vorhanden.
jsonlValidationFailed	string	Fehler bei der Überprüfung von JSONL-Daten.
notFound	string	Die Ressource wurde nicht gefunden.
quotaExceeded	string	Kontingent überschritten.
serviceUnavailable	string	Der Dienst ist derzeit nicht verfügbar.
tooManyRequests	string	Too many requests. (Zu viele Anforderungen.) Versuchen Sie es später noch mal.
unauthorized	string	Der aktuelle Benutzer-/API-Schlüssel ist nicht für den Vorgang autorisiert.
unexpectedEntityState	string	Der Vorgang kann nicht im Zustand der aktuellen Ressource ausgeführt werden.

ErrorResponse

Name	Typ	Beschreibung
error	Error	Fehler Fehlerinhalt gemäß der Definition in den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

IngestionJob

Name	Typ	Standardwert	Beschreibung
chunkSize	integer	1024	Diese Zahl definiert die maximale Anzahl von Token in jedem Blöcke, der vom Erfassungsfluss erzeugt wird.
completionAction	IngestionJobCompletionAction		IngestionJobCompletionAction Die Aktion, die beim Abschluss des Erfassungsauftrags ausgeführt werden soll.
dataRefreshIntervalInMinutes	integer
error	Error		Fehler Fehlerinhalt gemäß der Definition in den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
id	string
progress	IngestionJobProgress		IngestionJobProgress
status	OperationState		OperationState Der Status eines Auftrags oder Elements.
warnings	string[]

IngestionJobCompletionAction

Name	Typ	Beschreibung
cleanUpAssets	string	Wird sauber zwischengeschaltete Ressourcen, die während des Erfassungsprozesses erstellt wurden.
keepAllAssets	string	Sauber keines der während des Erfassungsprozesses erstellten Zwischenressourcen.

IngestionJobProgress

Name	Typ	Beschreibung
stageProgress	StageProgress[]

InnerError

Name	Typ	Beschreibung
code	InnerErrorCode	InnerErrorCode Interne Fehlercodes, wie in den Microsoft REST-Richtlinien definiert (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Innerer Fehler, wie in den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) definiert.

InnerErrorCode

Name	Typ	Beschreibung
invalidPayload	string	Die Anforderungsdaten sind für diesen Vorgang ungültig.

OperationState

Name	Typ	Beschreibung
failed	string	Der Vorgang hat die Verarbeitung mit einem Fehler abgeschlossen und kann nicht weiter genutzt werden.
notRunning	string	Der Vorgang ist noch nicht in die Warteschlange eingereiht, um in Zukunft verarbeitet zu werden.
running	string	Die Verarbeitung des Vorgangs wurde gestartet.
succeeded	string	Der Vorgang wurde erfolgreich verarbeitet und kann verwendet werden.

StageProgress

Name	Typ	Beschreibung
name	string
processedItems	integer
totalItems	integer

Share via