通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Indexes - Create Or Update Version

服务:
AI Foundry
API 版本:
v1

使用给定版本 ID 创建新索引或更新现有索引

PATCH {endpoint}/indexes/{name}/versions/{version}?api-version=v1

URI 参数

名称 在 必需 类型 说明
endpoint
 path True

string (uri)

Project 端点。 在格式 “https://your-ai-services-account-name.services.ai.azure.com/api/projects/_project"如果您的 Foundry Hub 只有一个 Project，或者使用 Hub 中的默认 Project。 或以 “https://your-ai-services-account-name.services.ai.azure.com/api/projects/your-project-name"如果要显式指定 Foundry Project 名称。
name
 path True

string

资源的名称
version
 path True

string

要创建或更新的索引的特定版本 ID。
api-version
 query True

string

minLength: 1

用于此操作的 API 版本。

请求正文

Media Types: "application/merge-patch+json"

请求正文可以为下列任一内容：

名称 说明
AzureAISearchIndex

Azure AI 搜索索引定义
CosmosDBIndex

CosmosDB 矢量存储索引定义
ManagedAzureAISearchIndex

托管 Azure AI 搜索索引定义

AzureAISearchIndex

Azure AI 搜索索引定义

名称 必需 类型 说明
connectionName True

string

与 Azure AI 搜索的连接名称
indexName True

string

要附加的 Azure AI 搜索资源中的索引名称
type True string:

AzureSearch

索引类型
description

string

资产说明文本。
fieldMapping

FieldMapping

字段映射配置
tags

object

标记字典。 可以添加、删除和更新标记。

CosmosDBIndex

CosmosDB 矢量存储索引定义

名称 必需 类型 说明
connectionName True

string

与 CosmosDB 的连接名称
containerName True

string

CosmosDB 容器的名称
databaseName True

string

CosmosDB 数据库的名称
embeddingConfiguration True

EmbeddingConfiguration

嵌入模型配置
fieldMapping True

FieldMapping

字段映射配置
type True string:

CosmosDBNoSqlVectorStore

索引类型
description

string

资产说明文本。
tags

object

标记字典。 可以添加、删除和更新标记。

ManagedAzureAISearchIndex

托管 Azure AI 搜索索引定义

名称 必需 类型 说明
type True string:

ManagedAzureSearch

索引类型
vectorStoreId True

string

托管索引的向量存储 ID
description

string

资产说明文本。
tags

object

标记字典。 可以添加、删除和更新标记。

响应

名称 类型 说明
200 OK Index:

请求已成功。
201 Created Index:

请求已成功，因此创建了一个新资源。
Other Status Codes

Azure.Core.Foundations.ErrorResponse

意外的错误响应。

标头

x-ms-error-code: string

安全性

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

作用域

名称 说明
https://ai.azure.com/.default

示例

Indexes_CreateOrUpdateVersion_MaximumSet
Indexes_CreateOrUpdateVersion_MinimumSet

Indexes_CreateOrUpdateVersion_MaximumSet

示例请求

PATCH {endpoint}/indexes/kptgsnpfjcunvvdgzfjdmnurq/versions/hxutytnzwioiijfinpdojrnrqhqb?api-version=v1

{
  "type": "Index",
  "description": "wtjqhnlwihffw",
  "tags": {
    "key1654": "aqtywrvy"
  }
}

示例响应

状态代码:
200 
{
  "type": "Index",
  "id": "xtjevbrwrwuwkbujuwpq",
  "name": "wwikvkcdcobt",
  "version": "swnonkxmjl"
}
状态代码:
201 
{
  "type": "Index",
  "id": "xtjevbrwrwuwkbujuwpq",
  "name": "wwikvkcdcobt",
  "version": "swnonkxmjl"
}

Indexes_CreateOrUpdateVersion_MinimumSet

示例请求

PATCH {endpoint}/indexes/dpfjghwaowffzhoyuwrnmws/versions/priaizsqiwxrwnhhyk?api-version=v1

{
  "type": "Index"
}

示例响应

状态代码:
200 
{
  "type": "Index",
  "name": "wwikvkcdcobt",
  "version": "swnonkxmjl"
}
状态代码:
201 
{
  "type": "Index",
  "name": "wwikvkcdcobt",
  "version": "swnonkxmjl"
}

定义

名称 说明
Azure.Core.Foundations.Error

错误对象。
Azure.Core.Foundations.ErrorResponse

包含错误详细信息的响应。
Azure.Core.Foundations.InnerError

包含有关错误的更具体信息的对象。 根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。
AzureAISearchIndex

Azure AI 搜索索引定义
CosmosDBIndex

CosmosDB 矢量存储索引定义
EmbeddingConfiguration

嵌入配置类
FieldMapping

字段映射配置类
IndexType
ManagedAzureAISearchIndex

托管 Azure AI 搜索索引定义

Azure.Core.Foundations.Error

Object

错误对象。

名称 类型 说明
code

string

服务器定义的错误代码集之一。
details

Azure.Core.Foundations.Error[]

导致此报告错误的特定错误的详细信息数组。
innererror

Azure.Core.Foundations.InnerError

包含与当前对象有关错误的更具体信息的对象。
message

string

有关错误的可读的表示形式。
target

string

错误的目标。

Azure.Core.Foundations.ErrorResponse

Object

包含错误详细信息的响应。

名称 类型 说明
error

Azure.Core.Foundations.Error

错误对象。

Azure.Core.Foundations.InnerError

Object

包含有关错误的更具体信息的对象。 根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。

名称 类型 说明
code

string

服务器定义的错误代码集之一。
innererror

Azure.Core.Foundations.InnerError

内部错误。

AzureAISearchIndex

Object

Azure AI 搜索索引定义

名称 类型 说明
connectionName

string

与 Azure AI 搜索的连接名称
description

string

资产说明文本。
fieldMapping

FieldMapping

字段映射配置
id

string

资产 ID，资产的唯一标识符
indexName

string

要附加的 Azure AI 搜索资源中的索引名称
name

string

资源的名称
tags

object

标记字典。 可以添加、删除和更新标记。
type string:

AzureSearch

索引类型
version

string

资源的版本

CosmosDBIndex

Object

CosmosDB 矢量存储索引定义

名称 类型 说明
connectionName

string

与 CosmosDB 的连接名称
containerName

string

CosmosDB 容器的名称
databaseName

string

CosmosDB 数据库的名称
description

string

资产说明文本。
embeddingConfiguration

EmbeddingConfiguration

嵌入模型配置
fieldMapping

FieldMapping

字段映射配置
id

string

资产 ID，资产的唯一标识符
name

string

资源的名称
tags

object

标记字典。 可以添加、删除和更新标记。
type string:

CosmosDBNoSqlVectorStore

索引类型
version

string

资源的版本

EmbeddingConfiguration

Object

嵌入配置类

名称 类型 说明
embeddingField

string

Embedding 字段
modelDeploymentName

string

嵌入模型的部署名称。 它可以指向父 AIServices 或连接中的模型部署。

FieldMapping

Object

字段映射配置类

名称 类型 说明
contentFields

string[]

包含文本内容的字段列表
filepathField

string

要用作文本内容源的文件路径
metadataFields

string[]

包含元数据内容的字段列表
titleField

string

包含文档标题的字段
urlField

string

包含文档 URL 的字段
vectorFields

string[]

包含向量内容的字段列表

IndexType

枚举
值 说明
AzureSearch

Azure 搜索
CosmosDBNoSqlVectorStore

科斯莫斯DB
ManagedAzureSearch

托管 Azure 搜索

ManagedAzureAISearchIndex

Object

托管 Azure AI 搜索索引定义

名称 类型 说明
description

string

资产说明文本。
id

string

资产 ID，资产的唯一标识符
name

string

资源的名称
tags

object

标记字典。 可以添加、删除和更新标记。
type string:

ManagedAzureSearch

索引类型
vectorStoreId

string

托管索引的向量存储 ID
version

string

资源的版本