Ingestion Jobs - Get

Referenz

Dienst:: Azure AI Services

API-Version:: 2024-05-01-preview

Ruft die Details der angegebenen Auftrags-ID ab.

GET {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2024-05-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.
api-version	query	True	string	Die angeforderte API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	IngestionJob: IngestionJobSystemCompute IngestionJobUserCompute	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

Get ingestion job

Beispielanforderung

HTTP

GET {endpoint}/openai/ingestion/jobs/ingestion-job?api-version=2024-05-01-preview

Beispiel für eine Antwort

Statuscode:: 200

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

Name	Typ	Beschreibung
maxChunkSizeInTokens	integer

ComputeType

Der Berechnungstyp.

Name	Typ	Beschreibung
CustomCompute	string	Benutzerdefinierte Benutzerberechnung.
ServerlessCompute	string	Serverlose Benutzerberechnung.

ConnectionStringConnection

Verbindungszeichenfolgenverbindung.

Name	Typ	Beschreibung
connectionString	string	Verbindungszeichenfolge
kind	string: ConnectionString	Der Verbindungstyp.

ConnectionType

Der Verbindungstyp.

Name	Typ	Beschreibung
ConnectionString	string	Verbindungszeichenfolge.
EndpointWithKey	string	Endpunkt- und Schlüsselverbindung.
EndpointWithManagedIdentity	string	Endpunkt und verwaltete Identität.
RelativeConnection	string	Relative Bereitstellung
WorkspaceConnection	string	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

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

Name	Typ	Beschreibung
conflict	string	Der angeforderte Vorgang ist mit dem aktuellen Ressourcenstatus in Konflikt.
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 verboten.
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	Das Kontingent wurde überschritten.
serviceUnavailable	string	Der Dienst ist derzeit nicht verfügbar.
tooManyRequests	string	Zu viele Anforderungen. Versuchen Sie es später erneut.
unauthorized	string	Der aktuelle Benutzer-/API-Schlüssel ist für den Vorgang nicht autorisiert.
unexpectedEntityState	string	Der Vorgang kann nicht im Zustand der aktuellen Ressource ausgeführt werden.

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: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Eine Verbindung mit einer Ressource.
deploymentName	string
modelName	string

IngestionJobCompletionAction

Die Abschlussaktion.

Name	Typ	Beschreibung
cleanUpTempAssets	string	Bereinigt Zwischenressourcen, die während des Aufnahmevorgangs erstellt wurden.
keepAllAssets	string	Bereinigt keine der zwischengeschalteten Ressourcen, die während des Aufnahmevorgangs erstellt wurden.

IngestionJobSystemCompute

Name	Typ	Beschreibung
completionAction	IngestionJobCompletionAction	Die Abschlussaktion.
dataRefreshIntervalInHours	integer
datasource	SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId	string
kind	string: SystemCompute	IngestionJobType Der Auftragstyp.
searchServiceConnection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Eine Verbindung mit einer Ressource.

IngestionJobType

Name	Typ	Beschreibung
SystemCompute	string	Aufträge, die in diensteigenen Ressourcen ausgeführt werden.
UserCompute	string	Aufträge, die im Arbeitsbereich des Benutzers ausgeführt werden.

IngestionJobUserCompute

Name	Typ	Beschreibung
compute	JobCompute: CustomCompute ServerlessCompute	JobCompute Die Berechnungseinstellungen des Auftrags.
dataRefreshIntervalInHours	integer
datasource	UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId	string
kind	string: UserCompute	IngestionJobType Der Auftragstyp.
target	TargetIndex: AzureAISearchIndex CosmosDBIndex PineconeIndex	TargetIndex Informationen zum zu erstellenden Index.
workspaceId	string

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

Name	Typ	Beschreibung
invalidPayload	string	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.

Name	Typ	Beschreibung
Storage	string	Azure Storage-Konto.
Urls	string	URLs.

SystemComputeStorage

Name	Typ	Beschreibung
chunking	ChunkingSettings	ChunkingSettings Abschnittseinstellungen
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	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

Name	Typ	Beschreibung
chunking	ChunkingSettings	ChunkingSettings Abschnittseinstellungen
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	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.

Name	Typ	Beschreibung
AzureAISearch	string	Azure AI Search Index.
CosmosDB	string	CosmosDB Index.
Pinecone	string	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