Ingestion Jobs - Get
Lekéri a megadott feladatazonosító adatait.
GET {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2024-05-01-preview
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
endpoint
|
path | True |
string url |
Támogatott Cognitive Services-végpontok (protokoll és állomásnév, például: https://aoairesource.openai.azure.com. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-fiók nevére. |
job-id
|
path | True |
string |
A feladat azonosítója. |
api-version
|
query | True |
string |
A kért API-verzió. |
Kérelem fejléce
Name | Kötelező | Típus | Description |
---|---|---|---|
api-key | True |
string |
Itt adhatja meg a Cognitive Services Azure OpenAI-fiókkulcsát. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK | IngestionJob: |
Siker |
Other Status Codes |
Hiba történt. |
Biztonság
api-key
Itt adhatja meg a Cognitive Services Azure OpenAI-fiókkulcsát.
Típus:
apiKey
In:
header
Példák
Get ingestion job
Mintakérelem
GET {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2024-05-01-preview
Mintaválasz
{
"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"
}
}
Definíciók
Name | Description |
---|---|
ACSIndex |
ACS-index. |
Base |
BaseConnection |
Chunking |
Adattömbbeállítások |
Compute |
A számítási típus. |
Connection |
Kapcsolati sztringkapcsolat. |
Connection |
A kapcsolat típusa. |
Cosmos |
CosmosDB-index. |
Crawling |
Bejárásbeállítások |
Custom |
Egyéni számítás. |
Datasource |
Az adatforrás típusa. |
Deployment |
Relatív üzembehelyezési kapcsolat. |
Endpoint |
Végpontkulcs-kapcsolat. |
Endpoint |
Végpont által felügyelt identitáskapcsolat. |
Error |
Hiba |
Error |
ErrorCode |
Error |
ErrorResponse |
Generic |
ConnectionEmbeddingSettings |
Ingestion |
A befejezési művelet. |
Ingestion |
|
Ingestion |
IngestionJobType |
Ingestion |
|
Inner |
InnerError |
Inner |
InnerErrorCode |
Pinecone |
Pinecone Index. |
Serverless |
Kiszolgáló nélküli számítás. |
System |
SystemComputeDatasource |
System |
SystemComputeStorage |
System |
SystemComputeUrl |
Target |
A cél típusa. |
User |
UserComputeStorage |
User |
UserComputeUrl |
Workspace |
AML-munkaterület kapcsolata. |
Workspace |
WorkspaceConnectionEmbeddingSettings |
ACSIndex
ACS-index.
Name | Típus | Description |
---|---|---|
connectionId |
string |
Az ACS-indexre mutató kapcsolat azonosítója. |
kind |
string:
acs |
A cél típusa. |
BaseConnection
BaseConnection
Name | Típus | Description |
---|---|---|
kind |
A kapcsolat típusa. |
ChunkingSettings
Adattömbbeállítások
Name | Típus | Description |
---|---|---|
maxChunkSizeInTokens |
integer |
ComputeType
A számítási típus.
Name | Típus | Description |
---|---|---|
custom |
string |
Egyéni felhasználói számítás. |
serverless |
string |
Kiszolgáló nélküli felhasználói számítás. |
ConnectionStringConnection
Kapcsolati sztringkapcsolat.
Name | Típus | Description |
---|---|---|
connectionString |
string |
Kapcsolati sztring |
kind |
A kapcsolat típusa. |
ConnectionType
A kapcsolat típusa.
Name | Típus | Description |
---|---|---|
connectionString |
string |
Kapcsolati sztring. |
endpointKey |
string |
Végpont- és kulcskapcsolat. |
endpointMI |
string |
Végpont és felügyelt identitás. |
workspace |
string |
AML-munkaterület kapcsolata. |
CosmosDBIndex
CosmosDB-index.
Name | Típus | Description |
---|---|---|
collectionName |
string |
A cosmos DB-gyűjtemény neve. |
connectionId |
string |
A cosmos DB-re mutató kapcsolat azonosítója. |
databaseName |
string |
A cosmos DB-adatbázis neve. |
kind |
string:
cosmosdb |
A cél típusa. |
CrawlingSettings
Bejárásbeállítások
Name | Típus | Description |
---|---|---|
maxCrawlDepth |
integer |
|
maxCrawlTimeInMins |
integer |
|
maxDownloadTimeInMins |
integer |
|
maxFileSize |
integer |
|
maxFiles |
integer |
|
maxRedirects |
integer |
CustomCompute
Egyéni számítás.
Name | Típus | Description |
---|---|---|
computeId |
string |
Az egyéni számítás azonosítója |
kind |
string:
custom |
A számítási típus. |
DatasourceType
Az adatforrás típusa.
Name | Típus | Description |
---|---|---|
storage |
string |
Azure Storage-fiók. |
urls |
string |
Urls. |
DeploymentConnection
Relatív üzembehelyezési kapcsolat.
Name | Típus | Description |
---|---|---|
kind |
A kapcsolat típusa. |
EndpointKeyConnection
Végpontkulcs-kapcsolat.
Name | Típus | Description |
---|---|---|
endpoint |
string |
Végpont |
key |
string |
Kulcs |
kind |
A kapcsolat típusa. |
EndpointMIConnection
Végpont által felügyelt identitáskapcsolat.
Name | Típus | Description |
---|---|---|
endpoint |
string |
Végpont |
kind |
A kapcsolat típusa. |
Error
Hiba
Name | Típus | Description |
---|---|---|
code |
ErrorCode |
|
details |
Error[] |
A hiba részletei, ha elérhetők. |
innererror |
InnerError |
|
message |
string |
A hiba üzenete. |
target |
string |
Az a hely, ahol a hiba történt, ha elérhető. |
ErrorCode
ErrorCode
Name | Típus | Description |
---|---|---|
conflict |
string |
A kért művelet ütközik az aktuális erőforrásállapottal. |
contentFilter |
string |
A rendszerképek létrehozása a biztonsági rendszerünk miatt meghiúsult. |
fileImportFailed |
string |
A fájl importálása nem sikerült. |
forbidden |
string |
A művelet az aktuális felhasználói/API-kulcs esetében tiltott. |
internalFailure |
string |
Belső hiba történt. Próbálkozzon újra. |
invalidPayload |
string |
A kérelem adatai érvénytelenek ehhez a művelethez. |
itemDoesAlreadyExist |
string |
Az elem már létezik. |
jsonlValidationFailed |
string |
A jsonl-adatok ellenőrzése nem sikerült. |
notFound |
string |
Az erőforrás nem található. |
quotaExceeded |
string |
Túllépte a kvótát. |
serviceUnavailable |
string |
A szolgáltatás jelenleg nem érhető el. |
tooManyRequests |
string |
Túl sok kérés. Próbálkozzon újra később. |
unauthorized |
string |
Az aktuális felhasználói/API-kulcs nincs engedélyezve a művelethez. |
unexpectedEntityState |
string |
A művelet nem hajtható végre az aktuális erőforrás állapotában. |
ErrorResponse
ErrorResponse
Name | Típus | Description |
---|---|---|
error |
Hiba |
GenericEmbeddingSettings
ConnectionEmbeddingSettings
Name | Típus | Description |
---|---|---|
connection | BaseConnection: |
BaseConnection |
deploymentName |
string |
|
modelName |
string |
IngestionJobCompletionAction
A befejezési művelet.
Name | Típus | Description |
---|---|---|
cleanUpAssets |
string |
Törli a betöltési folyamat során létrehozott köztes eszközöket. |
keepAllAssets |
string |
Nem törli a betöltési folyamat során létrehozott köztes eszközöket. |
IngestionJobSystemCompute
Name | Típus | Description |
---|---|---|
completionAction |
A befejezési művelet. |
|
dataRefreshIntervalInHours |
integer |
|
datasource | SystemComputeDatasource: |
SystemComputeDatasource |
jobId |
string |
|
kind |
string:
system |
IngestionJobType |
searchServiceConnection | BaseConnection: |
BaseConnection |
IngestionJobType
IngestionJobType
Name | Típus | Description |
---|---|---|
system |
string |
A szolgáltatás tulajdonában lévő erőforrásokon futó feladatok. |
user |
string |
A felhasználó tulajdonában lévő munkaterületen futó feladatok. |
IngestionJobUserCompute
Name | Típus | Description |
---|---|---|
compute | JobCompute: |
JobCompute |
dataRefreshIntervalInHours |
integer |
|
datasource | UserComputeDatasource: |
UserComputeDatasource |
jobId |
string |
|
kind |
string:
user |
IngestionJobType |
target | TargetIndex: |
TargetIndex |
workspaceId |
string |
InnerError
InnerError
Name | Típus | Description |
---|---|---|
code |
InnerErrorCode |
|
innererror |
InnerError |
InnerErrorCode
InnerErrorCode
Name | Típus | Description |
---|---|---|
invalidPayload |
string |
A kérelem adatai érvénytelenek ehhez a művelethez. |
PineconeIndex
Pinecone Index.
Name | Típus | Description |
---|---|---|
connectionId |
string |
A pinecone-ra mutató kapcsolat azonosítója. |
kind |
string:
pinecone |
A cél típusa. |
ServerlessCompute
Kiszolgáló nélküli számítás.
Name | Típus | Description |
---|---|---|
instanceCount |
integer |
A feladat futtatásához tartozó példányok száma. |
kind |
string:
serverless |
A számítási típus. |
sku |
string |
Termékváltozat szintje |
SystemComputeDatasource
SystemComputeDatasource
Name | Típus | Description |
---|---|---|
kind |
Az adatforrás típusa. |
SystemComputeStorage
SystemComputeStorage
Name | Típus | Description |
---|---|---|
chunking |
Adattömb-beállítások |
|
connection | BaseConnection: |
BaseConnection |
containerName |
string |
tároló neve |
embeddings |
ConnectionEmbeddingSettings |
|
kind |
Az adatforrás típusa. |
SystemComputeUrl
SystemComputeUrl
Name | Típus | Description |
---|---|---|
chunking |
Adattömb-beállítások |
|
connection | BaseConnection: |
BaseConnection |
containerName |
string |
tároló neve |
crawling |
Bejárásbeállítások |
|
embeddings |
ConnectionEmbeddingSettings |
|
kind |
Az adatforrás típusa. |
|
urls |
string[] |
TargetType
A cél típusa.
Name | Típus | Description |
---|---|---|
acs |
string |
Azure AI Search-index. |
cosmosdb |
string |
CosmosDB-index. |
pinecone |
string |
Pinecone Index. |
UserComputeDataset
UserComputeStorage
Name | Típus | Description |
---|---|---|
chunking |
Adattömbbeállítások |
|
datasetId |
string |
|
datasetType |
string |
|
embeddings |
WorkspaceConnectionEmbeddingSettings |
|
kind |
string:
dataset |
Az adatforrás típusa. |
UserComputeUrl
UserComputeUrl
Name | Típus | Description |
---|---|---|
chunking |
Adattömbbeállítások |
|
crawling |
Bejárásbeállítások |
|
embeddings |
WorkspaceConnectionEmbeddingSettings |
|
kind |
string:
urls |
Az adatforrás típusa. |
urls |
string[] |
WorkspaceConnection
AML-munkaterület kapcsolata.
Name | Típus | Description |
---|---|---|
connectionId |
string |
Kapcsolatazonosító |
kind |
A kapcsolat típusa. |
WorkspaceConnectionEmbeddingSettings
WorkspaceConnectionEmbeddingSettings
Name | Típus | Description |
---|---|---|
connectionId |
string |
|
deploymentName |
string |
|
modelName |
string |