Ingestion Jobs - Create

Başvuru

Hizmet:: Azure AI Services

API Sürümü:: 2025-02-01-preview

Belirtilen iş kimliğine sahip bir alma işi oluşturur.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string (url)	Desteklenen Bilişsel Hizmetler uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI hesap adınızı yazın).
job-id	path	True	string	Oluşturulacak işin kimliği.
api-version	query	True	string	İstenen API sürümü.

İstek Başlığı

Name	Gerekli	Tür	Description
mgmt-user-token		string	Çalışma alanına erişmek için kullanılan belirteç (yalnızca kullanıcı işlem işleri için gereklidir).
aml-user-token		string	Çalışma alanında işin içindeki kaynaklara erişmek için kullanılan belirteç (yalnızca kullanıcı işlem işleri için gereklidir).

İstek Gövdesi

İstek gövdesi şunlardan biri olabilir:

Name	Description
IngestionJobSystemCompute
IngestionJobUserCompute

IngestionJobSystemCompute

Name	Gerekli	Tür	Description
kind	True	string: SystemCompute	IngestionJobType İş türü.
completionAction		IngestionJobCompletionAction	Tamamlama eylemi.
dataRefreshIntervalInHours		integer
datasource		SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId		string
searchServiceConnection		BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Bir kaynağa bağlantı.

IngestionJobUserCompute

Name	Gerekli	Tür	Description
kind	True	string: UserCompute	IngestionJobType İş türü.
workspaceId	True	string
compute		JobCompute: CustomCompute ServerlessCompute	jobcompute İşin işlem ayarları.
dataRefreshIntervalInHours		integer
datasource		UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId		string
target		TargetIndex: AzureAISearchIndex CosmosDBIndex PineconeIndex	TargetIndex Oluşturulacak dizin hakkında bilgi.

Yanıtlar

Name	Tür	Description
200 OK	IngestionJob: IngestionJobSystemCompute IngestionJobUserCompute	Başarı
Other Status Codes	ErrorResponse	Bir hata oluştu.

Güvenlik

api-key

API anahtarı kimlik doğrulaması

Tür: apiKey
İçinde: header

OAuth2Auth

OAuth2 kimlik doğrulaması

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Kapsamlar

Name	Description
https://cognitiveservices.azure.com/.default

Örnekler

Create a system-compute ingestion job

Create a user-compute ingestion job

Create a system-compute ingestion job

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:: 200

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

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:: 200

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

Tanımlar

Name	Description
AzureAISearchIndex	Azure AI Arama Dizini.
ChunkingSettings	ChunkingSettings
ComputeType	İşlem türü.
ConnectionStringConnection	Bağlantı dizesi bağlantısı.
ConnectionType	Bağlantı türü.
CosmosDBIndex	CosmosDB Dizini.
CrawlingSettings	GezinmeAyarları
CustomCompute	Özel işlem.
DeploymentConnection	Göreli dağıtım bağlantısı.
EndpointKeyConnection	Uç nokta anahtarı bağlantısı.
EndpointMIConnection	Uç Nokta Yönetilen Kimlik bağlantısı.
Error	Hata
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
GenericEmbeddingSettings	ConnectionEmbeddingSettings
IngestionJobCompletionAction	Tamamlama eylemi.
IngestionJobSystemCompute
IngestionJobType	IngestionJobType
IngestionJobUserCompute
InnerError	InnerError
InnerErrorCode	InnerErrorCode
PineconeIndex	Pinecone Dizini.
ServerlessCompute	Sunucusuz işlem.
SystemComputeDatasourceType	Veri kaynağı türü.
SystemComputeStorage	SystemComputeStorage
SystemComputeUrl	SystemComputeUrl
TargetType	Hedef türü.
UserComputeDataset	UserComputeStorage
UserComputeDatasourceType	Veri kaynağı türü.
UserComputeUrl	UserComputeUrl
WorkspaceConnection	AML Çalışma Alanı bağlantısı.
WorkspaceConnectionEmbeddingSettings	WorkspaceConnectionEmbeddingSettings

AzureAISearchIndex

Object

Azure AI Arama Dizini.

Name	Tür	Description
connectionId	string	Azure AI Arama Dizini'ni işaret eden bağlantının kimliği.
kind	string: AzureAISearch	Hedef türü.

ChunkingSettings

Object

ChunkingSettings

Name	Tür	Description
maxChunkSizeInTokens	integer

ComputeType

Listeleme

İşlem türü.

Değer	Description
CustomCompute	Özel kullanıcı işlem.
ServerlessCompute	Sunucusuz kullanıcı işlem.

ConnectionStringConnection

Object

Bağlantı dizesi bağlantısı.

Name	Tür	Description
connectionString	string	Bağlantı dizesi
kind	string: ConnectionString	Bağlantı türü.

ConnectionType

Listeleme

Bağlantı türü.

Değer	Description
ConnectionString	Bağlantı dizesi.
EndpointWithKey	Uç nokta ve anahtar bağlantısı.
EndpointWithManagedIdentity	Uç nokta ve yönetilen kimlik.
RelativeConnection	Göreli dağıtım
WorkspaceConnection	AML Çalışma Alanı bağlantısı.

CosmosDBIndex

Object

CosmosDB Dizini.

Name	Tür	Description
collectionName	string	Cosmos DB koleksiyonunun adı.
connectionId	string	Cosmos DB'ye işaret eden bağlantının kimliği.
databaseName	string	Cosmos DB veritabanının adı.
kind	string: CosmosDB	Hedef türü.

CrawlingSettings

Object

GezinmeAyarları

Name	Tür	Description
maxCrawlDepth	integer
maxCrawlTimeInMins	integer
maxDownloadTimeInMins	integer
maxFileSize	integer
maxFiles	integer
maxRedirects	integer

CustomCompute

Object

Özel işlem.

Name	Tür	Description
computeId	string	Özel işlemin kimliği
kind	string: CustomCompute	İşlem türü.

DeploymentConnection

Object

Göreli dağıtım bağlantısı.

Name	Tür	Description
kind	string: RelativeConnection	Bağlantı türü.

EndpointKeyConnection

Object

Uç nokta anahtarı bağlantısı.

Name	Tür	Description
endpoint	string	Bitiş noktası
key	string	Anahtar
kind	string: EndpointWithKey	Bağlantı türü.

EndpointMIConnection

Object

Uç Nokta Yönetilen Kimlik bağlantısı.

Name	Tür	Description
endpoint	string	Bitiş noktası
kind	string: EndpointWithManagedIdentity	Bağlantı türü.
resourceId	string	Kaynak Kimliği

Error

Object

Hata

Name	Tür	Description
code	ErrorCode	ErrorCode Microsoft REST yönergelerinde (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) tanımlanan hata kodları.
details	Error[]	Varsa hata ayrıntıları.
innererror	InnerError	InnerError Microsoft REST yönergelerinde (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) tanımlanan iç hata.
message	string minLength: 1	Bu hatanın iletisi.
target	string	Varsa hatanın oluştuğu konum.

ErrorCode

Listeleme

ErrorCode

Değer	Description
conflict	İstenen işlem geçerli kaynak durumuyla çakişer.
contentFilter	Görüntü oluşturma, güvenlik sistemimizin bir sonucu olarak başarısız oldu.
fileImportFailed	Dosya içeri aktarılamadı.
forbidden	geçerli kullanıcı/api anahtarı için işlem yasaktır.
internalFailure	İç hata. Lütfen yeniden deneyin.
invalidPayload	İstek verileri bu işlem için geçersiz.
itemDoesAlreadyExist	Öğe zaten var.
jsonlValidationFailed	Jsonl verileri doğrulanamadı.
notFound	Kaynak bulunamadı.
quotaExceeded	Kota aşıldı.
serviceUnavailable	Hizmet şu anda kullanılamıyor.
tooManyRequests	Çok fazla istek var. Lütfen daha sonra yeniden deneyin.
unauthorized	Geçerli kullanıcı/api anahtarı işlem için yetkilendirilmedi.
unexpectedEntityState	İşlem geçerli kaynağın durumunda yürütülemez.

ErrorResponse

Object

ErrorResponse

Name	Tür	Description
error	Error	Hata Microsoft REST yönergelerinde (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) tanımlanan hata içeriği.

GenericEmbeddingSettings

Object

ConnectionEmbeddingSettings

Name	Tür	Description
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Bir kaynağa bağlantı.
deploymentName	string
modelName	string

IngestionJobCompletionAction

Listeleme

Tamamlama eylemi.

Değer	Description
cleanUpTempAssets	Alma işlemi sırasında oluşturulan ara varlıkları temizler.
keepAllAssets	Alım işlemi sırasında oluşturulan ara varlıkların hiçbirini temizlemez.

IngestionJobSystemCompute

Object

Name	Tür	Description
completionAction	IngestionJobCompletionAction	Tamamlama eylemi.
dataRefreshIntervalInHours	integer
datasource	SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId	string
kind	string: SystemCompute	IngestionJobType İş türü.
searchServiceConnection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Bir kaynağa bağlantı.

IngestionJobType

Listeleme

IngestionJobType

Değer	Description
SystemCompute	Hizmete ait kaynaklarda çalışan işler.
UserCompute	Kullanıcıya ait çalışma alanında çalışan işler.

IngestionJobUserCompute

Object

Name	Tür	Description
compute	JobCompute: CustomCompute ServerlessCompute	jobcompute İşin işlem ayarları.
dataRefreshIntervalInHours	integer
datasource	UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId	string
kind	string: UserCompute	IngestionJobType İş türü.
target	TargetIndex: AzureAISearchIndex CosmosDBIndex PineconeIndex	TargetIndex Oluşturulacak dizin hakkında bilgi.
workspaceId	string

InnerError

Object

InnerError

Name	Tür	Description
code	InnerErrorCode	InnerErrorCode Microsoft REST yönergelerinde (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) tanımlanan iç hata kodları.
innererror	InnerError	InnerError Microsoft REST yönergelerinde (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) tanımlanan iç hata.

InnerErrorCode

Listeleme

InnerErrorCode

Değer	Description
invalidPayload	İstek verileri bu işlem için geçersiz.

PineconeIndex

Object

Pinecone Dizini.

Name	Tür	Description
connectionId	string	Pinecone'a işaret eden bağlantının kimliği.
kind	string: Pinecone	Hedef türü.

ServerlessCompute

Object

Sunucusuz işlem.

Name	Tür	Description
instanceCount	integer	İşi çalıştırılacak örneklerin sayısı.
kind	string: ServerlessCompute	İşlem türü.
sku	string	SKU Düzeyi

SystemComputeDatasourceType

Listeleme

Veri kaynağı türü.

Değer	Description
Storage	Azure Depolama Hesabı.
Urls	URL'ler.

SystemComputeStorage

Object

SystemComputeStorage

Name	Tür	Description
chunking	ChunkingSettings	ChunkingSettings Öbekleme ayarları
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Bir kaynağa bağlantı.
containerName	string	kapsayıcı adı
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Bağlantı Ekleme Ayarları
kind	string: Storage	Veri kaynağı türü.

SystemComputeUrl

Object

SystemComputeUrl

Name	Tür	Description
chunking	ChunkingSettings	ChunkingSettings Öbekleme ayarları
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Bir kaynağa bağlantı.
containerName	string	kapsayıcı adı
crawling	CrawlingSettings	GezinmeAyarları Gezinme ayarları
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Bağlantı Ekleme Ayarları
kind	string: Urls	Veri kaynağı türü.
urls	string[]

TargetType

Listeleme

Hedef türü.

Değer	Description
AzureAISearch	Azure AI Arama Dizini.
CosmosDB	CosmosDB Dizini.
Pinecone	Pinecone Dizini.

UserComputeDataset

Object

UserComputeStorage

Name	Tür	Description
chunking	ChunkingSettings	ChunkingSettings Öbekleme ayarları
datasetId	string
datasetType	string
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings Ekleme modeline bağlantı kimliği
kind	string: Dataset	Veri kaynağı türü.

UserComputeDatasourceType

Listeleme

Veri kaynağı türü.

Değer	Description
Dataset	Çalışma Alanı Veri Kümesi.
Urls	URL'ler.

UserComputeUrl

Object

UserComputeUrl

Name	Tür	Description
chunking	ChunkingSettings	ChunkingSettings Öbekleme ayarları
crawling	CrawlingSettings	GezinmeAyarları Gezinme ayarları
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings Ekleme modeline bağlantı kimliği
kind	string: Urls	Veri kaynağı türü.
urls	string[]

WorkspaceConnection

Object

AML Çalışma Alanı bağlantısı.

Name	Tür	Description
connectionId	string	ConnectionId
kind	string: WorkspaceConnection	Bağlantı türü.

WorkspaceConnectionEmbeddingSettings

Object

WorkspaceConnectionEmbeddingSettings

Name	Tür	Description
connectionId	string
deploymentName	string
modelName	string

Aracılığıyla paylaş

Ingestion Jobs - Create

URI Parametreleri

İstek Başlığı

İstek Gövdesi

IngestionJobSystemCompute

IngestionJobUserCompute

Yanıtlar

Güvenlik

api-key

OAuth2Auth

Kapsamlar

Örnekler

Create a system-compute ingestion job

Örnek isteği

Örnek yanıt

Create a user-compute ingestion job

Örnek isteği

Örnek yanıt

Tanımlar

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

Ek kaynaklar