Bagikan melalui

Ingestion Jobs - Create

  • Referensi
Layanan:
Azure AI Services
Versi API:
2025-02-01-preview

Membuat pekerjaan penyerapan dengan id pekerjaan yang ditentukan.

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
endpoint
 path True

string (url)

Titik akhir Cognitive Services yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama akun Azure OpenAI Anda).
job-id
 path True

string

Id pekerjaan yang akan dibuat.
api-version
 query True

string

Versi API yang diminta.

Header Permintaan

Nama Diperlukan Jenis Deskripsi
mgmt-user-token

string

Token yang digunakan untuk mengakses ruang kerja (hanya diperlukan untuk pekerjaan komputasi pengguna).
aml-user-token

string

Token yang digunakan untuk mengakses sumber daya dalam pekerjaan di ruang kerja (hanya diperlukan untuk pekerjaan komputasi pengguna).

Isi Permintaan

Isi permintaan dapat berupa salah satu hal berikut:

Nama Deskripsi
IngestionJobSystemCompute
IngestionJobUserCompute

IngestionJobSystemCompute

Nama Diperlukan Jenis Deskripsi
kind True string:

SystemCompute

IngestionJobType
Jenis pekerjaan.
completionAction

IngestionJobCompletionAction

Tindakan penyelesaian.
dataRefreshIntervalInHours

integer

datasource SystemComputeDatasource:

SystemComputeDatasource
jobId

string

searchServiceConnection BaseConnection:

BaseConnection
Koneksi ke sumber daya.

IngestionJobUserCompute

Nama Diperlukan Jenis Deskripsi
kind True string:

UserCompute

IngestionJobType
Jenis pekerjaan.
workspaceId True

string

compute JobCompute:

JobCompute
Pengaturan komputasi pekerjaan.
dataRefreshIntervalInHours

integer

datasource UserComputeDatasource:

UserComputeDatasource
jobId

string

target TargetIndex:

TargetIndex
Informasi tentang indeks yang akan dibuat.

Respons

Nama Jenis Deskripsi
200 OK IngestionJob:

Keberhasilan
Other Status Codes

ErrorResponse

Terjadi kesalahan.

Keamanan

api-key

Autentikasi kunci API

Jenis: apiKey
Dalam: header

OAuth2Auth

Autentikasi OAuth2

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Cakupan

Nama Deskripsi
https://cognitiveservices.azure.com/.default

Contoh

Create a system-compute ingestion job
Create a user-compute ingestion job

Create a system-compute ingestion job

Permintaan sampel

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"
}

Respon sampel

Kode status:
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

Permintaan sampel

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"
  }
}

Respon sampel

Kode status:
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"
  }
}

Definisi

Nama Deskripsi
AzureAISearchIndex

Indeks Pencarian Azure AI.
ChunkingSettings

ChunkingSettings
ComputeType

Jenis komputasi.
ConnectionStringConnection

Koneksi string koneksi.
ConnectionType

Jenis koneksi.
CosmosDBIndex

Indeks CosmosDB.
CrawlingSettings

CrawlingSettings
CustomCompute

Komputasi kustom.
DeploymentConnection

Koneksi penyebaran relatif.
EndpointKeyConnection

Koneksi kunci titik akhir.
EndpointMIConnection

Koneksi Identitas Terkelola Titik Akhir.
Error

Kesalahan
ErrorCode

ErrorCode
ErrorResponse

ErrorResponse
GenericEmbeddingSettings

ConnectionEmbeddingSettings
IngestionJobCompletionAction

Tindakan penyelesaian.
IngestionJobSystemCompute
IngestionJobType

IngestionJobType
IngestionJobUserCompute
InnerError

InnerError
InnerErrorCode

InnerErrorCode
PineconeIndex

Indeks Pinecone.
ServerlessCompute

Komputasi tanpa server.
SystemComputeDatasourceType

Jenis sumber data.
SystemComputeStorage

SystemComputeStorage
SystemComputeUrl

SystemComputeUrl
TargetType

Jenis target.
UserComputeDataset

UserComputeStorage
UserComputeDatasourceType

Jenis sumber data.
UserComputeUrl

UserComputeUrl
WorkspaceConnection

Koneksi Ruang Kerja AML.
WorkspaceConnectionEmbeddingSettings

WorkspaceConnectionEmbeddingSettings

AzureAISearchIndex

Objek

Indeks Pencarian Azure AI.

Nama Jenis Deskripsi
connectionId

string

Id koneksi yang menunjuk ke Indeks Pencarian Azure AI.
kind string:

AzureAISearch

Jenis target.

ChunkingSettings

Objek

ChunkingSettings

Nama Jenis Deskripsi
maxChunkSizeInTokens

integer

ComputeType

Enumeration

Jenis komputasi.

Nilai Deskripsi
CustomCompute

Komputasi pengguna kustom.
ServerlessCompute

Komputasi pengguna tanpa server.

ConnectionStringConnection

Objek

Koneksi string koneksi.

Nama Jenis Deskripsi
connectionString

string

String koneksi
kind string:

ConnectionString

Jenis koneksi.

ConnectionType

Enumeration

Jenis koneksi.

Nilai Deskripsi
ConnectionString

String koneksi.
EndpointWithKey

Titik akhir dan koneksi kunci.
EndpointWithManagedIdentity

Titik akhir dan identitas terkelola.
RelativeConnection

Penyebaran relatif
WorkspaceConnection

Koneksi Ruang Kerja AML.

CosmosDBIndex

Objek

Indeks CosmosDB.

Nama Jenis Deskripsi
collectionName

string

Nama koleksi cosmos DB.
connectionId

string

Id koneksi yang menunjuk ke cosmos DB.
databaseName

string

Nama database cosmos DB.
kind string:

CosmosDB

Jenis target.

CrawlingSettings

Objek

CrawlingSettings

Nama Jenis Deskripsi
maxCrawlDepth

integer

maxCrawlTimeInMins

integer

maxDownloadTimeInMins

integer

maxFileSize

integer

maxFiles

integer

maxRedirects

integer

CustomCompute

Objek

Komputasi kustom.

Nama Jenis Deskripsi
computeId

string

Id komputasi kustom
kind string:

CustomCompute

Jenis komputasi.

DeploymentConnection

Objek

Koneksi penyebaran relatif.

Nama Jenis Deskripsi
kind string:

RelativeConnection

Jenis koneksi.

EndpointKeyConnection

Objek

Koneksi kunci titik akhir.

Nama Jenis Deskripsi
endpoint

string

Endpoint
key

string

Kunci
kind string:

EndpointWithKey

Jenis koneksi.

EndpointMIConnection

Objek

Koneksi Identitas Terkelola Titik Akhir.

Nama Jenis Deskripsi
endpoint

string

Endpoint
kind string:

EndpointWithManagedIdentity

Jenis koneksi.
resourceId

string

Id Sumber Daya

Error

Objek

Kesalahan

Nama Jenis Deskripsi
code

ErrorCode

ErrorCode
Kode kesalahan seperti yang didefinisikan dalam panduan Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details

Error[]

Detail kesalahan jika tersedia.
innererror

InnerError

InnerError
Kesalahan dalam seperti yang didefinisikan dalam panduan Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message

string

minLength: 1

Pesan kesalahan ini.
target

string

Lokasi tempat kesalahan terjadi jika tersedia.

ErrorCode

Enumeration

ErrorCode

Nilai Deskripsi
conflict

Operasi yang diminta berkonflik dengan status sumber daya saat ini.
contentFilter

Pembuatan gambar gagal sebagai akibat dari sistem keamanan kami.
fileImportFailed

Impor file gagal.
forbidden

Operasi dilarang untuk kunci pengguna/api saat ini.
internalFailure

Kesalahan internal. Silakan coba lagi.
invalidPayload

Data permintaan tidak valid untuk operasi ini.
itemDoesAlreadyExist

Item sudah ada.
jsonlValidationFailed

Validasi data jsonl gagal.
notFound

Sumber daya tidak ditemukan.
quotaExceeded

Kuota terlampaui.
serviceUnavailable

Layanan saat ini tidak tersedia.
tooManyRequests

Terlalu banyak permintaan. Silakan coba lagi nanti.
unauthorized

Kunci pengguna/api saat ini tidak diotorisasi untuk operasi.
unexpectedEntityState

Operasi tidak dapat dijalankan dalam status sumber daya saat ini.

ErrorResponse

Objek

ErrorResponse

Nama Jenis Deskripsi
error

Error

Kesalahan
Konten kesalahan seperti yang didefinisikan dalam panduan Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

GenericEmbeddingSettings

Objek

ConnectionEmbeddingSettings

Nama Jenis Deskripsi
connection BaseConnection:

BaseConnection
Koneksi ke sumber daya.
deploymentName

string

modelName

string

IngestionJobCompletionAction

Enumeration

Tindakan penyelesaian.

Nilai Deskripsi
cleanUpTempAssets

Akan membersihkan aset perantara yang dibuat selama proses penyerapan.
keepAllAssets

Tidak akan membersihkan salah satu aset perantara yang dibuat selama proses penyerapan.

IngestionJobSystemCompute

Objek
Nama Jenis Deskripsi
completionAction

IngestionJobCompletionAction

Tindakan penyelesaian.
dataRefreshIntervalInHours

integer

datasource SystemComputeDatasource:

SystemComputeDatasource
jobId

string

kind string:

SystemCompute

IngestionJobType
Jenis pekerjaan.
searchServiceConnection BaseConnection:

BaseConnection
Koneksi ke sumber daya.

IngestionJobType

Enumeration

IngestionJobType

Nilai Deskripsi
SystemCompute

Pekerjaan yang berjalan pada sumber daya yang dimiliki layanan.
UserCompute

Pekerjaan yang berjalan di ruang kerja milik pengguna.

IngestionJobUserCompute

Objek
Nama Jenis Deskripsi
compute JobCompute:

JobCompute
Pengaturan komputasi pekerjaan.
dataRefreshIntervalInHours

integer

datasource UserComputeDatasource:

UserComputeDatasource
jobId

string

kind string:

UserCompute

IngestionJobType
Jenis pekerjaan.
target TargetIndex:

TargetIndex
Informasi tentang indeks yang akan dibuat.
workspaceId

string

InnerError

Objek

InnerError

Nama Jenis Deskripsi
code

InnerErrorCode

InnerErrorCode
Kode kesalahan dalam seperti yang didefinisikan dalam panduan Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror

InnerError

InnerError
Kesalahan dalam seperti yang didefinisikan dalam panduan Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Enumeration

InnerErrorCode

Nilai Deskripsi
invalidPayload

Data permintaan tidak valid untuk operasi ini.

PineconeIndex

Objek

Indeks Pinecone.

Nama Jenis Deskripsi
connectionId

string

Id koneksi yang menunjuk ke pinecone.
kind string:

Pinecone

Jenis target.

ServerlessCompute

Objek

Komputasi tanpa server.

Nama Jenis Deskripsi
instanceCount

integer

Jumlah instans untuk menjalankan pekerjaan.
kind string:

ServerlessCompute

Jenis komputasi.
sku

string

Tingkat SKU

SystemComputeDatasourceType

Enumeration

Jenis sumber data.

Nilai Deskripsi
Storage

Akun Azure Storage.
Urls

URL.

SystemComputeStorage

Objek

SystemComputeStorage

Nama Jenis Deskripsi
chunking

ChunkingSettings

ChunkingSettings
Pengaturan pemotongan
connection BaseConnection:

BaseConnection
Koneksi ke sumber daya.
containerName

string

nama kontainer
embeddings

GenericEmbeddingSettings[]

ConnectionEmbeddingSettings
Pengaturan Penyematan Koneksi
kind string:

Storage

Jenis sumber data.

SystemComputeUrl

Objek

SystemComputeUrl

Nama Jenis Deskripsi
chunking

ChunkingSettings

ChunkingSettings
Pengaturan pemotongan
connection BaseConnection:

BaseConnection
Koneksi ke sumber daya.
containerName

string

nama kontainer
crawling

CrawlingSettings

CrawlingSettings
Pengaturan perayapan
embeddings

GenericEmbeddingSettings[]

ConnectionEmbeddingSettings
Pengaturan Penyematan Koneksi
kind string:

Urls

Jenis sumber data.
urls

string[]

TargetType

Enumeration

Jenis target.

Nilai Deskripsi
AzureAISearch

Indeks Pencarian Azure AI.
CosmosDB

Indeks CosmosDB.
Pinecone

Indeks Pinecone.

UserComputeDataset

Objek

UserComputeStorage

Nama Jenis Deskripsi
chunking

ChunkingSettings

ChunkingSettings
Pengaturan pemotongan
datasetId

string

datasetType

string

embeddings

WorkspaceConnectionEmbeddingSettings[]

WorkspaceConnectionEmbeddingSettings
Id koneksi ke model penyematan
kind string:

Dataset

Jenis sumber data.

UserComputeDatasourceType

Enumeration

Jenis sumber data.

Nilai Deskripsi
Dataset

Himpunan Data Ruang Kerja.
Urls

URL.

UserComputeUrl

Objek

UserComputeUrl

Nama Jenis Deskripsi
chunking

ChunkingSettings

ChunkingSettings
Pengaturan pemotongan
crawling

CrawlingSettings

CrawlingSettings
Pengaturan perayapan
embeddings

WorkspaceConnectionEmbeddingSettings[]

WorkspaceConnectionEmbeddingSettings
Id koneksi ke model penyematan
kind string:

Urls

Jenis sumber data.
urls

string[]

WorkspaceConnection

Objek

Koneksi Ruang Kerja AML.

Nama Jenis Deskripsi
connectionId

string

ConnectionId
kind string:

WorkspaceConnection

Jenis koneksi.

WorkspaceConnectionEmbeddingSettings

Objek

WorkspaceConnectionEmbeddingSettings

Nama Jenis Deskripsi
connectionId

string

deploymentName

string

modelName

string