Ingestion Jobs - Create

Referencia

Szolgáltatás:: Azure AI Services

API-verzió:: 2025-02-01-preview

Létrehoz egy betöltési feladatot a megadott feladatazonosítóval.

PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-02-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 létrehozandó feladat azonosítója.
api-version	query	True	string	A kért API-verzió.

Kérelem fejléce

Name	Kötelező	Típus	Description
mgmt-user-token		string	A munkaterület eléréséhez használt jogkivonat (csak a felhasználói számítási feladatokhoz szükséges).
aml-user-token		string	A munkaterületen lévő feladat erőforrásainak eléréséhez használt jogkivonat (csak a felhasználói számítási feladatokhoz szükséges).

Kérelem törzse

A kérelem törzse az alábbiak valamelyike lehet:

Name	Description
IngestionJobSystemCompute
IngestionJobUserCompute

IngestionJobSystemCompute

Name	Kötelező	Típus	Description
kind	True	string: SystemCompute	IngestionJobType A feladat típusa.
completionAction		IngestionJobCompletionAction	A befejezési művelet.
dataRefreshIntervalInHours		integer
datasource		SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId		string
searchServiceConnection		BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Kapcsolat egy erőforrással.

IngestionJobUserCompute

Name	Kötelező	Típus	Description
kind	True	string: UserCompute	IngestionJobType A feladat típusa.
workspaceId	True	string
compute		JobCompute: CustomCompute ServerlessCompute	JobCompute A feladat számítási beállításai.
dataRefreshIntervalInHours		integer
datasource		UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId		string
target		TargetIndex: AzureAISearchIndex CosmosDBIndex PineconeIndex	TargetIndex A létrehozandó indexre vonatkozó információk.

Válaszok

Name	Típus	Description
200 OK	IngestionJob: IngestionJobSystemCompute IngestionJobUserCompute	Siker
Other Status Codes	ErrorResponse	Hiba történt.

Biztonság

api-key

API-kulcs hitelesítése

Típus: apiKey
In: header

OAuth2Auth

OAuth2-hitelesítés

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Hatókörök

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

Példák

Create a system-compute ingestion job

Create a user-compute ingestion job

Create a system-compute ingestion job

Mintakérelem

HTTP

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

{
  "kind": "SystemCompute",
  "searchServiceConnection": {
    "kind": "EndpointWithManagedIdentity",
    "endpoint": "https://aykame-dev-search.search.windows.net"
  },
  "datasource": {
    "kind": "Storage",
    "connection": {
      "kind": "EndpointWithManagedIdentity",
      "endpoint": "https://mystorage.blob.core.windows.net/",
      "resourceId": "/subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage"
    },
    "containerName": "container",
    "chunking": {
      "maxChunkSizeInTokens": 2048
    },
    "embeddings": [
      {
        "connection": {
          "kind": "RelativeConnection"
        },
        "deploymentName": "Ada"
      }
    ]
  },
  "dataRefreshIntervalInHours": 24,
  "completionAction": "keepAllAssets"
}

Mintaválasz

Állapotkód:: 200

operation-location: https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-02-01-preview

{
  "kind": "SystemCompute",
  "jobId": "ingestion-job",
  "searchServiceConnection": {
    "kind": "EndpointWithManagedIdentity",
    "endpoint": "https://aykame-dev-search.search.windows.net"
  },
  "datasource": {
    "kind": "Storage",
    "connection": {
      "kind": "EndpointWithManagedIdentity",
      "endpoint": "https://mystorage.blob.core.windows.net/",
      "resourceId": "/subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage"
    },
    "containerName": "container",
    "chunking": {
      "maxChunkSizeInTokens": 2048
    },
    "embeddings": [
      {
        "connection": {
          "kind": "RelativeConnection"
        },
        "deploymentName": "Ada"
      }
    ]
  },
  "dataRefreshIntervalInHours": 24,
  "completionAction": "keepAllAssets"
}

Create a user-compute ingestion job

Mintakérelem

HTTP

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

{
  "kind": "UserCompute",
  "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"
  }
}

Mintaválasz

Állapotkód:: 200

operation-location: https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-02-01-preview

{
  "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
AzureAISearchIndex	Azure AI Search Index.
ChunkingSettings	ChunkingSettings
ComputeType	A számítási típus.
ConnectionStringConnection	Kapcsolati sztringkapcsolat.
ConnectionType	A kapcsolat típusa.
CosmosDBIndex	CosmosDB-index.
CrawlingSettings	CrawlingSettings
CustomCompute	Egyéni számítás.
DeploymentConnection	Relatív üzembehelyezési kapcsolat.
EndpointKeyConnection	Végpontkulcs-kapcsolat.
EndpointMIConnection	Végpont felügyelt identitáskapcsolata.
Error	Hiba
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
GenericEmbeddingSettings	ConnectionEmbeddingSettings
IngestionJobCompletionAction	A befejezési művelet.
IngestionJobSystemCompute
IngestionJobType	IngestionJobType
IngestionJobUserCompute
InnerError	InnerError
InnerErrorCode	InnerErrorCode
PineconeIndex	Pinecone Index.
ServerlessCompute	Kiszolgáló nélküli számítás.
SystemComputeDatasourceType	Az adatforrás típusa.
SystemComputeStorage	SystemComputeStorage
SystemComputeUrl	SystemComputeUrl
TargetType	A cél típusa.
UserComputeDataset	UserComputeStorage
UserComputeDatasourceType	Az adatforrás típusa.
UserComputeUrl	UserComputeUrl
WorkspaceConnection	AML-munkaterület kapcsolata.
WorkspaceConnectionEmbeddingSettings	WorkspaceConnectionEmbeddingSettings

AzureAISearchIndex

Objektum

Azure AI Search Index.

Name	Típus	Description
connectionId	string	Az Azure AI Search Indexre mutató kapcsolat azonosítója.
kind	string: AzureAISearch	A cél típusa.

ChunkingSettings

Objektum

ChunkingSettings

Name	Típus	Description
maxChunkSizeInTokens	integer

ComputeType

Enumerálás

A számítási típus.

Érték	Description
CustomCompute	Egyéni felhasználói számítás.
ServerlessCompute	Kiszolgáló nélküli felhasználói számítás.

ConnectionStringConnection

Objektum

Kapcsolati sztringkapcsolat.

Name	Típus	Description
connectionString	string	Kapcsolati sztring
kind	string: ConnectionString	A kapcsolat típusa.

ConnectionType

Enumerálás

A kapcsolat típusa.

Érték	Description
ConnectionString	Kapcsolati sztring.
EndpointWithKey	Végpont és kulcskapcsolat.
EndpointWithManagedIdentity	Végpont és felügyelt identitás.
RelativeConnection	Relatív üzembe helyezés
WorkspaceConnection	AML-munkaterület kapcsolata.

CosmosDBIndex

Objektum

CosmosDB-index.

Name	Típus	Description
collectionName	string	A cosmos DB-gyűjtemény neve.
connectionId	string	A cosmos DB-hez mutató kapcsolat azonosítója.
databaseName	string	A cosmos DB-adatbázis neve.
kind	string: CosmosDB	A cél típusa.

CrawlingSettings

Objektum

CrawlingSettings

Name	Típus	Description
maxCrawlDepth	integer
maxCrawlTimeInMins	integer
maxDownloadTimeInMins	integer
maxFileSize	integer
maxFiles	integer
maxRedirects	integer

CustomCompute

Objektum

Egyéni számítás.

Name	Típus	Description
computeId	string	Az egyéni számítás azonosítója
kind	string: CustomCompute	A számítási típus.

DeploymentConnection

Objektum

Relatív üzembehelyezési kapcsolat.

Name	Típus	Description
kind	string: RelativeConnection	A kapcsolat típusa.

EndpointKeyConnection

Objektum

Végpontkulcs-kapcsolat.

Name	Típus	Description
endpoint	string	Végpont
key	string	Kulcs
kind	string: EndpointWithKey	A kapcsolat típusa.

EndpointMIConnection

Objektum

Végpont felügyelt identitáskapcsolata.

Name	Típus	Description
endpoint	string	Végpont
kind	string: EndpointWithManagedIdentity	A kapcsolat típusa.
resourceId	string	Erőforrás-azonosító

Error

Objektum

Hiba

Name	Típus	Description
code	ErrorCode	ErrorCode A Microsoft REST irányelveiben (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) meghatározott hibakódok.
details	Error[]	A hiba részletei, ha elérhetők.
innererror	InnerError	InnerError A Microsoft REST irányelveiben (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) meghatározott belső hiba.
message	string minLength: 1	A hiba üzenete.
target	string	Az a hely, ahol a hiba történt, ha elérhető.

ErrorCode

Enumerálás

ErrorCode

Érték	Description
conflict	A kért művelet ütközik az aktuális erőforrásállapottal.
contentFilter	A rendszerkép létrehozása a biztonsági rendszerünk miatt meghiúsult.
fileImportFailed	A fájl importálása nem sikerült.
forbidden	A művelet az aktuális felhasználói/API-kulcs esetében tilos.
internalFailure	Belső hiba. Próbálkozzon újra.
invalidPayload	A kérelem adatai érvénytelenek ehhez a művelethez.
itemDoesAlreadyExist	Az elem már létezik.
jsonlValidationFailed	A jsonl-adatok ellenőrzése nem sikerült.
notFound	Az erőforrás nem található.
quotaExceeded	A kvóta túllépve.
serviceUnavailable	A szolgáltatás jelenleg nem érhető el.
tooManyRequests	Túl sok kérés. Próbálkozzon újra később.
unauthorized	A művelethez nincs engedélyezve az aktuális felhasználói/API-kulcs.
unexpectedEntityState	A művelet nem hajtható végre az aktuális erőforrás állapotában.

ErrorResponse

Objektum

ErrorResponse

Name	Típus	Description
error	Error	Hiba A Microsoft REST irányelveiben (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) meghatározott hibatartalom.

GenericEmbeddingSettings

Objektum

ConnectionEmbeddingSettings

Name	Típus	Description
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Kapcsolat egy erőforrással.
deploymentName	string
modelName	string

IngestionJobCompletionAction

Enumerálás

A befejezési művelet.

Érték	Description
cleanUpTempAssets	Törli a betöltési folyamat során létrehozott köztes eszközöket.
keepAllAssets	A betöltési folyamat során létrehozott köztes eszközök egyikét sem törli.

IngestionJobSystemCompute

Objektum

Name	Típus	Description
completionAction	IngestionJobCompletionAction	A befejezési művelet.
dataRefreshIntervalInHours	integer
datasource	SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId	string
kind	string: SystemCompute	IngestionJobType A feladat típusa.
searchServiceConnection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Kapcsolat egy erőforrással.

IngestionJobType

Enumerálás

IngestionJobType

Érték	Description
SystemCompute	Szolgáltatás tulajdonában lévő erőforrásokon futó feladatok.
UserCompute	A felhasználó által birtokolt munkaterületen futó feladatok.

IngestionJobUserCompute

Objektum

Name	Típus	Description
compute	JobCompute: CustomCompute ServerlessCompute	JobCompute A feladat számítási beállításai.
dataRefreshIntervalInHours	integer
datasource	UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId	string
kind	string: UserCompute	IngestionJobType A feladat típusa.
target	TargetIndex: AzureAISearchIndex CosmosDBIndex PineconeIndex	TargetIndex A létrehozandó indexre vonatkozó információk.
workspaceId	string

InnerError

Objektum

InnerError

Name	Típus	Description
code	InnerErrorCode	InnerErrorCode A Microsoft REST irányelveiben (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) meghatározott belső hibakódok.
innererror	InnerError	InnerError A Microsoft REST irányelveiben (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) meghatározott belső hiba.

InnerErrorCode

Enumerálás

InnerErrorCode

Érték	Description
invalidPayload	A kérelem adatai érvénytelenek ehhez a művelethez.

PineconeIndex

Objektum

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

Objektum

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: ServerlessCompute	A számítási típus.
sku	string	Termékváltozat szintje

SystemComputeDatasourceType

Enumerálás

Az adatforrás típusa.

Érték	Description
Storage	Azure Storage-fiók.
Urls	URL-címek.

SystemComputeStorage

Objektum

SystemComputeStorage

Name	Típus	Description
chunking	ChunkingSettings	ChunkingSettings Adattömb beállításai
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Kapcsolat egy erőforrással.
containerName	string	tároló neve
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Kapcsolat beágyazási beállításai
kind	string: Storage	Az adatforrás típusa.

SystemComputeUrl

Objektum

SystemComputeUrl

Name	Típus	Description
chunking	ChunkingSettings	ChunkingSettings Adattömb beállításai
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Kapcsolat egy erőforrással.
containerName	string	tároló neve
crawling	CrawlingSettings	CrawlingSettings Bejárási beállítások
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Kapcsolat beágyazási beállításai
kind	string: Urls	Az adatforrás típusa.
urls	string[]

TargetType

Enumerálás

A cél típusa.

Érték	Description
AzureAISearch	Azure AI Search Index.
CosmosDB	CosmosDB-index.
Pinecone	Pinecone Index.

UserComputeDataset

Objektum

UserComputeStorage

Name	Típus	Description
chunking	ChunkingSettings	ChunkingSettings Adattömb beállításai
datasetId	string
datasetType	string
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings Kapcsolatazonosító a beágyazási modellhez
kind	string: Dataset	Az adatforrás típusa.

UserComputeDatasourceType

Enumerálás

Az adatforrás típusa.

Érték	Description
Dataset	Munkaterület-adatkészlet.
Urls	URL-címek.

UserComputeUrl

Objektum

UserComputeUrl

Name	Típus	Description
chunking	ChunkingSettings	ChunkingSettings Adattömb beállításai
crawling	CrawlingSettings	CrawlingSettings Bejárási beállítások
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings Kapcsolatazonosító a beágyazási modellhez
kind	string: Urls	Az adatforrás típusa.
urls	string[]

WorkspaceConnection

Objektum

AML-munkaterület kapcsolata.

Name	Típus	Description
connectionId	string	ConnectionId
kind	string: WorkspaceConnection	A kapcsolat típusa.

WorkspaceConnectionEmbeddingSettings

Objektum

WorkspaceConnectionEmbeddingSettings

Name	Típus	Description
connectionId	string
deploymentName	string
modelName	string

Megosztás a következőn keresztül:

Ingestion Jobs - Create

URI-paraméterek

Kérelem fejléce

Kérelem törzse

IngestionJobSystemCompute

IngestionJobUserCompute

Válaszok

Biztonság

api-key

OAuth2Auth

Hatókörök

Példák

Create a system-compute ingestion job

Mintakérelem

Mintaválasz

Create a user-compute ingestion job

Mintakérelem

Mintaválasz

Definíciók

AzureAISearchIndex

ChunkingSettings

ComputeType

ConnectionStringConnection

ConnectionType

CosmosDBIndex

CrawlingSettings

CustomCompute

DeploymentConnection

EndpointKeyConnection

EndpointMIConnection

Error

ErrorCode

ErrorResponse

GenericEmbeddingSettings

IngestionJobCompletionAction

IngestionJobSystemCompute

IngestionJobType

IngestionJobUserCompute

InnerError

InnerErrorCode

PineconeIndex

ServerlessCompute

SystemComputeDatasourceType

SystemComputeStorage

SystemComputeUrl

TargetType

UserComputeDataset

UserComputeDatasourceType

UserComputeUrl

WorkspaceConnection

WorkspaceConnectionEmbeddingSettings

További források