> ## Documentation Index > Fetch the complete documentation index at: https://docs.mka1.com/llms.txt > Use this file to discover all available pages before exploring further. # Pesquisar um armazenamento de vetores > Realiza busca semântica dentro de um armazenamento de vetores para encontrar os pedaços de documento mais relevantes para uma consulta. ## OpenAPI ````yaml https://apigw.mka1.com/speakeasy.json?language=pt-BR post /api/v1/llm/vector_stores/{vector_store_id}/search openapi: 3.1.1 info: title: MKA1 API version: 1.1.0 description: >- A API MKA1 é uma API RESTful que fornece acesso à plataforma MKA1. Aprenda como começar a usar a API e o SDK TypeScript [aqui](https://mka1.apidocumentation.com/guides/getting-started). license: name: Proprietário servers: - url: https://apigw.mka1.com description: MKA1 API Gateway - url: / description: Relative server URL (configurable via SDK constructor) security: [] tags: - name: Resource Authorization description: >- Gerencie permissões para recursos LLM. Crie recursos, conceda/revoque permissões e exclua recursos. Apenas os proprietários dos recursos podem conceder, revogar ou excluir permissões. x-displayName: Autorização de Recurso - name: Embeddings description: >- Endpoints da API de incorporação de texto para gerar representações vetoriais de texto. Crie incorporações semânticas para busca, clustering e correspondência de similaridade usando vários modelos de incorporação. x-displayName: Incorporações - name: Feedback description: >- API de feedback do usuário para avaliar e comentar sobre as conclusões de chat. Coleta de classificações de positivo/negativo e feedback detalhado para melhorar as respostas do modelo e acompanhar a satisfação do usuário. x-displayName: Feedback - name: Images description: >- Pontos de extremidade da API de geração de imagens para criar imagens a partir de descrições de texto. Gere imagens com controle sobre tamanho, qualidade e estilo. x-displayName: Imagens - name: MCP Vault description: >- API do cofre MCP para armazenar configurações de servidor MCP de propriedade do usuário e credenciais criptografadas. Os agentes referenciam IDs de cofre para que os segredos sejam resolvidos apenas no momento da execução da ferramenta. x-displayName: Cofre MCP - name: Speech description: >- Pontos de extremidade da API de fala para processamento de áudio. Converta texto em fala com som natural (TTS) ou transcreva fala em texto (STT) em diferentes idiomas. x-displayName: Discurso - name: Usage description: >- API de rastreamento de uso e análise para monitoramento do consumo de tokens, contagem de solicitações e análise de custos. Veja estatísticas detalhadas por usuário, modelo e período de tempo. x-displayName: Uso - name: Extract description: >- API de extração de dados estruturados para extrair informações de arquivos. Defina esquemas JSON para extrair dados estruturados de imagens, PDFs e documentos. Suporta modelos de esquema reutilizáveis. x-displayName: Extração - name: Text Classification description: >- API de classificação de texto para categorizar textos em rótulos predefinidos. Use modelos de IA para classificar o conteúdo textual para análise de sentimento, categorização de tópicos e moderação de conteúdo. x-displayName: Classificação de Texto - name: Responses description: >- API de respostas com agentes para criar agentes de IA com uso autônomo de ferramentas. Crie assistentes conversacionais que podem usar pesquisa na web, operações de arquivos, geração de imagens, execução de código, simulação de uso de computador e integrações MCP. Suporta processamento em segundo plano, streaming e monitoramento de status em tempo real. x-displayName: Respostas - name: Files description: >- API de gerenciamento de arquivos para upload, armazenamento e gerenciamento de arquivos com expiração automática e integração com S3. Faça upload de arquivos que podem ser usados com Assistentes, Armazenamentos Vetoriais e outras funcionalidades. Os arquivos são armazenados no S3 com metadados rastreados no PostgreSQL. Suporta limpeza automática de arquivos expirados. x-displayName: Arquivos - name: Vector Stores description: >- API de armazenamento de vetores para armazenar e pesquisar documentos usando embeddings. Crie armazenamentos de vetores, faça upload de arquivos com divisão automática e geração de embeddings, e realize pesquisas semânticas. Os arquivos são processados de forma assíncrona usando fluxos de trabalho Temporais para durabilidade. Suporta limpeza automática de armazenamentos expirados e LanceDB para armazenamento eficiente de vetores. x-displayName: Armazenamentos de Vetores - name: Conversations description: >- API de gerenciamento de conversas para armazenar e recuperar o estado da conversa durante chamadas à API de Resposta. Crie conversas, adicione itens (mensagens do usuário, mensagens do assistente, mensagens do sistema) e mantenha o histórico da conversa. Suporta rastreamento de metadados e gerenciamento de estado de diálogo em múltiplas interações. x-displayName: Conversa - name: Guardrails description: >- API de diretrizes de segurança de IA para configurar moderação de conteúdo e políticas de segurança. Configure listas de palavras proibidas, detecção de injeção de prompts e prevenção de vazamento de prompts do sistema. As diretrizes aplicam-se a todas as solicitações de uma conta e podem ser testadas antes da implementação. x-displayName: Guarda-corpos - name: Models description: >- API de listagem de modelos para descobrir modelos disponíveis. Retorna IDs de modelos, propriedade e metadados de todos os modelos registrados no gateway. x-displayName: Modelos - name: Skills description: >- API de habilidades para gerenciar pacotes versionados de instruções e arquivos seguindo o padrão de Habilidades do Agente. Crie, versionar e baixe pacotes de habilidades reutilizáveis que incluam manifestos SKILL.md para ambientes de agentes. x-displayName: Habilidades - name: Chat Completions description: >- **Obsoleto: Use a API de Respostas (`/api/v1/llm/responses`) em vez disso.** Endpoints de conclusão de chat com suporte para streaming, chamadas de ferramentas e múltiplos provedores. x-deprecated: true x-displayName: Conclusões de Bate-Papo - name: Batches x-displayName: Lotes - name: Evals x-displayName: Avaliações - name: Fine-Tuning x-displayName: Ajuste Fino - name: Memory Stores x-displayName: Armazenamentos de Memória - name: Prompts x-displayName: Sugestões - name: API Key x-displayName: Chave da API - name: Organization x-displayName: Organização - name: Cluster Admin x-displayName: Administrador do cluster - name: Sessions description: Crie, inspecione, acesse e encerre sessões de sandbox. x-displayName: Sessões - name: Browser description: >- Conecte-se às sessões do navegador através do proxy da porta do gateway. As sessões do navegador expõem um endpoint do Chrome DevTools Protocol na porta 9222. x-displayName: Navegador - name: Execution description: >- Executar comandos shell e código dentro de uma sessão de sandbox existente. x-displayName: Execução - name: Workspace description: >- Inspecione o manifesto do espaço de trabalho, transfira arquivos ou arquivos compactados e baixe artefatos gerados. x-displayName: Espaço de trabalho - name: Sandbox Usage description: >- Agregue estatísticas de uso da sandbox entre sessões, execução e operações do espaço de trabalho. x-displayName: Uso do Sandbox - name: Sandbox Pricing description: >- Gerenciamento de cluster-admin da tabela de preços de computação da sandbox usada para gastos orçados. x-displayName: Preço da Sandbox - name: Agents description: Crie e gerencie definições de agentes reutilizáveis. x-displayName: Agentes - name: Agent Versions description: >- Inspecione o histórico de configuração de um agente e reverta para uma versão anterior. x-displayName: Versões do Agente - name: Agent Runs description: Execute agentes salvos e inspecione os resultados da execução persistidos. x-displayName: Executa Agente - name: Agent Connectors description: >- Conecte agentes salvos a canais de mensagens externos, como o Telegram, incluindo troca de texto, foto e documentos compatíveis. x-displayName: Conectores de Agente - name: Agent Schedules description: Crie e gerencie execuções de agentes salvos agendadas ou recorrentes. x-displayName: Agendas de Agentes - name: schema-4_other x-displayName: outro - name: Budgets x-displayName: Orçamentos - name: Settings x-displayName: Configurações - name: Compute Jobs x-displayName: Jobs de Computação - name: Compute Services x-displayName: Serviços de Computação - name: Compute Catalog x-displayName: Catálogo de Computação - name: Compute Secrets x-displayName: Calcular Segredos - name: Compute Usage x-displayName: Uso de Computação - name: Compute Tenants x-displayName: Calcular Inquilinos - description: Criar, listar, ler, atualizar e excluir repositórios. name: Repositories x-displayName: Repositórios paths: /api/v1/llm/vector_stores/{vector_store_id}/search: post: tags: - Vector Stores summary: Pesquisar um armazenamento de vetores description: >- Realiza busca semântica dentro de um armazenamento de vetores para encontrar os pedaços de documento mais relevantes para uma consulta. operationId: searchVectorStore parameters: - name: vector_store_id in: path required: true schema: type: string description: O ID do armazenamento de vetores a ser pesquisado. example: vs_abc123 - name: X-On-Behalf-Of in: header required: false schema: type: string description: Optional external end-user identifier forwarded by the API gateway. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchVectorStoreRequest' example: query: How do I reset my password? max_num_results: 5 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/VectorStoreSearchResults' example: object: vector_store.search_results.page search_query: How do I reset my password? data: - file_id: file-abc123 filename: user-guide.pdf score: 0.92 content: - type: text text: >- To reset your password, navigate to Settings > Security > Reset Password... has_more: false next_page: null security: - bearerAuth: [] x-codeSamples: - lang: python label: Python (SDK) source: |- from meetkai_mka1 import SDK with SDK( bearer_auth="", ) as sdk: res = sdk.llm.vector_stores.search(vector_store_id="vs_abc123", query="How do I reset my password?", max_num_results=5, rewrite_query=False) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SDK } from "@meetkai/mka1"; const sdk = new SDK({ bearerAuth: "", }); async function run() { const result = await sdk.llm.vectorStores.search({ vectorStoreId: "vs_abc123", searchVectorStoreRequest: { query: "How do I reset my password?", maxNumResults: 5, }, }); console.log(result); } run(); - lang: csharp label: CSharp (SDK) source: |- using MeetKai.MKA1; using MeetKai.MKA1.Types.Components; var sdk = new SDK(bearerAuth: ""); var res = await sdk.Llm.VectorStores.SearchAsync( vectorStoreId: "vs_abc123", body: new MeetKai.MKA1.Types.Components.SearchVectorStoreRequest() { Query = Query.CreateStr( "How do I reset my password?" ), MaxNumResults = 5, } ); // handle response components: schemas: SearchVectorStoreRequest: type: object properties: query: anyOf: - type: string - type: array items: type: string description: >- Uma string de consulta para uma pesquisa, ou um array de strings de consulta. filters: $ref: '#/components/schemas/Filter' description: >- Um filtro a ser aplicado com base nos atributos do arquivo (avaliado em relação aos atributos atuais de cada arquivo). Uma chave de atributo ausente falha em todas as comparações, incluindo ne/nin; gt/gte/lt/lte são apenas numéricos; in/nin aceitam um valor de array. max_num_results: type: integer minimum: 1 maximum: 50 default: 10 description: >- O número máximo de resultados a retornar. Esse número deve estar entre 1 e 50, inclusive. ranking_options: type: object properties: ranker: enum: - auto - none type: string default: auto description: >- Ative a reclassificação; defina como 'nenhum' para desativar, o que pode ajudar a reduzir a latência. score_threshold: type: number default: 0 description: Limite mínimo de pontuação para resultados de busca. description: Opções de classificação para busca. rewrite_query: type: boolean default: false description: >- Se devemos reescrever a consulta em linguagem natural para busca vetorial. required: - query description: Corpo da solicitação para pesquisar um armazenamento de vetores. examples: - query: How do I reset my password? max_num_results: 5 VectorStoreSearchResults: type: object properties: object: const: vector_store.search_results.page description: O tipo de objeto, que é sempre 'vector_store.search_results.page'. search_query: type: string description: A consulta que foi usada para a busca. data: type: array items: $ref: '#/components/schemas/VectorSearchResult' description: Array de resultados da busca. has_more: type: boolean description: Se há mais resultados disponíveis. next_page: anyOf: - type: string - type: 'null' description: >- Cursor para a próxima página de resultados, ou nulo se não houver mais resultados. required: - object - search_query - data - has_more - next_page description: Uma página de resultados de busca do banco de vetores. examples: - object: vector_store.search_results.page search_query: How do I reset my password? data: - file_id: file-abc123 filename: user-guide.pdf score: 0.92 content: - type: text text: >- To reset your password, navigate to Settings > Security > Reset Password... has_more: false next_page: null Filter: anyOf: - type: object properties: type: enum: - eq - ne - gt - gte - lt - lte - in - nin type: string description: >- Operador de comparação: eq (igual), ne (diferente), gt (maior que), gte (maior ou igual), lt (menor que), lte (menor ou igual), in (dentro), nin (não dentro). key: type: string description: A chave para comparar com o valor. value: anyOf: - type: string - type: number - type: boolean - type: array items: anyOf: - type: string - type: number - type: boolean description: >- O valor a ser comparado com a chave do atributo; suporta tipos string, número, booleano ou array. required: - type - key - value description: >- Um filtro usado para comparar uma chave de atributo especificada a um valor dado usando uma operação de comparação definida. - type: object properties: type: enum: - and - or type: string description: 'Tipo de operação: ''e'' ou ''ou''.' filters: type: array items: anyOf: - type: object properties: type: enum: - eq - ne - gt - gte - lt - lte - in - nin type: string description: >- Operador de comparação: eq (igual), ne (diferente), gt (maior que), gte (maior ou igual), lt (menor que), lte (menor ou igual), in (dentro), nin (não dentro). key: type: string description: A chave para comparar com o valor. value: anyOf: - type: string - type: number - type: boolean - type: array items: anyOf: - type: string - type: number - type: boolean description: >- O valor a ser comparado com a chave do atributo; suporta tipos string, número, booleano ou array. required: - type - key - value description: >- Um filtro usado para comparar uma chave de atributo especificada a um valor dado usando uma operação de comparação definida. - type: object properties: type: enum: - and - or type: string description: 'Tipo de operação: ''e'' ou ''ou''.' filters: type: array items: anyOf: - type: object properties: type: enum: - eq - ne - gt - gte - lt - lte - in - nin type: string description: >- Operador de comparação: eq (igual), ne (diferente), gt (maior que), gte (maior ou igual), lt (menor que), lte (menor ou igual), in (dentro), nin (não dentro). key: type: string description: A chave para comparar com o valor. value: anyOf: - type: string - type: number - type: boolean - type: array items: anyOf: - type: string - type: number - type: boolean description: >- O valor a ser comparado com a chave do atributo; suporta tipos string, número, booleano ou array. required: - type - key - value description: >- Um filtro usado para comparar uma chave de atributo especificada a um valor dado usando uma operação de comparação definida. - {} description: >- Array de filtros para combinar. Os itens podem ser ComparisonFilter ou CompoundFilter. required: - type - filters description: Combine vários filtros usando 'e' ou 'ou'. description: >- Array de filtros para combinar. Os itens podem ser ComparisonFilter ou CompoundFilter. required: - type - filters description: Combine vários filtros usando 'e' ou 'ou'. VectorSearchResult: type: object properties: file_id: type: string description: A ID do arquivo contendo este resultado. filename: type: string description: O nome do arquivo. score: type: number description: A pontuação de relevância deste resultado. attributes: type: object propertyNames: type: string additionalProperties: anyOf: - type: string - type: boolean - type: number description: Atributos do arquivo. content: type: array items: $ref: '#/components/schemas/VectorSearchResultContent' description: Array de itens de conteúdo. required: - file_id - filename - score - content description: >- Um único resultado de busca de uma pesquisa em um banco de dados vetorial. VectorSearchResultContent: type: object properties: type: const: text description: O identificador de tipo de conteúdo para conteúdo de texto. text: type: string description: O conteúdo textual do resultado da pesquisa. required: - type - text description: Item de conteúdo em um resultado de busca. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key description: >- Gateway auth: send `Authorization: Bearer `. For multi-user server-side integrations, you can also send `X-On-Behalf-Of: `. ````