Ingestion Jobs - Create

Referentie

Service:: Azure AI Services

API-versie:: 2024-05-01-preview

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

PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2024-05-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
api-key	True	string	Geef hier uw Azure OpenAI-accountsleutel voor Cognitive Services op.
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 in de taak in de werkruimte (alleen nodig voor gebruikersrekentaken).

Aanvraagbody

De aanvraagtekst kan een van de volgende zijn:

Name	Description
IngestionJobSystemCompute
IngestionJobUserCompute

IngestionJobSystemCompute

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

IngestionJobUserCompute

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

Antwoorden

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

Beveiliging

api-key

Geef hier uw Azure OpenAI-accountsleutel voor Cognitive Services op.

Type: apiKey
In: header

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/{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
}

Voorbeeldrespons

Statuscode:: 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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
ACSIndex	ACS-index.
BaseConnection	BaseConnection
ChunkingSettings	ChunkingSettings
ComputeType	Het rekentype.
ConnectionStringConnection	Verbindingsreeksverbinding.
ConnectionType	Het verbindingstype.
CosmosDBIndex	CosmosDB-index.
CrawlingSettings	CrawlingSettings
CustomCompute	Aangepaste rekenkracht.
DatasourceType	Het type gegevensbron.
DeploymentConnection	Relatieve implementatieverbinding.
EndpointKeyConnection	Verbinding met eindpuntsleutel.
EndpointMIConnection	Eindpunt beheerde identiteit-verbinding.
Error	Fout
ErrorCode	ErrorCode
ErrorResponse	Foutresponse
GenericEmbeddingSettings	ConnectionEmbeddingSettings
IngestionJobCompletionAction	De voltooiingsactie.
IngestionJobSystemCompute
IngestionJobType	IngestionJobType
IngestionJobUserCompute
InnerError	InnerError
InnerErrorCode	InnerErrorCode
PineconeIndex	Pinecone Index.
ServerlessCompute	Serverloze rekenkracht.
SystemComputeDatasource	SystemComputeDatasource
SystemComputeStorage	SystemComputeStorage
SystemComputeUrl	SystemComputeUrl
TargetType	Het doeltype.
UserComputeDataset	UserComputeStorage
UserComputeUrl	UserComputeUrl
WorkspaceConnection	Verbinding met AML-werkruimte.
WorkspaceConnectionEmbeddingSettings	WorkspaceConnectionEmbeddingSettings

ACSIndex

ACS-index.

Name	Type	Description
connectionId	string	De id van de verbinding die verwijst naar de ACS-index.
kind	string: acs	Het doeltype.

BaseConnection

Name	Type	Description
kind	ConnectionType	Het verbindingstype.

ChunkingSettings

Name	Type	Description
maxChunkSizeInTokens	integer

ComputeType

Het rekentype.

Name	Type	Description
custom	string	Aangepaste gebruikersberekening.
serverless	string	Serverloze gebruikersberekening.

ConnectionStringConnection

Verbindingsreeksverbinding.

Name	Type	Description
connectionString	string	Verbindingsreeks
kind	ConnectionType	Het verbindingstype.

ConnectionType

Het verbindingstype.

Name	Type	Description
connectionString	string	Verbindingsreeks.
endpointKey	string	Eindpunt- en sleutelverbinding.
endpointMI	string	Eindpunt en beheerde identiteit.
workspace	string	Verbinding met AML-werkruimte.

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 rekenkracht.

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

DatasourceType

Het type gegevensbron.

Name	Type	Description
storage	string	Azure Storage-account.
urls	string	Urls.

DeploymentConnection

Relatieve implementatieverbinding.

Name	Type	Description
kind	ConnectionType	Het verbindingstype.

EndpointKeyConnection

Verbinding met eindpuntsleutel.

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

EndpointMIConnection

Eindpunt beheerde identiteit-verbinding.

Name	Type	Description
endpoint	string	Eindpunt
kind	ConnectionType	Het verbindingstype.

Error

Fout

Name	Type	Description
code	ErrorCode	ErrorCode 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

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	Het importeren van het 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 gebruiker/API-sleutel is niet geautoriseerd voor de bewerking.
unexpectedEntityState	string	De bewerking kan niet worden uitgevoerd in de status van de huidige resource.

ErrorResponse

Foutresponse

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
cleanUpAssets	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: system	IngestionJobType Het taaktype.
searchServiceConnection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Een verbinding met een resource.

IngestionJobType

Name	Type	Description
system	string	Taken die worden uitgevoerd op resources die eigendom zijn van de service.
user	string	Taken die worden uitgevoerd in een 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: user	IngestionJobType Het taaktype.
target	TargetIndex: ACSIndex 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 naar de pinecone wijst.
kind	string: pinecone	Het doeltype.

ServerlessCompute

Serverloze rekenkracht.

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

SystemComputeDatasource

Name	Type	Description
kind	DatasourceType	Het type gegevensbron.

SystemComputeStorage

Name	Type	Description
chunking	ChunkingSettings	ChunkingSettings Instellingen voor segmentering
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Een verbinding met een resource.
containerName	string	containernaam
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Instellingen voor het insluiten van verbindingen
kind	DatasourceType	Het type gegevensbron.

SystemComputeUrl

Name	Type	Description
chunking	ChunkingSettings	ChunkingSettings Instellingen voor segmentering
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Een verbinding met een resource.
containerName	string	containernaam
crawling	CrawlingSettings	CrawlingSettings Instellingen voor verkennen
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Instellingen voor het insluiten van verbindingen
kind	DatasourceType	Het type gegevensbron.
urls	string[]

TargetType

Het doeltype.

Name	Type	Description
acs	string	Azure AI Search-index.
cosmosdb	string	CosmosDB-index.
pinecone	string	Pinecone Index.

UserComputeDataset

UserComputeStorage

Name	Type	Description
chunking	ChunkingSettings	ChunkingSettings Instellingen voor segmentering
datasetId	string
datasetType	string
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings Verbindings-id met het insluitmodel
kind	string: dataset	Het type gegevensbron.

UserComputeUrl

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

WorkspaceConnection

Verbinding met AML-werkruimte.

Name	Type	Description
connectionId	string	ConnectionId
kind	ConnectionType	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

Voorbeelden

Create a system-compute ingestion job

Voorbeeldaanvraag

Voorbeeldrespons

Create a user-compute ingestion job

Voorbeeldaanvraag

Voorbeeldrespons

Definities

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

Aanvullende resources