Ingestion Jobs - Create

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: 2025-01-01-preview

Tworzy zadanie pozyskiwania o określonym identyfikatorze zadania.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string url	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą konta usługi Azure OpenAI.
job-id	path	True	string	Identyfikator zadania, które zostanie utworzone.
api-version	query	True	string	Żądana wersja interfejsu API.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
mgmt-user-token		string	Token używany do uzyskiwania dostępu do obszaru roboczego (wymagany tylko w przypadku zadań obliczeniowych użytkownika).
aml-user-token		string	Token używany do uzyskiwania dostępu do zasobów w ramach zadania w obszarze roboczym (wymagany tylko w przypadku zadań obliczeniowych użytkownika).

Treść żądania

Treść żądania może być jedną z następujących:

Nazwa	Opis
IngestionJobSystemCompute
IngestionJobUserCompute

IngestionJobSystemCompute

Nazwa	Wymagane	Typ	Opis
kind	True	string: SystemCompute	IngestionJobType Typ zadania.
completionAction		IngestionJobCompletionAction	Akcja ukończenia.
dataRefreshIntervalInHours		integer
datasource		SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId		string
searchServiceConnection		BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	Połączenie podstawowe Połączenie z zasobem.

IngestionJobUserCompute

Nazwa	Wymagane	Typ	Opis
kind	True	string: UserCompute	IngestionJobType Typ zadania.
workspaceId	True	string
compute		JobCompute: CustomCompute ServerlessCompute	ZadanieCompute Ustawienia obliczeniowe zadania.
dataRefreshIntervalInHours		integer
datasource		UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId		string
target		TargetIndex: AzureAISearchIndex CosmosDBIndex PineconeIndex	TargetIndex Informacje o indeksie do utworzenia.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	IngestionJob: IngestionJobSystemCompute IngestionJobUserCompute	Sukces
Other Status Codes	ErrorResponse	Wystąpił błąd.

Zabezpieczenia

api-key

Uwierzytelnianie klucza interfejsu API

Typ: apiKey
W: header

OAuth2Auth

Uwierzytelnianie OAuth2

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Zakresy

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

Create a system-compute ingestion job

Create a user-compute ingestion job

Create a system-compute ingestion job

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
  }
}

Definicje

Nazwa	Opis
AzureAISearchIndex	Indeks usługi Azure AI Search.
ChunkingSettings	ChunkingSettings
ComputeType	Typ obliczeniowy.
ConnectionStringConnection	Połączenie parametrów połączenia.
ConnectionType	Typ połączenia.
CosmosDBIndex	Indeks usługi CosmosDB.
CrawlingSettings	PrzeszukiwanieUstawienia
CustomCompute	Niestandardowe obliczenia.
DeploymentConnection	Względne połączenie wdrożenia.
EndpointKeyConnection	Połączenie klucza punktu końcowego.
EndpointMIConnection	Połączenie tożsamości zarządzanej punktu końcowego.
Error	Błąd
ErrorCode	Kod błędu
ErrorResponse	ErrorResponse
GenericEmbeddingSettings	ConnectionEmbeddingSettings
IngestionJobCompletionAction	Akcja ukończenia.
IngestionJobSystemCompute
IngestionJobType	IngestionJobType
IngestionJobUserCompute
InnerError	InnerError
InnerErrorCode	InnerErrorCode
PineconeIndex	Indeks Pinecone.
ServerlessCompute	Bezserwerowe obliczenia.
SystemComputeDatasourceType	Typ źródła danych.
SystemComputeStorage	SystemComputeStorage
SystemComputeUrl	SystemComputeUrl
TargetType	Typ docelowy.
UserComputeDataset	UserComputeStorage
UserComputeDatasourceType	Typ źródła danych.
UserComputeUrl	UserComputeUrl
WorkspaceConnection	Połączenie obszaru roboczego AML.
WorkspaceConnectionEmbeddingSettings	WorkspaceConnectionEmbeddingSettings

AzureAISearchIndex

Indeks usługi Azure AI Search.

Nazwa	Typ	Opis
connectionId	string	Identyfikator połączenia wskazującego indeks usługi Azure AI Search.
kind	string: AzureAISearch	Typ docelowy.

ChunkingSettings

Nazwa	Typ	Opis
maxChunkSizeInTokens	integer

ComputeType

Typ obliczeniowy.

Nazwa	Typ	Opis
CustomCompute	string	Niestandardowe obliczenia użytkownika.
ServerlessCompute	string	Obliczenia użytkownika bezserwerowego.

ConnectionStringConnection

Połączenie parametrów połączenia.

Nazwa	Typ	Opis
connectionString	string	Parametry połączenia
kind	string: ConnectionString	Typ połączenia.

ConnectionType

Typ połączenia.

Nazwa	Typ	Opis
ConnectionString	string	Parametry połączenia.
EndpointWithKey	string	Połączenie punktów końcowych i kluczy.
EndpointWithManagedIdentity	string	Punkt końcowy i tożsamość zarządzana.
RelativeConnection	string	Wdrożenie względne
WorkspaceConnection	string	Połączenie obszaru roboczego AML.

CosmosDBIndex

Indeks usługi CosmosDB.

Nazwa	Typ	Opis
collectionName	string	Nazwa kolekcji cosmos DB.
connectionId	string	Identyfikator połączenia wskazującego usługę Cosmos DB.
databaseName	string	Nazwa bazy danych cosmos DB.
kind	string: CosmosDB	Typ docelowy.

CrawlingSettings

PrzeszukiwanieUstawienia

Nazwa	Typ	Opis
maxCrawlDepth	integer
maxCrawlTimeInMins	integer
maxDownloadTimeInMins	integer
maxFileSize	integer
maxFiles	integer
maxRedirects	integer

CustomCompute

Niestandardowe obliczenia.

Nazwa	Typ	Opis
computeId	string	Identyfikator obliczeń niestandardowych
kind	string: CustomCompute	Typ obliczeniowy.

DeploymentConnection

Względne połączenie wdrożenia.

Nazwa	Typ	Opis
kind	string: RelativeConnection	Typ połączenia.

EndpointKeyConnection

Połączenie klucza punktu końcowego.

Nazwa	Typ	Opis
endpoint	string	Punkt końcowy
key	string	Klucz
kind	string: EndpointWithKey	Typ połączenia.

EndpointMIConnection

Połączenie tożsamości zarządzanej punktu końcowego.

Nazwa	Typ	Opis
endpoint	string	Punkt końcowy
kind	string: EndpointWithManagedIdentity	Typ połączenia.
resourceId	string	Identyfikator zasobu

Error

Błąd

Nazwa	Typ	Opis
code	ErrorCode	Kod błędu Kody błędów zdefiniowane w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Szczegóły błędu, jeśli są dostępne.
innererror	InnerError	InnerError Błąd wewnętrzny zdefiniowany w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	Komunikat o tym błędzie.
target	string	Lokalizacja, w której wystąpił błąd, jeśli jest dostępny.

ErrorCode

Kod błędu

Nazwa	Typ	Opis
conflict	string	Żądana operacja powoduje konflikt z bieżącym stanem zasobu.
contentFilter	string	Generowanie obrazu nie powiodło się w wyniku naszego systemu bezpieczeństwa.
fileImportFailed	string	Importowanie pliku nie powiodło się.
forbidden	string	Operacja jest zabroniona dla bieżącego klucza użytkownika/interfejsu API.
internalFailure	string	Błąd wewnętrzny. Ponów próbę.
invalidPayload	string	Dane żądania są nieprawidłowe dla tej operacji.
itemDoesAlreadyExist	string	Element już istnieje.
jsonlValidationFailed	string	Sprawdzanie poprawności danych jsonl nie powiodło się.
notFound	string	Nie można odnaleźć zasobu.
quotaExceeded	string	Przekroczono limit przydziału.
serviceUnavailable	string	Usługa jest obecnie niedostępna.
tooManyRequests	string	Zbyt wiele żądań. Spróbuj ponownie później.
unauthorized	string	Bieżący klucz użytkownika/interfejsu API nie jest autoryzowany dla operacji.
unexpectedEntityState	string	Nie można wykonać operacji w stanie bieżącego zasobu.

ErrorResponse

Nazwa	Typ	Opis
error	Error	Błąd Zawartość błędu zdefiniowana w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

GenericEmbeddingSettings

ConnectionEmbeddingSettings

Nazwa	Typ	Opis
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	Połączenie podstawowe Połączenie z zasobem.
deploymentName	string
modelName	string

IngestionJobCompletionAction

Akcja ukończenia.

Nazwa	Typ	Opis
cleanUpTempAssets	string	Czyści pośrednie zasoby utworzone podczas procesu pozyskiwania.
keepAllAssets	string	Nie wyczyści żadnego z zasobów pośrednich utworzonych podczas procesu pozyskiwania.

IngestionJobSystemCompute

Nazwa	Typ	Opis
completionAction	IngestionJobCompletionAction	Akcja ukończenia.
dataRefreshIntervalInHours	integer
datasource	SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId	string
kind	string: SystemCompute	IngestionJobType Typ zadania.
searchServiceConnection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	Połączenie podstawowe Połączenie z zasobem.

IngestionJobType

Nazwa	Typ	Opis
SystemCompute	string	Zadania uruchamiane w zasobach należących do usługi.
UserCompute	string	Zadania uruchamiane w obszarze roboczym należącym do użytkownika.

IngestionJobUserCompute

Nazwa	Typ	Opis
compute	JobCompute: CustomCompute ServerlessCompute	ZadanieCompute Ustawienia obliczeniowe zadania.
dataRefreshIntervalInHours	integer
datasource	UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId	string
kind	string: UserCompute	IngestionJobType Typ zadania.
target	TargetIndex: AzureAISearchIndex CosmosDBIndex PineconeIndex	TargetIndex Informacje o indeksie do utworzenia.
workspaceId	string

InnerError

Nazwa	Typ	Opis
code	InnerErrorCode	InnerErrorCode Wewnętrzne kody błędów zdefiniowane w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Błąd wewnętrzny zdefiniowany w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Nazwa	Typ	Opis
invalidPayload	string	Dane żądania są nieprawidłowe dla tej operacji.

PineconeIndex

Indeks Pinecone.

Nazwa	Typ	Opis
connectionId	string	Identyfikator połączenia wskazującego na pinecone.
kind	string: Pinecone	Typ docelowy.

ServerlessCompute

Bezserwerowe obliczenia.

Nazwa	Typ	Opis
instanceCount	integer	Liczba wystąpień do uruchomienia zadania.
kind	string: ServerlessCompute	Typ obliczeniowy.
sku	string	Poziom jednostki SKU

SystemComputeDatasourceType

Typ źródła danych.

Nazwa	Typ	Opis
Storage	string	Konto usługi Azure Storage.
Urls	string	Adresy URL.

SystemComputeStorage

Nazwa	Typ	Opis
chunking	ChunkingSettings	ChunkingSettings Ustawienia fragmentowania
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	Połączenie podstawowe Połączenie z zasobem.
containerName	string	nazwa kontenera
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Ustawienia osadzania połączenia
kind	string: Storage	Typ źródła danych.

SystemComputeUrl

Nazwa	Typ	Opis
chunking	ChunkingSettings	ChunkingSettings Ustawienia fragmentowania
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	Połączenie podstawowe Połączenie z zasobem.
containerName	string	nazwa kontenera
crawling	CrawlingSettings	PrzeszukiwanieUstawienia Ustawienia przeszukiwania
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Ustawienia osadzania połączenia
kind	string: Urls	Typ źródła danych.
urls	string[]

TargetType

Typ docelowy.

Nazwa	Typ	Opis
AzureAISearch	string	Indeks usługi Azure AI Search.
CosmosDB	string	Indeks usługi CosmosDB.
Pinecone	string	Indeks Pinecone.

UserComputeDataset

UserComputeStorage

Nazwa	Typ	Opis
chunking	ChunkingSettings	ChunkingSettings Ustawienia fragmentowania
datasetId	string
datasetType	string
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings Identyfikator połączenia z modelem osadzania
kind	string: Dataset	Typ źródła danych.

UserComputeDatasourceType

Typ źródła danych.

Nazwa	Typ	Opis
Dataset	string	Zestaw danych obszaru roboczego.
Urls	string	Adresy URL.

UserComputeUrl

Nazwa	Typ	Opis
chunking	ChunkingSettings	ChunkingSettings Ustawienia fragmentowania
crawling	CrawlingSettings	PrzeszukiwanieUstawienia Ustawienia przeszukiwania
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings Identyfikator połączenia z modelem osadzania
kind	string: Urls	Typ źródła danych.
urls	string[]

WorkspaceConnection

Połączenie obszaru roboczego AML.

Nazwa	Typ	Opis
connectionId	string	Identyfikator połączenia
kind	string: WorkspaceConnection	Typ połączenia.

WorkspaceConnectionEmbeddingSettings

Nazwa	Typ	Opis
connectionId	string
deploymentName	string
modelName	string

Udostępnij za pośrednictwem

Ingestion Jobs - Create

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

IngestionJobSystemCompute

IngestionJobUserCompute

Odpowiedzi

Zabezpieczenia

api-key

OAuth2Auth

Zakresy

Przykłady

Create a system-compute ingestion job

Przykładowe żądanie

Przykładowa odpowiedź

Create a user-compute ingestion job

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

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

Dodatkowe zasoby