Ingestion Jobs - List

Referens

Service:: Azure AI Services

API Version:: 2024-05-01-preview

Listor inmatningsjobben.

GET {endpoint}/openai/ingestion/jobs?api-version=2024-05-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).
api-version	query	True	string	Den begärda API-versionen.

Begärandehuvud

Name	Obligatorisk	Typ	Description
api-key	True	string	Ange din Azure OpenAI-kontonyckel för Cognitive Services här.
mgmt-user-token		string	Den token som används för att komma åt arbetsytan (behövs endast för användarberäkningsjobb).

Svar

Name	Typ	Description
200 OK	IngestionJobList	Klart
Other Status Codes	ErrorResponse	Ett fel inträffade.

Säkerhet

api-key

Ange din Azure OpenAI-kontonyckel för Cognitive Services här.

Type: apiKey
In: header

Exempel

List all ingestion jobs

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "jobId": "usercompute-ingestion-job",
      "kind": "UserCompute",
      "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev"
    },
    {
      "jobId": "syscompute-ingestion-job",
      "kind": "SystemCompute"
    }
  ]
}

Definitioner

Name	Description
ACSIndex	ACS-index.
BaseConnection	BaseConnection
ChunkingSettings	SegmenteringInställningar
ComputeType	Beräkningstypen.
ConnectionStringConnection	Anslutning av anslutningssträng.
ConnectionType	Anslutningstypen.
CosmosDBIndex	CosmosDB-index.
CrawlingSettings	CrawlingSettings
CustomCompute	Anpassad beräkning.
DatasourceType	Datakällans typ.
DeploymentConnection	Relativ distributionsanslutning.
EndpointKeyConnection	Slutpunktsnyckelanslutning.
EndpointMIConnection	Slutpunktshanterad identitetsanslutning.
Error	Fel
ErrorCode	Felkod
ErrorResponse	ErrorResponse
GenericEmbeddingSettings	ConnectionEmbeddingSettings
IngestionJobCompletionAction	Slutförandeåtgärden.
IngestionJobList	IngestionJobList
IngestionJobSystemCompute
IngestionJobType	IngestionJobType
IngestionJobUserCompute
InnerError	InnerError
InnerErrorCode	InnerErrorCode
PineconeIndex	Pinecone Index.
ServerlessCompute	Serverlös beräkning.
SystemComputeDatasource	SystemComputeDatasource
SystemComputeStorage	SystemComputeStorage
SystemComputeUrl	SystemComputeUrl
TargetType	Måltypen.
UserComputeDataset	UserComputeStorage
UserComputeUrl	UserComputeUrl
WorkspaceConnection	Anslutning till AML-arbetsyta.
WorkspaceConnectionEmbeddingSettings	ArbetsytaAnslutningEmbeddingSettings

ACSIndex

ACS-index.

Name	Typ	Description
connectionId	string	ID:t för anslutningen som pekar på ACS-indexet.
kind	string: acs	Måltypen.

BaseConnection

Name	Typ	Description
kind	ConnectionType	Anslutningstypen.

ChunkingSettings

SegmenteringInställningar

Name	Typ	Description
maxChunkSizeInTokens	integer

ComputeType

Beräkningstypen.

Name	Typ	Description
custom	string	Anpassad användarberäkning.
serverless	string	Serverlös användarberäkning.

ConnectionStringConnection

Anslutning av anslutningssträng.

Name	Typ	Description
connectionString	string	Anslutningssträng
kind	ConnectionType	Anslutningstypen.

ConnectionType

Anslutningstypen.

Name	Typ	Description
connectionString	string	Anslutningssträng.
endpointKey	string	Slutpunkt och nyckelanslutning.
endpointMI	string	Slutpunkt och hanterad identitet.
workspace	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: custom	Beräkningstypen.

DatasourceType

Datakällans typ.

Name	Typ	Description
storage	string	Azure Storage-konto.
urls	string	Webbadresser.

DeploymentConnection

Relativ distributionsanslutning.

Name	Typ	Description
kind	ConnectionType	Anslutningstypen.

EndpointKeyConnection

Slutpunktsnyckelanslutning.

Name	Typ	Description
endpoint	string	Slutpunkt
key	string	Nyckel
kind	ConnectionType	Anslutningstypen.

EndpointMIConnection

Slutpunktshanterad identitetsanslutning.

Name	Typ	Description
endpoint	string	Slutpunkt
kind	ConnectionType	Anslutningstypen.

Error

Fel

Name	Typ	Description
code	ErrorCode	Felkod Felkoder som definieras 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

Felkod

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	Det går inte att utföra åtgärden 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
cleanUpAssets	string	Rensar mellanliggande tillgångar som skapats under inmatningsprocessen.
keepAllAssets	string	Rensar inte några av de mellanliggande tillgångar som skapats under inmatningsprocessen.

IngestionJobList

Name	Typ	Description
nextLink	string	Länken till nästa sida.
value	IngestionJob[]: IngestionJobSystemCompute[] IngestionJobUserCompute[]	Listan över objekt.

IngestionJobSystemCompute

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

IngestionJobType

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

IngestionJobUserCompute

Name	Typ	Description
compute	JobCompute: CustomCompute ServerlessCompute	JobCompute Jobbets beräkningsinställningar.
dataRefreshIntervalInHours	integer
datasource	UserComputeDatasource: UserComputeDataset UserComputeUrl	UserComputeDatasource
jobId	string
kind	string: user	IngestionJobType Jobbtypen.
target	TargetIndex: ACSIndex 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: serverless	Beräkningstypen.
sku	string	SKU-nivå

SystemComputeDatasource

Name	Typ	Description
kind	DatasourceType	Datakällans typ.

SystemComputeStorage

Name	Typ	Description
chunking	ChunkingSettings	SegmenteringInställningar 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 anslutning
kind	DatasourceType	Datakällans typ.

SystemComputeUrl

Name	Typ	Description
chunking	ChunkingSettings	SegmenteringInställningar 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 anslutning
kind	DatasourceType	Datakällans typ.
urls	string[]

TargetType

Måltypen.

Name	Typ	Description
acs	string	Azure AI Search Index.
cosmosdb	string	CosmosDB-index.
pinecone	string	Pinecone Index.

UserComputeDataset

UserComputeStorage

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

UserComputeUrl

Name	Typ	Description
chunking	ChunkingSettings	SegmenteringInställningar Segmenteringsinställningar
crawling	CrawlingSettings	CrawlingSettings Crawlningsinställningar
embeddings	WorkspaceConnectionEmbeddingSettings[]	ArbetsytaAnslutningEmbeddingSettings 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	ConnectionType	Anslutningstypen.

WorkspaceConnectionEmbeddingSettings

ArbetsytaAnslutningEmbeddingSettings

Name	Typ	Description
connectionId	string
deploymentName	string
modelName	string

Dela via