Ingestion Jobs - Create

Referentie

Service:: Azure AI Services

API-versie:: 2025-01-01-preview

Hiermee maakt u een opnametaak met de opgegeven taak-id.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string url	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-account).
job-id	path	True	string	De id van de taak die wordt gemaakt.
api-version	query	True	string	De aangevraagde API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
mgmt-user-token		string	Het token dat wordt gebruikt voor toegang tot de werkruimte (alleen nodig voor rekentaken van gebruikers).
aml-user-token		string	Het token dat wordt gebruikt voor toegang tot de resources binnen de taak in de werkruimte (alleen nodig voor rekentaken van gebruikers).

Aanvraagbody

De aanvraagtekst kan een van de volgende zijn:

Name	Description
IngestionJobSystemCompute
IngestionJobUserCompute

IngestionJobSystemCompute

Name	Vereist	Type	Description
kind	True	string: SystemCompute	IngestionJobType Het taaktype.
completionAction		IngestionJobCompletionAction	De voltooiingsactie.
dataRefreshIntervalInHours		integer
datasource		SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId		string
searchServiceConnection		BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Een verbinding met een resource.

IngestionJobUserCompute

Name	Vereist	Type	Description
kind	True	string: UserCompute	IngestionJobType Het taaktype.
workspaceId	True	string
compute		JobCompute: CustomCompute ServerlessCompute	JobCompute De rekeninstellingen van de taak.
dataRefreshIntervalInHours		integer
datasource		UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId		string
target		TargetIndex: AzureAISearchIndex CosmosDBIndex PineconeIndex	TargetIndex Informatie over de index die moet worden gemaakt.

Antwoorden

Name	Type	Description
200 OK	IngestionJob: IngestionJobSystemCompute IngestionJobUserCompute	Succes
Other Status Codes	ErrorResponse	Er is een fout opgetreden.

Beveiliging

api-key

VERIFICATIE van API-sleutel

Type: apiKey
In: header

OAuth2Auth

OAuth2-verificatie

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiken

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

Voorbeelden

Create a system-compute ingestion job

Create a user-compute ingestion job

Create a system-compute ingestion job

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

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

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

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

Definities

Name	Description
AzureAISearchIndex	Azure AI Search-index.
ChunkingSettings	ChunkingSettings
ComputeType	Het rekentype.
ConnectionStringConnection	Verbindingsreeksverbinding.
ConnectionType	Het verbindingstype.
CosmosDBIndex	CosmosDB-index.
CrawlingSettings	CrawlingSettings
CustomCompute	Aangepaste berekening.
DeploymentConnection	Relatieve implementatieverbinding.
EndpointKeyConnection	Verbinding met eindpuntsleutel.
EndpointMIConnection	Managed Identity-verbinding met eindpunt.
Error	Fout
ErrorCode	Foutcode
ErrorResponse	ErrorResponse
GenericEmbeddingSettings	ConnectionEmbeddingSettings
IngestionJobCompletionAction	De voltooiingsactie.
IngestionJobSystemCompute
IngestionJobType	IngestionJobType
IngestionJobUserCompute
InnerError	InnerError
InnerErrorCode	InnerErrorCode
PineconeIndex	Pinecone Index.
ServerlessCompute	Serverloze berekening.
SystemComputeDatasourceType	Het gegevensbrontype.
SystemComputeStorage	SystemComputeStorage
SystemComputeUrl	SystemComputeUrl
TargetType	Het doeltype.
UserComputeDataset	UserComputeStorage
UserComputeDatasourceType	Het gegevensbrontype.
UserComputeUrl	UserComputeUrl
WorkspaceConnection	AML-werkruimteverbinding.
WorkspaceConnectionEmbeddingSettings	WorkspaceConnectionEmbeddingSettings

AzureAISearchIndex

Azure AI Search-index.

Name	Type	Description
connectionId	string	De id van de verbinding die verwijst naar de Azure AI Search-index.
kind	string: AzureAISearch	Het doeltype.

ChunkingSettings

Name	Type	Description
maxChunkSizeInTokens	integer

ComputeType

Het rekentype.

Name	Type	Description
CustomCompute	string	Aangepaste rekenkracht van gebruikers.
ServerlessCompute	string	Serverloze gebruikers berekenen.

ConnectionStringConnection

Verbindingsreeksverbinding.

Name	Type	Description
connectionString	string	Verbindingsreeks
kind	string: ConnectionString	Het verbindingstype.

ConnectionType

Het verbindingstype.

Name	Type	Description
ConnectionString	string	Verbindingsreeks.
EndpointWithKey	string	Eindpunt- en sleutelverbinding.
EndpointWithManagedIdentity	string	Eindpunt en beheerde identiteit.
RelativeConnection	string	Relatieve implementatie
WorkspaceConnection	string	AML-werkruimteverbinding.

CosmosDBIndex

CosmosDB-index.

Name	Type	Description
collectionName	string	De naam van de cosmos DB-verzameling.
connectionId	string	De id van de verbinding die verwijst naar de cosmos DB.
databaseName	string	De naam van de cosmos DB-database.
kind	string: CosmosDB	Het doeltype.

CrawlingSettings

Name	Type	Description
maxCrawlDepth	integer
maxCrawlTimeInMins	integer
maxDownloadTimeInMins	integer
maxFileSize	integer
maxFiles	integer
maxRedirects	integer

CustomCompute

Aangepaste berekening.

Name	Type	Description
computeId	string	Id van de aangepaste berekening
kind	string: CustomCompute	Het rekentype.

DeploymentConnection

Relatieve implementatieverbinding.

Name	Type	Description
kind	string: RelativeConnection	Het verbindingstype.

EndpointKeyConnection

Verbinding met eindpuntsleutel.

Name	Type	Description
endpoint	string	Eindpunt
key	string	Sleutel
kind	string: EndpointWithKey	Het verbindingstype.

EndpointMIConnection

Managed Identity-verbinding met eindpunt.

Name	Type	Description
endpoint	string	Eindpunt
kind	string: EndpointWithManagedIdentity	Het verbindingstype.
resourceId	string	Resource-id

Error

Fout

Name	Type	Description
code	ErrorCode	Foutcode Foutcodes zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	De foutdetails indien beschikbaar.
innererror	InnerError	InnerError Interne fout zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	Het bericht van deze fout.
target	string	De locatie waar de fout is opgetreden, indien beschikbaar.

ErrorCode

Foutcode

Name	Type	Description
conflict	string	De aangevraagde bewerking conflicteert met de huidige resourcestatus.
contentFilter	string	Het genereren van installatiekopieën is mislukt als gevolg van ons veiligheidssysteem.
fileImportFailed	string	Importeren van bestand is mislukt.
forbidden	string	De bewerking is verboden voor de huidige gebruiker/API-sleutel.
internalFailure	string	Interne fout. Probeer het opnieuw.
invalidPayload	string	De aanvraaggegevens zijn ongeldig voor deze bewerking.
itemDoesAlreadyExist	string	Het item bestaat al.
jsonlValidationFailed	string	Validatie van jsonl-gegevens is mislukt.
notFound	string	De resource is niet gevonden.
quotaExceeded	string	Het quotum is overschreden.
serviceUnavailable	string	De service is momenteel niet beschikbaar.
tooManyRequests	string	Te veel aanvragen. Probeer het later opnieuw.
unauthorized	string	De huidige sleutel van de gebruiker/API is niet geautoriseerd voor de bewerking.
unexpectedEntityState	string	De bewerking kan niet worden uitgevoerd in de status van de huidige resource.

ErrorResponse

Name	Type	Description
error	Error	Fout Foutinhoud zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

GenericEmbeddingSettings

ConnectionEmbeddingSettings

Name	Type	Description
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Een verbinding met een resource.
deploymentName	string
modelName	string

IngestionJobCompletionAction

De voltooiingsactie.

Name	Type	Description
cleanUpTempAssets	string	Hiermee worden tussenliggende assets opgeschoond die tijdens het opnameproces zijn gemaakt.
keepAllAssets	string	De tussenliggende assets die tijdens het opnameproces zijn gemaakt, worden niet opgeschoond.

IngestionJobSystemCompute

Name	Type	Description
completionAction	IngestionJobCompletionAction	De voltooiingsactie.
dataRefreshIntervalInHours	integer
datasource	SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId	string
kind	string: SystemCompute	IngestionJobType Het taaktype.
searchServiceConnection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Een verbinding met een resource.

IngestionJobType

Name	Type	Description
SystemCompute	string	Taken die worden uitgevoerd op resources die eigendom zijn van de service.
UserCompute	string	Taken die worden uitgevoerd op de werkruimte die eigendom is van de gebruiker.

IngestionJobUserCompute

Name	Type	Description
compute	JobCompute: CustomCompute ServerlessCompute	JobCompute De rekeninstellingen van de taak.
dataRefreshIntervalInHours	integer
datasource	UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId	string
kind	string: UserCompute	IngestionJobType Het taaktype.
target	TargetIndex: AzureAISearchIndex CosmosDBIndex PineconeIndex	TargetIndex Informatie over de index die moet worden gemaakt.
workspaceId	string

InnerError

Name	Type	Description
code	InnerErrorCode	InnerErrorCode Interne foutcodes zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Interne fout zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Name	Type	Description
invalidPayload	string	De aanvraaggegevens zijn ongeldig voor deze bewerking.

PineconeIndex

Pinecone Index.

Name	Type	Description
connectionId	string	De id van de verbinding die verwijst naar de pinecone.
kind	string: Pinecone	Het doeltype.

ServerlessCompute

Serverloze berekening.

Name	Type	Description
instanceCount	integer	Het aantal exemplaren waarop de taak moet worden uitgevoerd.
kind	string: ServerlessCompute	Het rekentype.
sku	string	SKU-niveau

SystemComputeDatasourceType

Het gegevensbrontype.

Name	Type	Description
Storage	string	Azure Storage-account.
Urls	string	URL's.

SystemComputeStorage

Name	Type	Description
chunking	ChunkingSettings	ChunkingSettings Segmenteringsinstellingen
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Een verbinding met een resource.
containerName	string	containernaam
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Instellingen voor insluiten van verbinding
kind	string: Storage	Het gegevensbrontype.

SystemComputeUrl

Name	Type	Description
chunking	ChunkingSettings	ChunkingSettings Segmenteringsinstellingen
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Een verbinding met een resource.
containerName	string	containernaam
crawling	CrawlingSettings	CrawlingSettings Verkenningsinstellingen
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Instellingen voor insluiten van verbinding
kind	string: Urls	Het gegevensbrontype.
urls	string[]

TargetType

Het doeltype.

Name	Type	Description
AzureAISearch	string	Azure AI Search-index.
CosmosDB	string	CosmosDB-index.
Pinecone	string	Pinecone Index.

UserComputeDataset

UserComputeStorage

Name	Type	Description
chunking	ChunkingSettings	ChunkingSettings Segmenteringsinstellingen
datasetId	string
datasetType	string
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings Verbindings-id met het insluitmodel
kind	string: Dataset	Het gegevensbrontype.

UserComputeDatasourceType

Het gegevensbrontype.

Name	Type	Description
Dataset	string	Werkruimtegegevensset.
Urls	string	URL's.

UserComputeUrl

Name	Type	Description
chunking	ChunkingSettings	ChunkingSettings Segmenteringsinstellingen
crawling	CrawlingSettings	CrawlingSettings Verkenningsinstellingen
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings Verbindings-id met het insluitmodel
kind	string: Urls	Het gegevensbrontype.
urls	string[]

WorkspaceConnection

AML-werkruimteverbinding.

Name	Type	Description
connectionId	string	ConnectionId
kind	string: WorkspaceConnection	Het verbindingstype.

WorkspaceConnectionEmbeddingSettings

Name	Type	Description
connectionId	string
deploymentName	string
modelName	string

Delen via

Ingestion Jobs - Create

URI-parameters

Aanvraagkoptekst

Aanvraagbody

IngestionJobSystemCompute

IngestionJobUserCompute

Antwoorden

Beveiliging

api-key

OAuth2Auth

Bereiken

Voorbeelden

Create a system-compute ingestion job

Voorbeeldaanvraag

Voorbeeldrespons

Create a user-compute ingestion job

Voorbeeldaanvraag

Voorbeeldrespons

Definities

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

Aanvullende resources