Dokumentacja interfejsu API REST usługi Azure OpenAI w usłudze Microsoft Foundry Models

Ten artykuł zawiera szczegółowe informacje na temat punktów końcowych interfejsu API REST wnioskowania dla usługi Azure OpenAI.

Specyfikacje interfejsu API

Zarządzanie modelami i zasobami Azure OpenAI oraz interakcja z nimi są podzielone na trzy podstawowe elementy interfejsu API.

• Płaszczyzna sterowania
• Płaszczyzna danych — tworzenie
• Płaszczyzna danych — wnioskowanie

Każda powierzchnia/specyfikacja interfejsu API hermetyzuje inny zestaw funkcji usługi Azure OpenAI. Każdy interfejs API ma swój własny unikatowy zestaw wersji zapoznawczych i stabilne/ogólnie dostępne wersje interfejsu API. Obecnie wersje zapoznawcze zwykle podążają za miesięcznym harmonogramem.

Authentication

Usługa Azure OpenAI udostępnia dwie metody uwierzytelniania. Możesz użyć kluczy interfejsu API lub Microsoft Entra ID.

• Uwierzytelnianie klucza interfejsu API: w przypadku tego typu uwierzytelniania wszystkie żądania interfejsu API muszą zawierać klucz interfejsu API w nagłówku api-key HTTP. Przewodnik Szybki start zawiera wskazówki dotyczące wykonywania wywołań przy użyciu tego typu uwierzytelniania.

• Uwierzytelnianie identyfikatora Entra firmy Microsoft: możesz uwierzytelnić wywołanie interfejsu API przy użyciu tokenu Entra firmy Microsoft. Tokeny uwierzytelniania są dołączane do żądania jako nagłówka Authorization . Podany token musi być poprzedzony elementem Bearer, na przykład Bearer YOUR_AUTH_TOKEN. Możesz przeczytać nasz przewodnik z instrukcjami dotyczącymi uwierzytelniania za pomocą identyfikatora Entra firmy Microsoft.

Przechowywanie wersji interfejsu API REST

Interfejsy API usługi są wersjonowane za pomocą parametru api-version zapytania. Wszystkie wersje są zgodne ze strukturą dat RRRR-MM-DD. Przykład:

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01

Wnioskowanie płaszczyzny danych

W pozostałej części artykułu omówiono 2025-04-01-preview wersję zapoznawczą specyfikacji wnioskowania płaszczyzny danych usługi Azure OpenAI.

Jeśli szukasz dokumentacji najnowszej wersji interfejsu API ga, zapoznaj się z najnowszym interfejsem API wnioskowania płaszczyzny danych ogólnie dostępnego

Uzupełnianie — tworzenie

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-01-preview

Tworzy uzupełnienie dla podanej podpowiedzi, parametrów i wybranego modelu.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Treść żądania

Typ zawartości: aplikacja/json

Responses

Kod stanu: 200

Opis: OK

Kod stanu: wartość domyślna

Opis: Usługa niedostępna

Examples

Example

Tworzy uzupełnienie dla podanej podpowiedzi, parametrów i wybranego modelu.

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-01-preview

{
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
    "created": 1686617332,
    "choices": [
      {
        "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
        "index": 0,
        "finish_reason": "stop",
        "logprobs": null
      }
    ],
    "usage": {
      "completion_tokens": 20,
      "prompt_tokens": 6,
      "total_tokens": 26
    }
  }
}

Osadzanie — tworzenie

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-01-preview

Uzyskaj wektorową reprezentację danych wejściowych, które mogą być łatwo używane przez modele i algorytmy uczenia maszynowego.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Treść żądania

Typ zawartości: aplikacja/json

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Zwróć wektory osadzeń dla danego zapytania.

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-01-preview

{
 "input": [
  "this is a test"
 ]
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0020113448
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Ukończenie czatu — tworzenie

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

Tworzy uzupełnienie wiadomości na czacie

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Treść żądania

Typ zawartości: aplikacja/json

Responses

Kod stanu: 200

Opis: OK

Kod stanu: wartość domyślna

Opis: Usługa niedostępna

Examples

Example

Tworzy uzupełnienie dla podanej podpowiedzi, parametrów i wybranego modelu.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "system",
   "content": "you are a helpful assistant that talks like a pirate"
  },
  {
   "role": "user",
   "content": "can you tell me how to care for a parrot?"
  }
 ]
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Tworzy uzupełnienie w oparciu o dane z Azure Search oraz zarządzaną tożsamość przypisaną przez system.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "authentication": {
     "type": "system_assigned_managed_identity"
    }
   }
  }
 ]
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Tworzy uzupełnianie na podstawie danych wektorów obrazów usługi Azure Search.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "query_type": "vector",
    "fields_mapping": {
     "image_vector_fields": [
      "image_vector"
     ]
    },
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    }
   }
  }
 ]
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Tworzy uzupełnianie na podstawie danych wektora usługi Azure Search, poprzedniego komunikatu asystenta i tożsamości zarządzanej przypisanej przez użytkownika.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a cat?"
  },
  {
   "role": "assistant",
   "content": "Content of the completion [doc1].",
   "context": {
    "intent": "cat care"
   }
  },
  {
   "role": "user",
   "content": "how about dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "authentication": {
     "type": "user_assigned_managed_identity",
     "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
    },
    "index_name": "{index name}",
    "query_type": "vector",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "in_scope": true,
    "top_n_documents": 5,
    "strictness": 3,
    "role_information": "You are an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content 2.",
                "title": "Citation Title 2",
                "filepath": "contoso2.txt",
                "url": "https://contoso.blob.windows.net/container/contoso2.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Tworzy ukończenie dla podanej usługi Azure Cosmos DB.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_cosmos_db",
   "parameters": {
    "authentication": {
     "type": "connection_string",
     "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    },
    "database_name": "vectordb",
    "container_name": "azuredocs",
    "index_name": "azuredocindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Tworzy ukończenie dla podanej bazy danych Mongo DB.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "mongo_db",
   "parameters": {
    "authentication": {
     "type": "username_and_password",
     "username": "<username>",
     "password": "<password>"
    },
    "endpoint": "<endpoint_name>",
    "app_name": "<application name>",
    "database_name": "sampledb",
    "collection_name": "samplecollection",
    "index_name": "sampleindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Tworzy ukończenie dla podanego programu Elasticsearch.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "elasticsearch",
   "parameters": {
    "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io",
    "index_name": "{index name}",
    "authentication": {
     "type": "key_and_key_id",
     "key": "{key}",
     "key_id": "{key id}"
    }
   }
  }
 ]
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Tworzy ukończenie dla podanego zasobu Pinecone.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "pinecone",
   "parameters": {
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    },
    "environment": "{environment name}",
    "index_name": "{index name}",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "title_field": "title",
     "url_field": "url",
     "filepath_field": "filepath",
     "content_fields": [
      "content"
     ],
     "content_fields_separator": "\n"
    }
   }
  }
 ]
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Transkrypcje — tworzenie

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

Transkrybuje dźwięk w języku wejściowym.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Treść żądania

Typ zawartości: dane wielu części/formularzu

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Pobiera transkrybowany tekst i powiązane metadane z dostarczonych danych dźwiękowych.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Example

Pobiera transkrybowany tekst i powiązane metadane z dostarczonych danych dźwiękowych.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Odpowiedzi: Kod stanu: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Tłumaczenia — tworzenie

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

Transkrybuje i tłumaczy dźwięk wejściowy na tekst w języku angielskim.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Treść żądania

Typ zawartości: dane wielu części/formularzu

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Pobiera transkrybowany tekst w języku angielskim i skojarzone metadane z dostarczonych danych dźwiękowych mówionych.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Example

Pobiera transkrybowany tekst w języku angielskim i skojarzone metadane z dostarczonych danych dźwiękowych mówionych.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Odpowiedzi: Kod stanu: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Mowa — tworzenie

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

Generuje dźwięk z tekstu wejściowego.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Treść żądania

Typ zawartości: dane wielu części/formularzu

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Syntetyzuje dźwięk z dostarczonego tekstu.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3"
}

Odpowiedzi: Kod stanu: 200

{
  "body": "101010101"
}

Generacje obrazów — tworzenie

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

Generuje zestaw obrazów na podstawie opisu tekstowego dla określonego wdrożenia modelu z serii DALL-E lub gpt-image-1

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Treść żądania

Typ zawartości: aplikacja/json

Responses

Kod stanu: 200

Opis: Ok

Kod stanu: wartość domyślna

Opis: Wystąpił błąd.

Examples

Example

Tworzy obrazy z monitem.

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

{
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

Generacje obrazów — edycja

POST https://{endpoint}/openai/deployments/{deployment-id}/images/edits?api-version=2025-04-01-preview

Edytuje obraz z tekstowego podpisu w ramach danego wdrożenia modelu gpt-image-1

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Treść żądania

Typ zawartości: dane wielu części/formularzu

Responses

Kod stanu: 200

Opis: Ok

Kod stanu: wartość domyślna

Opis: Wystąpił błąd.

Lista — Asystenci

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

Zwraca listę asystentów.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Zwraca listę asystentów.

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "asst_abc123",
        "object": "assistant",
        "created_at": 1707257477,
        "name": "Stock Analyst",
        "description": null,
        "model": "gpt-4-1106-preview",
        "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.",
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc456",
        "object": "assistant",
        "created_at": 1698982718,
        "name": "My Assistant",
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": "You are a helpful assistant designed to make me better at coding!",
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc789",
        "object": "assistant",
        "created_at": 1698982643,
        "name": null,
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      }
    ],
    "first_id": "asst_abc123",
    "last_id": "asst_abc789",
    "has_more": false
  }
}

Tworzenie — Asystent

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

Utwórz asystenta przy użyciu modelu i instrukcji.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Treść żądania

Typ zawartości: aplikacja/json

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Utwórz asystenta przy użyciu modelu i instrukcji.

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

{
 "name": "Math Tutor",
 "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
 "tools": [
  {
   "type": "code_interpreter"
  }
 ],
 "model": "gpt-4-1106-preview"
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant",
    "created_at": 1707295707,
    "name": "Math Tutor",
    "description": null,
    "model": "gpt-4-1106-preview",
    "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Pobierz — Asystent

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Pobiera asystenta.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Pobiera asystenta.

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "asst_abc123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Modyfikowanie — Asystent

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Modyfikuje asystenta.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Treść żądania

Typ zawartości: aplikacja/json

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Modyfikuje asystenta.

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

{
 "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
 "tools": [
  {
   "type": "file_search"
  }
 ],
 "model": "gpt-4-turbo"
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "asst_123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": []
      }
    },
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Usuwanie — Asystent

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Usuń asystenta.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Usuwa asystenta.

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant.deleted",
    "deleted": true
  }
}

Tworzenie — wątek

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

Utwórz wątek.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Treść żądania

Typ zawartości: aplikacja/json

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Tworzy wątek.

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {}
  }
}

Pobierz — wątek

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Pobiera wątek.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Pobiera wątek.

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {},
    "tool_resources": {
      "code_interpreter": {
        "file_ids": []
      }
    }
  }
}

Modyfikuj — wątek

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Modyfikuje wątek.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Treść żądania

Typ zawartości: aplikacja/json

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Modyfikuje wątek.

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {
      "modified": "true",
      "user": "abc123"
    },
    "tool_resources": {}
  }
}

Usuwanie — wątek

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Usuń wątek.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Usuwa wątek.

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread.deleted",
    "deleted": true
  }
}

Lista — komunikaty

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

Zwraca listę komunikatów dla danego wątku.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Wyświetlanie listy komunikatów

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "msg_abc123",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "How does AI work? Explain it in simple terms.",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      },
      {
        "id": "msg_abc456",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "Hello, what is AI?",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      }
    ],
    "first_id": "msg_abc123",
    "last_id": "msg_abc456",
    "has_more": false
  }
}

Tworzenie — komunikat

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

Utwórz wiadomość.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Treść żądania

Typ zawartości: aplikacja/json

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Utwórz wiadomość.

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

{
 "role": "user",
 "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces."
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "assistant_id": null,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "attachments": [],
    "metadata": {}
  }
}

Pobierz — komunikat

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

Pobieranie komunikatu.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Pobieranie komunikatu.

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "assistant_id": null,
    "run_id": null,
    "metadata": {}
  }
}

Modyfikuj — komunikat

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

Modyfikuje komunikat.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Treść żądania

Typ zawartości: aplikacja/json

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Zmodyfikuj komunikat.

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "msg_abc123",
    "object": "thread.message",
    "created_at": 1699017614,
    "assistant_id": null,
    "thread_id": "thread_abc123",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "How does AI work? Explain it in simple terms.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "metadata": {
      "modified": "true",
      "user": "abc123"
    }
  }
}

Tworzenie — wątek i uruchamianie

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

Utwórz wątek i uruchom go w jednym żądaniu.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Treść żądania

Typ zawartości: aplikacja/json

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Utwórz wątek i uruchom go w jednym żądaniu.

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123",
 "thread": {
  "messages": [
   {
    "role": "user",
    "content": "Explain deep learning to a 5 year old."
   }
  ]
 }
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076792,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": null,
    "expires_at": 1699077392,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "required_action": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You are a helpful assistant.",
    "tools": [],
    "tool_resources": {},
    "metadata": {},
    "temperature": 1.0,
    "top_p": 1.0,
    "max_completion_tokens": null,
    "max_prompt_tokens": null,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "incomplete_details": null,
    "usage": null,
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Lista — uruchomienia

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

Zwraca listę przebiegów należących do wątku.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Zwraca listę przebiegów należących do wątku.

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "run_abc123",
        "object": "thread.run",
        "created_at": 1699075072,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699075072,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699075073,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      },
      {
        "id": "run_abc456",
        "object": "thread.run",
        "created_at": 1699063290,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699063290,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699063291,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      }
    ],
    "first_id": "run_abc123",
    "last_id": "run_abc456",
    "has_more": false
  }
}

Tworzenie — uruchamianie

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

Utwórz przebieg.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Treść żądania

Typ zawartości: aplikacja/json

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Utwórz przebieg.

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123"
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699063290,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": 1699063290,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699063291,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Pobierz — uruchamianie

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

Pobiera przebieg.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Pobiera przebieg.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q",
    "object": "thread.run",
    "created_at": 1707303196,
    "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl",
    "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh",
    "status": "completed",
    "started_at": 1707303197,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1707303201,
    "last_error": null,
    "model": "gpt-4-1106-preview",
    "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.",
    "tools": [],
    "file_ids": [],
    "metadata": {}
  }
}

Modyfikowanie — uruchamianie

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

Modyfikuje przebieg.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Treść żądania

Typ zawartości: aplikacja/json

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Modyfikuje przebieg.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "user_id": "user_abc123"
 }
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699075072,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "completed",
    "started_at": 1699075072,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699075073,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "tool_resources": {
      "code_interpreter": {
        "file_ids": [
          "file-abc123",
          "file-abc456"
        ]
      }
    },
    "metadata": {
      "user_id": "user_abc123"
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    },
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Przesyłanie — dane wyjściowe narzędzia do uruchomienia

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

Gdy przebieg ma status: "requires_action" wartość i required_action.type to submit_tool_outputs, ten punkt końcowy może służyć do przesyłania danych wyjściowych z wywołań narzędzia po ich zakończeniu. Wszystkie dane wyjściowe muszą zostać przesłane w jednym żądaniu.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Treść żądania

Typ zawartości: aplikacja/json

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Gdy przebieg ma status: "requires_action" wartość i required_action.type to submit_tool_outputs, ten punkt końcowy może służyć do przesyłania danych wyjściowych z wywołań narzędzia po ich zakończeniu. Wszystkie dane wyjściowe muszą zostać przesłane w jednym żądaniu.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

{
 "tool_outputs": [
  {
   "tool_call_id": "call_001",
   "output": "70 degrees and sunny."
  }
 ]
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "run_123",
    "object": "thread.run",
    "created_at": 1699075592,
    "assistant_id": "asst_123",
    "thread_id": "thread_123",
    "status": "queued",
    "started_at": 1699075592,
    "expires_at": 1699076192,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "tools": [
      {
        "type": "function",
        "function": {
          "name": "get_current_weather",
          "description": "Get the current weather in a given location",
          "parameters": {
            "type": "object",
            "properties": {
              "location": {
                "type": "string",
                "description": "The city and state, e.g. San Francisco, CA"
              },
              "unit": {
                "type": "string",
                "enum": [
                  "celsius",
                  "fahrenheit"
                ]
              }
            },
            "required": [
              "location"
            ]
          }
        }
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Anulowanie — uruchamianie

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

Anuluje przebieg, który ma wartość in_progress.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Anuluje przebieg, który ma wartość in_progress.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076126,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "cancelling",
    "started_at": 1699076126,
    "expires_at": 1699076726,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You summarize books.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": [
          "vs_123"
        ]
      }
    },
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "response_format": "auto"
  }
}

Lista — kroki uruchamiania

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

Zwraca listę kroków uruchamiania należących do przebiegu.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Zwraca listę kroków uruchamiania należących do przebiegu.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "step_abc123",
        "object": "thread.run.step",
        "created_at": 1699063291,
        "run_id": "run_abc123",
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "type": "message_creation",
        "status": "completed",
        "cancelled_at": null,
        "completed_at": 1699063291,
        "expired_at": null,
        "failed_at": null,
        "last_error": null,
        "step_details": {
          "type": "message_creation",
          "message_creation": {
            "message_id": "msg_abc123"
          }
        },
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        }
      }
    ],
    "first_id": "step_abc123",
    "last_id": "step_abc456",
    "has_more": false
  }
}

Pobieranie — krok uruchamiania

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

Pobiera krok uruchomienia.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Pobiera krok uruchomienia.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "step_abc123",
    "object": "thread.run.step",
    "created_at": 1699063291,
    "run_id": "run_abc123",
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "type": "message_creation",
    "status": "completed",
    "cancelled_at": null,
    "completed_at": 1699063291,
    "expired_at": null,
    "failed_at": null,
    "last_error": null,
    "step_details": {
      "type": "message_creation",
      "message_creation": {
        "message_id": "msg_abc123"
      }
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    }
  }
}

Lista — magazyny wektorowe

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Zwraca listę magazynów wektorów.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Zwraca listę magazynów wektorów.

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "vs_abc123",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      },
      {
        "id": "vs_abc456",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ v2",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      }
    ],
    "first_id": "vs_abc123",
    "last_id": "vs_abc456",
    "has_more": false
  }
}

Tworzenie — magazyn wektorów

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Utwórz magazyn wektorów.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Treść żądania

Typ zawartości: aplikacja/json

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Tworzy magazyn wektorów.

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

Pobieranie — magazyn wektorów

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Pobiera magazyn wektorów.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Pobiera magazyn wektorów.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776
  }
}

Modyfikuj — magazyn wektorów

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Modyfikuje magazyn wektorów.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Treść żądania

Typ zawartości: aplikacja/json

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Modyfikuje magazyn wektorów.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

{
 "name": "Support FAQ"
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

Usuwanie — magazyn wektorów

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Usuń magazyn wektorów.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Usuwa magazyn wektorów.

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store.deleted",
    "deleted": true
  }
}

Lista — pliki magazynu wektorowego

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

Zwraca listę plików magazynu wektorowego.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Zwraca listę plików magazynu wektorowego.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Tworzenie — plik magazynu wektorów

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

Utwórz plik magazynu wektorów, dołączając plik do magazynu wektorów.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Treść żądania

Typ zawartości: aplikacja/json

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Utwórz plik magazynu wektorów, dołączając plik do magazynu wektorów.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

{
 "file_id": "file-abc123"
}

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "usage_bytes": 1234,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Get — plik magazynu wektorów

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Pobiera plik magazynu wektorów.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Pobiera plik magazynu wektorów.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Usuwanie — plik magazynu wektorowego

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Usuń plik magazynu wektorów. Spowoduje to usunięcie pliku z magazynu wektorów, ale sam plik nie zostanie usunięty. Aby usunąć plik, użyj punktu końcowego usuwania pliku.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Usuń plik magazynu wektorów. Spowoduje to usunięcie pliku z magazynu wektorów, ale sam plik nie zostanie usunięty. Aby usunąć plik, użyj punktu końcowego usuwania pliku.

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "file_abc123",
    "object": "vector_store.file.deleted",
    "deleted": true
  }
}

Updatevectorstorefileattributes

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Zaktualizuj atrybuty w pliku wektorowym.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Treść żądania

Typ zawartości: aplikacja/json

Responses

Kod stanu: 200

Opis: OK

Pobierz zawartość pliku magazynu wektorów

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}/content?api-version=2025-04-01-preview

Pobierz przeanalizowaną zawartość pliku repozytorium wektorów.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Responses

Kod stanu: 200

Opis: OK

Repozytorium wektorów wyszukiwania

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/search?api-version=2025-04-01-preview

Przeszukaj magazyn wektorów pod kątem odpowiednich fragmentów na podstawie filtru atrybutów zapytania i pliku.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Treść żądania

Typ zawartości: aplikacja/json

Responses

Kod stanu: 200

Opis: OK

Tworzenie — wektorowa partia plików magazynu

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

Utwórz wektorową partię plików magazynu.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Treść żądania

Typ zawartości: aplikacja/json

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Utwórz wektorową partię plików magazynu.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

{
 "file_ids": [
  "file-abc123",
  "file-abc456"
 ]
}

Odpowiedzi: Kod stanu: 200

{
  "id": "vsfb_abc123",
  "object": "vector_store.file_batch",
  "created_at": 1699061776,
  "vector_store_id": "vs_abc123",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 1,
    "completed": 1,
    "failed": 0,
    "cancelled": 0,
    "total": 0
  }
}

Get — wektorowa partia plików magazynu

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

Pobiera wektorową partię plików magazynu.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Pobiera wektorową partię plików magazynu.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "in_progress",
    "file_counts": {
      "in_progress": 1,
      "completed": 1,
      "failed": 0,
      "cancelled": 0,
      "total": 0
    }
  }
}

Anulowanie — wektorowy magazyn plików wsadowy

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

Anuluj partię plików magazynu wektorów. Spowoduje to jak najszybsze anulowanie przetwarzania plików w tej partii.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Anuluj partię plików magazynu wektorów. Spowoduje to jak najszybsze anulowanie przetwarzania plików w tej partii.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "cancelling",
    "file_counts": {
      "in_progress": 12,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 15
    }
  }
}

Lista — pliki wsadowe magazynu wektorów

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

Zwraca listę plików magazynu wektorów w partii.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Responses

Kod stanu: 200

Opis: OK

Examples

Example

Zwraca listę plików magazynu wektorowego.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

Odpowiedzi: Kod stanu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Tworzenie — Realtimesession

POST https://{endpoint}/openai/realtimeapi/sessions?api-version=2025-04-01-preview

Utwórz tymczasowy token API do użycia na stronie klienta korzystając z API w czasie rzeczywistym. Można skonfigurować z takimi samymi parametrami sesji, co zdarzenie klienta session.update. Odpowiada obiektem sesji oraz kluczem client_secret, który zawiera tymczasowy token API, umożliwiający uwierzytelnianie klientów przeglądarki w interfejsie API czasu rzeczywistego.

Treść żądania

Typ zawartości: aplikacja/json

Responses

Kod stanu: 200

Opis: Sesja została pomyślnie utworzona.

Utwórz — Transkrypcja sesji w czasie rzeczywistym

POST https://{endpoint}/openai/realtimeapi/transcription_sessions?api-version=2025-04-01-preview

Utwórz tymczasowy token API do używania w aplikacjach klienckich z API czasu rzeczywistego dedykowanym transkrypcjom w czasie rzeczywistym. Można skonfigurować z takimi samymi parametrami sesji, co zdarzenie klienta transcription_session.update. Odpowiada obiektem sesji oraz kluczem client_secret, który zawiera tymczasowy token API, umożliwiający uwierzytelnianie klientów przeglądarki w interfejsie API czasu rzeczywistego.

Treść żądania

Typ zawartości: aplikacja/json

Responses

Kod stanu: 200

Opis: Sesja została pomyślnie utworzona.

Responses

POST https://{endpoint}/openai/responses?api-version=2025-04-01-preview

Tworzy odpowiedź modelu.

Treść żądania

Typ zawartości: aplikacja/json

Responses

Kod stanu: 200

Opis: OK

Kod stanu: wartość domyślna

Opis: Usługa niedostępna

Interfejs API odpowiedzi — elementy wejściowe

GET https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

Pobiera odpowiedź modelu z danym identyfikatorem.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Responses

Kod stanu: 200

Opis: OK

Kod stanu: wartość domyślna

Opis: Usługa niedostępna

Usuń odpowiedź

DELETE https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

Usuwa odpowiedź modelu z danym identyfikatorem.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Responses

Kod stanu: 200

Opis: OK

Kod stanu: 404

Opis: Nie znaleziono

Kod stanu: wartość domyślna

Opis: Usługa niedostępna

Interfejs API odpowiedzi — lista elementów odpowiedzi

GET https://{endpoint}/openai/responses/{response_id}/input_items?api-version=2025-04-01-preview

Zwraca listę elementów wejściowych dla danej odpowiedzi.

Parametry identyfikatora URI

Nagłówek żądania

Użyj uwierzytelniania opartego na tokenach lub klucza interfejsu API. Uwierzytelnianie przy użyciu uwierzytelniania opartego na tokenach jest zalecane i bezpieczniejsze.

Responses

Kod stanu: 200

Opis: OK

Components

errorResponse

errorBase