Ingestion Jobs - Create

リファレンス

サービス:: Azure AI Services

API バージョン:: 2024-07-01-preview

指定したジョブ ID を使用してインジェストジョブを作成します。

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

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string url	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など: https://aoairesource.openai.azure.com。"aoairesource" を Azure OpenAI アカウント名に置き換えます)。
job-id	path	True	string	作成されるジョブの ID。
api-version	query	True	string	要求された API バージョン。

要求ヘッダー

名前	必須	型	説明
mgmt-user-token		string	ワークスペースへのアクセスに使用されるトークン (ユーザーコンピューティングジョブにのみ必要)。
aml-user-token		string	ワークスペース内のジョブ内のリソースにアクセスするために使用されるトークン (ユーザーコンピューティングジョブにのみ必要)。

要求本文

要求本文は、次のいずれかの可能性があります。

名前	説明
IngestionJobSystemCompute
IngestionJobUserCompute

IngestionJobSystemCompute

名前	必須	型	説明
kind	True	string: SystemCompute	IngestionJobType ジョブの種類。
completionAction		IngestionJobCompletionAction	完了アクション。
dataRefreshIntervalInHours		integer
datasource		SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId		string
searchServiceConnection		BaseConnection: EndpointKeyConnection ConnectionStringConnection EndpointMIConnection WorkspaceConnection DeploymentConnection	BaseConnection リソースへの接続。

IngestionJobUserCompute

名前	必須	型	説明
kind	True	string: UserCompute	IngestionJobType ジョブの種類。
workspaceId	True	string
compute		JobCompute: ServerlessCompute CustomCompute	JobCompute ジョブのコンピューティング設定。
dataRefreshIntervalInHours		integer
datasource		UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId		string
target		TargetIndex: AzureAISearchIndex CosmosDBIndex PineconeIndex	TargetIndex 作成するインデックスに関する情報。

応答

名前	型	説明
200 OK	IngestionJob: IngestionJobSystemCompute IngestionJobUserCompute	成功
Other Status Codes	ErrorResponse	エラーが発生しました。

セキュリティ

api-key

API キー認証

型: apiKey
/: header

OAuth2Auth

OAuth2 認証

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ

名前	説明
https://cognitiveservices.azure.com/.default

例

Create a system-compute ingestion job

Create a user-compute ingestion job

Create a system-compute ingestion job

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

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

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

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

定義

名前	説明
AzureAISearchIndex	Azure AI Search インデックス。
ChunkingSettings	ChunkingSettings
ComputeType	コンピューティングの種類。
ConnectionStringConnection	接続文字列の接続。
ConnectionType	接続の種類。
CosmosDBIndex	CosmosDB インデックス。
CrawlingSettings	CrawlingSettings
CustomCompute	カスタムコンピューティング。
DeploymentConnection	相対デプロイ接続。
EndpointKeyConnection	エンドポイントキー接続。
EndpointMIConnection	エンドポイントマネージド ID 接続。
Error	エラー
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
GenericEmbeddingSettings	ConnectionEmbeddingSettings
IngestionJobCompletionAction	完了アクション。
IngestionJobSystemCompute
IngestionJobType	IngestionJobType
IngestionJobUserCompute
InnerError	InnerError
InnerErrorCode	InnerErrorCode
PineconeIndex	Pinecone インデックス。
ServerlessCompute	サーバーレスコンピューティング。
SystemComputeDatasourceType	データソースの型。
SystemComputeStorage	SystemComputeStorage
SystemComputeUrl	SystemComputeUrl
TargetType	ターゲットの種類。
UserComputeDataset	UserComputeStorage
UserComputeDatasourceType	データソースの型。
UserComputeUrl	UserComputeUrl
WorkspaceConnection	AML ワークスペース接続。
WorkspaceConnectionEmbeddingSettings	WorkspaceConnectionEmbeddingSettings

AzureAISearchIndex

Azure AI Search インデックス。

名前	型	説明
connectionId	string	Azure AI Search インデックスを指す接続の ID。
kind	string: AzureAISearch	ターゲットの種類。

ChunkingSettings

名前	型	説明
maxChunkSizeInTokens	integer

ComputeType

コンピューティングの種類。

名前	型	説明
CustomCompute	string	カスタムユーザーコンピューティング。
ServerlessCompute	string	サーバーレスユーザーコンピューティング。

ConnectionStringConnection

接続文字列の接続。

名前	型	説明
connectionString	string	接続文字列
kind	string: ConnectionString	接続の種類。

ConnectionType

接続の種類。

名前	型	説明
ConnectionString	string	接続文字列。
EndpointWithKey	string	エンドポイントとキーの接続。
EndpointWithManagedIdentity	string	エンドポイントとマネージド ID。
RelativeConnection	string	相対デプロイ
WorkspaceConnection	string	AML ワークスペース接続。

CosmosDBIndex

CosmosDB インデックス。

名前	型	説明
collectionName	string	Cosmos DB コレクションの名前。
connectionId	string	Cosmos DB を指す接続の ID。
databaseName	string	Cosmos DB データベースの名前。
kind	string: CosmosDB	ターゲットの種類。

CrawlingSettings

名前	型	説明
maxCrawlDepth	integer
maxCrawlTimeInMins	integer
maxDownloadTimeInMins	integer
maxFileSize	integer
maxFiles	integer
maxRedirects	integer

CustomCompute

カスタムコンピューティング。

名前	型	説明
computeId	string	カスタムコンピューティングの ID
kind	string: CustomCompute	コンピューティングの種類。

DeploymentConnection

相対デプロイ接続。

名前	型	説明
kind	string: RelativeConnection	接続の種類。

EndpointKeyConnection

エンドポイントキー接続。

名前	型	説明
endpoint	string	エンドポイント
key	string	鍵
kind	string: EndpointWithKey	接続の種類。

EndpointMIConnection

エンドポイントマネージド ID 接続。

名前	型	説明
endpoint	string	エンドポイント
kind	string: EndpointWithManagedIdentity	接続の種類。
resourceId	string	リソース ID

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) で定義されているエラーコンテンツ。

GenericEmbeddingSettings

ConnectionEmbeddingSettings

名前	型	説明
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection リソースへの接続。
deploymentName	string
modelName	string

IngestionJobCompletionAction

完了アクション。

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

IngestionJobSystemCompute

名前	型	説明
completionAction	IngestionJobCompletionAction	完了アクション。
dataRefreshIntervalInHours	integer
datasource	SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId	string
kind	string: SystemCompute	IngestionJobType ジョブの種類。
searchServiceConnection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection リソースへの接続。

IngestionJobType

名前	型	説明
SystemCompute	string	サービス所有のリソースで実行されるジョブ。
UserCompute	string	ユーザー所有のワークスペースで実行されるジョブ。

IngestionJobUserCompute

名前	型	説明
compute	JobCompute: CustomCompute ServerlessCompute	JobCompute ジョブのコンピューティング設定。
dataRefreshIntervalInHours	integer
datasource	UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId	string
kind	string: UserCompute	IngestionJobType ジョブの種類。
target	TargetIndex: AzureAISearchIndex CosmosDBIndex PineconeIndex	TargetIndex 作成するインデックスに関する情報。
workspaceId	string

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	要求データがこの操作に対して無効です。

PineconeIndex

Pinecone インデックス。

名前	型	説明
connectionId	string	パインコンを指す接続の ID。
kind	string: Pinecone	ターゲットの種類。

ServerlessCompute

サーバーレスコンピューティング。

名前	型	説明
instanceCount	integer	ジョブを実行するインスタンスの数。
kind	string: ServerlessCompute	コンピューティングの種類。
sku	string	SKU レベル

SystemComputeDatasourceType

データソースの型。

名前	型	説明
Storage	string	Azure ストレージアカウント。
Urls	string	URL。

SystemComputeStorage

名前	型	説明
chunking	ChunkingSettings	ChunkingSettings チャンク設定
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection リソースへの接続。
containerName	string	コンテナー名
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings 接続埋め込み設定
kind	string: Storage	データソースの型。

SystemComputeUrl

名前	型	説明
chunking	ChunkingSettings	ChunkingSettings チャンク設定
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection リソースへの接続。
containerName	string	コンテナー名
crawling	CrawlingSettings	CrawlingSettings クロール設定
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings 接続埋め込み設定
kind	string: Urls	データソースの型。
urls	string[]

TargetType

ターゲットの種類。

名前	型	説明
AzureAISearch	string	Azure AI Search インデックス。
CosmosDB	string	CosmosDB インデックス。
Pinecone	string	Pinecone インデックス。

UserComputeDataset

UserComputeStorage

名前	型	説明
chunking	ChunkingSettings	ChunkingSettings チャンク設定
datasetId	string
datasetType	string
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings 埋め込みモデルへの接続 ID
kind	string: Dataset	データソースの型。

UserComputeDatasourceType

データソースの型。

名前	型	説明
Dataset	string	ワークスペースデータセット。
Urls	string	URL。

UserComputeUrl

名前	型	説明
chunking	ChunkingSettings	ChunkingSettings チャンク設定
crawling	CrawlingSettings	CrawlingSettings クロール設定
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings 埋め込みモデルへの接続 ID
kind	string: Urls	データソースの型。
urls	string[]

WorkspaceConnection

AML ワークスペース接続。

名前	型	説明
connectionId	string	ConnectionId
kind	string: WorkspaceConnection	接続の種類。

WorkspaceConnectionEmbeddingSettings

名前	型	説明
connectionId	string
deploymentName	string
modelName	string

次の方法で共有

Ingestion Jobs - Create

URI パラメーター

要求ヘッダー

要求本文

IngestionJobSystemCompute

IngestionJobUserCompute

応答

セキュリティ

api-key

OAuth2Auth

スコープ

例

Create a system-compute ingestion job

要求のサンプル

応答のサンプル

Create a user-compute ingestion job

要求のサンプル

応答のサンプル

定義

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

その他のリソース