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 パラメーター

名前	/	必須	型	説明
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 バージョン。

要求ヘッダー

名前	必須	型	説明
api-key	True	string	Cognitive Services Azure OpenAI アカウントキーをここで指定します。
searchServiceEndpoint	True	string	インジェスト資産が作成される検索サービスリソースへのエンドポイント。
searchServiceAdminKey		string	マネージド ID が設定されていない場合は、検索サービスリソースの管理キー。
storageConnectionString	True	string	取り込まれるデータをホストしている BLOB ストレージアカウントへの接続文字列。
storageContainer	True	string	取り込まれるデータをホストしているコンテナーの名前。
embeddingEndpoint		string	有効になっている場合に埋め込み計算に使用する埋め込みモデルのエンドポイント。
embeddingKey		string	有効になっている場合とマネージド ID がセットアップされていない場合に、埋め込みモデルへのアクセスに使用するキー。
storageEndpoint		string	取り込まれるデータをホストする BLOB ストレージエンドポイント。 storageConnectionString の ResourceId 形式に必要です。
embeddingDeploymentName		string	埋め込みモデルへのアクセスに使用する現在の Azure OpenAI リソースの埋め込みデプロイの名前。

要求本文

名前	必須	型	説明
dataRefreshIntervalInMinutes	True	integer
chunkSize		integer	この数は、インジェストフローによって生成される各チャンク内のトークンの最大数を定義します。
completionAction		IngestionJobCompletionAction	IngestionJobCompletionAction インジェストジョブの完了時に実行するアクション。
id		string
progress		IngestionJobProgress	IngestionJobProgress
warnings		string[]

応答

名前	型	説明
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
      }
    ]
  }
}

定義

名前	説明
Error	エラー
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
IngestionJob	IngestionJob
IngestionJobCompletionAction	IngestionJobCompletionAction
IngestionJobProgress	IngestionJobProgress
InnerError	InnerError
InnerErrorCode	InnerErrorCode
OperationState	OperationState
StageProgress

Error

エラー

名前	型	説明
code	ErrorCode	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

名前	型	説明
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

名前	型	説明
error	Error	エラー Microsoft REST ガイドライン (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) で定義されているエラーコンテンツ。

IngestionJob

名前	型	既定値	説明
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

名前	型	説明
cleanUpAssets	string	インジェストプロセス中に作成された中間資産をクリーンします。
keepAllAssets	string	インジェストプロセス中に作成された中間資産はクリーンされません。

IngestionJobProgress

名前	型	説明
stageProgress	StageProgress[]

InnerError

名前	型	説明
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

名前	型	説明
invalidPayload	string	この操作の要求データが無効です。

OperationState

名前	型	説明
failed	string	操作はエラーで処理を完了し、それ以上使用することはできません。
notRunning	string	この操作は、今後処理されるキューにまだありません。
running	string	操作の処理が開始されました。
succeeded	string	操作は正常に処理され、使用する準備ができています。

StageProgress

名前	型	説明
name	string
processedItems	integer
totalItems	integer

Ingestion Jobs - Create

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

api-key

例

Starting an ingestion job.

Sample Request

Sample Response

定義

Error

ErrorCode

ErrorResponse

IngestionJob

IngestionJobCompletionAction

IngestionJobProgress

InnerError

InnerErrorCode

OperationState

StageProgress

その他のリソース