Documentación de Oracle Cloud Infrastructure

API de archivos

Puede utilizar la API de archivos para cargar y gestionar documentos y otros datos que los agentes pueden utilizar mientras se ejecutan.

Al adjuntar archivos a flujos de trabajo como tareas de recuperación y resumen, los agentes pueden trabajar con materiales de origen grandes o complejos sin necesidad de pegar contenido en peticiones de datos. Este enfoque le ayuda a crear agentes más capaces que puedan utilizar bases de conocimientos, informes, logs y conjuntos de datos de una manera escalable y reutilizable, al tiempo que mantiene el manejo de datos centralizado y coherente.

Advertencia

Este servicio no pretende procesar información personal ni ningún dato (por ejemplo, determinados datos sanitarios regulados o información sobre tarjetas de pago) que imponga a Oracle obligaciones normativas, de seguridad o protección de datos específicas además de las especificadas en su acuerdo con Oracle o distintas de estas.

Nota

La API de archivos de OCI utiliza el mismo formato que la API de archivos de OpenAI con el punto final compatible con OpenAI de OCI. Para obtener información sobre la sintaxis y las solicitudes, consulte la documentación de la API de archivos de OpenAI.

Punto final de API soportado

URL Base Ruta de punto final Autenticación
https://inference.generativeai.${region}.oci.oraclecloud.com/openai/v1 /files Clave de API o sesión de IAM

Sustituya ${region} por una región de OCI soportada como us-chicago-1.

Aunque el formato de solicitud es compatible con OpenAI, la autenticación utiliza credenciales de OCI, las solicitudes se enrutan a través de puntos finales de inferencia de OCI Generative AI y los recursos y la ejecución permanecen en OCI.

Consejo

Para conocer los pasos de configuración antes de utilizar esta API, consulte Inicio rápido.

Carga de un archivo

POST /files

Parámetros del cuerpo
  • file (necesario): objeto de archivo que se va a cargar
  • purpose (necesario): finalidad del archivo. Valores soportados:
    • assistants
    • batch
    • fine-tune
    • vision
    • user_data
    • evals
  • expires_after (opcional): política de caducidad para el archivo
Restricciones de tipo de archivo (por finalidad)
  • batch: .jsonl
  • fine-tune: .jsonl
  • evals: .jsonl
  • vision: .gif, .jpeg, .jpg, .png, .webp
Referencia

Cargar el archivo

Ejemplo de Python:

# upload a file

file_path = "./example-file.pdf"
with open(file_path, "rb") as f:
    file = client.files.create(
        file=f,
        purpose="user_data"
    )
print(file.id)

Listado de archivos

GET /files

Parámetros de Entrada
  • after (opcional): cursor para su uso en la paginación
  • limit (opcional): número de objetos que se van a devolver
  • order (opcional): Ordenar por created_at ("asc" o "desc")
  • purpose (opcional): filtre los archivos por finalidad
Referencia

Mostrar los archivos

Ejemplo de Python:

# list files

client = OpenAI(
    base_url="https://inference.generativeai.us-chicago-1.oci.oraclecloud.com/openai/v1",
    api_key="sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    project="ocid1.generativeaiproject.oc1.us-chicago-1.xxxxxxxx",
)
files_list = client.files.list(order="asc")
print(files_list)

Recuperación de Información de Archivo

GET /files/{file_id}

Parámetro de Entrada
  • file_id (necesario): ID del archivo que se va a recuperar
Referencia

Recuperar archivo

Ejemplo de Python:

# retrieve file
file = client.files.retrieve(file_id="xxx")
print(file)

Recuperación de contenido de archivo

GET /files/{file_id}/content

Parámetro de Entrada
  • file_id (necesario): ID del archivo cuyo contenido desea recuperar
Referencia

Recuperar contenido de archivo

Ejemplo de Python:

# retrieve file content
file = client.files.content(file_id="xxx")
print(file.content)

Supresión de un archivo

DELETE /files/{file_id}

Parámetro de Entrada
  • file_id (necesario): ID del archivo que se va a suprimir
Referencia

Suprimir Archivo

Ejemplo de Python:

# delete file
delete_result = client.files.delete(file_id="xxx")
print(delete_result)