Ingestion Jobs - Create

Reference

Service:: Cognitive Services - Azure OpenAI

API Version:: 2023-10-01-preview

Spustí úlohu pro ingestování dat do indexu Azure Search, která se použije jako zdroj dat pro dokončení. Stav úlohy příjmu dat se zachová po dobu 48 hodin po jejím dokončení a potom se odstraní.

PUT {endpoint}/openai/extensions/on-your-data/ingestion-jobs/{jobId}?api-version=2023-10-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. "aoairesource" nahraďte názvem vašeho účtu Azure OpenAI).
jobId	path	True	string	ID úlohy příjmu dat.
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.
searchServiceEndpoint	True	string	Koncový bod prostředku vyhledávací služby, kde se vytvoří prostředky příjmu dat.
searchServiceAdminKey		string	Klíč správce k prostředku Vyhledávací služby, pokud spravovaná identita není nastavená.
storageConnectionString	True	string	Připojovací řetězec k účtu úložiště objektů blob, který hostuje data, která se budou ingestovat.
storageContainer	True	string	Název kontejneru hostujícího data, která se budou ingestovat.
embeddingEndpoint		string	Koncový bod modelu vkládání, který se má použít pro výpočty vkládání, pokud je povolený.
embeddingKey		string	Klíč, který se použije pro přístup k modelu vkládání, pokud je povolený a pokud spravovaná identita není nastavená.
storageEndpoint		string	Koncový bod úložiště objektů blob, který hostuje data, která se budou ingestovat. Vyžaduje se pro formát ResourceId storageConnectionString.
embeddingDeploymentName		string	Název vložení nasazení aktuálního prostředku Azure OpenAI, který se použije pro přístup k modelu vkládání.

Text požadavku

Name	Vyžadováno	Typ	Description
dataRefreshIntervalInMinutes	True	integer
chunkSize		integer	Toto číslo definuje maximální počet tokenů v každém bloku vytvořeném tokem příjmu dat.
completionAction		IngestionJobCompletionAction	IngestionJobCompletionAction Akce, která se má provést při dokončení úlohy příjmu dat.
id		string
progress		IngestionJobProgress	IngestionJobProgress
warnings		string[]

Odpovědi

Name	Typ	Description
200 OK	IngestionJob	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

Starting an ingestion job.

Sample Request

HTTP

PUT https://aoairesource.openai.azure.com/openai/extensions/on-your-data/ingestion-jobs/test?api-version=2023-10-01-preview






{
  "dataRefreshIntervalInMinutes": 60,
  "completionAction": "cleanUpAssets"
}

Sample Response

Status code:: 200

{
  "id": "test",
  "dataRefreshIntervalInMinutes": 60,
  "completionAction": "cleanUpAssets",
  "status": "notRunning",
  "warnings": [],
  "progress": {
    "stageProgress": [
      {
        "name": "Preprocessing",
        "totalItems": 0,
        "processedItems": 0
      },
      {
        "name": "Indexing",
        "totalItems": 0,
        "processedItems": 0
      }
    ]
  }
}

Definice

Name	Description
Error	Chyba
ErrorCode	ErrorCode
ErrorResponse	ChybaResponse
IngestionJob	Úloha příjmu dat
IngestionJobCompletionAction	IngestionJobCompletionAction
IngestionJobProgress	IngestionJobProgress
InnerError	Vnitřní chyba
InnerErrorCode	InnerErrorCode
OperationState	Stav operace
StageProgress

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í klíč uživatele nebo 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 se nenašel.
quotaExceeded	string	Kvóta byla překročena.
serviceUnavailable	string	Služba v současné době není 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 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).

IngestionJob

Úloha příjmu dat

Name	Typ	Výchozí hodnota	Description
chunkSize	integer	1024	Toto číslo definuje maximální počet tokenů v každém bloku vytvořeném tokem příjmu dat.
completionAction	IngestionJobCompletionAction		IngestionJobCompletionAction Akce, která se má provést při dokončení úlohy příjmu dat.
dataRefreshIntervalInMinutes	integer
error	Error		Chyba Obsah chyb definovaný v pokynech Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
id	string
progress	IngestionJobProgress		IngestionJobProgress
status	OperationState		Stav operace Stav úlohy nebo položky.
warnings	string[]

IngestionJobCompletionAction

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.

IngestionJobProgress

Name	Typ	Description
stageProgress	StageProgress[]

InnerError

Vnitřní chyba

Name	Typ	Description
code	InnerErrorCode	InnerErrorCode Kódy vnitřních 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á.

OperationState

Stav operace

Name	Typ	Description
failed	string	Operace dokončila zpracování s chybou a nelze ji dále využívat.
notRunning	string	Operace ještě není zařazena do fronty ke zpracování v budoucnu.
running	string	Operace se začala zpracovávat.
succeeded	string	Operace byla úspěšně zpracována a je připravena k použití.

StageProgress

Name	Typ	Description
name	string
processedItems	integer
totalItems	integer

Share via