Ingestion Jobs - Get

Riferimento

Servizio:: Azure AI Services

Versione API:: 2024-05-01-preview

Ottiene i dettagli dell'ID processo specificato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string url	Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il nome dell'account Azure OpenAI.
job-id	path	True	string	ID del processo.
api-version	query	True	string	Versione dell'API richiesta.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
api-key	True	string	Specificare qui la chiave dell'account Azure OpenAI di Servizi cognitivi.

Risposte

Nome	Tipo	Descrizione
200 OK	IngestionJob: IngestionJobSystemCompute IngestionJobUserCompute	Operazione riuscita
Other Status Codes	ErrorResponse	Si è verificato un errore.

Sicurezza

api-key

Specificare qui la chiave dell'account Azure OpenAI di Servizi cognitivi.

Tipo: apiKey
In: header

Esempio

Get ingestion job

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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"
  }
}

Definizioni

Nome	Descrizione
ACSIndex	Indice ACS.
BaseConnection	BaseConnection
ChunkingSettings	ChunkingSettings
ComputeType	Tipo di calcolo.
ConnectionStringConnection	Connessione stringa di connessione.
ConnectionType	Tipo di connessione.
CosmosDBIndex	Indice CosmosDB.
CrawlingSettings	CrawlingSettings
CustomCompute	Calcolo personalizzato.
DatasourceType	Tipo di origine dati.
DeploymentConnection	Connessione di distribuzione relativa.
EndpointKeyConnection	Connessione chiave endpoint.
EndpointMIConnection	Connessione identità gestita dell'endpoint.
Error	Errore
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
GenericEmbeddingSettings	ConnectionEmbeddingSettings
IngestionJobCompletionAction	Azione di completamento.
IngestionJobSystemCompute
IngestionJobType	InserimentoJobType
IngestionJobUserCompute
InnerError	InnerError
InnerErrorCode	InnerErrorCode
PineconeIndex	Indice Pinecone.
ServerlessCompute	Calcolo serverless.
SystemComputeDatasource	SystemComputeDatasource
SystemComputeStorage	SystemComputeStorage
SystemComputeUrl	SystemComputeUrl
TargetType	Tipo di destinazione.
UserComputeDataset	UserComputeStorage
UserComputeUrl	UserComputeUrl
WorkspaceConnection	Connessione dell'area di lavoro AML.
WorkspaceConnectionEmbeddingSettings	WorkspaceConnectionEmbeddingSettings

ACSIndex

Indice ACS.

Nome	Tipo	Descrizione
connectionId	string	ID della connessione che punta all'indice ACS.
kind	string: acs	Tipo di destinazione.

BaseConnection

Nome	Tipo	Descrizione
kind	ConnectionType	Tipo di connessione.

ChunkingSettings

Nome	Tipo	Descrizione
maxChunkSizeInTokens	integer

ComputeType

Tipo di calcolo.

Nome	Tipo	Descrizione
custom	string	Calcolo utente personalizzato.
serverless	string	Calcolo utente serverless.

ConnectionStringConnection

Connessione stringa di connessione.

Nome	Tipo	Descrizione
connectionString	string	Stringa di connessione
kind	ConnectionType	Tipo di connessione.

ConnectionType

Tipo di connessione.

Nome	Tipo	Descrizione
connectionString	string	Stringa di connessione.
endpointKey	string	Connessione endpoint e chiave.
endpointMI	string	Endpoint e identità gestita.
workspace	string	Connessione dell'area di lavoro AML.

CosmosDBIndex

Indice CosmosDB.

Nome	Tipo	Descrizione
collectionName	string	Nome dell'insieme cosmos DB.
connectionId	string	ID della connessione che punta al cosmos DB.
databaseName	string	Nome del database cosmos DB.
kind	string: cosmosdb	Tipo di destinazione.

CrawlingSettings

Nome	Tipo	Descrizione
maxCrawlDepth	integer
maxCrawlTimeInMins	integer
maxDownloadTimeInMins	integer
maxFileSize	integer
maxFiles	integer
maxRedirects	integer

CustomCompute

Calcolo personalizzato.

Nome	Tipo	Descrizione
computeId	string	ID dell'elaborazione personalizzata
kind	string: custom	Tipo di calcolo.

DatasourceType

Tipo di origine dati.

Nome	Tipo	Descrizione
storage	string	Account di archiviazione di Azure
urls	string	URL.

DeploymentConnection

Connessione di distribuzione relativa.

Nome	Tipo	Descrizione
kind	ConnectionType	Tipo di connessione.

EndpointKeyConnection

Connessione chiave endpoint.

Nome	Tipo	Descrizione
endpoint	string	Endpoint
key	string	Chiave
kind	ConnectionType	Tipo di connessione.

EndpointMIConnection

Connessione identità gestita dell'endpoint.

Nome	Tipo	Descrizione
endpoint	string	Endpoint
kind	ConnectionType	Tipo di connessione.

Error

Errore

Nome	Tipo	Descrizione
code	ErrorCode	ErrorCode Codici di errore definiti nelle linee guida MICROSOFT REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Dettagli dell'errore se disponibile.
innererror	InnerError	InnerError Errore interno definito nelle linee guida MICROSOFT REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	Messaggio di questo errore.
target	string	Posizione in cui si è verificato l'errore se disponibile.

ErrorCode

Nome	Tipo	Descrizione
conflict	string	L'operazione richiesta è in conflitto con lo stato della risorsa corrente.
contentFilter	string	La generazione di immagini non è riuscita a causa del nostro sistema di sicurezza.
fileImportFailed	string	Importazione di file non riuscita.
forbidden	string	L'operazione non è consentita per la chiave utente/API corrente.
internalFailure	string	Errore interno. Riprovare.
invalidPayload	string	I dati della richiesta non sono validi per questa operazione.
itemDoesAlreadyExist	string	L'elemento esiste già.
jsonlValidationFailed	string	La convalida dei dati jsonl non è riuscita.
notFound	string	La risorsa non viene trovata.
quotaExceeded	string	Quota superata.
serviceUnavailable	string	Il servizio non è attualmente disponibile.
tooManyRequests	string	Numero eccessivo di richieste. Riprovare più tardi.
unauthorized	string	La chiave utente/API corrente non è autorizzata per l'operazione.
unexpectedEntityState	string	Impossibile eseguire l'operazione nello stato della risorsa corrente.

ErrorResponse

Nome	Tipo	Descrizione
error	Error	Errore Contenuto degli errori definito nelle linee guida REST Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

GenericEmbeddingSettings

ConnectionEmbeddingSettings

Nome	Tipo	Descrizione
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Connessione a una risorsa.
deploymentName	string
modelName	string

IngestionJobCompletionAction

Azione di completamento.

Nome	Tipo	Descrizione
cleanUpAssets	string	Pulisce gli asset intermedi creati durante il processo di inserimento.
keepAllAssets	string	Non pulisce nessuno degli asset intermedi creati durante il processo di inserimento.

IngestionJobSystemCompute

Nome	Tipo	Descrizione
completionAction	IngestionJobCompletionAction	Azione di completamento.
dataRefreshIntervalInHours	integer
datasource	SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId	string
kind	string: system	InserimentoJobType Tipo di processo.
searchServiceConnection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Connessione a una risorsa.

IngestionJobType

InserimentoJobType

Nome	Tipo	Descrizione
system	string	Processi eseguiti sulle risorse di proprietà del servizio.
user	string	Processi eseguiti nell'area di lavoro di proprietà dell'utente.

IngestionJobUserCompute

Nome	Tipo	Descrizione
compute	JobCompute: CustomCompute ServerlessCompute	JobCompute Impostazioni di calcolo del processo.
dataRefreshIntervalInHours	integer
datasource	UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId	string
kind	string: user	InserimentoJobType Tipo di processo.
target	TargetIndex: ACSIndex CosmosDBIndex PineconeIndex	TargetIndex Informazioni sull'indice da creare.
workspaceId	string

InnerError

Nome	Tipo	Descrizione
code	InnerErrorCode	InnerErrorCode Codici di errore interni definiti nelle linee guida MICROSOFT REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Errore interno definito nelle linee guida MICROSOFT REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Nome	Tipo	Descrizione
invalidPayload	string	I dati della richiesta non sono validi per questa operazione.

PineconeIndex

Indice Pinecone.

Nome	Tipo	Descrizione
connectionId	string	ID della connessione che punta al pinecone.
kind	string: pinecone	Tipo di destinazione.

ServerlessCompute

Calcolo serverless.

Nome	Tipo	Descrizione
instanceCount	integer	Numero di istanze in cui eseguire il processo.
kind	string: serverless	Tipo di calcolo.
sku	string	Livello SKU

SystemComputeDatasource

Nome	Tipo	Descrizione
kind	DatasourceType	Tipo di origine dati.

SystemComputeStorage

Nome	Tipo	Descrizione
chunking	ChunkingSettings	ChunkingSettings Impostazioni di blocco
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Connessione a una risorsa.
containerName	string	nome del contenitore
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Impostazioni di incorporamento connessione
kind	DatasourceType	Tipo di origine dati.

SystemComputeUrl

Nome	Tipo	Descrizione
chunking	ChunkingSettings	ChunkingSettings Impostazioni di blocco
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Connessione a una risorsa.
containerName	string	nome del contenitore
crawling	CrawlingSettings	CrawlingSettings Impostazioni di ricerca per indicizzazione
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Impostazioni di incorporamento connessione
kind	DatasourceType	Tipo di origine dati.
urls	string[]

TargetType

Tipo di destinazione.

Nome	Tipo	Descrizione
acs	string	Indice di Ricerca intelligenza artificiale di Azure.
cosmosdb	string	Indice CosmosDB.
pinecone	string	Indice Pinecone.

UserComputeDataset

UserComputeStorage

Nome	Tipo	Descrizione
chunking	ChunkingSettings	ChunkingSettings Impostazioni di blocco
datasetId	string
datasetType	string
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings ID connessione al modello di incorporamento
kind	string: dataset	Tipo di origine dati.

UserComputeUrl

Nome	Tipo	Descrizione
chunking	ChunkingSettings	ChunkingSettings Impostazioni di blocco
crawling	CrawlingSettings	CrawlingSettings Impostazioni di ricerca per indicizzazione
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings ID connessione al modello di incorporamento
kind	string: urls	Tipo di origine dati.
urls	string[]

WorkspaceConnection

Connessione dell'area di lavoro AML.

Nome	Tipo	Descrizione
connectionId	string	ConnectionId
kind	ConnectionType	Tipo di connessione.

WorkspaceConnectionEmbeddingSettings

Nome	Tipo	Descrizione
connectionId	string
deploymentName	string
modelName	string

Condividi tramite