Consulte la liste et les informations des fragments de texte.
Description de l'opération
- Pour les bases de connaissances de recherche de documents ou de recherche audio et vidéo, cette opération interroge tous les fragments d'un fichier spécifié. Pour les bases de connaissances de requête de données ou de questions-réponses sur images, cette opération récupère les informations sur tous les fragments de texte.
- Les utilisateurs Resource Access Management (RAM) doivent d'abord obtenir les autorisations d'API pour Model Studio (nécessite
AliyunBailianDataFullAccess, qui inclut l'autorisation sfm:ChunkList), et rejoindre un espace de travail avant d'appeler cette opération. Les comptes Alibaba Cloud peuvent appeler cette opération directement sans autorisation. Utilisez la dernière version du SDK Model Studio pour appeler cette opération. - Avant d'appeler cette opération, assurez-vous que votre base de connaissances a été créée et n'a pas été supprimée (c'est-à-dire que l'identifiant de la base de connaissances
IndexIdest valide). - Cette opération est idempotente.
Testez maintenant
Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.
Autorisation RAM
Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :
-
Action : les actions peuvent être utilisées dans l'élément
Actiondes instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération. - API : l'API que vous pouvez appeler pour exécuter l'action.
- Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
-
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément
Resourcede la politique. - Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément
Resourcede la politique.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément
- Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
- Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.
Action | Niveau d'accès | Type de ressource | Clé de condition | Action dépendante |
|---|---|---|---|---|
sfm:ChunkList | list | *All Resource
| Aucune | Aucune |
Syntaxe de la requête
Paramètres de chemin
Paramètre | Type | Requis | Description | Exemple |
|---|---|---|---|---|
| WorkspaceId | string | Oui | L'identifiant de l'espace de travail de la base de connaissances. Pour plus d'informations sur la façon d'obtenir l'identifiant de l'espace de travail, consultez Comment utiliser un espace de travail. | llm-3z7uw7fwz0vxxxx |
Paramètres de requête
| Paramètre | Type | Requis | Description | Exemple |
|---|---|---|---|---|
| body | object | Non | Le corps des paramètres de la requête. | |
| Fields | array | Non | Un tableau de noms de champs utilisé pour filtrer les champs non privés (ceux qui ne sont pas préfixés par un tiret bas _) dans le champ Metadata renvoyé par cette opération. Par défaut, Fields est vide et tous les champs non privés de Metadata sont renvoyés. Pour ne renvoyer que des champs non privés spécifiques dans Metadata, comme title, transmettez title dans ce paramètre.Valeur par défaut : vide. | |
| string | Non | Le nom du champ. | name | |
| Filed | string | Non | Le champ d'identifiant de fichier dans l'ancien SDK Model Studio. L'utilisation et la valeur par défaut sont identiques à celles du champ FileId. Si vous utilisez les versions suivantes (ou ultérieures) du SDK Model Studio, utilisez plutôt le champ FileId. Si vous utilisez le SDK Model Studio SWIFT, continuez à utiliser ce champ.
Comment vérifier la version du SDK Model Studio : Visitez le centre du SDK Model Studio, cliquez sur "Installer" dans le volet de navigation gauche, définissez la version de l'API sur "2023-12-29", sélectionnez votre langage de programmation, puis cliquez sur "Historique des versions" pour afficher la version. | file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx |
| FileId | string | Non | L'identifiant du fichier, qui correspond au FileId renvoyé par l'opération AddFile. Ce champ n'est pas requis pour les bases de connaissances de requête de données ou de questions-réponses sur images. Ce champ est requis pour les bases de connaissances de recherche de documents. Vous pouvez également obtenir l'identifiant du fichier en cliquant sur l'icône d'identifiant à côté du nom du fichier dans l'onglet Fichiers des
Données d'application. Vous pouvez utiliser l'identifiant du fichier pour filtrer les fragments renvoyés. Valeur par défaut : vide.. | file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx |
| IndexId | string | Oui | L'identifiant de la base de connaissances, qui correspond au Data.Id renvoyé par l'opération CreateIndex. | otoru9xxxx |
| PageNum | integer | Non | Le numéro de page à interroger. Valeur minimale : 1. Valeur par défaut : 1. | 1 |
| PageSize | integer | Non | Le nombre de fragments de texte à afficher par page dans une requête paginée. Valeur maximale : 100. Valeur par défaut : 10. | 10 |
Éléments de réponse
| Élément | Type | Description | Exemple |
|---|---|---|---|
| object | |||
| Code | string | Le code d'état de l'erreur. | Index.InvalidParameter |
| Data | object | Les données métier renvoyées par l'opération. | |
| Nodes | array<object> | La liste des fragments de texte. | |
| object | L'objet fragment de texte. | ||
| Metadata | any | The metadata map of the text chunk. The file_path field in the metadata map of document search knowledge bases is meaningless. Do not use it in your business code.When retrieving a document search knowledge base, if a chunk contains an image, the image is returned through the image_url field in the metadata map, along with an expiration time. | |
| Score | number | The similarity score of the text chunk. | 0 |
| Text | string | The content of the text chunk. | 阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员,都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作,在 5分钟内开发出一款大模型应用,或在几小时内训练出一个专属模型,从而将更多精力专注于应用创新。 |
| Total | integer | Le nombre total de résultats renvoyés. | 1 |
| Message | string | Le message d'erreur. | Paramètre requis (%s) manquant ou non valide, veuillez vérifier les paramètres de la requête |
| RequestId | string | L'identifiant de la requête. | 8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1 |
| Status | string | Le code d'état renvoyé par l'opération. | 200 |
| Success | boolean | Indique si l'opération a réussi. Valeurs valides :
| true |
Exemples
正常返回示例
JSON format