Ingestion Jobs - Get

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: 2024-05-01-preview

Pobiera szczegóły określonego identyfikatora zadania.

GET {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2024-05-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.
api-version	query	True	string	Żądana wersja interfejsu API.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
api-key	True	string	Tutaj podaj klucz konta usługi Azure OpenAI w usługach Cognitive Services.

Odpowiedzi

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

Zabezpieczenia

api-key

Tutaj podaj klucz konta usługi Azure OpenAI w usługach Cognitive Services.

Typ: apiKey
W: header

Przykłady

Get ingestion job

Przykładowe żądanie

HTTP

GET {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2024-05-01-preview

Przykładowa odpowiedź

Kod stanu:: 200

{
  "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
ACSIndex	Indeks ACS.
BaseConnection	Połączenie podstawowe
ChunkingSettings	FragmentowanieUstawienia
ComputeType	Typ obliczeniowy.
ConnectionStringConnection	Połączenie parametrów połączenia.
ConnectionType	Typ połączenia.
CosmosDBIndex	Indeks usługi CosmosDB.
CrawlingSettings	CrawlingSettings
CustomCompute	Obliczenia niestandardowe.
DatasourceType	Typ źródła danych.
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	ErrorCode
ErrorResponse	ErrorResponse
GenericEmbeddingSettings	ConnectionEmbeddingSettings
IngestionJobCompletionAction	Akcja ukończenia.
IngestionJobSystemCompute
IngestionJobType	IngestionJobType
IngestionJobUserCompute
InnerError	InnerError
InnerErrorCode	InnerErrorCode
PineconeIndex	Indeks Pinecone.
ServerlessCompute	Bezserwerowe obliczenia.
SystemComputeDatasource	SystemComputeDatasource
SystemComputeStorage	SystemComputeStorage
SystemComputeUrl	SystemComputeUrl
TargetType	Typ docelowy.
UserComputeDataset	UserComputeStorage
UserComputeUrl	UserComputeUrl
WorkspaceConnection	Połączenie obszaru roboczego AML.
WorkspaceConnectionEmbeddingSettings	WorkspaceConnectionEmbeddingSettings

ACSIndex

Indeks ACS.

Nazwa	Typ	Opis
connectionId	string	Identyfikator połączenia wskazującego indeks ACS.
kind	string: acs	Typ docelowy.

BaseConnection

Połączenie podstawowe

Nazwa	Typ	Opis
kind	ConnectionType	Typ połączenia.

ChunkingSettings

FragmentowanieUstawienia

Nazwa	Typ	Opis
maxChunkSizeInTokens	integer

ComputeType

Typ obliczeniowy.

Nazwa	Typ	Opis
custom	string	Niestandardowe obliczenia użytkownika.
serverless	string	Obliczenia użytkownika bezserwerowego.

ConnectionStringConnection

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

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

ConnectionType

Typ połączenia.

Nazwa	Typ	Opis
connectionString	string	Parametry połączenia.
endpointKey	string	Połączenie punktów końcowych i kluczy.
endpointMI	string	Punkt końcowy i tożsamość zarządzana.
workspace	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

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

CustomCompute

Obliczenia niestandardowe.

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

DatasourceType

Typ źródła danych.

Nazwa	Typ	Opis
storage	string	Konto usługi Azure Storage.
urls	string	Adresy url.

DeploymentConnection

Względne połączenie wdrożenia.

Nazwa	Typ	Opis
kind	ConnectionType	Typ połączenia.

EndpointKeyConnection

Połączenie klucza punktu końcowego.

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

EndpointMIConnection

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

Nazwa	Typ	Opis
endpoint	string	Punkt końcowy
kind	ConnectionType	Typ połączenia.

Error

Błąd

Nazwa	Typ	Opis
code	ErrorCode	ErrorCode 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 Wewnętrzny błąd 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

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. Spróbuj ponownie.
invalidPayload	string	Dane żądania są nieprawidłowe dla tej operacji.
itemDoesAlreadyExist	string	Element już istnieje.
jsonlValidationFailed	string	Walidacja danych jsonl nie powiodła 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
cleanUpAssets	string	Czyści pośrednie zasoby utworzone podczas procesu pozyskiwania.
keepAllAssets	string	Nie wyczyści żadnego z pośrednich zasobów utworzonych podczas procesu pozyskiwania.

IngestionJobSystemCompute

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

IngestionJobType

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

IngestionJobUserCompute

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

InnerError

Nazwa	Typ	Opis
code	InnerErrorCode	InnerErrorCode Wewnętrzne kody błędów zgodnie z definicją w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Wewnętrzny błąd 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 pinecone.
kind	string: pinecone	Typ docelowy.

ServerlessCompute

Bezserwerowe obliczenia.

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

SystemComputeDatasource

Nazwa	Typ	Opis
kind	DatasourceType	Typ źródła danych.

SystemComputeStorage

Nazwa	Typ	Opis
chunking	ChunkingSettings	FragmentingSettings 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	DatasourceType	Typ źródła danych.

SystemComputeUrl

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

TargetType

Typ docelowy.

Nazwa	Typ	Opis
acs	string	Indeks usługi Azure AI Search.
cosmosdb	string	Indeks usługi CosmosDB.
pinecone	string	Indeks Pinecone.

UserComputeDataset

UserComputeStorage

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

UserComputeUrl

Nazwa	Typ	Opis
chunking	ChunkingSettings	FragmentowanieUstawienia Ustawienia fragmentowania
crawling	CrawlingSettings	CrawlingSettings 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	Connectionid
kind	ConnectionType	Typ połączenia.

WorkspaceConnectionEmbeddingSettings

Nazwa	Typ	Opis
connectionId	string
deploymentName	string
modelName	string

Udostępnij za pośrednictwem