Ingestion Jobs - Get

Referência

Service:: Azure AI Services

API Version:: 2024-05-01-preview

Obtém os detalhes da ID do trabalho especificada.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string url	Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome da conta do OpenAI do Azure).
job-id	path	True	string	A ID do trabalho.
api-version	query	True	string	A versão da API solicitada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
api-key	True	string	Forneça a chave de conta do Azure OpenAI dos Serviços Cognitivos aqui.

Respostas

Nome	Tipo	Description
200 OK	IngestionJob: IngestionJobSystemCompute IngestionJobUserCompute	Êxito
Other Status Codes	ErrorResponse	Ocorreu um erro.

Segurança

api-key

Forneça a chave de conta do Azure OpenAI dos Serviços Cognitivos aqui.

Type: apiKey
In: header

Exemplos

Get ingestion job

Sample Request

HTTP

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

Sample Response

Status code:: 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"
  }
}

Definições

Nome	Description
ACSIndex	Índice ACS.
BaseConnection	BaseConnection
ChunkingSettings	ChunkingSettings
ComputeType	O tipo de computação.
ConnectionStringConnection	Conexão de cadeia de conexão.
ConnectionType	O tipo de conexão.
CosmosDBIndex	Índice do CosmosDB.
CrawlingSettings	CrawlingSettings
CustomCompute	Computação personalizada.
DatasourceType	O tipo de fonte de dados.
DeploymentConnection	Conexão de implantação relativa.
EndpointKeyConnection	Conexão de chave de ponto de extremidade.
EndpointMIConnection	Conexão de Identidade Gerenciada de Ponto de Extremidade.
Error	Erro
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
GenericEmbeddingSettings	ConnectionEmbeddingSettings
IngestionJobCompletionAction	A ação de conclusão.
IngestionJobSystemCompute
IngestionJobType	IngestionJobType
IngestionJobUserCompute
InnerError	InnerError
InnerErrorCode	InnerErrorCode
PineconeIndex	Índice Pinecone.
ServerlessCompute	Computação sem servidor.
SystemComputeDatasource	SystemComputeDatasource
SystemComputeStorage	SystemComputeStorage
SystemComputeUrl	SystemComputeUrl
TargetType	O tipo de destino.
UserComputeDataset	UserComputeStorage
UserComputeUrl	UserComputeUrl
WorkspaceConnection	Conexão de workspace do AML.
WorkspaceConnectionEmbeddingSettings	WorkspaceConnectionEmbeddingSettings

ACSIndex

Índice ACS.

Nome	Tipo	Description
connectionId	string	A ID da conexão que aponta para o índice ACS.
kind	string: acs	O tipo de destino.

BaseConnection

Nome	Tipo	Description
kind	ConnectionType	O tipo de conexão.

ChunkingSettings

Nome	Tipo	Description
maxChunkSizeInTokens	integer

ComputeType

O tipo de computação.

Nome	Tipo	Description
custom	string	Computação de usuário personalizada.
serverless	string	Computação de usuário sem servidor.

ConnectionStringConnection

Conexão de cadeia de conexão.

Nome	Tipo	Description
connectionString	string	Cadeia de conexão
kind	ConnectionType	O tipo de conexão.

ConnectionType

O tipo de conexão.

Nome	Tipo	Description
connectionString	string	Cadeia de conexão.
endpointKey	string	Ponto de extremidade e conexão de chave.
endpointMI	string	Ponto de extremidade e identidade gerenciada.
workspace	string	Conexão de workspace do AML.

CosmosDBIndex

Índice do CosmosDB.

Nome	Tipo	Description
collectionName	string	O nome da coleção cosmos DB.
connectionId	string	A ID da conexão que aponta para o cosmos DB.
databaseName	string	O nome do banco de dados cosmos DB.
kind	string: cosmosdb	O tipo de destino.

CrawlingSettings

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

CustomCompute

Computação personalizada.

Nome	Tipo	Description
computeId	string	ID da computação personalizada
kind	string: custom	O tipo de computação.

DatasourceType

O tipo de fonte de dados.

Nome	Tipo	Description
storage	string	Conta de Armazenamento do Azure.
urls	string	URLs.

DeploymentConnection

Conexão de implantação relativa.

Nome	Tipo	Description
kind	ConnectionType	O tipo de conexão.

EndpointKeyConnection

Conexão de chave de ponto de extremidade.

Nome	Tipo	Description
endpoint	string	Ponto de extremidade
key	string	Chave
kind	ConnectionType	O tipo de conexão.

EndpointMIConnection

Conexão de Identidade Gerenciada de Ponto de Extremidade.

Nome	Tipo	Description
endpoint	string	Ponto de extremidade
kind	ConnectionType	O tipo de conexão.

Error

Erro

Nome	Tipo	Description
code	ErrorCode	ErrorCode Códigos de erro conforme definido nas diretrizes rest da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Os detalhes do erro, se disponíveis.
innererror	InnerError	InnerError Erro interno, conforme definido nas diretrizes rest da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	A mensagem desse erro.
target	string	O local em que o erro ocorreu, se disponível.

ErrorCode

Nome	Tipo	Description
conflict	string	A operação solicitada está em conflito com o estado atual do recurso.
contentFilter	string	A geração de imagens falhou como resultado do nosso sistema de segurança.
fileImportFailed	string	Falha na importação do arquivo.
forbidden	string	A operação é proibida para a chave de usuário/api atual.
internalFailure	string	Erro interno. Tente novamente.
invalidPayload	string	Os dados da solicitação são inválidos para esta operação.
itemDoesAlreadyExist	string	O item já existe.
jsonlValidationFailed	string	Falha na validação de dados jsonl.
notFound	string	O recurso não foi encontrado.
quotaExceeded	string	Cota excedida.
serviceUnavailable	string	No momento, o serviço não está disponível.
tooManyRequests	string	Solicitações demais. Tente novamente mais tarde.
unauthorized	string	A chave de usuário/api atual não está autorizada para a operação.
unexpectedEntityState	string	A operação não pode ser executada no estado do recurso atual.

ErrorResponse

Nome	Tipo	Description
error	Error	Erro Conteúdo do erro conforme definido nas diretrizes rest da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

GenericEmbeddingSettings

ConnectionEmbeddingSettings

Nome	Tipo	Description
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Uma conexão com um recurso.
deploymentName	string
modelName	string

IngestionJobCompletionAction

A ação de conclusão.

Nome	Tipo	Description
cleanUpAssets	string	O limpo ativos intermediários criados durante o processo de ingestão.
keepAllAssets	string	Não limpo nenhum dos ativos intermediários criados durante o processo de ingestão.

IngestionJobSystemCompute

Nome	Tipo	Description
completionAction	IngestionJobCompletionAction	A ação de conclusão.
dataRefreshIntervalInHours	integer
datasource	SystemComputeDatasource: SystemComputeStorage SystemComputeUrl	SystemComputeDatasource
jobId	string
kind	string: system	IngestionJobType O tipo de trabalho.
searchServiceConnection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Uma conexão com um recurso.

IngestionJobType

Nome	Tipo	Description
system	string	Trabalhos executados em recursos de serviço.
user	string	Trabalhos executados no workspace de propriedade do usuário.

IngestionJobUserCompute

Nome	Tipo	Description
compute	JobCompute: CustomCompute ServerlessCompute	JobCompute As configurações de computação do trabalho.
dataRefreshIntervalInHours	integer
datasource	UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId	string
kind	string: user	IngestionJobType O tipo de trabalho.
target	TargetIndex: ACSIndex CosmosDBIndex PineconeIndex	TargetIndex Informações sobre o índice a ser criado.
workspaceId	string

InnerError

Nome	Tipo	Description
code	InnerErrorCode	InnerErrorCode Códigos de erro internos, conforme definido nas diretrizes rest da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Erro interno, conforme definido nas diretrizes rest da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Nome	Tipo	Description
invalidPayload	string	Os dados da solicitação são inválidos para esta operação.

PineconeIndex

Índice Pinecone.

Nome	Tipo	Description
connectionId	string	A ID da conexão apontando para o pinecone.
kind	string: pinecone	O tipo de destino.

ServerlessCompute

Computação sem servidor.

Nome	Tipo	Description
instanceCount	integer	A contagem de instâncias em que executar o trabalho.
kind	string: serverless	O tipo de computação.
sku	string	Nível de SKU

SystemComputeDatasource

Nome	Tipo	Description
kind	DatasourceType	O tipo de fonte de dados.

SystemComputeStorage

Nome	Tipo	Description
chunking	ChunkingSettings	ChunkingSettings Configurações de agrupamento
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Uma conexão com um recurso.
containerName	string	nome do contêiner
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Configurações de inserção de conexão
kind	DatasourceType	O tipo de fonte de dados.

SystemComputeUrl

Nome	Tipo	Description
chunking	ChunkingSettings	ChunkingSettings Configurações de agrupamento
connection	BaseConnection: ConnectionStringConnection DeploymentConnection EndpointKeyConnection EndpointMIConnection WorkspaceConnection	BaseConnection Uma conexão com um recurso.
containerName	string	nome do contêiner
crawling	CrawlingSettings	CrawlingSettings Configurações de rastreamento
embeddings	GenericEmbeddingSettings[]	ConnectionEmbeddingSettings Configurações de inserção de conexão
kind	DatasourceType	O tipo de fonte de dados.
urls	string[]

TargetType

O tipo de destino.

Nome	Tipo	Description
acs	string	Índice do Azure AI Search.
cosmosdb	string	Índice do CosmosDB.
pinecone	string	Índice Pinecone.

UserComputeDataset

UserComputeStorage

Nome	Tipo	Description
chunking	ChunkingSettings	ChunkingSettings Configurações de agrupamento
datasetId	string
datasetType	string
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings ID de conexão para o modelo de inserção
kind	string: dataset	O tipo de fonte de dados.

UserComputeUrl

Nome	Tipo	Description
chunking	ChunkingSettings	ChunkingSettings Configurações de agrupamento
crawling	CrawlingSettings	CrawlingSettings Configurações de rastreamento
embeddings	WorkspaceConnectionEmbeddingSettings[]	WorkspaceConnectionEmbeddingSettings ID de conexão para o modelo de inserção
kind	string: urls	O tipo de fonte de dados.
urls	string[]

WorkspaceConnection

Conexão de workspace do AML.

Nome	Tipo	Description
connectionId	string	ConnectionId
kind	ConnectionType	O tipo de conexão.

WorkspaceConnectionEmbeddingSettings

Nome	Tipo	Description
connectionId	string
deploymentName	string
modelName	string

Compartilhar via