Files - Get File

Usługa:

AI Foundry

Wersja interfejsu API:

v1

Zwraca informacje o określonym pliku. Nie pobiera zawartości pliku.

GET {endpoint}/files/{fileId}?api-version=v1

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (uri)	Punkt końcowy projektu w postaci: https://.services.ai.azure.com/api/projects/
fileId	path	True	string	Identyfikator pliku do pobrania.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	FileInfo	Żądanie zakończyło się pomyślnie.
Other Status Codes	AgentV1Error	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

OAuth2Auth

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Zakresy

Nazwa	Opis
https://ai.azure.com/.default

Przykłady

Files_GetFile_MaximumSet

Files_GetFile_MinimumSet

Files_GetFile_MaximumSet

Przykładowe żądanie

HTTP

GET {endpoint}/files/yzh?api-version=v1

Przykładowa odpowiedź

Kod stanu:

200

{
  "object": "file",
  "id": "bgufti",
  "bytes": 29,
  "filename": "gzsribefbfyskpvb",
  "created_at": 11,
  "purpose": "fine-tune",
  "status": "uploaded",
  "status_details": "kvlslojuaiwev"
}

Files_GetFile_MinimumSet

Przykładowe żądanie

HTTP

GET {endpoint}/files/nokqtmihmjlncmmrknlsdopgej?api-version=v1

Przykładowa odpowiedź

Kod stanu:

200

{
  "object": "file",
  "id": "bgufti",
  "bytes": 29,
  "filename": "gzsribefbfyskpvb",
  "created_at": 11,
  "purpose": "fine-tune"
}

Definicje

Nazwa	Opis
AgentErrorDetail	Opisuje informacje o błędach zwracane przez interfejs API agentów.
AgentV1Error	Ładunek błędu zwrócony przez interfejs API agentów.
FileInfo	Reprezentuje agenta, który może wywoływać model i używać narzędzi.
FilePurpose	Możliwe wartości oznaczające zamierzone użycie pliku.
FileState	Stan pliku.

AgentErrorDetail

Objekt

Opisuje informacje o błędach zwracane przez interfejs API agentów.

Nazwa	Typ	Opis
code	string	Kod błędu nadający się do odczytu maszynowego.
message	string	Opis błędu czytelny dla człowieka.
param	string	Nazwa parametru, który spowodował błąd, jeśli dotyczy.
type	string	Identyfikator typu błędu (np. invalid_request_error).

AgentV1Error

Objekt

Ładunek błędu zwrócony przez interfejs API agentów.

Nazwa	Typ	Opis
error	AgentErrorDetail	Reprezentuje błąd.

FileInfo

Objekt

Reprezentuje agenta, który może wywoływać model i używać narzędzi.

Nazwa	Typ	Opis
bytes	integer (int32)	Rozmiar pliku w bajtach.
created_at	integer (unixtime)	Sygnatura czasowa systemu Unix w sekundach reprezentująca czas utworzenia tego obiektu.
filename	string	Nazwa pliku.
id	string	Identyfikator, do którego można odwoływać się w punktach końcowych interfejsu API.
object	enum: file	Typ obiektu, który jest zawsze "plik".
purpose	FilePurpose	Zamierzony cel pliku.
status	FileState	Stan pliku. To pole jest dostępne tylko w usłudze Azure OpenAI.
status_details	string	Komunikat o błędzie ze szczegółami w przypadku niepowodzenia przetwarzania tego pliku. To pole jest dostępne tylko w usłudze Azure OpenAI.

FilePurpose

Wyliczanie

Możliwe wartości oznaczające zamierzone użycie pliku.

Wartość	Opis
assistants	Wskazuje, że plik jest używany jako dane wejściowe dla agentów.
assistants_output	Wskazuje, że plik jest używany jako dane wyjściowe przez agentów.
vision	Wskazuje, że plik jest używany jako dane wejściowe dla operacji przetwarzania obrazów.

FileState

Wyliczanie

Stan pliku.

Wartość	Opis
deleted	Jednostka została usunięta, ale nadal może być przywoływała inne jednostki poprzedzające usunięcie. Można go podzielić na stan terminalu.
deleting	Encja jest w trakcie usuwania. Ten stan nie jest zwracany przez usługę Azure OpenAI i uwidaczniany tylko pod kątem zgodności. Można go sklasyfikować jako aktywny stan.
error	Operacja zakończyła przetwarzanie z powodu błędu i nie może być jeszcze bardziej zużywana. Można go podzielić na stan terminalu.
pending	Operacja została utworzona i nie zostanie utworzona w kolejce do przetworzenia w przyszłości. Można go sklasyfikować jako stan nieaktywny.
processed	Operacja została pomyślnie przetworzona i jest gotowa do spożycia. Można go podzielić na stan terminalu.
running	Operacja została rozpoczęta do przetworzenia. Można go sklasyfikować jako aktywny stan.
uploaded	Plik został przekazany, ale nie został jeszcze przetworzony. Ten stan nie jest zwracany przez usługę Azure OpenAI i uwidaczniany tylko pod kątem zgodności. Można go sklasyfikować jako stan nieaktywny.