Vector Store File Batches - Cancel Vector Store File Batch

Tjänst:

AI Foundry

API-version:

v1

Avbryt en vektorlagringsfilbatch. Detta försöker avbryta bearbetningen av filer i den här batchen så snart som möjligt.

POST {endpoint}/vector_stores/{vectorStoreId}/file_batches/{batchId}/cancel?api-version=v1

URI-parametrar

Name	I	Obligatorisk	Typ	Description
batchId	path	True	string	Identifierare för filbatchen.
endpoint	path	True	string (uri)	Projektets slutpunkt i form av: https://.services.ai.azure.com/api/projects/
vectorStoreId	path	True	string	Identifierare för vektorlagret.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	VectorStoreFileBatch	Begäran har slutförts.
Other Status Codes	AgentV1Error	Ett oväntat felsvar.

Säkerhet

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Omfattningar

Name	Description
https://ai.azure.com/.default

Exempel

VectorStoreFileBatches_CancelVectorStoreFileBatch_MaximumSet

VectorStoreFileBatches_CancelVectorStoreFileBatch_MinimumSet

VectorStoreFileBatches_CancelVectorStoreFileBatch_MaximumSet

Exempelbegäran

HTTP

POST {endpoint}/vector_stores/yvbvqokagirvt/file_batches/guarpvjxyowmcwoyysz/cancel?api-version=v1

Exempelsvar

Statuskod:

200

{
  "id": "rkpnnrgosprjypskpmr",
  "object": "vector_store.files_batch",
  "created_at": 15,
  "vector_store_id": "ljflbugcwtjwme",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 14,
    "completed": 21,
    "failed": 12,
    "cancelled": 1,
    "total": 25
  }
}

VectorStoreFileBatches_CancelVectorStoreFileBatch_MinimumSet

Exempelbegäran

HTTP

POST {endpoint}/vector_stores/xnacgdzqloim/file_batches/oxoqf/cancel?api-version=v1

Exempelsvar

Statuskod:

200

{
  "id": "rkpnnrgosprjypskpmr",
  "object": "vector_store.files_batch",
  "created_at": 15,
  "vector_store_id": "ljflbugcwtjwme",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 14,
    "completed": 21,
    "failed": 12,
    "cancelled": 1,
    "total": 25
  }
}

Definitioner

Name	Description
AgentErrorDetail	Beskriver felinformationen som returneras av agent-API:et.
AgentV1Error	Felnyttolast som returnerades av agent-API:et.
VectorStoreFileBatch	En batch med filer som är kopplade till ett vektorlager.
VectorStoreFileBatchStatus	Status för batchen för vektorlagringsfilen.
VectorStoreFileCount	Antal filer som bearbetas eller bearbetas av det här vektorarkivet grupperat efter status.

AgentErrorDetail

Objekt

Beskriver felinformationen som returneras av agent-API:et.

Name	Typ	Description
code	string	Maskinläsbar felkod.
message	string	En beskrivning av felet som är läsbart för människor.
param	string	Namnet på den parameter som orsakade felet, om tillämpligt.
type	string	Identifierare för feltyp (t.ex. invalid_request_error).

AgentV1Error

Objekt

Felnyttolast som returnerades av agent-API:et.

Name	Typ	Description
error	AgentErrorDetail	Representerar felet.

VectorStoreFileBatch

Objekt

En batch med filer som är kopplade till ett vektorlager.

Name	Typ	Description
created_at	integer (unixtime)	Unix-tidsstämpeln (i sekunder) för när batchen för vektorlagringsfiler skapades.
file_counts	VectorStoreFileCount	Filer räknas grupperade efter status som bearbetas eller bearbetas av det här vektorarkivet.
id	string	Identifieraren, som kan refereras till i API-slutpunkter.
object	enum: vector_store.files_batch	Objekttypen, som alltid vector_store.file_batchär .
status	VectorStoreFileBatchStatus	Status för batchen för vektorlagringsfiler, som kan vara antingen in_progress, completedeller cancelledfailed.
vector_store_id	string	ID:t för vektorarkivet som filen är kopplad till.

VectorStoreFileBatchStatus

Uppräkning

Status för batchen för vektorlagringsfilen.

Värde	Description
cancelled	Batchen för vektorlagringsfilen avbröts.
completed	Batch Vector Store-filen är klar att användas.
failed	Det gick inte att bearbeta batchen för vektorlagringsfilen.
in_progress	Vektorarkivet bearbetar fortfarande den här filbatchen.

VectorStoreFileCount

Objekt

Antal filer som bearbetas eller bearbetas av det här vektorarkivet grupperat efter status.

Name	Typ	Description
cancelled	integer (int32)	Antalet filer som avbröts.
completed	integer (int32)	Antalet filer som har bearbetats.
failed	integer (int32)	Antalet filer som inte har bearbetats.
in_progress	integer (int32)	Antalet filer som bearbetas för närvarande.
total	integer (int32)	Det totala antalet filer.