Ingestion Jobs - Create

참조

Service:: Cognitive Services - Azure OpenAI

API Version:: 2023-10-01-preview

완료를 위해 데이터 원본으로 사용할 Azure Search 인덱스에 데이터를 수집하기 위한 작업을 시작합니다. 수집 작업의 상태 완료 후 48시간 동안 유지되며 나중에 삭제됩니다.

PUT {endpoint}/openai/extensions/on-your-data/ingestion-jobs/{jobId}?api-version=2023-10-01-preview

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string url	지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름( 예: https://aoairesource.openai.azure.com) "aoairesource"를 Azure OpenAI 계정 이름으로 대체합니다.)
jobId	path	True	string	수집 작업의 ID입니다.
api-version	query	True	string	요청된 API 버전입니다.

요청 헤더

Name	필수	형식	Description
api-key	True	string	여기에서 Cognitive Services Azure OpenAI 계정 키를 제공합니다.
searchServiceEndpoint	True	string	수집 자산을 만들 검색 서비스 리소스에 대한 엔드포인트입니다.
searchServiceAdminKey		string	관리 ID가 설정되지 않은 경우 검색 서비스 리소스의 관리 키입니다.
storageConnectionString	True	string	수집될 데이터를 호스팅하는 Blob Storage 계정에 대한 연결 문자열.
storageContainer	True	string	수집할 데이터를 호스팅하는 컨테이너의 이름입니다.
embeddingEndpoint		string	사용하도록 설정된 경우 embeddings 계산에 사용할 embeddings 모델의 엔드포인트입니다.
embeddingKey		string	사용하도록 설정된 경우 및 관리 ID가 설정되지 않은 경우 embeddings 모델에 액세스하는 데 사용할 키입니다.
storageEndpoint		string	수집할 데이터를 호스팅하는 Blob Storage 엔드포인트입니다. StorageConnectionString의 ResourceId 형식에 필요합니다.
embeddingDeploymentName		string	embeddings 모델에 액세스하는 데 사용할 현재 Azure OpenAI 리소스의 배포 포함 이름입니다.

요청 본문

Name	필수	형식	Description
dataRefreshIntervalInMinutes	True	integer
chunkSize		integer	이 숫자는 수집 흐름에서 생성된 각 청크의 최대 토큰 수를 정의합니다.
completionAction		IngestionJobCompletionAction	IngestionJobCompletionAction 수집 작업 완료 시 수행할 작업입니다.
id		string
progress		IngestionJobProgress	IngestionJobProgress
warnings		string[]

응답

Name	형식	Description
200 OK	IngestionJob	Success
Other Status Codes	ErrorResponse	오류가 발생했습니다.

보안

api-key

여기에서 Cognitive Services Azure OpenAI 계정 키를 제공합니다.

Type: apiKey
In: header

예제

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
      }
    ]
  }
}

정의

Name	Description
Error	오류
ErrorCode	오류 코드
ErrorResponse	ErrorResponse
IngestionJob	IngestionJob
IngestionJobCompletionAction	IngestionJobCompletionAction
IngestionJobProgress	IngestionJobProgress
InnerError	InnerError
InnerErrorCode	InnerErrorCode
OperationState	OperationState
StageProgress

Error

오류

Name	형식	Description
code	ErrorCode	오류 코드 Microsoft REST 지침(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)에 정의된 오류 코드입니다.
details	Error[]	사용 가능한 경우 오류 세부 정보입니다.
innererror	InnerError	InnerError Microsoft REST 지침(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)에 정의된 내부 오류입니다.
message	string	이 오류의 메시지입니다.
target	string	사용 가능한 경우 오류가 발생한 위치입니다.

ErrorCode

오류 코드

Name	형식	Description
conflict	string	요청된 작업이 현재 리소스 상태와 충돌합니다.
contentFilter	string	안전 시스템의 결과로 이미지 생성이 실패했습니다.
fileImportFailed	string	파일을 가져오지 못했습니다.
forbidden	string	현재 사용자/api 키에는 작업이 금지되어 있습니다.
internalFailure	string	내부 오류입니다. 다시 시도하세요.
invalidPayload	string	이 작업에 대한 요청 데이터가 잘못되었습니다.
itemDoesAlreadyExist	string	항목이 이미 있습니다.
jsonlValidationFailed	string	jsonl 데이터의 유효성 검사에 실패했습니다.
notFound	string	리소스를 찾을 수 없습니다.
quotaExceeded	string	할당량이 초과되었습니다.
serviceUnavailable	string	현재 서비스를 사용할 수 없습니다.
tooManyRequests	string	요청이 너무 많습니다. 나중에 다시 시도하십시오.
unauthorized	string	현재 사용자/api 키는 작업에 대한 권한이 없습니다.
unexpectedEntityState	string	작업은 현재 리소스의 상태에서 실행할 수 없습니다.

ErrorResponse

Name	형식	Description
error	Error	오류 Microsoft REST 지침(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)에 정의된 오류 콘텐츠입니다.

IngestionJob

Name	형식	기본값	Description
chunkSize	integer	1024	이 숫자는 수집 흐름에서 생성된 각 청크의 최대 토큰 수를 정의합니다.
completionAction	IngestionJobCompletionAction		IngestionJobCompletionAction 수집 작업 완료 시 수행할 작업입니다.
dataRefreshIntervalInMinutes	integer
error	Error		오류 Microsoft REST 지침(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)에 정의된 오류 콘텐츠입니다.
id	string
progress	IngestionJobProgress		IngestionJobProgress
status	OperationState		OperationState 작업 또는 항목의 상태입니다.
warnings	string[]

IngestionJobCompletionAction

Name	형식	Description
cleanUpAssets	string	수집 프로세스 중에 만든 중간 자산을 클린.
keepAllAssets	string	수집 프로세스 중에 생성된 중간 자산을 클린 않습니다.

IngestionJobProgress

Name	형식	Description
stageProgress	StageProgress[]

InnerError

Name	형식	Description
code	InnerErrorCode	InnerErrorCode Microsoft REST 지침(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)에 정의된 내부 오류 코드입니다.
innererror	InnerError	InnerError Microsoft REST 지침(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)에 정의된 내부 오류입니다.

InnerErrorCode

Name	형식	Description
invalidPayload	string	이 작업에 대한 요청 데이터가 잘못되었습니다.

OperationState

Name	형식	Description
failed	string	작업이 실패로 처리를 완료했으며 더 이상 사용할 수 없습니다.
notRunning	string	작업은 나중에 처리될 큐에 대기되지 않습니다.
running	string	작업이 처리되기 시작했습니다.
succeeded	string	작업이 성공적으로 처리되었으며 사용할 준비가 되었습니다.

StageProgress

Name	형식	Description
name	string
processedItems	integer
totalItems	integer

Share via

Ingestion Jobs - Create

URI 매개 변수

요청 헤더

요청 본문

응답

보안

api-key

예제

Starting an ingestion job.

Sample Request

Sample Response

정의

Error

ErrorCode

ErrorResponse

IngestionJob

IngestionJobCompletionAction

IngestionJobProgress

InnerError

InnerErrorCode

OperationState

StageProgress

추가 리소스