Ingestion Jobs - Create

Reference

Služba:: Azure AI Services

Verze rozhraní API:: 2025-01-01-preview

Vytvoří úlohu příjmu dat se zadaným ID úlohy.

PUT {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, která se vytvoří.
api-version	query	True	string	Požadovaná verze rozhraní API.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
mgmt-user-token		string	Token použitý pro přístup k pracovnímu prostoru (potřebný pouze pro výpočetní úlohy uživatele)
aml-user-token		string	Token použitý pro přístup k prostředkům v rámci úlohy v pracovním prostoru (potřebný pouze pro výpočetní úlohy uživatele).

Text požadavku

Text žádosti může tvořit:

Name	Description
IngestionJobSystemCompute
IngestionJobUserCompute

IngestionJobSystemCompute

Name	Vyžadováno	Typ	Description
kind	True	string: SystemCompute	IngestionJobType Typ úlohy.
completionAction		IngestionJobCompletionAction	Akce dokončení.
dataRefreshIntervalInHours		integer
datasource		SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId		string
searchServiceConnection		BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Připojení k prostředku.

IngestionJobUserCompute

Name	Vyžadováno	Typ	Description
kind	True	string: UserCompute	IngestionJobType Typ úlohy.
workspaceId	True	string
compute		JobCompute: CustomCompute ServerlessCompute	JobCompute Nastavení výpočetních prostředků úlohy
dataRefreshIntervalInHours		integer
datasource		UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId		string
target		TargetIndex: AzureAISearchIndex CosmosDBIndex PineconeIndex	TargetIndex Informace o indexu, který se má vytvořit.

Odpovědi

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

Create a system-compute ingestion job

Create a user-compute ingestion job

Create a system-compute ingestion job

Ukázkový požadavek

HTTP

PUT {endpoint}/openai/ingestion/jobs/ingestion-job?api-version=2025-01-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"
}

Ukázková odpověď

Stavový kód:: 200

operation-location: https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-01-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

Ukázkový požadavek

HTTP

PUT {endpoint}/openai/ingestion/jobs/ingestion-job?api-version=2025-01-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"
  }
}

Ukázková odpověď

Stavový kód:: 200

operation-location: https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-01-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"
  }
}

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

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

BlokingSettings

Name	Typ	Description
maxChunkSizeInTokens	integer

ComputeType

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

Name	Typ	Description
CustomCompute	string	Vlastní výpočetní prostředky uživatele.
ServerlessCompute	string	Výpočetní prostředky bez serveru.

ConnectionStringConnection

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

Name	Typ	Description
connectionString	string	Připojovací řetězec
kind	string: ConnectionString	Typ připojení.

ConnectionType

Typ připojení.

Name	Typ	Description
ConnectionString	string	Připojovací řetězec.
EndpointWithKey	string	Připojení koncového bodu a klíče
EndpointWithManagedIdentity	string	Koncový bod a spravovaná identita
RelativeConnection	string	Relativní nasazení
WorkspaceConnection	string	Připojení pracovního prostoru AML

CosmosDBIndex

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

Name	Typ	Description
maxCrawlDepth	integer
maxCrawlTimeInMins	integer
maxDownloadTimeInMins	integer
maxFileSize	integer
maxFiles	integer
maxRedirects	integer

CustomCompute

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

Relativní připojení k nasazení

Name	Typ	Description
kind	string: RelativeConnection	Typ připojení.

EndpointKeyConnection

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

Name	Typ	Description
endpoint	string	Zakončení
key	string	Klíč
kind	string: EndpointWithKey	Typ připojení.

EndpointMIConnection

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

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	Zpráva o této chybě.
target	string	Umístění, kde k chybě došlo, pokud je k dispozici.

ErrorCode

Kód chyby

Name	Typ	Description
conflict	string	Požadovaná operace je v konfliktu s aktuálním stavem prostředku.
contentFilter	string	Generování obrázků selhalo v důsledku našeho bezpečnostního systému.
fileImportFailed	string	Import souboru se nezdařil.
forbidden	string	Operace je zakázaná pro aktuální klíč uživatele nebo rozhraní API.
internalFailure	string	Vnitřní chyba. Zkuste to prosím znovu.
invalidPayload	string	Data požadavku jsou pro tuto operaci neplatná.
itemDoesAlreadyExist	string	Položka již existuje.
jsonlValidationFailed	string	Ověření dat jsonl se nezdařilo.
notFound	string	Prostředek nebyl nalezen.
quotaExceeded	string	Kvóta byla překročena.
serviceUnavailable	string	Služba není aktuálně dostupná.
tooManyRequests	string	Příliš mnoho požadavků. Zkuste to prosím znovu později.
unauthorized	string	Aktuální klíč uživatele nebo rozhraní API není pro operaci autorizovaný.
unexpectedEntityState	string	Operaci nelze spustit ve stavu aktuálního prostředku.

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

ConnectionEmbeddingSettings

Name	Typ	Description
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Připojení k prostředku.
deploymentName	string
modelName	string

IngestionJobCompletionAction

Akce dokončení.

Name	Typ	Description
cleanUpTempAssets	string	Vyčistí zprostředkující prostředky vytvořené během procesu příjmu dat.
keepAllAssets	string	Nevyčistí žádné z přechodných prostředků vytvořených během procesu příjmu dat.

IngestionJobSystemCompute

Name	Typ	Description
completionAction	IngestionJobCompletionAction	Akce dokončení.
dataRefreshIntervalInHours	integer
datasource	SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId	string
kind	string: SystemCompute	IngestionJobType Typ úlohy.
searchServiceConnection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Připojení k prostředku.

IngestionJobType

Name	Typ	Description
SystemCompute	string	Úlohy, které běží na prostředcích vlastněných službou.
UserCompute	string	Úlohy, které běží v pracovním prostoru vlastněného uživatelem.

IngestionJobUserCompute

Name	Typ	Description
compute	JobCompute: CustomCompute ServerlessCompute	JobCompute Nastavení výpočetních prostředků úlohy
dataRefreshIntervalInHours	integer
datasource	UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId	string
kind	string: UserCompute	IngestionJobType Typ úlohy.
target	TargetIndex: AzureAISearchIndex CosmosDBIndex PineconeIndex	TargetIndex Informace o indexu, který se má vytvořit.
workspaceId	string

InnerError

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

Name	Typ	Description
invalidPayload	string	Data požadavku jsou pro tuto operaci neplatná.

PineconeIndex

Borovišový index.

Name	Typ	Description
connectionId	string	ID spojení směřujícího na borovice.
kind	string: Pinecone	Typ cíle.

ServerlessCompute

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

Typ zdroje dat.

Name	Typ	Description
Storage	string	Účet služby Azure Storage.
Urls	string	Adresy URL.

SystemComputeStorage

Name	Typ	Description
chunking	ChunkingSettings	BlokingSettings Nastavení bloků dat
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	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

Name	Typ	Description
chunking	ChunkingSettings	BlokingSettings Nastavení bloků dat
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	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

Typ cíle.

Name	Typ	Description
AzureAISearch	string	Index služby Azure AI Search.
CosmosDB	string	Index Služby Cosmos DB
Pinecone	string	Borovišový index.

UserComputeDataset

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

Typ zdroje dat.

Name	Typ	Description
Dataset	string	Datová sada pracovního prostoru.
Urls	string	Adresy URL.

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

Připojení pracovního prostoru AML

Name	Typ	Description
connectionId	string	ConnectionId
kind	string: WorkspaceConnection	Typ připojení.

WorkspaceConnectionEmbeddingSettings

Name	Typ	Description
connectionId	string
deploymentName	string
modelName	string

Sdílet prostřednictvím

Ingestion Jobs - Create

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

IngestionJobSystemCompute

IngestionJobUserCompute

Odpovědi

Zabezpečení

api-key

OAuth2Auth

Rozsahy

Příklady

Create a system-compute ingestion job

Ukázkový požadavek

Ukázková odpověď

Create a user-compute ingestion job

Ukázkový požadavek

Ukázková odpověď

Definice

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

Další materiály