Справочное руководство по предварительной версии REST API Azure OpenAI в Azure AI Foundry Models REST API

В этой статье содержатся сведения о конечных точках REST API вывода для Azure OpenAI.

Спецификации API

Управление и взаимодействие с моделями и ресурсами Azure OpenAI разделено на три основных поверхности API:

• Контрольная плоскость
• Плоскость данных — разработка
• Плоскость данных — вывод

Каждая область или спецификация API инкапсулирует другой набор возможностей Azure OpenAI. Каждый API имеет собственный уникальный набор выпусков API предварительной версии и стабильных и общедоступных (GA). Предварительные версии выпусков в настоящее время, как правило, следуют ежемесячному курсу.

Аутентификация

Azure OpenAI предоставляет два метода проверки подлинности. Вы можете использовать ключи API или идентификатор Microsoft Entra.

• Проверка подлинности ключа API. Для этого типа проверки подлинности все запросы API должны содержать Ключ API в заголовке HTTP api-key. В кратком руководстве показано, как выполнять вызовы с помощью этого типа проверки подлинности.

• Проверка подлинности идентификатора Microsoft Entra: можно пройти проверку подлинности вызова API с помощью маркера Microsoft Entra. Маркеры проверки подлинности включаются в запрос в заголовке Authorization. К маркеру следует добавить префикс Bearer, например Bearer YOUR_AUTH_TOKEN. Вы можете ознакомиться с нашим руководством по проверке подлинности с помощью идентификатора Microsoft Entra.

Управление версиями REST API

Управление версиями API служб осуществляется с использованием параметра запроса api-version. Все версии имеют структуру даты ГГГГ-ММ-ДД. Рассмотрим пример.

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

Вывод плоскости данных

В остальной части статьи рассматривается 2025-04-01-preview предварительная версия спецификации инференции плоскости данных Azure OpenAI.

Если вы ищете документацию по последнему выпуску API общедоступной версии, обратитесь к последнему API вывода плоскости данных общедоступной версии

Завершение — создание

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

Создает завершение для предоставленного запроса, параметров и выбранной модели.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: ОК

Код состояния: по умолчанию

Описание: служба недоступна

Примеры

Пример

Создает завершение для предоставленного запроса, параметров и выбранной модели.

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
}

Ответы: код состояния: 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
    }
  }
}

Внедрение — создание

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

Получение векторного представления заданных входных данных, которые можно легко использовать моделями и алгоритмами машинного обучения.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Верните встраивания для заданного запроса.

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

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

Ответы: код состояния: 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
    }
  }
}

Завершение чата — создание

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

Создает завершение для сообщения чата

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: ОК

Код состояния: по умолчанию

Описание: служба недоступна

Примеры

Пример

Создает завершение для предоставленного запроса, параметров и выбранной модели.

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?"
  }
 ]
}

Ответы: код состояния: 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
    }
  }
}

Пример

Создает завершение на основе данных поиска Azure и управляемого удостоверения, назначаемого системой.

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"
    }
   }
  }
 ]
}

Ответы: код состояния: 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
    }
  }
}

Пример

Создает завершение на основе векторных данных изображения поиска Azure.

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}"
    }
   }
  }
 ]
}

Ответы: код состояния: 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
    }
  }
}

Пример

Создает завершение на основе данных вектора поиска Azure, предыдущего сообщения помощника и управляемого удостоверения, назначаемого пользователем.

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"
     ]
    }
   }
  }
 ]
}

Ответы: код состояния: 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
    }
  }
}

Пример

Создает завершение для предоставленного 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"
     ]
    }
   }
  }
 ]
}

Ответы: код состояния: 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
    }
  }
}

Пример

Создает завершение для предоставленной базы данных Mongo.

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"
     ]
    }
   }
  }
 ]
}

Ответы: код состояния: 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
    }
  }
}

Пример

Создает завершение для предоставленного 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}"
    }
   }
  }
 ]
}

Ответы: код состояния: 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
    }
  }
}

Пример

Создает завершение для предоставленного ресурса 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"
    }
   }
  }
 ]
}

Ответы: код состояния: 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
    }
  }
}

Транскрибирование — создание

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

Транскрибирует звук на язык ввода.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Тело запроса

Content-Type: многочастный формат данных

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Получает транскрибированный текст и связанные метаданные из предоставленных речевых звуковых данных.

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

Ответы: код состояния: 200

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

Пример

Получает транскрибированный текст и связанные метаданные из предоставленных речевых звуковых данных.

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--"

Ответы: код состояния: 200

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

Переводы — создание

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

Транскрибирует и преобразует входной звук на английский текст.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Тело запроса

Content-Type: многочастный формат данных

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Получает транскрибированный текст на английском языке и связанные метаданные из предоставленных речевых звуковых данных.

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--"

Ответы: код состояния: 200

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

Пример

Получает транскрибированный текст на английском языке и связанные метаданные из предоставленных речевых звуковых данных.

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--"

Ответы: код состояния: 200

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

Речь — создание

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

Создает звук из входного текста.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Тело запроса

Content-Type: многочастный формат данных

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Синтезирует звук из предоставленного текста.

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"
}

Ответы: код состояния: 200

{
  "body": "101010101"
}

Поколения изображений — создание

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

Создает набор изображений из текстового заголовка с использованием заданной модели развертывания DALLE или gpt-image-1.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: ОК

Код состояния: по умолчанию

Описание: произошла ошибка.

Примеры

Пример

Создает изображения с запросом.

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"
}

Ответы: код состояния: 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
          }
        }
      }
    ]
  }
}

Генерация изображений — редактирование

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

Изменяет изображение из текстового заголовка для заданного развертывания модели gpt-image-1

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Тело запроса

Content-Type: многочастный формат данных

Ответы

Код состояния: 200

Описание: ОК

Код состояния: по умолчанию

Описание: произошла ошибка.

Список — помощники

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

Возвращает список помощников.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Возвращает список помощников.

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

Ответы: код состояния: 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
  }
}

Создание — помощник

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

Создайте помощника с моделью и инструкциями.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Создайте помощника с моделью и инструкциями.

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"
}

Ответы: код состояния: 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"
  }
}

Получить - Ассистент

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

Извлекает помощника.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Извлекает помощника.

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

Ответы: код состояния: 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"
  }
}

Изменение — помощник

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

Изменяет помощника.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Изменяет помощника.

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"
}

Ответы: код состояния: 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"
  }
}

Delete — Помощник

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

Удаление помощника.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Удаляет помощника.

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

Ответы: код состояния: 200

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

Create — Thread

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

Создание потока.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Создает поток.

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

Ответы: код состояния: 200

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

Get - Thread

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

Извлекает поток.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Извлекает поток.

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

Ответы: код состояния: 200

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

Изменение — поток

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

Изменяет поток.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Изменяет поток.

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

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

Ответы: код состояния: 200

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

Delete — Thread

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

Удаление потока.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Удаляет поток.

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

Ответы: код состояния: 200

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

Список — сообщения

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

Возвращает список сообщений для данного потока.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Вывод списка сообщений

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

Ответы: код состояния: 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
  }
}

Создание — сообщение

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

Создать сообщение.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Создать сообщение.

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."
}

Ответы: код состояния: 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": {}
  }
}

Получить - Сообщение

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

Получение сообщения.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Получение сообщения.

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

Ответы: код состояния: 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": {}
  }
}

Изменение — сообщение

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

Изменяет сообщение.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Изменение сообщения.

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

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

Ответы: код состояния: 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"
    }
  }
}

Создание — поток и запуск

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

Создайте поток и запустите его в одном запросе.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Создайте поток и запустите его в одном запросе.

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."
   }
  ]
 }
}

Ответы: код состояния: 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"
  }
}

Список — запуски

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

Возвращает список запусков, принадлежащих потоку.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Возвращает список запусков, принадлежащих потоку.

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

Ответы: код состояния: 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
  }
}

Создание — запуск

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

Создайте запуск.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Создайте запуск.

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

{
 "assistant_id": "asst_abc123"
}

Ответы: код состояния: 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"
  }
}

Получить - Запустить

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

Извлекает запуск.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Возвращает выполнение.

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

Ответы: код состояния: 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": {}
  }
}

Изменение — запуск

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

Изменяет выполнение.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Изменяет выполнение.

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

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

Ответы: код состояния: 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"
  }
}

Отправка — выходные данные средства для запуска

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

Если выполнение имеет status: "requires_action" и required_action.type есть submit_tool_outputs, эта конечная точка может использоваться для отправки выходных данных из вызовов средства после их завершения. Все выходные данные должны быть отправлены в одном запросе.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Если выполнение имеет status: "requires_action" и required_action.type есть submit_tool_outputs, эта конечная точка может использоваться для отправки выходных данных из вызовов средства после их завершения. Все выходные данные должны быть отправлены в одном запросе.

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."
  }
 ]
}

Ответы: код состояния: 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"
  }
}

Отмена — запуск

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

Отменяет запуск, который является in_progress.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Отменяет запуск, который является in_progress.

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

Ответы: код состояния: 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"
  }
}

Список — шаги выполнения

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

Возвращает список шагов выполнения, принадлежащих выполнению.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Возвращает список шагов выполнения, принадлежащих выполнению.

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

Ответы: код состояния: 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
  }
}

Получение — шаг выполнения

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

Извлекает шаг выполнения.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Извлекает шаг выполнения.

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

Ответы: код состояния: 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
    }
  }
}

Список — векторные хранилища

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

Возвращает список хранилищ векторов.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Возвращает список хранилищ векторов.

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

Ответы: код состояния: 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
  }
}

Создание — векторное хранилище

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

Создайте векторное хранилище.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Создает векторное хранилище.

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

Ответы: код состояния: 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
    }
  }
}

Get — Vector Store

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

Извлекает векторное хранилище.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Извлекает векторное хранилище.

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

Ответы: код состояния: 200

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

Изменение — векторное хранилище

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

Изменяет векторное хранилище.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Изменяет векторное хранилище.

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

{
 "name": "Support FAQ"
}

Ответы: код состояния: 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
    }
  }
}

Удаление — векторное хранилище

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

Удаление векторного хранилища.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Удаляет векторное хранилище.

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

Ответы: код состояния: 200

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

Список — файлы векторного хранилища

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

Возвращает список файлов векторного хранилища.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Возвращает список файлов векторного хранилища.

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

Ответы: код состояния: 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
  }
}

Создание файла векторного хранилища

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

Создайте файл векторного хранилища, вложив файл в векторное хранилище.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Создайте файл векторного хранилища, вложив файл в векторное хранилище.

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

{
 "file_id": "file-abc123"
}

Ответы: код состояния: 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 https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Извлекает файл векторного хранилища.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Извлекает файл векторного хранилища.

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

Ответы: код состояния: 200

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

Delete — векторный файл хранилища

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

Удаление файла векторного хранилища. Это приведет к удалению файла из векторного хранилища, но сам файл не будет удален. Чтобы удалить файл, используйте конечную точку удаления файла.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Удаление файла векторного хранилища. Это приведет к удалению файла из векторного хранилища, но сам файл не будет удален. Чтобы удалить файл, используйте конечную точку удаления файла.

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

Ответы: код состояния: 200

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

Обновить атрибуты файла векторного хранилища

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

Обновление атрибутов в файле векторного хранилища.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: ОК

Получение содержимого файла векторного хранилища

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

Извлеките проанализированное содержимое файла векторного хранилища.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Ответы

Код состояния: 200

Описание: ОК

Хранилище векторов поиска

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

Поиск векторного хранилища соответствующих блоков на основе фильтра атрибутов запроса и файла.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: ОК

Создание пакета файлов векторного хранилища

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

Создайте пакет файла векторного хранилища.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Создайте пакет файла векторного хранилища.

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

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

Ответы: код состояния: 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 https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

Извлекает пакет файла векторного хранилища.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Извлекает пакет файла векторного хранилища.

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

Ответы: код состояния: 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
    }
  }
}

Отмена — пакет файла векторного хранилища

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

Отмена пакета файла векторного хранилища. Это пытается отменить обработку файлов в этом пакете как можно скорее.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Отмена пакета файла векторного хранилища. Это пытается отменить обработку файлов в этом пакете как можно скорее.

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

Ответы: код состояния: 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
    }
  }
}

Список — пакетные файлы векторного хранилища

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

Возвращает список файлов векторного хранилища в пакете.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Ответы

Код состояния: 200

Описание: ОК

Примеры

Пример

Возвращает список файлов векторного хранилища.

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

Ответы: код состояния: 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
  }
}

Создание: Realtimesession

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

Создайте временный маркер API для использования в клиентских приложениях с API Realtime. Можно настроить с такими же параметрами сеанса, как и у события клиента session.update. Она возвращает объект сеанса и ключ client_secret, содержащий временный токен для API, который можно использовать для проверки подлинности клиентов браузера для API Реального времени.

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: сеанс успешно создан.

Создание — транскрипция сессии в реальном времени

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

Создайте эфемерный маркер API для использования в клиентских приложениях с API Реального времени специально для транскрибирования в режиме реального времени. Можно настроить с такими же параметрами сеанса, как и у события клиента transcription_session.update. Она возвращает объект сеанса и ключ client_secret, содержащий временный токен для API, который можно использовать для проверки подлинности клиентов браузера для API Реального времени.

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: сеанс успешно создан.

Ответы

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

Создает модельный ответ.

Тело запроса

Content-Type: application/json

Ответы

Код состояния: 200

Описание: ОК

Код состояния: по умолчанию

Описание: служба недоступна

API ответов — входные элементы

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

Извлекает ответ модели с заданным идентификатором.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Ответы

Код состояния: 200

Описание: ОК

Код состояния: по умолчанию

Описание: служба недоступна

Удаление ответа

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

Удаляет ответ модели с заданным идентификатором.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Ответы

Код состояния: 200

Описание: ОК

Код состояния: 404

Описание: не найдено

Код состояния: по умолчанию

Описание: служба недоступна

API ответов — список элементов ответа

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

Возвращает список входных элементов для заданного ответа.

Параметры URI

Заголовок запроса

Используйте аутентификацию на основе токенов или API-ключ. Рекомендуется использовать аутентификацию на основе токенов, так как это более безопасно.

Ответы

Код состояния: 200

Описание: ОК

Компоненты

ответ ошибки

errorBase

ошибка

внутренняя ошибка