Ingestion Jobs - Create

Başvuru

Hizmet:: Azure AI Services

API Sürümü:: 2024-05-01-preview

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

PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2024-05-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
api-key	True	string	Bilişsel Hizmetler Azure OpenAI hesap anahtarınızı buradan sağlayın.
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: system	IngestionJobType İş türü.
completionAction		IngestionJobCompletionAction	Tamamlama eylemi.
dataRefreshIntervalInHours		integer
datasource		SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId		string
searchServiceConnection		BaseConnection: EndpointKeyConnection ConnectionStringConnection EndpointMIConnection WorkspaceConnection DeploymentConnection	BaseConnection Bir kaynağa bağlantı.

IngestionJobUserCompute

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

Yanıtlar

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

Güvenlik

api-key

Bilişsel Hizmetler Azure OpenAI hesap anahtarınızı buradan sağlayın.

Tür: apiKey
İçinde: header

Ö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/{job-id}?api-version=2024-05-01-preview

{
  "kind": "SystemCompute",
  "searchServiceConnection": {
    "kind": "EndpointWithManagedIdentity",
    "endpoint": "https://aykame-dev-search.search.windows.net"
  },
  "datasource": {
    "kind": "Storage",
    "storageAccountConnection": {
      "kind": "EndpointWithManagedIdentity",
      "endpoint": "https://mystorage.blob.core.windows.net/",
      "resourceId": "ResourceId=/subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage"
    },
    "containerName": "container",
    "chunkingSettings": {
      "maxChunkSizeInTokens": 2048
    },
    "embeddingsSettings": [
      {
        "embeddingResourceConnection": {
          "kind": "RelativeConnection"
        },
        "modelProvider": "AOAI",
        "deploymentName": "Ada"
      }
    ]
  },
  "dataRefreshIntervalInHours": 24,
  "completionAction": 0
}

Örnek yanıt

Durum kodu:: 200

operation-location: https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2024-05-01-preview

{
  "kind": "SystemCompute",
  "jobId": "ingestion-job",
  "searchServiceConnection": {
    "kind": "EndpointWithManagedIdentity",
    "endpoint": "https://aykame-dev-search.search.windows.net"
  },
  "datasource": {
    "kind": "Storage",
    "storageAccountConnection": {
      "kind": "EndpointWithManagedIdentity",
      "endpoint": "https://mystorage.blob.core.windows.net/",
      "resourceId": "ResourceId=/subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage"
    },
    "containerName": "container",
    "chunkingSettings": {
      "maxChunkSizeInTokens": 2048
    },
    "embeddingsSettings": [
      {
        "embeddingResourceConnection": {
          "kind": "RelativeConnection"
        },
        "modelProvider": "AOAI",
        "deploymentName": "Ada"
      }
    ]
  },
  "dataRefreshIntervalInHours": 24,
  "completionAction": 0
}

Create a user-compute ingestion job

Örnek isteği

HTTP

PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2024-05-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=2024-05-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
ACSIndex	ACS Dizini.
BaseConnection	BaseConnection
ChunkingSettings	ChunkingSettings
ComputeType	İşlem türü.
ConnectionStringConnection	Bağlantı dizesi bağlantısı.
ConnectionType	Bağlantı türü.
CosmosDBIndex	CosmosDB Dizini.
CrawlingSettings	CrawlingSettings
CustomCompute	Özel işlem.
DatasourceType	Veri kaynağı türü.
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.
SystemComputeDatasource	SystemComputeDatasource
SystemComputeStorage	SystemComputeStorage
SystemComputeUrl	SystemComputeUrl
TargetType	Hedef türü.
UserComputeDataset	UserComputeStorage
UserComputeUrl	UserComputeUrl
WorkspaceConnection	AML Çalışma Alanı bağlantısı.
WorkspaceConnectionEmbeddingSettings	WorkspaceConnectionEmbeddingSettings

ACSIndex

ACS Dizini.

Name	Tür	Description
connectionId	string	ACS Dizinine işaret eden bağlantının kimliği.
kind	string: acs	Hedef türü.

BaseConnection

Name	Tür	Description
kind	ConnectionType	Bağlantı türü.

ChunkingSettings

Name	Tür	Description
maxChunkSizeInTokens	integer

ComputeType

İşlem türü.

Name	Tür	Description
custom	string	Özel kullanıcı işlem.
serverless	string	Sunucusuz kullanıcı işlem.

ConnectionStringConnection

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

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

ConnectionType

Bağlantı türü.

Name	Tür	Description
connectionString	string	Bağlantı dizesi.
endpointKey	string	Uç nokta ve anahtar bağlantısı.
endpointMI	string	Uç nokta ve yönetilen kimlik.
workspace	string	AML Çalışma Alanı bağlantısı.

CosmosDBIndex

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

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

CustomCompute

Özel işlem.

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

DatasourceType

Veri kaynağı türü.

Name	Tür	Description
storage	string	Azure Depolama Hesabı.
urls	string	Url 'leri.

DeploymentConnection

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

Name	Tür	Description
kind	ConnectionType	Bağlantı türü.

EndpointKeyConnection

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

Name	Tür	Description
endpoint	string	Uç Nokta
key	string	Anahtar
kind	ConnectionType	Bağlantı türü.

EndpointMIConnection

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

Name	Tür	Description
endpoint	string	Uç Nokta
kind	ConnectionType	Bağlantı türü.

Error

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ımlandığı gibi 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ımlandığı gibi iç hata.
message	string	Bu hatanın iletisi.
target	string	Varsa hatanın oluştuğu konum.

ErrorCode

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

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ımlandığı gibi hata içeriği.

GenericEmbeddingSettings

ConnectionEmbeddingSettings

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

IngestionJobCompletionAction

Tamamlama eylemi.

Name	Tür	Description
cleanUpAssets	string	Alım işlemi sırasında oluşturulan ara varlıkları temizler.
keepAllAssets	string	Alma işlemi sırasında oluşturulan ara varlıkların hiçbirini temizlemez.

IngestionJobSystemCompute

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

IngestionJobType

Name	Tür	Description
system	string	Hizmete ait kaynaklarda çalışan işler.
user	string	Kullanıcıya ait çalışma alanında çalışan işler.

IngestionJobUserCompute

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

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ımlandığı gibi iç hata.

InnerErrorCode

Name	Tür	Description
invalidPayload	string	İstek verileri bu işlem için geçersiz.

PineconeIndex

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

Sunucusuz işlem.

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

SystemComputeDatasource

Name	Tür	Description
kind	DatasourceType	Veri kaynağı türü.

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	DatasourceType	Veri kaynağı türü.

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	CrawlingSettings Gezinme ayarları
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Bağlantı Ekleme Ayarları
kind	DatasourceType	Veri kaynağı türü.
urls	string[]

TargetType

Hedef türü.

Name	Tür	Description
acs	string	Azure AI Arama Dizini.
cosmosdb	string	CosmosDB Dizini.
pinecone	string	Pinecone Dizini.

UserComputeDataset

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ü.

UserComputeUrl

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

WorkspaceConnection

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

Name	Tür	Description
connectionId	string	Connectionıd
kind	ConnectionType	Bağlantı türü.

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

Ö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

ACSIndex

BaseConnection

ChunkingSettings

ComputeType

ConnectionStringConnection

ConnectionType

CosmosDBIndex

CrawlingSettings

CustomCompute

DatasourceType

DeploymentConnection

EndpointKeyConnection

EndpointMIConnection

Error

ErrorCode

ErrorResponse

GenericEmbeddingSettings

IngestionJobCompletionAction

IngestionJobSystemCompute

IngestionJobType

IngestionJobUserCompute

InnerError

InnerErrorCode

PineconeIndex

ServerlessCompute

SystemComputeDatasource

SystemComputeStorage

SystemComputeUrl

TargetType

UserComputeDataset

UserComputeUrl

WorkspaceConnection

WorkspaceConnectionEmbeddingSettings

Ek kaynaklar