Ingestion Jobs - Create

Referencia

Szolgáltatás:: Azure AI Services

API-verzió:: 2024-05-01-preview

Létrehoz egy betöltési feladatot a megadott feladatazonosítóval.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string url	Támogatott Cognitive Services-végpontok (protokoll és állomásnév, például: https://aoairesource.openai.azure.com. Cserélje le az "aoairesource" kifejezést az Azure OpenAI-fiók nevére).
job-id	path	True	string	A létrehozandó feladat azonosítója.
api-version	query	True	string	A kért API-verzió.

Kérelem fejléce

Name	Kötelező	Típus	Description
api-key	True	string	Itt adja meg a Cognitive Services Azure OpenAI-fiókkulcsát.
mgmt-user-token		string	A munkaterület eléréséhez használt jogkivonat (csak a felhasználói számítási feladatokhoz szükséges).
aml-user-token		string	A munkaterületen lévő feladat erőforrásainak eléréséhez használt jogkivonat (csak a felhasználói számítási feladatokhoz szükséges).

Kérelem törzse

A kérelem törzse az alábbiak valamelyike lehet:

Name	Description
IngestionJobSystemCompute
IngestionJobUserCompute

IngestionJobSystemCompute

Name	Kötelező	Típus	Description
kind	True	string: system	IngestionJobType A feladat típusa.
completionAction		IngestionJobCompletionAction	A befejezési művelet.
dataRefreshIntervalInHours		integer
datasource		SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId		string
searchServiceConnection		BaseConnection: EndpointKeyConnection ConnectionStringConnection EndpointMIConnection WorkspaceConnection DeploymentConnection	BaseConnection Egy erőforráshoz való kapcsolat.

IngestionJobUserCompute

Name	Kötelező	Típus	Description
kind	True	string: user	IngestionJobType A feladat típusa.
workspaceId	True	string
compute		JobCompute: ServerlessCompute CustomCompute	JobCompute A feladat számítási beállításai.
dataRefreshIntervalInHours		integer
datasource		UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId		string
target		TargetIndex: ACSIndex CosmosDBIndex PineconeIndex	TargetIndex A létrehozandó indexre vonatkozó információk.

Válaszok

Name	Típus	Description
200 OK	IngestionJob: IngestionJobSystemCompute IngestionJobUserCompute	Siker
Other Status Codes	ErrorResponse	Hiba történt.

Biztonság

api-key

Itt adja meg a Cognitive Services Azure OpenAI-fiókkulcsát.

Típus: apiKey
In: header

Példák

Create a system-compute ingestion job

Create a user-compute ingestion job

Create a system-compute ingestion job

Mintakérelem

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
}

Mintaválasz

Állapotkód:: 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

Mintakérelem

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

Mintaválasz

Állapotkód:: 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"
  }
}

Definíciók

Name	Description
ACSIndex	ACS-index.
BaseConnection	BaseConnection
ChunkingSettings	Adattömb-beállítások
ComputeType	A számítási típus.
ConnectionStringConnection	Kapcsolati sztringkapcsolat.
ConnectionType	A kapcsolat típusa.
CosmosDBIndex	CosmosDB-index.
CrawlingSettings	Bejárásbeállítások
CustomCompute	Egyéni számítás.
DatasourceType	Az adatforrás típusa.
DeploymentConnection	Relatív üzembehelyezési kapcsolat.
EndpointKeyConnection	Végpontkulcs-kapcsolat.
EndpointMIConnection	Végpont által felügyelt identitáskapcsolat.
Error	Hiba
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
GenericEmbeddingSettings	ConnectionEmbeddingSettings
IngestionJobCompletionAction	A befejezési művelet.
IngestionJobSystemCompute
IngestionJobType	IngestionJobType
IngestionJobUserCompute
InnerError	InnerError
InnerErrorCode	InnerErrorCode
PineconeIndex	Pinecone Index.
ServerlessCompute	Kiszolgáló nélküli számítás.
SystemComputeDatasource	SystemComputeDatasource
SystemComputeStorage	SystemComputeStorage
SystemComputeUrl	SystemComputeUrl
TargetType	A cél típusa.
UserComputeDataset	UserComputeStorage
UserComputeUrl	UserComputeUrl
WorkspaceConnection	AML-munkaterület kapcsolata.
WorkspaceConnectionEmbeddingSettings	WorkspaceConnectionEmbeddingSettings

ACSIndex

ACS-index.

Name	Típus	Description
connectionId	string	Az ACS-indexre mutató kapcsolat azonosítója.
kind	string: acs	A cél típusa.

BaseConnection

Name	Típus	Description
kind	ConnectionType	A kapcsolat típusa.

ChunkingSettings

Adattömb-beállítások

Name	Típus	Description
maxChunkSizeInTokens	integer

ComputeType

A számítási típus.

Name	Típus	Description
custom	string	Egyéni felhasználói számítás.
serverless	string	Kiszolgáló nélküli felhasználói számítás.

ConnectionStringConnection

Kapcsolati sztringkapcsolat.

Name	Típus	Description
connectionString	string	Kapcsolati sztring
kind	ConnectionType	A kapcsolat típusa.

ConnectionType

A kapcsolat típusa.

Name	Típus	Description
connectionString	string	Kapcsolati sztring.
endpointKey	string	Végpont- és kulcskapcsolat.
endpointMI	string	Végpont és felügyelt identitás.
workspace	string	AML-munkaterület kapcsolata.

CosmosDBIndex

CosmosDB-index.

Name	Típus	Description
collectionName	string	A cosmos DB-gyűjtemény neve.
connectionId	string	A cosmos DB-hez mutató kapcsolat azonosítója.
databaseName	string	A cosmos DB-adatbázis neve.
kind	string: cosmosdb	A cél típusa.

CrawlingSettings

Bejárásbeállítások

Name	Típus	Description
maxCrawlDepth	integer
maxCrawlTimeInMins	integer
maxDownloadTimeInMins	integer
maxFileSize	integer
maxFiles	integer
maxRedirects	integer

CustomCompute

Egyéni számítás.

Name	Típus	Description
computeId	string	Az egyéni számítás azonosítója
kind	string: custom	A számítási típus.

DatasourceType

Az adatforrás típusa.

Name	Típus	Description
storage	string	Azure Storage-fiók.
urls	string	Urls.

DeploymentConnection

Relatív üzembehelyezési kapcsolat.

Name	Típus	Description
kind	ConnectionType	A kapcsolat típusa.

EndpointKeyConnection

Végpontkulcs-kapcsolat.

Name	Típus	Description
endpoint	string	Végpont
key	string	Kulcs
kind	ConnectionType	A kapcsolat típusa.

EndpointMIConnection

Végpont által felügyelt identitáskapcsolat.

Name	Típus	Description
endpoint	string	Végpont
kind	ConnectionType	A kapcsolat típusa.

Error

Hiba

Name	Típus	Description
code	ErrorCode	ErrorCode A Microsoft REST irányelveiben (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) meghatározott hibakódok.
details	Error[]	A hiba részletei, ha elérhetők.
innererror	InnerError	InnerError A Microsoft REST irányelveiben (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) meghatározott belső hiba.
message	string	A hiba üzenete.
target	string	Az a hely, ahol a hiba történt, ha elérhető.

ErrorCode

Name	Típus	Description
conflict	string	A kért művelet ütközik az aktuális erőforrásállapottal.
contentFilter	string	A rendszerképek létrehozása a biztonsági rendszerünk miatt meghiúsult.
fileImportFailed	string	A fájl importálása nem sikerült.
forbidden	string	A művelet az aktuális felhasználói/API-kulcs esetében tiltott.
internalFailure	string	Belső hiba történt. Próbálkozzon újra.
invalidPayload	string	A kérelem adatai érvénytelenek ehhez a művelethez.
itemDoesAlreadyExist	string	Az elem már létezik.
jsonlValidationFailed	string	A jsonl-adatok ellenőrzése nem sikerült.
notFound	string	Az erőforrás nem található.
quotaExceeded	string	Túllépte a kvótát.
serviceUnavailable	string	A szolgáltatás jelenleg nem érhető el.
tooManyRequests	string	Túl sok kérés. Próbálkozzon újra később.
unauthorized	string	Az aktuális felhasználói/API-kulcs nincs engedélyezve a művelethez.
unexpectedEntityState	string	A művelet nem hajtható végre az aktuális erőforrás állapotában.

ErrorResponse

Name	Típus	Description
error	Error	Hiba A Microsoft REST irányelveiben (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) meghatározott hibatartalom.

GenericEmbeddingSettings

ConnectionEmbeddingSettings

Name	Típus	Description
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Egy erőforráshoz való kapcsolat.
deploymentName	string
modelName	string

IngestionJobCompletionAction

A befejezési művelet.

Name	Típus	Description
cleanUpAssets	string	Törli a betöltési folyamat során létrehozott köztes eszközöket.
keepAllAssets	string	Nem törli a betöltési folyamat során létrehozott köztes eszközöket.

IngestionJobSystemCompute

Name	Típus	Description
completionAction	IngestionJobCompletionAction	A befejezési művelet.
dataRefreshIntervalInHours	integer
datasource	SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId	string
kind	string: system	IngestionJobType A feladat típusa.
searchServiceConnection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Egy erőforráshoz való kapcsolat.

IngestionJobType

Name	Típus	Description
system	string	A szolgáltatás tulajdonában lévő erőforrásokon futó feladatok.
user	string	A felhasználó tulajdonában lévő munkaterületen futó feladatok.

IngestionJobUserCompute

Name	Típus	Description
compute	JobCompute: CustomCompute ServerlessCompute	JobCompute A feladat számítási beállításai.
dataRefreshIntervalInHours	integer
datasource	UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId	string
kind	string: user	IngestionJobType A feladat típusa.
target	TargetIndex: ACSIndex CosmosDBIndex PineconeIndex	TargetIndex A létrehozandó indexre vonatkozó információk.
workspaceId	string

InnerError

Name	Típus	Description
code	InnerErrorCode	InnerErrorCode A Microsoft REST irányelveiben (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) meghatározott belső hibakódok.
innererror	InnerError	InnerError A Microsoft REST irányelveiben (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) meghatározott belső hiba.

InnerErrorCode

Name	Típus	Description
invalidPayload	string	A kérelem adatai érvénytelenek ehhez a művelethez.

PineconeIndex

Pinecone Index.

Name	Típus	Description
connectionId	string	A pinecone-ra mutató kapcsolat azonosítója.
kind	string: pinecone	A cél típusa.

ServerlessCompute

Kiszolgáló nélküli számítás.

Name	Típus	Description
instanceCount	integer	A feladat futtatásához tartozó példányok száma.
kind	string: serverless	A számítási típus.
sku	string	Termékváltozat szintje

SystemComputeDatasource

Name	Típus	Description
kind	DatasourceType	Az adatforrás típusa.

SystemComputeStorage

Name	Típus	Description
chunking	ChunkingSettings	Adattömb-beállítások Adattömb beállításai
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Egy erőforráshoz való kapcsolat.
containerName	string	tároló neve
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Kapcsolatbeágyazási beállítások
kind	DatasourceType	Az adatforrás típusa.

SystemComputeUrl

Name	Típus	Description
chunking	ChunkingSettings	Adattömb-beállítások Adattömb beállításai
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Egy erőforráshoz való kapcsolat.
containerName	string	tároló neve
crawling	CrawlingSettings	Bejárásbeállítások Bejárási beállítások
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Kapcsolatbeágyazási beállítások
kind	DatasourceType	Az adatforrás típusa.
urls	string[]

TargetType

A cél típusa.

Name	Típus	Description
acs	string	Azure AI Search-index.
cosmosdb	string	CosmosDB-index.
pinecone	string	Pinecone Index.

UserComputeDataset

UserComputeStorage

Name	Típus	Description
chunking	ChunkingSettings	Adattömb-beállítások Adattömb beállításai
datasetId	string
datasetType	string
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings Kapcsolatazonosító a beágyazási modellhez
kind	string: dataset	Az adatforrás típusa.

UserComputeUrl

Name	Típus	Description
chunking	ChunkingSettings	Adattömb-beállítások Adattömb beállításai
crawling	CrawlingSettings	Bejárásbeállítások Bejárási beállítások
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings Kapcsolatazonosító a beágyazási modellhez
kind	string: urls	Az adatforrás típusa.
urls	string[]

WorkspaceConnection

AML-munkaterület kapcsolata.

Name	Típus	Description
connectionId	string	Kapcsolatazonosító
kind	ConnectionType	A kapcsolat típusa.

WorkspaceConnectionEmbeddingSettings

Name	Típus	Description
connectionId	string
deploymentName	string
modelName	string

Megosztás a következőn keresztül:

Ingestion Jobs - Create

URI-paraméterek

Kérelem fejléce

Kérelem törzse

IngestionJobSystemCompute

IngestionJobUserCompute

Válaszok

Biztonság

api-key

Példák

Create a system-compute ingestion job

Mintakérelem

Mintaválasz

Create a user-compute ingestion job

Mintakérelem

Mintaválasz

Definíciók

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

További források