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 den Namen Ihres Azure OpenAI-Kontos).
job-id	path	True	string	Die ID des Auftrags.
api-version	query	True	string	Die angeforderte API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
api-key	True	string	Geben Sie hier Ihren Cognitive Services Azure OpenAI-Kontoschlüssel an.

Antworten

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

Sicherheit

api-key

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

Typ: apiKey
In: header

Beispiele

Get ingestion job

Beispielanforderung

HTTP

GET {endpoint}/openai/ingestion/jobs/{job-id}?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
ACSIndex	ACS-Index.
BaseConnection	BaseConnection
ChunkingSettings	ChunkingSettings
ComputeType	Der Computetyp.
ConnectionStringConnection	Verbindungszeichenfolgenverbindung.
ConnectionType	Der Verbindungstyp.
CosmosDBIndex	CosmosDB-Index.
CrawlingSettings	CrawlingSettings
CustomCompute	Benutzerdefiniertes Compute.
DatasourceType	Der Datenquellentyp.
DeploymentConnection	Relative Bereitstellungsverbindung.
EndpointKeyConnection	Endpunktschlüsselverbindung.
EndpointMIConnection	Endpunktverwaltete Identitätsverbindung.
Error	Fehler
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
GenericEmbeddingSettings	ConnectionEmbeddingSettings
IngestionJobCompletionAction	Die Vervollständigungsaktion.
IngestionJobSystemCompute
IngestionJobType	IngestionJobType
IngestionJobUserCompute
InnerError	InnerError
InnerErrorCode	InnerErrorCode
PineconeIndex	Pinecone-Index.
ServerlessCompute	Serverloses Compute.
SystemComputeDatasource	SystemComputeDatasource
SystemComputeStorage	SystemComputeStorage
SystemComputeUrl	SystemComputeUrl
TargetType	Der Zieltyp.
UserComputeDataset	UserComputeStorage
UserComputeUrl	UserComputeUrl
WorkspaceConnection	AML-Arbeitsbereichsverbindung.
WorkspaceConnectionEmbeddingSettings	WorkspaceConnectionEmbeddingSettings

ACSIndex

ACS-Index.

Name	Typ	Beschreibung
connectionId	string	Die ID der Verbindung, die auf den ACS-Index verweist.
kind	string: acs	Der Zieltyp.

BaseConnection

Name	Typ	Beschreibung
kind	ConnectionType	Der Verbindungstyp.

ChunkingSettings

Name	Typ	Beschreibung
maxChunkSizeInTokens	integer

ComputeType

Der Computetyp.

Name	Typ	Beschreibung
custom	string	Benutzerdefinierte Benutzercompute.
serverless	string	Serverlose Benutzercompute.

ConnectionStringConnection

Verbindungszeichenfolgenverbindung.

Name	Typ	Beschreibung
connectionString	string	Verbindungszeichenfolge
kind	ConnectionType	Der Verbindungstyp.

ConnectionType

Der Verbindungstyp.

Name	Typ	Beschreibung
connectionString	string	Verbindungszeichenfolge.
endpointKey	string	Endpunkt- und Schlüsselverbindung.
endpointMI	string	Endpunkt und verwaltete Identität.
workspace	string	AML-Arbeitsbereichsverbindung.

CosmosDBIndex

CosmosDB-Index.

Name	Typ	Beschreibung
collectionName	string	Der Name der cosmos DB-Auflistung.
connectionId	string	Die ID der Verbindung, die auf cosmos DB verweist.
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

Benutzerdefiniertes Compute.

Name	Typ	Beschreibung
computeId	string	ID des benutzerdefinierten Computes
kind	string: custom	Der Computetyp.

DatasourceType

Der Datenquellentyp.

Name	Typ	Beschreibung
storage	string	Azure-Speicherkonto
urls	string	URLs.

DeploymentConnection

Relative Bereitstellungsverbindung.

Name	Typ	Beschreibung
kind	ConnectionType	Der Verbindungstyp.

EndpointKeyConnection

Endpunktschlüsselverbindung.

Name	Typ	Beschreibung
endpoint	string	Endpunkt
key	string	Schlüssel
kind	ConnectionType	Der Verbindungstyp.

EndpointMIConnection

Endpunktverwaltete Identitätsverbindung.

Name	Typ	Beschreibung
endpoint	string	Endpunkt
kind	ConnectionType	Der Verbindungstyp.

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).

GenericEmbeddingSettings

ConnectionEmbeddingSettings

Name	Typ	Beschreibung
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Eine Verbindung mit einer Ressource.
deploymentName	string
modelName	string

IngestionJobCompletionAction

Die Vervollständigungsaktion.

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.

IngestionJobSystemCompute

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

IngestionJobType

Name	Typ	Beschreibung
system	string	Aufträge, die auf diensteigenen Ressourcen ausgeführt werden.
user	string	Aufträge, die im benutzereigenen Arbeitsbereich ausgeführt werden.

IngestionJobUserCompute

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

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.

PineconeIndex

Pinecone-Index.

Name	Typ	Beschreibung
connectionId	string	Die ID der Verbindung, die auf den Pinecone verweist.
kind	string: pinecone	Der Zieltyp.

ServerlessCompute

Serverloses Compute.

Name	Typ	Beschreibung
instanceCount	integer	Die Anzahl der Instanzen, auf denen der Auftrag ausgeführt werden soll.
kind	string: serverless	Der Computetyp.
sku	string	SKU-Ebene

SystemComputeDatasource

Name	Typ	Beschreibung
kind	DatasourceType	Der Datenquellentyp.

SystemComputeStorage

Name	Typ	Beschreibung
chunking	ChunkingSettings	ChunkingSettings Blockerstellungseinstellungen
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Eine Verbindung mit einer Ressource.
containerName	string	Containername
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Einstellungen für die Verbindungseinbettung
kind	DatasourceType	Der Datenquellentyp.

SystemComputeUrl

Name	Typ	Beschreibung
chunking	ChunkingSettings	ChunkingSettings Blockerstellungseinstellungen
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 die Verbindungseinbettung
kind	DatasourceType	Der Datenquellentyp.
urls	string[]

TargetType

Der Zieltyp.

Name	Typ	Beschreibung
acs	string	Azure AI Search-Index.
cosmosdb	string	CosmosDB-Index.
pinecone	string	Pinecone-Index.

UserComputeDataset

UserComputeStorage

Name	Typ	Beschreibung
chunking	ChunkingSettings	ChunkingSettings Chunkingeinstellungen
datasetId	string
datasetType	string
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings Verbindungs-ID mit dem Einbettungsmodell
kind	string: dataset	Der Datenquellentyp.

UserComputeUrl

Name	Typ	Beschreibung
chunking	ChunkingSettings	ChunkingSettings Chunkingeinstellungen
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	ConnectionType	Der Verbindungstyp.

WorkspaceConnectionEmbeddingSettings

Name	Typ	Beschreibung
connectionId	string
deploymentName	string
modelName	string

Freigeben über