Delen via


Ingestion Jobs - Create

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

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

SystemComputeDatasource

jobId

string

searchServiceConnection BaseConnection:

BaseConnection
Een verbinding met een resource.

IngestionJobUserCompute

Name Vereist Type Description
kind True string:

UserCompute

IngestionJobType
Het taaktype.

workspaceId True

string

compute JobCompute:

JobCompute
De rekeninstellingen van de taak.

dataRefreshIntervalInHours

integer

datasource UserComputeDatasource:

UserComputeDatasource

jobId

string

target TargetIndex:

TargetIndex
Informatie over de index die moet worden gemaakt.

Antwoorden

Name Type Description
200 OK IngestionJob:

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

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

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

ChunkingSettings

Name Type Description
maxChunkSizeInTokens

integer

ComputeType

Het rekentype.

Waarde Description
CustomCompute

Aangepaste rekenkracht van gebruikers.

ServerlessCompute

Serverloze gebruikers berekenen.

ConnectionStringConnection

Verbindingsreeksverbinding.

Name Type Description
connectionString

string

Verbindingsreeks

kind string:

ConnectionString

Het verbindingstype.

ConnectionType

Het verbindingstype.

Waarde Description
ConnectionString

Verbindingsreeks.

EndpointWithKey

Eindpunt- en sleutelverbinding.

EndpointWithManagedIdentity

Eindpunt en beheerde identiteit.

RelativeConnection

Relatieve implementatie

WorkspaceConnection

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

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

Waarde Description
conflict

De aangevraagde bewerking conflicteert met de huidige resourcestatus.

contentFilter

Het genereren van installatiekopieën is mislukt als gevolg van ons veiligheidssysteem.

fileImportFailed

Importeren van bestand is mislukt.

forbidden

De bewerking is verboden voor de huidige gebruiker/API-sleutel.

internalFailure

Interne fout. Probeer het opnieuw.

invalidPayload

De aanvraaggegevens zijn ongeldig voor deze bewerking.

itemDoesAlreadyExist

Het item bestaat al.

jsonlValidationFailed

Validatie van jsonl-gegevens is mislukt.

notFound

De resource is niet gevonden.

quotaExceeded

Het quotum is overschreden.

serviceUnavailable

De service is momenteel niet beschikbaar.

tooManyRequests

Te veel aanvragen. Probeer het later opnieuw.

unauthorized

De huidige sleutel van de gebruiker/API is niet geautoriseerd voor de bewerking.

unexpectedEntityState

De bewerking kan niet worden uitgevoerd in de status van de huidige resource.

ErrorResponse

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:

BaseConnection
Een verbinding met een resource.

deploymentName

string

modelName

string

IngestionJobCompletionAction

De voltooiingsactie.

Waarde Description
cleanUpTempAssets

Hiermee worden tussenliggende assets opgeschoond die tijdens het opnameproces zijn gemaakt.

keepAllAssets

De tussenliggende assets die tijdens het opnameproces zijn gemaakt, worden niet opgeschoond.

IngestionJobSystemCompute

Name Type Description
completionAction

IngestionJobCompletionAction

De voltooiingsactie.

dataRefreshIntervalInHours

integer

datasource SystemComputeDatasource:

SystemComputeDatasource

jobId

string

kind string:

SystemCompute

IngestionJobType
Het taaktype.

searchServiceConnection BaseConnection:

BaseConnection
Een verbinding met een resource.

IngestionJobType

IngestionJobType

Waarde Description
SystemCompute

Taken die worden uitgevoerd op resources die eigendom zijn van de service.

UserCompute

Taken die worden uitgevoerd op de werkruimte die eigendom is van de gebruiker.

IngestionJobUserCompute

Name Type Description
compute JobCompute:

JobCompute
De rekeninstellingen van de taak.

dataRefreshIntervalInHours

integer

datasource UserComputeDatasource:

UserComputeDatasource

jobId

string

kind string:

UserCompute

IngestionJobType
Het taaktype.

target TargetIndex:

TargetIndex
Informatie over de index die moet worden gemaakt.

workspaceId

string

InnerError

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

InnerErrorCode

Waarde Description
invalidPayload

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.

Waarde Description
Storage

Azure Storage-account.

Urls

URL's.

SystemComputeStorage

SystemComputeStorage

Name Type Description
chunking

ChunkingSettings

ChunkingSettings
Segmenteringsinstellingen

connection BaseConnection:

BaseConnection
Een verbinding met een resource.

containerName

string

containernaam

embeddings

GenericEmbeddingSettings[]

ConnectionEmbeddingSettings
Instellingen voor insluiten van verbinding

kind string:

Storage

Het gegevensbrontype.

SystemComputeUrl

SystemComputeUrl

Name Type Description
chunking

ChunkingSettings

ChunkingSettings
Segmenteringsinstellingen

connection BaseConnection:

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.

Waarde Description
AzureAISearch

Azure AI Search-index.

CosmosDB

CosmosDB-index.

Pinecone

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.

Waarde Description
Dataset

Werkruimtegegevensset.

Urls

URL's.

UserComputeUrl

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

WorkspaceConnectionEmbeddingSettings

Name Type Description
connectionId

string

deploymentName

string

modelName

string