Published - Get Settings

Tjeneste:: DataAgent

API-version:: v1

Returnerer de publicerede indstillinger for den angivne DataAgent.

Bemærk

Administration af konfiguration af Data Agent findes i øjeblikket som prøveversion (få mere at vide).

Rettigheder

Den person, der ringer op, skal have læserettigheder til DataAgent.

Påkrævede delegerede områder

Item.Read.All eller Item.ReadWrite.All eller DataAgent.Read.All eller DataAgent.ReadWrite.All

Microsoft Entra understøttede identiteter

Denne API understøtter de Microsoft identities, der er angivet i dette afsnit.

Identity	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Ja

Grænseflade

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataAgents/{dataAgentId}/settings

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
dataAgentId	path	True	string (uuid)	DataAgent-id'et.
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.

Svar

Name Type Beskrivelse

200 OK

Name	Type	Beskrivelse
200 OK	DataAgentSettingsResponse	Anmodningen blev fuldført.
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en `Retry-After` header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: ItemNotFound – Det ønskede element blev ikke fundet.

DataAgentSettingsResponse

Anmodningen blev fuldført.

429 Too Many Requests

ErrorResponse

Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger.

Headere

Retry-After: integer

Other Status Codes

ErrorResponse

Almindelige fejlkoder:

ItemNotFound – Det ønskede element blev ikke fundet.

Eksempler

Get published DataAgent settings example

Eksempelanmodning

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataAgents/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/settings

Eksempelsvar

Statuskode:: 200

{
  "aiInstructions": "Always respond in English. Be concise."
}

Definitioner

Name	Beskrivelse
DataAgentSettingsResponse	Indstillingerne for DataAgent.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.

DataAgentSettingsResponse

Objekt

Indstillingerne for DataAgent.

Name	Type	Beskrivelse
aiInstructions	string	Brugerdefineret AI-systemprompt for DataAgent.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
isRetriable	boolean	Når sand, kan anmodningen prøves igen. Brug svarheaderen `Retry-After` til at bestemme forsinkelsen, hvis den er tilgængelig.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.