Ingestion Jobs - Create

Reference

Service:: Azure AI Services

API Version:: 2024-05-01-preview

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

PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2024-05-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 vašeho úč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
api-key	True	string	Tady zadejte klíč účtu Cognitive Services Azure OpenAI.
mgmt-user-token		string	Token použitý pro přístup k pracovnímu prostoru (potřebný pouze pro uživatelské výpočetní úlohy).
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živatelů).

Text požadavku

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

Name	Description
IngestionJobSystemCompute
IngestionJobUserCompute

IngestionJobSystemCompute

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

IngestionJobUserCompute

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

Odpovědi

Name	Typ	Description
200 OK	IngestionJob: IngestionJobSystemCompute IngestionJobUserCompute	Success
Other Status Codes	ErrorResponse	Došlo k chybě.

Zabezpečení

api-key

Tady zadejte klíč účtu Cognitive Services Azure OpenAI.

Type: apiKey
In: header

Příklady

Create a system-compute ingestion job

Create a user-compute ingestion job

Create a system-compute ingestion job

Sample Request

HTTP

PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2024-05-01-preview

{
  "kind": "SystemCompute",
  "searchServiceConnection": {
    "kind": "EndpointWithManagedIdentity",
    "endpoint": "https://aykame-dev-search.search.windows.net"
  },
  "datasource": {
    "kind": "Storage",
    "storageAccountConnection": {
      "kind": "EndpointWithManagedIdentity",
      "endpoint": "https://mystorage.blob.core.windows.net/",
      "resourceId": "ResourceId=/subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage"
    },
    "containerName": "container",
    "chunkingSettings": {
      "maxChunkSizeInTokens": 2048
    },
    "embeddingsSettings": [
      {
        "embeddingResourceConnection": {
          "kind": "RelativeConnection"
        },
        "modelProvider": "AOAI",
        "deploymentName": "Ada"
      }
    ]
  },
  "dataRefreshIntervalInHours": 24,
  "completionAction": 0
}

Sample Response

Status code:: 200

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

Response Body

{
  "kind": "SystemCompute",
  "jobId": "ingestion-job",
  "searchServiceConnection": {
    "kind": "EndpointWithManagedIdentity",
    "endpoint": "https://aykame-dev-search.search.windows.net"
  },
  "datasource": {
    "kind": "Storage",
    "storageAccountConnection": {
      "kind": "EndpointWithManagedIdentity",
      "endpoint": "https://mystorage.blob.core.windows.net/",
      "resourceId": "ResourceId=/subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage"
    },
    "containerName": "container",
    "chunkingSettings": {
      "maxChunkSizeInTokens": 2048
    },
    "embeddingsSettings": [
      {
        "embeddingResourceConnection": {
          "kind": "RelativeConnection"
        },
        "modelProvider": "AOAI",
        "deploymentName": "Ada"
      }
    ]
  },
  "dataRefreshIntervalInHours": 24,
  "completionAction": 0
}

Create a user-compute ingestion job

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

Response Body

{
  "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
ACSIndex	Index služby ACS.
BaseConnection	Základní spojení
ChunkingSettings	Nastavení bloků dat
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	Nastavení procházení
CustomCompute	Vlastní výpočetní prostředky.
DatasourceType	Typ zdroje dat.
DeploymentConnection	Relativní připojení nasazení.
EndpointKeyConnection	Připojení ke klíči koncového bodu.
EndpointMIConnection	Připojení spravované identity koncového bodu
Error	Chyba
ErrorCode	ErrorCode
ErrorResponse	ChybaResponse
GenericEmbeddingSettings	ConnectionEmbeddingSettings
IngestionJobCompletionAction	Akce dokončení.
IngestionJobSystemCompute
IngestionJobType	Typ úlohy Příjmu dat
IngestionJobUserCompute
InnerError	Vnitřní chyba
InnerErrorCode	InnerErrorCode
PineconeIndex	Pinecone Index.
ServerlessCompute	Výpočetní prostředky bez serveru.
SystemComputeDatasource	SystemComputeDatasource
SystemComputeStorage	SystemComputeStorage
SystemComputeUrl	SystemComputeUrl
TargetType	Typ cíle.
UserComputeDataset	UserComputeStorage
UserComputeUrl	UserComputeUrl
WorkspaceConnection	Připojení pracovního prostoru AML.
WorkspaceConnectionEmbeddingSettings	WorkspaceConnectionEmbeddingSettings

ACSIndex

Index služby ACS.

Name	Typ	Description
connectionId	string	ID připojení odkazujícího na index služby ACS.
kind	string: acs	Typ cíle.

BaseConnection

Základní spojení

Name	Typ	Description
kind	ConnectionType	Typ připojení.

ChunkingSettings

Nastavení bloků dat

Name	Typ	Description
maxChunkSizeInTokens	integer

ComputeType

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

Name	Typ	Description
custom	string	Vlastní uživatelské výpočetní prostředky.
serverless	string	Bezserverové uživatelské výpočetní prostředky.

ConnectionStringConnection

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

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

ConnectionType

Typ připojení.

Name	Typ	Description
connectionString	string	Připojovací řetězec.
endpointKey	string	Připojení ke koncovému bodu a klíči.
endpointMI	string	Koncový bod a spravovaná identita.
workspace	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

Nastavení procházení

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: custom	Typ výpočetních prostředků.

DatasourceType

Typ zdroje dat.

Name	Typ	Description
storage	string	Účet úložiště Azure.
urls	string	Adresy url.

DeploymentConnection

Relativní připojení nasazení.

Name	Typ	Description
kind	ConnectionType	Typ připojení.

EndpointKeyConnection

Připojení ke klíči koncového bodu.

Name	Typ	Description
endpoint	string	Koncový bod
key	string	Klíč
kind	ConnectionType	Typ připojení.

EndpointMIConnection

Připojení spravované identity koncového bodu

Name	Typ	Description
endpoint	string	Koncový bod
kind	ConnectionType	Typ připojení.

Error

Chyba

Name	Typ	Description
code	ErrorCode	ErrorCode 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

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 pro aktuálního uživatele nebo klíče rozhraní API zakázaná.
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 v současné době není k dispozici.
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 provést v aktuálním stavu prostředku.

ErrorResponse

ChybaResponse

Name	Typ	Description
error	Error	Chyba Obsah chyb 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
cleanUpAssets	string	Vyčistí zprostředkující prostředky vytvořené během procesu příjmu dat.
keepAllAssets	string	Nevyčistí žádné zprostředkující prostředky vytvořené 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: system	Typ úlohy Příjmu dat Typ úlohy.
searchServiceConnection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	Základní spojení Připojení k prostředku.

IngestionJobType

Typ úlohy Příjmu dat

Name	Typ	Description
system	string	Úlohy, které běží na prostředcích vlastněných službou.
user	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: user	Typ úlohy Příjmu dat Typ úlohy.
target	TargetIndex: ACSIndex CosmosDBIndex PineconeIndex	Index cíle Informace o indexu, který se má vytvořit.
workspaceId	string

InnerError

Vnitřní chyba

Name	Typ	Description
code	InnerErrorCode	InnerErrorCode Kódy vnitřních chyb definované v pokynech microsoftu 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

Pinecone Index.

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

ServerlessCompute

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

Name	Typ	Description
instanceCount	integer	Počet instancí, na kterých se má úloha spustit.
kind	string: serverless	Typ výpočetních prostředků.
sku	string	Úroveň skladové položky

SystemComputeDatasource

Name	Typ	Description
kind	DatasourceType	Typ zdroje dat.

SystemComputeStorage

Name	Typ	Description
chunking	ChunkingSettings	Nastavení bloků dat Nastavení bloků dat
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	Základní spojení Připojení k prostředku.
containerName	string	název kontejneru
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Nastavení vkládání připojení
kind	DatasourceType	Typ zdroje dat.

SystemComputeUrl

Name	Typ	Description
chunking	ChunkingSettings	Nastavení bloků dat Nastavení bloků dat
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	Základní spojení Připojení k prostředku.
containerName	string	název kontejneru
crawling	CrawlingSettings	Nastavení procházení Nastavení procházení
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Nastavení vkládání připojení
kind	DatasourceType	Typ zdroje dat.
urls	string[]

TargetType

Typ cíle.

Name	Typ	Description
acs	string	Index služby Azure AI Search.
cosmosdb	string	Index služby CosmosDB.
pinecone	string	Index pinecone.

UserComputeDataset

UserComputeStorage

Name	Typ	Description
chunking	ChunkingSettings	Nastavení bloků dat Nastavení bloků dat
datasetId	string
datasetType	string
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings ID připojení k modelu vkládání
kind	string: dataset	Typ zdroje dat.

UserComputeUrl

Name	Typ	Description
chunking	ChunkingSettings	Nastavení bloků dat Nastavení bloků dat
crawling	CrawlingSettings	Nastavení procházení 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	ID připojení
kind	ConnectionType	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

Příklady

Create a system-compute ingestion job

Sample Request

Sample Response

Create a user-compute ingestion job

Sample Request

Sample Response

Definice

ACSIndex

BaseConnection

ChunkingSettings

ComputeType

ConnectionStringConnection

ConnectionType

CosmosDBIndex

CrawlingSettings

CustomCompute

DatasourceType

DeploymentConnection

EndpointKeyConnection

EndpointMIConnection

Error

ErrorCode

ErrorResponse

GenericEmbeddingSettings

IngestionJobCompletionAction

IngestionJobSystemCompute

IngestionJobType

IngestionJobUserCompute

InnerError

InnerErrorCode

PineconeIndex

ServerlessCompute

SystemComputeDatasource

SystemComputeStorage

SystemComputeUrl

TargetType

UserComputeDataset

UserComputeUrl

WorkspaceConnection

WorkspaceConnectionEmbeddingSettings

Další materiály