Поделиться через

Ingestion Jobs - Create

  • Ссылка
Служба:
Azure AI Services
Версия API:
2025-02-01-preview

Создает задание приема с указанным идентификатором задания.

PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-02-01-preview

Параметры URI

Имя В Обязательно Тип Описание
endpoint
 path True

string (url)

Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например https://aoairesource.openai.azure.com. Замените aoairesource именем учетной записи Azure OpenAI.
job-id
 path True

string

Идентификатор создаваемого задания.
api-version
 query True

string

Запрошенная версия API.

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

Имя Обязательно Тип Описание
mgmt-user-token

string

Маркер, используемый для доступа к рабочей области (необходим только для заданий вычислений пользователей).
aml-user-token

string

Маркер, используемый для доступа к ресурсам в задании в рабочей области (необходим только для заданий вычислений пользователей).

Текст запроса

Текст запроса может быть таким:

Имя Описание
IngestionJobSystemCompute
IngestionJobUserCompute

IngestionJobSystemCompute

Имя Обязательно Тип Описание
kind True string:

SystemCompute

IngestionJobType
Тип задания.
completionAction

IngestionJobCompletionAction

Действие завершения.
dataRefreshIntervalInHours

integer

datasource SystemComputeDatasource:

SystemComputeDatasource
jobId

string

searchServiceConnection BaseConnection:

BaseConnection
Подключение к ресурсу.

IngestionJobUserCompute

Имя Обязательно Тип Описание
kind True string:

UserCompute

IngestionJobType
Тип задания.
workspaceId True

string

compute JobCompute:

JobCompute
Параметры вычислений задания.
dataRefreshIntervalInHours

integer

datasource UserComputeDatasource:

UserComputeDatasource
jobId

string

target TargetIndex:

TargetIndex
Сведения о создаваемом индексе.

Ответы

Имя Тип Описание
200 OK IngestionJob:

Успех
Other Status Codes

ErrorResponse

Произошла ошибка.

Безопасность

api-key

Проверка подлинности ключа API

Тип: apiKey
В: header

OAuth2Auth

Проверка подлинности OAuth2

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области

Имя Описание
https://cognitiveservices.azure.com/.default

Примеры

Create a system-compute ingestion job
Create a user-compute ingestion job

Create a system-compute ingestion job

Образец запроса

PUT {endpoint}/openai/ingestion/jobs/ingestion-job?api-version=2025-02-01-preview

{
  "kind": "SystemCompute",
  "searchServiceConnection": {
    "kind": "EndpointWithManagedIdentity",
    "endpoint": "https://aykame-dev-search.search.windows.net"
  },
  "datasource": {
    "kind": "Storage",
    "connection": {
      "kind": "EndpointWithManagedIdentity",
      "endpoint": "https://mystorage.blob.core.windows.net/",
      "resourceId": "/subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage"
    },
    "containerName": "container",
    "chunking": {
      "maxChunkSizeInTokens": 2048
    },
    "embeddings": [
      {
        "connection": {
          "kind": "RelativeConnection"
        },
        "deploymentName": "Ada"
      }
    ]
  },
  "dataRefreshIntervalInHours": 24,
  "completionAction": "keepAllAssets"
}

Пример ответа

Код состояния:
200 
operation-location: https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-02-01-preview
{
  "kind": "SystemCompute",
  "jobId": "ingestion-job",
  "searchServiceConnection": {
    "kind": "EndpointWithManagedIdentity",
    "endpoint": "https://aykame-dev-search.search.windows.net"
  },
  "datasource": {
    "kind": "Storage",
    "connection": {
      "kind": "EndpointWithManagedIdentity",
      "endpoint": "https://mystorage.blob.core.windows.net/",
      "resourceId": "/subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage"
    },
    "containerName": "container",
    "chunking": {
      "maxChunkSizeInTokens": 2048
    },
    "embeddings": [
      {
        "connection": {
          "kind": "RelativeConnection"
        },
        "deploymentName": "Ada"
      }
    ]
  },
  "dataRefreshIntervalInHours": 24,
  "completionAction": "keepAllAssets"
}

Create a user-compute ingestion job

Образец запроса

PUT {endpoint}/openai/ingestion/jobs/ingestion-job?api-version=2025-02-01-preview

{
  "kind": "UserCompute",
  "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev",
  "compute": {
    "kind": "ServerlessCompute"
  },
  "target": {
    "kind": "AzureAISearch",
    "connectionId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection"
  },
  "datasource": {
    "kind": "Dataset",
    "datasetId": "azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1",
    "datasetType": "uri_folder"
  }
}

Пример ответа

Код состояния:
200 
operation-location: https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-02-01-preview
{
  "kind": "UserCompute",
  "jobId": "ingestion-job",
  "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev",
  "compute": {
    "kind": "ServerlessCompute"
  },
  "target": {
    "kind": "AzureAISearch",
    "connectionId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection"
  },
  "datasource": {
    "kind": "Dataset",
    "datasetId": "azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1",
    "datasetType": "uri_folder"
  }
}

Определения

Имя Описание
AzureAISearchIndex

Индекс поиска ИИ Azure.
ChunkingSettings

ChunkingSettings
ComputeType

Тип вычислений.
ConnectionStringConnection

Подключение строки подключения.
ConnectionType

Тип подключения.
CosmosDBIndex

Индекс CosmosDB.
CrawlingSettings

Обход контентаSettings
CustomCompute

Пользовательские вычисления.
DeploymentConnection

Относительное подключение к развертыванию.
EndpointKeyConnection

Подключение к ключу конечной точки.
EndpointMIConnection

Подключение управляемого удостоверения конечной точки.
Error

Ошибка
ErrorCode

Код ошибки
ErrorResponse

ErrorResponse
GenericEmbeddingSettings

ConnectionEmbeddingSettings
IngestionJobCompletionAction

Действие завершения.
IngestionJobSystemCompute
IngestionJobType

IngestionJobType
IngestionJobUserCompute
InnerError

InnerError
InnerErrorCode

InnerErrorCode
PineconeIndex

Индекс Pinecone.
ServerlessCompute

Бессерверные вычисления.
SystemComputeDatasourceType

Тип источника данных.
SystemComputeStorage

SystemComputeStorage
SystemComputeUrl

SystemComputeUrl
TargetType

Тип целевого объекта.
UserComputeDataset

UserComputeStorage
UserComputeDatasourceType

Тип источника данных.
UserComputeUrl

UserComputeUrl
WorkspaceConnection

Подключение к рабочей области AML.
WorkspaceConnectionEmbeddingSettings

WorkspaceConnectionEmbeddingSettings

AzureAISearchIndex

Object

Индекс поиска ИИ Azure.

Имя Тип Описание
connectionId

string

Идентификатор подключения, указывающего на индекс поиска ИИ Azure.
kind string:

AzureAISearch

Тип целевого объекта.

ChunkingSettings

Object

ChunkingSettings

Имя Тип Описание
maxChunkSizeInTokens

integer

ComputeType

Перечисление

Тип вычислений.

Значение Описание
CustomCompute

Пользовательские вычисления пользователей.
ServerlessCompute

Бессерверные вычисления пользователей.

ConnectionStringConnection

Object

Подключение строки подключения.

Имя Тип Описание
connectionString

string

Строка подключения
kind string:

ConnectionString

Тип подключения.

ConnectionType

Перечисление

Тип подключения.

Значение Описание
ConnectionString

Строка подключения.
EndpointWithKey

Конечная точка и подключение к ключу.
EndpointWithManagedIdentity

Конечная точка и управляемое удостоверение.
RelativeConnection

Относительное развертывание
WorkspaceConnection

Подключение к рабочей области AML.

CosmosDBIndex

Object

Индекс CosmosDB.

Имя Тип Описание
collectionName

string

Имя коллекции Cosmos DB.
connectionId

string

Идентификатор соединения, указывающего на cosmos DB.
databaseName

string

Имя базы данных Cosmos DB.
kind string:

CosmosDB

Тип целевого объекта.

CrawlingSettings

Object

Обход контентаSettings

Имя Тип Описание
maxCrawlDepth

integer

maxCrawlTimeInMins

integer

maxDownloadTimeInMins

integer

maxFileSize

integer

maxFiles

integer

maxRedirects

integer

CustomCompute

Object

Пользовательские вычисления.

Имя Тип Описание
computeId

string

Идентификатор пользовательского вычисления
kind string:

CustomCompute

Тип вычислений.

DeploymentConnection

Object

Относительное подключение к развертыванию.

Имя Тип Описание
kind string:

RelativeConnection

Тип подключения.

EndpointKeyConnection

Object

Подключение к ключу конечной точки.

Имя Тип Описание
endpoint

string

Конечная точка
key

string

Ключ
kind string:

EndpointWithKey

Тип подключения.

EndpointMIConnection

Object

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

Имя Тип Описание
endpoint

string

Конечная точка
kind string:

EndpointWithManagedIdentity

Тип подключения.
resourceId

string

Идентификатор ресурса

Error

Object

Ошибка

Имя Тип Описание
code

ErrorCode

Код ошибки
Коды ошибок, определенные в рекомендациях Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details

Error[]

Сведения об ошибке, если они доступны.
innererror

InnerError

InnerError
Внутренняя ошибка, определенная в рекомендациях Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message

string

minLength: 1

Сообщение об этой ошибке.
target

string

Расположение, в котором произошла ошибка, если она доступна.

ErrorCode

Перечисление

Код ошибки

Значение Описание
conflict

Запрошенная операция конфликтует с текущим состоянием ресурса.
contentFilter

Сбой создания изображений в результате нашей системы безопасности.
fileImportFailed

Сбой импорта файла.
forbidden

Операция запрещена для текущего ключа пользователя или API.
internalFailure

Внутренняя ошибка. Повторите попытку.
invalidPayload

Данные запроса недопустимы для этой операции.
itemDoesAlreadyExist

Элемент уже существует.
jsonlValidationFailed

Сбой проверки данных jsonl.
notFound

Ресурс не найден.
quotaExceeded

Превышена квота.
serviceUnavailable

В настоящее время служба недоступна.
tooManyRequests

Слишком много запросов. Повторите попытку позже.
unauthorized

Текущий ключ пользователя или API не авторизован для операции.
unexpectedEntityState

Невозможно выполнить операцию в состоянии текущего ресурса.

ErrorResponse

Object

ErrorResponse

Имя Тип Описание
error

Error

Ошибка
Содержимое ошибки, определенное в рекомендациях Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

GenericEmbeddingSettings

Object

ConnectionEmbeddingSettings

Имя Тип Описание
connection BaseConnection:

BaseConnection
Подключение к ресурсу.
deploymentName

string

modelName

string

IngestionJobCompletionAction

Перечисление

Действие завершения.

Значение Описание
cleanUpTempAssets

Будет очищать промежуточные ресурсы, созданные во время процесса приема.
keepAllAssets

Не будет очищать какие-либо промежуточные ресурсы, созданные во время процесса приема.

IngestionJobSystemCompute

Object
Имя Тип Описание
completionAction

IngestionJobCompletionAction

Действие завершения.
dataRefreshIntervalInHours

integer

datasource SystemComputeDatasource:

SystemComputeDatasource
jobId

string

kind string:

SystemCompute

IngestionJobType
Тип задания.
searchServiceConnection BaseConnection:

BaseConnection
Подключение к ресурсу.

IngestionJobType

Перечисление

IngestionJobType

Значение Описание
SystemCompute

Задания, выполняемые на ресурсах, принадлежащих службе.
UserCompute

Задания, выполняемые в рабочей области, принадлежащей пользователю.

IngestionJobUserCompute

Object
Имя Тип Описание
compute JobCompute:

JobCompute
Параметры вычислений задания.
dataRefreshIntervalInHours

integer

datasource UserComputeDatasource:

UserComputeDatasource
jobId

string

kind string:

UserCompute

IngestionJobType
Тип задания.
target TargetIndex:

TargetIndex
Сведения о создаваемом индексе.
workspaceId

string

InnerError

Object

InnerError

Имя Тип Описание
code

InnerErrorCode

InnerErrorCode
Внутренние коды ошибок, определенные в рекомендациях Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror

InnerError

InnerError
Внутренняя ошибка, определенная в рекомендациях Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Перечисление

InnerErrorCode

Значение Описание
invalidPayload

Данные запроса недопустимы для этой операции.

PineconeIndex

Object

Индекс Pinecone.

Имя Тип Описание
connectionId

string

Идентификатор соединения, указывающего на сосновый сосновый.
kind string:

Pinecone

Тип целевого объекта.

ServerlessCompute

Object

Бессерверные вычисления.

Имя Тип Описание
instanceCount

integer

Количество экземпляров для запуска задания.
kind string:

ServerlessCompute

Тип вычислений.
sku

string

Уровень SKU

SystemComputeDatasourceType

Перечисление

Тип источника данных.

Значение Описание
Storage

Учетная запись хранения Azure.
Urls

URL-адреса.

SystemComputeStorage

Object

SystemComputeStorage

Имя Тип Описание
chunking

ChunkingSettings

ChunkingSettings
Параметры блокирования
connection BaseConnection:

BaseConnection
Подключение к ресурсу.
containerName

string

имя контейнера
embeddings

GenericEmbeddingSettings[]

ConnectionEmbeddingSettings
Параметры внедрения подключений
kind string:

Storage

Тип источника данных.

SystemComputeUrl

Object

SystemComputeUrl

Имя Тип Описание
chunking

ChunkingSettings

ChunkingSettings
Параметры блокирования
connection BaseConnection:

BaseConnection
Подключение к ресурсу.
containerName

string

имя контейнера
crawling

CrawlingSettings

Обход контентаSettings
Параметры обхода контента
embeddings

GenericEmbeddingSettings[]

ConnectionEmbeddingSettings
Параметры внедрения подключений
kind string:

Urls

Тип источника данных.
urls

string[]

TargetType

Перечисление

Тип целевого объекта.

Значение Описание
AzureAISearch

Индекс поиска ИИ Azure.
CosmosDB

Индекс CosmosDB.
Pinecone

Индекс Pinecone.

UserComputeDataset

Object

UserComputeStorage

Имя Тип Описание
chunking

ChunkingSettings

ChunkingSettings
Параметры блокирования
datasetId

string

datasetType

string

embeddings

WorkspaceConnectionEmbeddingSettings[]

WorkspaceConnectionEmbeddingSettings
Идентификатор подключения к модели внедрения
kind string:

Dataset

Тип источника данных.

UserComputeDatasourceType

Перечисление

Тип источника данных.

Значение Описание
Dataset

Набор данных рабочей области.
Urls

URL-адреса.

UserComputeUrl

Object

UserComputeUrl

Имя Тип Описание
chunking

ChunkingSettings

ChunkingSettings
Параметры блокирования
crawling

CrawlingSettings

Обход контентаSettings
Параметры обхода контента
embeddings

WorkspaceConnectionEmbeddingSettings[]

WorkspaceConnectionEmbeddingSettings
Идентификатор подключения к модели внедрения
kind string:

Urls

Тип источника данных.
urls

string[]

WorkspaceConnection

Object

Подключение к рабочей области AML.

Имя Тип Описание
connectionId

string

ConnectionId
kind string:

WorkspaceConnection

Тип подключения.

WorkspaceConnectionEmbeddingSettings

Object

WorkspaceConnectionEmbeddingSettings

Имя Тип Описание
connectionId

string

deploymentName

string

modelName

string