Sdílet prostřednictvím

Ingestion Jobs - Get

  • Reference
Služba:
Azure AI Services
Verze rozhraní API:
2025-01-01-preview

Získá podrobnosti o zadaném ID úlohy.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
endpoint
 path True

string (url)

Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem účtu Azure OpenAI).
job-id
 path True

string

ID úlohy.
api-version
 query True

string

Požadovaná verze rozhraní API.

Odpovědi

Name Typ Description
200 OK IngestionJob:

Úspěch
Other Status Codes

ErrorResponse

Došlo k chybě.

Zabezpečení

api-key

Ověřování pomocí klíče rozhraní API

Typ: apiKey
V: header

OAuth2Auth

Ověřování OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Rozsahy

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

Příklady

Get ingestion job

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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"
  }
}

Definice

Name Description
AzureAISearchIndex

Index služby Azure AI Search.
ChunkingSettings

BlokingSettings
ComputeType

Typ výpočetních prostředků.
ConnectionStringConnection

Připojení připojovacího řetězce.
ConnectionType

Typ připojení.
CosmosDBIndex

Index Služby Cosmos DB
CrawlingSettings

CrawlingSettings
CustomCompute

Vlastní výpočetní prostředky.
DeploymentConnection

Relativní připojení k nasazení
EndpointKeyConnection

Připojení klíče koncového bodu
EndpointMIConnection

Připojení spravované identity koncového bodu
Error

Chyba
ErrorCode

Kód chyby
ErrorResponse

ErrorResponse
GenericEmbeddingSettings

ConnectionEmbeddingSettings
IngestionJobCompletionAction

Akce dokončení.
IngestionJobSystemCompute
IngestionJobType

IngestionJobType
IngestionJobUserCompute
InnerError

Vnitřní chyba
InnerErrorCode

InnerErrorCode
PineconeIndex

Borovišový index.
ServerlessCompute

Bezserverové výpočetní prostředky.
SystemComputeDatasourceType

Typ zdroje dat.
SystemComputeStorage

SystemComputeStorage
SystemComputeUrl

SystemComputeUrl
TargetType

Typ cíle.
UserComputeDataset

UserComputeStorage
UserComputeDatasourceType

Typ zdroje dat.
UserComputeUrl

UserComputeUrl
WorkspaceConnection

Připojení pracovního prostoru AML
WorkspaceConnectionEmbeddingSettings

WorkspaceConnectionEmbeddingSettings

AzureAISearchIndex

Objekt

Index služby Azure AI Search.

Name Typ Description
connectionId

string

ID připojení odkazující na index služby Azure AI Search.
kind string:

AzureAISearch

Typ cíle.

ChunkingSettings

Objekt

BlokingSettings

Name Typ Description
maxChunkSizeInTokens

integer

ComputeType

Výčet

Typ výpočetních prostředků.

Hodnota Description
CustomCompute

Vlastní výpočetní prostředky uživatele.
ServerlessCompute

Výpočetní prostředky bez serveru.

ConnectionStringConnection

Objekt

Připojení připojovacího řetězce.

Name Typ Description
connectionString

string

Připojovací řetězec
kind string:

ConnectionString

Typ připojení.

ConnectionType

Výčet

Typ připojení.

Hodnota Description
ConnectionString

Připojovací řetězec.
EndpointWithKey

Připojení koncového bodu a klíče
EndpointWithManagedIdentity

Koncový bod a spravovaná identita
RelativeConnection

Relativní nasazení
WorkspaceConnection

Připojení pracovního prostoru AML

CosmosDBIndex

Objekt

Index Služby Cosmos DB

Name Typ Description
collectionName

string

Název kolekce Cosmos DB.
connectionId

string

ID připojení odkazujícího na cosmos DB.
databaseName

string

Název databáze cosmos DB.
kind string:

CosmosDB

Typ cíle.

CrawlingSettings

Objekt

CrawlingSettings

Name Typ Description
maxCrawlDepth

integer

maxCrawlTimeInMins

integer

maxDownloadTimeInMins

integer

maxFileSize

integer

maxFiles

integer

maxRedirects

integer

CustomCompute

Objekt

Vlastní výpočetní prostředky.

Name Typ Description
computeId

string

ID vlastního výpočetního prostředí
kind string:

CustomCompute

Typ výpočetních prostředků.

DeploymentConnection

Objekt

Relativní připojení k nasazení

Name Typ Description
kind string:

RelativeConnection

Typ připojení.

EndpointKeyConnection

Objekt

Připojení klíče koncového bodu

Name Typ Description
endpoint

string

Zakončení
key

string

Klíč
kind string:

EndpointWithKey

Typ připojení.

EndpointMIConnection

Objekt

Připojení spravované identity koncového bodu

Name Typ Description
endpoint

string

Zakončení
kind string:

EndpointWithManagedIdentity

Typ připojení.
resourceId

string

ID prostředku

Error

Objekt

Chyba

Name Typ Description
code

ErrorCode

Kód chyby
Kódy chyb definované v pokynech microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details

Error[]

Podrobnosti o chybě, pokud jsou k dispozici.
innererror

InnerError

Vnitřní chyba
Vnitřní chyba definovaná v pokynech microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message

string

minLength: 1

Zpráva o této chybě.
target

string

Umístění, kde k chybě došlo, pokud je k dispozici.

ErrorCode

Výčet

Kód chyby

Hodnota Description
conflict

Požadovaná operace je v konfliktu s aktuálním stavem prostředku.
contentFilter

Generování obrázků selhalo v důsledku našeho bezpečnostního systému.
fileImportFailed

Import souboru se nezdařil.
forbidden

Operace je zakázaná pro aktuální klíč uživatele nebo rozhraní API.
internalFailure

Vnitřní chyba. Zkuste to prosím znovu.
invalidPayload

Data požadavku jsou pro tuto operaci neplatná.
itemDoesAlreadyExist

Položka již existuje.
jsonlValidationFailed

Ověření dat jsonl se nezdařilo.
notFound

Prostředek nebyl nalezen.
quotaExceeded

Kvóta byla překročena.
serviceUnavailable

Služba není aktuálně dostupná.
tooManyRequests

Příliš mnoho požadavků. Zkuste to prosím znovu později.
unauthorized

Aktuální klíč uživatele nebo rozhraní API není pro operaci autorizovaný.
unexpectedEntityState

Operaci nelze spustit ve stavu aktuálního prostředku.

ErrorResponse

Objekt

ErrorResponse

Name Typ Description
error

Error

Chyba
Obsah chyby definovaný v pokynech microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

GenericEmbeddingSettings

Objekt

ConnectionEmbeddingSettings

Name Typ Description
connection BaseConnection:

BaseConnection
Připojení k prostředku.
deploymentName

string

modelName

string

IngestionJobCompletionAction

Výčet

Akce dokončení.

Hodnota Description
cleanUpTempAssets

Vyčistí zprostředkující prostředky vytvořené během procesu příjmu dat.
keepAllAssets

Nevyčistí žádné z přechodných prostředků vytvořených během procesu příjmu dat.

IngestionJobSystemCompute

Objekt
Name Typ Description
completionAction

IngestionJobCompletionAction

Akce dokončení.
dataRefreshIntervalInHours

integer

datasource SystemComputeDatasource:

SystemComputeDatasource
jobId

string

kind string:

SystemCompute

IngestionJobType
Typ úlohy.
searchServiceConnection BaseConnection:

BaseConnection
Připojení k prostředku.

IngestionJobType

Výčet

IngestionJobType

Hodnota Description
SystemCompute

Úlohy, které běží na prostředcích vlastněných službou.
UserCompute

Úlohy, které běží v pracovním prostoru vlastněného uživatelem.

IngestionJobUserCompute

Objekt
Name Typ Description
compute JobCompute:

JobCompute
Nastavení výpočetních prostředků úlohy
dataRefreshIntervalInHours

integer

datasource UserComputeDatasource:

UserComputeDatasource
jobId

string

kind string:

UserCompute

IngestionJobType
Typ úlohy.
target TargetIndex:

TargetIndex
Informace o indexu, který se má vytvořit.
workspaceId

string

InnerError

Objekt

Vnitřní chyba

Name Typ Description
code

InnerErrorCode

InnerErrorCode
Vnitřní kódy chyb definované v pokynech microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror

InnerError

Vnitřní chyba
Vnitřní chyba definovaná v pokynech microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Výčet

InnerErrorCode

Hodnota Description
invalidPayload

Data požadavku jsou pro tuto operaci neplatná.

PineconeIndex

Objekt

Borovišový index.

Name Typ Description
connectionId

string

ID spojení směřujícího na borovice.
kind string:

Pinecone

Typ cíle.

ServerlessCompute

Objekt

Bezserverové výpočetní prostředky.

Name Typ Description
instanceCount

integer

Počet instancí, na kterých se má úloha spustit.
kind string:

ServerlessCompute

Typ výpočetních prostředků.
sku

string

Úroveň skladové položky

SystemComputeDatasourceType

Výčet

Typ zdroje dat.

Hodnota Description
Storage

Účet služby Azure Storage.
Urls

Adresy URL.

SystemComputeStorage

Objekt

SystemComputeStorage

Name Typ Description
chunking

ChunkingSettings

BlokingSettings
Nastavení bloků dat
connection BaseConnection:

BaseConnection
Připojení k prostředku.
containerName

string

název kontejneru
embeddings

GenericEmbeddingSettings[]

ConnectionEmbeddingSettings
Nastavení vkládání připojení
kind string:

Storage

Typ zdroje dat.

SystemComputeUrl

Objekt

SystemComputeUrl

Name Typ Description
chunking

ChunkingSettings

BlokingSettings
Nastavení bloků dat
connection BaseConnection:

BaseConnection
Připojení k prostředku.
containerName

string

název kontejneru
crawling

CrawlingSettings

CrawlingSettings
Nastavení procházení
embeddings

GenericEmbeddingSettings[]

ConnectionEmbeddingSettings
Nastavení vkládání připojení
kind string:

Urls

Typ zdroje dat.
urls

string[]

TargetType

Výčet

Typ cíle.

Hodnota Description
AzureAISearch

Index služby Azure AI Search.
CosmosDB

Index Služby Cosmos DB
Pinecone

Borovišový index.

UserComputeDataset

Objekt

UserComputeStorage

Name Typ Description
chunking

ChunkingSettings

BlokingSettings
Nastavení bloků dat
datasetId

string

datasetType

string

embeddings

WorkspaceConnectionEmbeddingSettings[]

WorkspaceConnectionEmbeddingSettings
ID připojení k modelu vkládání
kind string:

Dataset

Typ zdroje dat.

UserComputeDatasourceType

Výčet

Typ zdroje dat.

Hodnota Description
Dataset

Datová sada pracovního prostoru.
Urls

Adresy URL.

UserComputeUrl

Objekt

UserComputeUrl

Name Typ Description
chunking

ChunkingSettings

BlokingSettings
Nastavení bloků dat
crawling

CrawlingSettings

CrawlingSettings
Nastavení procházení
embeddings

WorkspaceConnectionEmbeddingSettings[]

WorkspaceConnectionEmbeddingSettings
ID připojení k modelu vkládání
kind string:

Urls

Typ zdroje dat.
urls

string[]

WorkspaceConnection

Objekt

Připojení pracovního prostoru AML

Name Typ Description
connectionId

string

ConnectionId
kind string:

WorkspaceConnection

Typ připojení.

WorkspaceConnectionEmbeddingSettings

Objekt

WorkspaceConnectionEmbeddingSettings

Name Typ Description
connectionId

string

deploymentName

string

modelName

string