Cria uma base de conhecimento, seja uma base de conhecimento não estruturada baseada em documentos ou áudio/vídeo, ou uma base de conhecimento estruturada para consultas de dados ou perguntas e respostas baseadas em imagens.
Descrição da operação
-
Requisitos de permissão:
- Usuário do Resource Access Management (RAM): Obtenha primeiro as permissões de API para o Alibaba Cloud Model Studio (você pode usar a política
AliyunBailianDataFullAccess, que inclui a permissão sfm:CreateIndex necessária para esta operação) e entre em um workspace antes de invocar esta operação. - Conta Alibaba Cloud: Possui permissões por padrão e pode invocar esta operação diretamente.
- Usuário do Resource Access Management (RAM): Obtenha primeiro as permissões de API para o Alibaba Cloud Model Studio (você pode usar a política
-
Método de chamada: Use o SDK do Alibaba Cloud Model Studio mais recente. O SDK encapsulou a lógica complexa de cálculo de assinatura e simplifica o procedimento de invocação.
-
O que fazer a seguir: Esta operação realiza apenas a inicialização do trabalho de criação da base de conhecimento. Após invocar esta operação, você deve invocar a operação SubmitIndexJob para concluir a criação (caso contrário, você obterá uma base de conhecimento vazia). Para exemplos de código, consulte o Guia da API de Base de Conhecimento.
-
Idempotência: Esta operação não possui idempotência. Invocações repetidas podem criar múltiplas bases de conhecimento com o mesmo nome. Implemente invocações idempotentes consultando primeiro e depois criando.
Limite de taxa: Esta operação está sujeita a limitação de taxa. Não exceda 10 chamadas por segundo. Se você for limitado, tente novamente mais tarde.
Experimente agora
Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.
Autorização RAM
A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:
-
Ação: As ações que podem ser usadas no elemento
Actiondas instruções de política de permissão do RAM para conceder permissões para executar a operação. -
API: A API que você pode chamar para executar a ação.
-
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
-
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento
Resourceda política. - Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento
Resourceda política.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento
-
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
-
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.
Ação | Nível de acesso | Tipo de recurso | Chave de condição | Ação dependente |
|---|---|---|---|---|
sfm:CreateIndex | create | *Todos os recursos.
| Nenhuma | Nenhuma |
Sintaxe da solicitação
POST /{WorkspaceId}/index/create HTTP/1.1
Parâmetros de caminho
Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|
| WorkspaceId | string | Sim | O ID do workspace, que especifica o workspace no qual criar a base de conhecimento. Para mais informações, consulte Como usar workspaces. | llm-3z7uw7fwz0vexxxx. |
Parâmetros da solicitação
Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|
| Name | string | Sim | O nome da base de conhecimento. O nome deve ter de 1 a 20 caracteres e pode conter caracteres chineses, letras, dígitos, sublinhados (_), hifens (-), pontos (.) e dois-pontos (:). | EnterpriseHelpDocLibrary. |
| StructureType | string | Sim | O tipo da base de conhecimento. Valores válidos:
O tipo da base de conhecimento não pode ser alterado após a criação. Valores válidos:
| unstructured. |
| EmbeddingModelName | string | Não |
Valor padrão: vazio, que usa o modelo text-embedding-v2. | text-embedding-v4 |
| RerankModelName | string | Não | O modelo de reclassificação usado pela base de conhecimento. O modelo de reclassificação é um sistema de pontuação externo que calcula a pontuação de similaridade entre a consulta do usuário e cada trecho de texto na base de conhecimento, classifica-os em ordem decrescente e retorna os K principais trechos de texto com as maiores pontuações. Valores válidos:
Valor padrão: vazio, que usa gte-rerank-hybrid. Se você precisar apenas de reclassificação semântica, use Valores válidos:
| gte-rerank-hybrid. |
| RerankMinScore | number | Não | O limite de similaridade. Apenas trechos de texto com pontuações de similaridade que excedam este valor são recuperados. Este parâmetro filtra os trechos de texto retornados pelo modelo de reclassificação. Faixa de valores: [0,01-1,00]. Se não for especificado, o valor padrão é 0,01. | 0.20 |
| ChunkSize | integer | Não | O tamanho do trecho, que especifica o número máximo de caracteres por trecho de texto. Quando esse comprimento é excedido, é provável que o texto seja truncado. Faixa de valores: [1-6000]. Se não for especificado, o valor padrão é 500. Se | 128 |
| OverlapSize | integer | Não | O tamanho de sobreposição de trechos, que especifica o número de caracteres sobrepostos entre o trecho de texto atual e o trecho de texto anterior. Faixa de valores: [0-1024]. Se não for especificado, o valor padrão é 100.
| 16 |
| Separator | string | Não | Este parâmetro não está disponível. Não passe este parâmetro. | (?<=。) |
| SourceType | string | Não | Este parâmetro é obrigatório no SDK mais recente. Caso contrário, chamar a operação SubmitIndexJob retorna um erro: Required parameter(data_sources) missing or invalid. O tipo de fonte de dados. Valores válidos:
Se este parâmetro for definido como DATA_CENTER_CATEGORY, você deve especificar o parâmetro Para criar uma base de conhecimento vazia, use uma categoria vazia que não contenha arquivos: defina este parâmetro como DATA_CENTER_CATEGORY e passe o ID da categoria vazia em Valores válidos:
| DATA_CENTER_FILE. |
| DocumentIds | array | Não | A lista de arquivos a serem importados ao criar a base de conhecimento. Especifique os IDs dos arquivos aqui. Recomendamos importar no máximo 10.000 arquivos. Para os arquivos restantes, chame a operação SubmitIndexAddDocumentsJob para continuar a importação. | |
string | Não | O ID do arquivo, que é o | file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx. | |
| CategoryIds | array | Não | A lista de IDs de categorias a serem importados ao criar a base de conhecimento. Todos os arquivos nas categorias especificadas são importados. Recomendamos importar no máximo 500 arquivos. Para os arquivos restantes, chame a operação SubmitIndexAddDocumentsJob para continuar a importação. | |
string | Não | O ID da categoria, que é o | ca_hiu2383nfxxxx. | |
| TableIds | array | Não | Este parâmetro não está disponível. Não passe este parâmetro. | |
string | Não | |||
| SinkType | string | Sim | O tipo de armazenamento vetorial da base de conhecimento. Para mais informações, consulte Base de conhecimento. Valores válidos:
Se você não usou o armazenamento ADB no Alibaba Cloud Model Studio anteriormente, vá para a página Criar Base de Conhecimento, selecione ADB-PG como o tipo de armazenamento vetorial e conclua a autorização conforme solicitado. Se você passar ADB, deverá especificar os parâmetros Valores válidos:
| BUILT_IN. |
| SinkInstanceId | string | Não | O ID da instância do AnalyticDB for PostgreSQL (obrigatório apenas quando | gp-bp32109xxxx. |
| SinkRegion | string | Não | A região da instância do AnalyticDB for PostgreSQL (obrigatório apenas quando | cn-hangzhou. |
| Columns | array<object> | Não | Este parâmetro não está disponível. Não passe este parâmetro. | |
object | Não | Este parâmetro não está disponível. Não passe este parâmetro. | ||
| Column | string | Não | Este parâmetro não está disponível. Não passe este parâmetro. | school. |
| IsRecall | boolean | Não | Este parâmetro não está disponível. Não passe este parâmetro. | true. |
| IsSearch | boolean | Não | Este parâmetro não está disponível. Não passe este parâmetro. | true. |
| Name | string | Não | Este parâmetro não está disponível. Não passe este parâmetro. | School. |
| Type | string | Não | Este parâmetro não está disponível. Não passe este parâmetro. | string. |
| Description | string | Não | A descrição da base de conhecimento. A descrição pode ter até 1000 caracteres. Valor padrão: vazio. | A biblioteca de documentos de ajuda empresarial inclui materiais importantes, como políticas da empresa e catálogos de produtos. |
| metaExtractColumns | array<object> | Não | A configuração de extração de metadados. Metadados são um conjunto de atributos adicionais relacionados ao conteúdo de dados não estruturados. Esses atributos são integrados aos trechos de texto como pares chave-valor. Para mais informações, consulte Base de conhecimento. | |
object | Não | |||
| Key | string | Não | O campo de metadados. O campo deve ter de 1 a 50 caracteres e pode conter apenas letras e sublinhados. Se este parâmetro for especificado, você também deve especificar os parâmetros | author. |
| Value | string | Não | O valor do campo de metadados. | Tim. |
| Type | string | Não | O método de extração para o campo de metadados. Valores válidos:
Valores válidos:
| constant. |
| Desc | string | Não | A descrição em chinês do campo de metadados. A descrição pode ter até 1000 caracteres e pode conter caracteres chineses, letras, dígitos, sublinhados (_), hifens (-), pontos (.) e dois-pontos (:). Valor padrão: vazio. | AuthorName. |
| EnableLlm | boolean | Não | Especifica se este campo de metadados e seu valor participam do processo de geração de respostas do modelo de linguagem grande junto com o conteúdo do trecho de texto. Valores válidos:
Valor padrão: false. Valores válidos:
| false. |
| EnableSearch | boolean | Não | Especifica se este campo de metadados e seu valor participam da recuperação da base de conhecimento junto com o conteúdo do trecho de texto. Valores válidos:
Valor padrão: false. Valores válidos:
| false. |
| enableHeaders | boolean | Não | Especifica se deve tratar a primeira linha de todos os arquivos xlsx e xls como cabeçalhos e concatená-los em cada trecho de texto, impedindo que o modelo de linguagem grande trate os cabeçalhos como linhas de dados comuns. Ative este recurso apenas quando todos os arquivos importados estiverem no formato .xlsx ou .xls e contiverem cabeçalhos. Caso contrário, não o ative. Valores válidos:
Se não for especificado, este recurso estará desativado por padrão. Valores válidos:
| false. |
| chunkMode | string | Não | Este parâmetro não está disponível. Não passe este parâmetro. Valores válidos:
| regex. |
| EnableRewrite | boolean | Não | Especifica se deve ativar a reescrita de conversas de múltiplas rodadas. Valores válidos:
Se não for especificado, este recurso estará ativado por padrão. Valores válidos:
| true. |
| CreateIndexType | string | Não | Este parâmetro não está disponível. Não passe este parâmetro. | standard. |
| pipelineCommercialType | string | Não | Este parâmetro não está disponível. Não passe este parâmetro. | standard. |
| pipelineCommercialCu | integer | Não | Este parâmetro não está disponível. Não passe este parâmetro. | 1 |
| pipelineRetrieveRateLimitStrategy | string | Não | Este parâmetro não está disponível. Não passe este parâmetro. | downgrade. |
| knowledgeType | string | Não | O código da fonte de dados. Obrigatório ao criar uma base de conhecimento de consulta de dados. Usado em conjunto com os parâmetros table e database.
| 260xxx. |
| RerankMode | string | Não | O nome da tabela de dados. Obrigatório ao criar uma base de conhecimento de consulta de dados. A tabela de dados deve existir na fonte de dados especificada por connectId ou datasourceCode. Valores válidos:
| lance. |
| RerankInstruct | string | Não | O nome do banco de dados. Obrigatório ao criar uma base de conhecimento de consulta de dados. O banco de dados deve existir na fonte de dados especificada por datasourceCode. | database_a6eacabe6 |
Não | Este parâmetro não está disponível. Não passe este parâmetro. | document. | ||
Não | Este parâmetro não está disponível. Não passe este parâmetro. | basic_document_qa. | ||
Não | Este parâmetro não está disponível. Não passe este parâmetro. | conn_mysql_xxx_xxx. | ||
Não | connector. | |||
Não | Este parâmetro não está disponível. Não passe este parâmetro. [_single.params.RerankMode.enum.similar: 相似模式。]similar: Modo de similaridade. [_single.params.RerankMode.enum.custom: 自定义模式。]custom: Modo personalizado. [_single.params.RerankMode.enum.qa:(默认值) 问答模式。]qa: (Padrão) Modo de perguntas e respostas. [parameters.33.schema.enumValueTitles.similar: 相似模式。]similar: Modo de similaridade. [parameters.33.schema.enumValueTitles.custom: 自定义模式。]custom: Modo personalizado. [parameters.33.schema.enumValueTitles.qa:(默认值) 问答模式。]qa: (Padrão) Modo de perguntas e respostas. [_single.params.RerankMode.enum.similar: 相似模式。]similar: Modo de similaridade. [_single.params.RerankMode.enum.custom: 自定义模式。]custom: Modo personalizado. [_single.params.RerankMode.enum.qa:(默认值) 问答模式。]qa:(默认值) 问答模式。 [parameters.33.schema.enumValueTitles.similar: 相似模式。]similar: 相似模式。 [parameters.33.schema.enumValueTitles.custom: 自定义模式。]custom: 自定义模式。 [parameters.33.schema.enumValueTitles.qa:(默认值) 问答模式。]qa:(默认值) 问答模式。 Valores válidos:
| qa | ||
Não | Este parâmetro não está disponível. Não passe este parâmetro. |
Elementos de resposta
Elemento | Tipo | Descrição | Exemplo |
|---|---|---|---|
object | Esquema da resposta. | ||
| Code | string | O código de status do erro. | |
| Data | object | Os dados comerciais retornados quando a solicitação é bem-sucedida. | |
| Id | string | O ID da base de conhecimento, também conhecido como Armazene este valor adequadamente. Ele é necessário para todas as operações de API subsequentes relacionadas a esta base de conhecimento. | jkurxhxxxx. |
| Message | string | A mensagem de erro. | |
| RequestId | string | O ID da solicitação. | 17204B98-xxxx-4F9A--2446A84821CA. |
| Status | string | O código de status retornado pela operação. | "200" |
| Success | boolean | Indica se a solicitação foi bem-sucedida. Valores válidos:
| true. |
Exemplos
Resposta de sucesso
JSON formato
{
"Code": "",
"Data": {
"Id": "jkurxhxxxx"
},
"Message": "",
"RequestId": "17204B98-xxxx-4F9A--2446A84821CA",
"Status": "\"200\"",
"Success": true
}
Códigos de erro
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.