Ingestion Jobs - Create

Referens

Tjänst:: Azure AI Services

API-version:: 2025-01-01-preview

Skapar ett inmatningsjobb med det angivna jobb-ID:t.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string url	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-kontonamn).
job-id	path	True	string	ID:t för jobbet som ska skapas.
api-version	query	True	string	Den begärda API-versionen.

Begärandehuvud

Name	Obligatorisk	Typ	Description
mgmt-user-token		string	Den token som används för att komma åt arbetsytan (behövs endast för användarberäkningsjobb).
aml-user-token		string	Den token som används för att komma åt resurserna i jobbet på arbetsytan (behövs endast för användarberäkningsjobb).

Begärandetext

Brödtexten i begäran kan vara något av följande:

Name	Description
IngestionJobSystemCompute
IngestionJobUserCompute

IngestionJobSystemCompute

Name	Obligatorisk	Typ	Description
kind	True	string: SystemCompute	IngestionJobType Jobbtypen.
completionAction		IngestionJobCompletionAction	Slutförandeåtgärden.
dataRefreshIntervalInHours		integer
datasource		SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId		string
searchServiceConnection		BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection En anslutning till en resurs.

IngestionJobUserCompute

Name	Obligatorisk	Typ	Description
kind	True	string: UserCompute	IngestionJobType Jobbtypen.
workspaceId	True	string
compute		JobCompute: CustomCompute ServerlessCompute	JobCompute Beräkningsinställningarna för jobbet.
dataRefreshIntervalInHours		integer
datasource		UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId		string
target		TargetIndex: AzureAISearchIndex CosmosDBIndex PineconeIndex	TargetIndex Information om det index som ska skapas.

Svar

Name	Typ	Description
200 OK	IngestionJob: IngestionJobSystemCompute IngestionJobUserCompute	Framgång
Other Status Codes	ErrorResponse	Ett fel uppstod.

Säkerhet

api-key

API-nyckelautentisering

Typ: apiKey
I: header

OAuth2Auth

OAuth2-autentisering

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Omfattningar

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

Exempel

Create a system-compute ingestion job

Create a user-compute ingestion job

Create a system-compute ingestion job

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name	Description
AzureAISearchIndex	Azure AI Search Index.
ChunkingSettings	ChunkingSettings
ComputeType	Beräkningstypen.
ConnectionStringConnection	Anslutningssträngsanslutning.
ConnectionType	Anslutningstypen.
CosmosDBIndex	CosmosDB-index.
CrawlingSettings	CrawlingSettings
CustomCompute	Anpassad beräkning.
DeploymentConnection	Relativ distributionsanslutning.
EndpointKeyConnection	Slutpunktsnyckelanslutning.
EndpointMIConnection	Slutpunktshanterad identitetsanslutning.
Error	Fel
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
GenericEmbeddingSettings	ConnectionEmbeddingSettings
IngestionJobCompletionAction	Slutförandeåtgärden.
IngestionJobSystemCompute
IngestionJobType	IngestionJobType
IngestionJobUserCompute
InnerError	InnerError
InnerErrorCode	InnerErrorCode
PineconeIndex	Pinecone Index.
ServerlessCompute	Serverlös beräkning.
SystemComputeDatasourceType	Datakällans typ.
SystemComputeStorage	SystemComputeStorage
SystemComputeUrl	SystemComputeUrl
TargetType	Måltypen.
UserComputeDataset	UserComputeStorage
UserComputeDatasourceType	Datakällans typ.
UserComputeUrl	UserComputeUrl
WorkspaceConnection	Anslutning till AML-arbetsyta.
WorkspaceConnectionEmbeddingSettings	WorkspaceConnectionEmbeddingSettings

AzureAISearchIndex

Azure AI Search Index.

Name	Typ	Description
connectionId	string	ID:t för anslutningen som pekar på Azure AI Search Index.
kind	string: AzureAISearch	Måltypen.

ChunkingSettings

Name	Typ	Description
maxChunkSizeInTokens	integer

ComputeType

Beräkningstypen.

Name	Typ	Description
CustomCompute	string	Anpassad användarberäkning.
ServerlessCompute	string	Serverlös användarberäkning.

ConnectionStringConnection

Anslutningssträngsanslutning.

Name	Typ	Description
connectionString	string	Anslutningssträng
kind	string: ConnectionString	Anslutningstypen.

ConnectionType

Anslutningstypen.

Name	Typ	Description
ConnectionString	string	Anslutningssträng.
EndpointWithKey	string	Slutpunkt och nyckelanslutning.
EndpointWithManagedIdentity	string	Slutpunkt och hanterad identitet.
RelativeConnection	string	Relativ distribution
WorkspaceConnection	string	Anslutning till AML-arbetsyta.

CosmosDBIndex

CosmosDB-index.

Name	Typ	Description
collectionName	string	Namnet på cosmos DB-samlingen.
connectionId	string	ID:t för anslutningen som pekar på cosmos DB.
databaseName	string	Namnet på cosmos DB-databasen.
kind	string: CosmosDB	Måltypen.

CrawlingSettings

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

CustomCompute

Anpassad beräkning.

Name	Typ	Description
computeId	string	ID för den anpassade beräkningen
kind	string: CustomCompute	Beräkningstypen.

DeploymentConnection

Relativ distributionsanslutning.

Name	Typ	Description
kind	string: RelativeConnection	Anslutningstypen.

EndpointKeyConnection

Slutpunktsnyckelanslutning.

Name	Typ	Description
endpoint	string	Slutpunkt
key	string	Nyckel
kind	string: EndpointWithKey	Anslutningstypen.

EndpointMIConnection

Slutpunktshanterad identitetsanslutning.

Name	Typ	Description
endpoint	string	Slutpunkt
kind	string: EndpointWithManagedIdentity	Anslutningstypen.
resourceId	string	Resurs-ID

Error

Fel

Name	Typ	Description
code	ErrorCode	ErrorCode Felkoder enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Felinformationen om den är tillgänglig.
innererror	InnerError	InnerError Inre fel enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	Meddelandet om det här felet.
target	string	Platsen där felet inträffade om det var tillgängligt.

ErrorCode

Name	Typ	Description
conflict	string	Den begärda åtgärden står i konflikt med det aktuella resurstillståndet.
contentFilter	string	Bildgenereringen misslyckades till följd av vårt säkerhetssystem.
fileImportFailed	string	Det gick inte att importera filen.
forbidden	string	Åtgärden är förbjuden för den aktuella användaren/API-nyckeln.
internalFailure	string	Internt fel. Försök igen.
invalidPayload	string	Begärandedata är ogiltiga för den här åtgärden.
itemDoesAlreadyExist	string	Objektet finns redan.
jsonlValidationFailed	string	Verifieringen av jsonl-data misslyckades.
notFound	string	Det går inte att hitta resursen.
quotaExceeded	string	Kvoten har överskridits.
serviceUnavailable	string	Tjänsten är inte tillgänglig för närvarande.
tooManyRequests	string	För många begäranden. Försök igen senare.
unauthorized	string	Den aktuella användar-/API-nyckeln har inte behörighet för åtgärden.
unexpectedEntityState	string	Åtgärden kan inte köras i den aktuella resursens tillstånd.

ErrorResponse

Name	Typ	Description
error	Error	Fel Felinnehåll enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

GenericEmbeddingSettings

ConnectionEmbeddingSettings

Name	Typ	Description
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection En anslutning till en resurs.
deploymentName	string
modelName	string

IngestionJobCompletionAction

Slutförandeåtgärden.

Name	Typ	Description
cleanUpTempAssets	string	Rensar mellanliggande tillgångar som skapats under inmatningsprocessen.
keepAllAssets	string	Rensar inte någon av de mellanliggande tillgångar som skapades under inmatningsprocessen.

IngestionJobSystemCompute

Name	Typ	Description
completionAction	IngestionJobCompletionAction	Slutförandeåtgärden.
dataRefreshIntervalInHours	integer
datasource	SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId	string
kind	string: SystemCompute	IngestionJobType Jobbtypen.
searchServiceConnection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection En anslutning till en resurs.

IngestionJobType

Name	Typ	Description
SystemCompute	string	Jobb som körs på tjänstägda resurser.
UserCompute	string	Jobb som körs på användarägd arbetsyta.

IngestionJobUserCompute

Name	Typ	Description
compute	JobCompute: CustomCompute ServerlessCompute	JobCompute Beräkningsinställningarna för jobbet.
dataRefreshIntervalInHours	integer
datasource	UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId	string
kind	string: UserCompute	IngestionJobType Jobbtypen.
target	TargetIndex: AzureAISearchIndex CosmosDBIndex PineconeIndex	TargetIndex Information om det index som ska skapas.
workspaceId	string

InnerError

Name	Typ	Description
code	InnerErrorCode	InnerErrorCode Inre felkoder enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Inre fel enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Name	Typ	Description
invalidPayload	string	Begärandedata är ogiltiga för den här åtgärden.

PineconeIndex

Pinecone Index.

Name	Typ	Description
connectionId	string	ID:t för anslutningen som pekar på tallkotten.
kind	string: Pinecone	Måltypen.

ServerlessCompute

Serverlös beräkning.

Name	Typ	Description
instanceCount	integer	Antalet instanser som jobbet ska köras på.
kind	string: ServerlessCompute	Beräkningstypen.
sku	string	SKU-nivå

SystemComputeDatasourceType

Datakällans typ.

Name	Typ	Description
Storage	string	Azure Storage-konto.
Urls	string	URL:er.

SystemComputeStorage

Name	Typ	Description
chunking	ChunkingSettings	ChunkingSettings Segmenteringsinställningar
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection En anslutning till en resurs.
containerName	string	containernamn
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Inställningar för inbäddning av anslutningar
kind	string: Storage	Datakällans typ.

SystemComputeUrl

Name	Typ	Description
chunking	ChunkingSettings	ChunkingSettings Segmenteringsinställningar
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection En anslutning till en resurs.
containerName	string	containernamn
crawling	CrawlingSettings	CrawlingSettings Crawlningsinställningar
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Inställningar för inbäddning av anslutningar
kind	string: Urls	Datakällans typ.
urls	string[]

TargetType

Måltypen.

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

UserComputeDataset

UserComputeStorage

Name	Typ	Description
chunking	ChunkingSettings	ChunkingSettings Segmenteringsinställningar
datasetId	string
datasetType	string
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings Anslutnings-ID till inbäddningsmodellen
kind	string: Dataset	Datakällans typ.

UserComputeDatasourceType

Datakällans typ.

Name	Typ	Description
Dataset	string	Datauppsättning för arbetsyta.
Urls	string	URL:er.

UserComputeUrl

Name	Typ	Description
chunking	ChunkingSettings	ChunkingSettings Segmenteringsinställningar
crawling	CrawlingSettings	CrawlingSettings Crawlningsinställningar
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings Anslutnings-ID till inbäddningsmodellen
kind	string: Urls	Datakällans typ.
urls	string[]

WorkspaceConnection

Anslutning till AML-arbetsyta.

Name	Typ	Description
connectionId	string	ConnectionId
kind	string: WorkspaceConnection	Anslutningstypen.

WorkspaceConnectionEmbeddingSettings

Name	Typ	Description
connectionId	string
deploymentName	string
modelName	string

Dela via

Ingestion Jobs - Create

URI-parametrar

Begärandehuvud

Begärandetext

IngestionJobSystemCompute

IngestionJobUserCompute

Svar

Säkerhet

api-key

OAuth2Auth

Omfattningar

Exempel

Create a system-compute ingestion job

Exempelbegäran

Exempelsvar

Create a user-compute ingestion job

Exempelbegäran

Exempelsvar

Definitioner

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

Ytterligare resurser