Ingestion Jobs - Get
Belirtilen iş kimliğinin ayrıntılarını alır.
GET {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 |
İş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. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK | IngestionJob: |
Başarılı |
Other Status Codes |
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
Get ingestion job
Örnek isteği
GET {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2024-05-01-preview
Örnek yanıt
{
"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. |
Base |
BaseConnection |
Chunking |
ChunkingSettings |
Compute |
İşlem türü. |
Connection |
Bağlantı dizesi bağlantısı. |
Connection |
Bağlantı türü. |
Cosmos |
CosmosDB Dizini. |
Crawling |
CrawlingSettings |
Custom |
Özel işlem. |
Datasource |
Veri kaynağı türü. |
Deployment |
Göreli dağıtım bağlantısı. |
Endpoint |
Uç nokta anahtarı bağlantısı. |
Endpoint |
Uç Nokta Yönetilen Kimlik bağlantısı. |
Error |
Hata |
Error |
ErrorCode |
Error |
ErrorResponse |
Generic |
ConnectionEmbeddingSettings |
Ingestion |
Tamamlama eylemi. |
Ingestion |
|
Ingestion |
IngestionJobType |
Ingestion |
|
Inner |
InnerError |
Inner |
InnerErrorCode |
Pinecone |
Pinecone Dizini. |
Serverless |
Sunucusuz işlem. |
System |
SystemComputeDatasource |
System |
SystemComputeStorage |
System |
SystemComputeUrl |
Target |
Hedef türü. |
User |
UserComputeStorage |
User |
UserComputeUrl |
Workspace |
AML Çalışma Alanı bağlantısı. |
Workspace |
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
BaseConnection
Name | Tür | Description |
---|---|---|
kind |
Bağlantı türü. |
ChunkingSettings
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 |
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
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 |
Bağlantı türü. |
EndpointKeyConnection
Uç nokta anahtarı bağlantısı.
Name | Tür | Description |
---|---|---|
endpoint |
string |
Uç Nokta |
key |
string |
Anahtar |
kind |
Bağlantı türü. |
EndpointMIConnection
Uç Nokta Yönetilen Kimlik bağlantısı.
Name | Tür | Description |
---|---|---|
endpoint |
string |
Uç Nokta |
kind |
Bağlantı türü. |
Error
Hata
Name | Tür | Description |
---|---|---|
code |
ErrorCode |
|
details |
Error[] |
Varsa hata ayrıntıları. |
innererror |
InnerError |
|
message |
string |
Bu hatanın iletisi. |
target |
string |
Varsa hatanın oluştuğu konum. |
ErrorCode
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
ErrorResponse
Name | Tür | Description |
---|---|---|
error |
Hata |
GenericEmbeddingSettings
ConnectionEmbeddingSettings
Name | Tür | Description |
---|---|---|
connection | BaseConnection: |
BaseConnection |
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 |
Tamamlama eylemi. |
|
dataRefreshIntervalInHours |
integer |
|
datasource | SystemComputeDatasource: |
SystemComputeDatasource |
jobId |
string |
|
kind |
string:
system |
IngestionJobType |
searchServiceConnection | BaseConnection: |
BaseConnection |
IngestionJobType
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: |
jobcompute |
dataRefreshIntervalInHours |
integer |
|
datasource | UserComputeDatasource: |
UserComputeDatasource |
jobId |
string |
|
kind |
string:
user |
IngestionJobType |
target | TargetIndex: |
TargetIndex |
workspaceId |
string |
InnerError
InnerError
Name | Tür | Description |
---|---|---|
code |
InnerErrorCode |
|
innererror |
InnerError |
InnerErrorCode
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
SystemComputeDatasource
Name | Tür | Description |
---|---|---|
kind |
Veri kaynağı türü. |
SystemComputeStorage
SystemComputeStorage
Name | Tür | Description |
---|---|---|
chunking |
ChunkingSettings |
|
connection | BaseConnection: |
BaseConnection |
containerName |
string |
kapsayıcı adı |
embeddings |
ConnectionEmbeddingSettings |
|
kind |
Veri kaynağı türü. |
SystemComputeUrl
SystemComputeUrl
Name | Tür | Description |
---|---|---|
chunking |
ChunkingSettings |
|
connection | BaseConnection: |
BaseConnection |
containerName |
string |
kapsayıcı adı |
crawling |
CrawlingSettings |
|
embeddings |
ConnectionEmbeddingSettings |
|
kind |
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 |
|
datasetId |
string |
|
datasetType |
string |
|
embeddings |
WorkspaceConnectionEmbeddingSettings |
|
kind |
string:
dataset |
Veri kaynağı türü. |
UserComputeUrl
UserComputeUrl
Name | Tür | Description |
---|---|---|
chunking |
ChunkingSettings |
|
crawling |
CrawlingSettings |
|
embeddings |
WorkspaceConnectionEmbeddingSettings |
|
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 |
Bağlantı türü. |
WorkspaceConnectionEmbeddingSettings
WorkspaceConnectionEmbeddingSettings
Name | Tür | Description |
---|---|---|
connectionId |
string |
|
deploymentName |
string |
|
modelName |
string |